AX2537

Job properties

This topic is a reference for the settings that can be defined for a Scheduler job.

General

This section defines general settings for the job.

Item Description
Description

Optional. The description of the job.

The job description can also be edited in Axiom Explorer, in the Scheduler Jobs Library.
Job Restart Behavior

Specifies whether and how the job should be restarted if it is interrupted prior to completion. Select one of the following:

  • Do not reschedule this job. In this case, you must manually reschedule the job if it needs to be run before its next scheduled execution.

  • Restart the job from the first task. The entire job is run again, even if some of the tasks were completed successfully before the job was interrupted.

  • Resume the job beginning with the first uncompleted task. (Default) The job resumes and only the uncompleted tasks are run.

A job would be interrupted if the Scheduler server processing it was restarted, or if the Scheduler service on the server was stopped or restarted, or if the Scheduler server was disabled from the Servers tab (Service > Servers) of the Scheduler dialog.
Job Results Cleanup

Specifies whether historical job results are purged when the job is run.

To purge job results:

  1. Select Purge historical job results whenever this job runs.
  2. In Number of days to keep results for this job, specify the number of days to keep when purging results. By default this is set to 0, which means all job results will be purged except the result for the current job execution.

A day is counted as 24 hours from the time the cleanup task is executed. So if you specify 1 day, and the task is run at 11:00 PM on Tuesday, then all results prior to 11:00 PM Monday are purged.

If this option is not selected, then historical job results remain in the database until the system's Purge System Data task is run.
Priority Elevation

Specifies the priority of the job in the scheduled jobs queue, within the job's priority category. Select one of the following:

  • Default: (Default) This job is run on a "first come, first served" basis. The total number of jobs that can be run at one time is determined by the configured number of Scheduler threads for the installation.
  • Reduced: The job is designated as a low priority job, and remains at the bottom of the queue until other jobs with Default and Elevated priority have been run.
  • Elevated: The job is designated as a high priority job, and is moved to the top of the queue to be run before Default and Reduced priority jobs.
  • Interrupt: The job is run immediately, regardless of any jobs currently waiting in the scheduled jobs queue, and regardless of whether any Scheduler threads are currently available to run it. If no Scheduler threads are currently available, a new thread is created, even if this exceeds the configured thread limit for the installation.

Job execution order also depends on the priority category of a specific job execution. See Processing priority for scheduled jobs.
Mark as System Job

Specifies whether the job is run as a system job. Only administrators can edit this check box.

If this check box is selected, the job is run under the "Scheduler Service" system identity instead of a user identity, and the job is run by the system Scheduler server which operates on the Axiom Application Server.

Generally, this check box should only be selected for system "support" tasks that should not depend on individual user rights. This check box is not available if the job contains non-system tasks (generally, spreadsheet-related tasks).

For more information, see System jobs.

Put the system in 'admin only' mode during this job

If this option is selected, then the system will be placed into administrator-only mode at the start of the job, and then placed back into full access mode when all tasks are completed (including any sub-jobs). This is the same behavior as going to Manage > Security > System Access and selecting Administrators Only.

NOTES:  

  • You should make sure that any jobs using admin-only mode do not overlap. For example, imagine that job A starts and places the system in admin-only mode. While job A is still running, job B starts and finishes. If job B also uses admin-only mode, then when job B finishes the system will be placed back into full access mode, meaning the remainder of job A will be processed in full access mode.

  • Any job using admin-only mode must be run by an administrator.

Generally speaking, any job set to run using admin-only mode should be run at a time when no end users will be logged into the system and no other Scheduler jobs will be running. For more information about admin-only mode, see Preventing users from accessing the system.

Job Variables

This tab has two sections for job variables:

  • In the Job values section at the top of the tab, you can manage user-defined variables for use in the current job.

    To add or remove variables, use the Add, Remove Selected, or Clear All commands in the Job Variables group of the Job tab. This group is only available when you have selected the Job Variables section in the left-hand side of the job.

    When creating user-defined variables, do not add curly brackets to the variable name. Curly brackets are only required when you use the variable in a job or task setting.

  • In the System defined values section at the bottom of the tab, you can view the system variables available for use in the job.

You can right-click any variable in this section (user-defined or system-defined) and select Copy variable name to clipboard. You can then navigate to the setting where you want to use the variable, and then paste it. The variable will be pasted with the necessary curly brackets.

For more information, see Using job variables.

Scheduling Rules

Each row in this section defines a scheduling rule for the job. Jobs will be automatically scheduled according to the settings in this section.

To add or remove scheduling rules, use the Add, Remove Selected, or Clear All commands in the Scheduling Rules group of the Job tab. This group is only available when you have selected the Scheduling Rules section in the left-hand side of the job.

For more information, see Defining scheduling rules for a job.

Item Description
Active

Specifies whether the scheduling rule is active. If this check box is not selected, then the rule is ignored for purposes of scheduling the job.
Starting On

Optional. Specifies the earliest date and time for the scheduling rule to take effect.

If you want the job to run one time only, set Starting On and Ending On dates to the same date/time.
Ending On Optional. Specifies the expiration date and time for the scheduling rule. Once this date is past, no further executions will be scheduled for this rule.
Day of Week

Specifies the day(s) of the week that you want the job to be run:

  • * (Default): The job will be run on all days within the start / end range.
  • 0-6: The job will be run on the specified day or days, where 0 is Sunday and 6 is Saturday. Use a comma or a hyphen to separate multiple days (hyphen if the days are contiguous, commas if not).
