Add or Edit Scheduled Jobs

You can use the Background Processes page to add or edit jobs and then schedule the jobs so that they are executed as a background process. For example, there is a job that refreshes the students in dynamic groups that you created using views. You can schedule it to run on an interval of your choice. You can also specify whether or not it runs (Active Yes or No) and who is notified when it completes.

The page also displays existing SQL jobs which you can only view, activate, or deactivate but cannot add or edit from Anthology Student. For example, there is a job that refreshes the students in dynamic groups using a query. For SQL jobs, you cannot change the interval. You can specify whether or not it runs (Active Yes or No) and who is notified when it completes.

Prerequisites

You must have System Administration - Processes - Manage authorization.

You should also be familiar with the Background for the Jobs for Anthology Student .

Access Method

Select the Processes tile > locate System Administration in the tree > select Background Processes.

Procedure to Add or Edit Items

1. Click the Schedule tab.

2. If you want to:

   • Add a new list item, click the New button on the toolbar

   • Edit an existing list item, click the name in the list

   • Add a new list item by copying and modifying an existing list item, select on the row in the list and click the Duplicate button on the toolbar

3. Review, specify, or change the following values. The fields that are displayed will vary depending on the job type.

   End Date - Leave blank for none The end date of the scheduled job. Http Verb Select the HTTP verb. The values are Post, Put, Get, and Delete. This option is displayed when you select Webhook in Job Type. Is Active Specifies whether or not the job is active and still being run. Job Schedule Specifies when you want the job to run. You can select a predefined schedule or "Manually enter cron value" to specify your own schedule Job Type The supported job types are Batch Process, Service, Webhook, and Workflow. For information about using these options, contact your Professional Services Representative. Name The name of the job. Operation Name The Operation Name to display in notification messages. Notifications from scheduled jobs will route to the correct UI element based on the Operation Name. Schedule (cron format) The cron string that specifies when the job is run. If you selected:  - "Manually enter cron value" in the Job Schedule list, you must specify the cron string - Any other value in the Job Schedule list, Anthology Student displays the cron string appropriate for the selected schedule

   Start Date - Leave blank for immediately The start date of the scheduled job. Time Zone Select the time zone that you want Anthology Student to use to determine when to run a scheduled job. User Notification The staff who will be notified when a scheduled job is completed. Webhook URL The Webhook URL. Workflow Schedule Entity Name Enter the workflow schedule entity name to be used for the schedule.

4. If you selected Webhook and you want to add job parameters, click Add Parameter to add the parameter key and parameter value.

5. If you want to save and:

   • Continue making changes, click the Save button

   • Continue to add another item to the list, click the Save & New button

   • Close, click the Save & Close button

When the job is executed, Anthology Student displays the results on the History tab.

For information about scheduled jobs, refer to Scheduled Jobs Migration for Anthology Cloud topic in the Administration and Configuration Help for the version of the product using.

Example of a Cleanup Job

The following example of a cleanup job specifies 1000 history records will be kept across all jobs with up to 20 entries (rows) per job type. After 4 weeks all history records are deleted.

@MaxEntries INT = 1000,

@MaxPerJob INT = 20,

@MaxWeeks INT = 4

Example of an Archive Attendance Job

The following example displays the job that archives attendance on a daily basis.

Example of a Scheduled Workflow Job

Previously, when an institution created a workflow based on a schedule, the process was to schedule an SQL job to trigger the workflow.

With Anthology Student 20.0 and later, you can trigger workflows with scheduled jobs created in Anthology Student.

1. Sign into Anthology Student with an Administrator User Id. You must have permissions for the Admin.BackgroundProcesses.View and Admin.BackgroundProcesses.Save operations.

2. Select the Processes tile > locate System Administration in the tree > select Background Processes.

3. Click the New button and specify the schedule parameters. The schedule in the example below will execute the job every day at midnight.

   When you select a value from the Job Schedule drop-down, the Schedule (cron fornat) field is populated automatically. You can also specify a custom cron string. See Examples of crontab expressions.

   

4. Save the new job. Select it in the Scheduled Jobs grid and click Run Now to test it.

   

5. View the details by expanding the row.

   

Limitations

You cannot edit the following values for list items that have a Yes in the System Job column:

• Job Name

• Job Parameters

• Job Type

  The fields that are displayed depending on the job type

These items are defined by Anthology Student.