Hours

Specifies the time of day (hours) that you want the job to be run, in relation to the specified days:

  • * (Default): The job will be run on all hours.
  • 0-23: The job will be run on the specified hour or hours, where 0 is midnight and 23 is 11:00 PM. Use a comma or a hyphen to separate multiple hours (hyphen if the hours are contiguous, commas if not).
Minutes

Specifies the time of day (minutes) that you want the job to be run, in relation to the specified hours:

  • * (Default): The job will be run on all minutes (essentially the job is run continuously, once per minute).
  • 0-59: The job will be run on the specified minute or minutes of the hour, where 0 is the first minute of the hour and 59 is the last minute of the hour. Use a comma or a hyphen to separate multiple minutes (hyphen if the hours are contiguous, commas if not).

The following are some example schedules and the rules used to achieve them:

Schedule Start/End Day of Week Hours Minutes
Weekdays at 11:00 PM <optional> 1,2,3,4,5

23

 0
Every 15 minutes <optional> *

*

 0,15,30,45
Mondays at 11:30 PM <optional> 1 23 30
One time (6/30/2021) at 1:30 PM
(Option 1)

Start: 06/30/2021 00:00

End: 07/01/2021 00:00

 * 13 30
One time (6/30/2021) at 1:30 PM
(Option 2)

Start: 06/30/2021 13:30

End: 06/30/2021 13:30

 * * *
Every Wednesday in July at noon

Start: 07/01/2021 00:00

End: 08/01/2021 00:00

 3 12 0
Continuous <optional> * * *

To schedule a job to execute monthly, create twelve active scheduling rules, one for each month. This is necessary because scheduling rules do not have a property for day of month, so it is not possible to use a single scheduling rule to create a monthly schedule. In the following example, the job will be executed on the first day of each month, at 3:30 AM:

Example scheduling rules to execute a job monthly

When you save the job, the rules will be evaluated and the first scheduled execution will be placed on the schedule—in this example, the January 1 execution. Once that scheduled execution is complete, the rules will be evaluated again, which will cause the next scheduled execution (Feb 1) to be placed on the schedule, and so on.

Event Handlers

If an event handler is associated with the job, it is listed here. There are two types of event handlers:

To add or remove event handlers, use the Add, Remove Selected, or Clear All commands in the Event Handlers group of the Job tab. This group is only available when you have selected the Event Handlers section in the left-hand side of the job.

Item Description

Active

Specifies whether the event handler is active or not within the current job. If inactive, then actions that trigger the event handler will ignore this job.

Event Name

The name of the event handler.

Multiple jobs can have an event handler with the same name; all those jobs will be affected when the event handler is triggered.

Execute As

The user identity under which the job will be run when the event handler is triggered.

  • Owner: For system-managed event handlers, the owner is the system Scheduler identity. For user-defined event handlers, the owner is the user who last saved the job.
  • Requester: For all event handlers, the requester is the user who caused the event handler to be triggered.

Notification

This section defines email notification settings for the job. For more information, see Setting up notifications for jobs.

Job variables can be used in this section. For more information, see Using job variables.

Item Description

Job Notification Level

Specifies when email notifications are sent for the job. Select one of the following:

  • Send all email notifications (Default)
  • Send email notification only when the job has errors
  • None
  • Send email notification to different email addresses when the job has errors or succeeds

If anything other than None is selected, then you must complete the remaining fields.

To

The email address(es) to receive the notification email. Separate multiple addresses with a semicolon.

To (on error)

The email address(es) to receive the notification email when the job fails. Separate multiple addresses with a semicolon. Only applies when Send email notification to different email addresses when the job has errors or succeeds is enabled.

From

The email address to use as the "From" address for the notification email.

Subject

The subject text for the notification email.

Subject (on error)

The subject text for the notification email when the job fails. Only applies when Send email notification to different email addresses when the job has errors or succeeds is enabled.

User Message

Optional. The body text for the notification email.

Text entered here will be appended to the body text generated by Scheduler.

Tasks

This section defines the tasks in the job. In the ribbon, task commands are available on the Job tab, in the Tasks group.

  • To add a task, click Add.
  • To change the order of tasks, select a task and then click Move Up or Move Down.
  • To delete a task, select the task and then click Remove Selected.
  • To delete all tasks, click Clear All.
  • To copy a task, right-click the task and then click Copy. You can copy the task within the same job, or to another open job in the Scheduler window. Right-click any task (or the Tasks section header) and then select Paste. The job is pasted underneath the job you right-clicked (or at the end of the list if you right-clicked the Tasks section header).
  • To rename a task, double-click the task name to make it editable, and then type the new name. For example, if you have a job with multiple File Processing tasks, then you may want to edit the name of each task so that you know which file each task relates to at a glance. (You can also right-click and select Rename.)

Tasks are processed in the order they are listed in the job. By default, when you add a new task to a job, it is placed at the bottom of the list. Make sure to move the new job if it should not be processed last.

Tasks can be processed concurrently instead of sequentially if they are configured to be run as a subordinate job within the parent job.

Each task type has its own unique settings in addition to the standard task settings. For more information, see Scheduler tasks.

Job Results

Displays historical results for the job. This section is blank if the job has never been run.

Job results may be purged periodically by using the Job Results Cleanup option for the job, or by the system Purge System Data task.

NOTE: Users with the Scheduled Jobs User security permission only see results for jobs that they executed. Administrators see results for all executions.

For more information on job results, see Viewing job results.