4.8 Scheduler Administration

The Scheduler tab enables administrators to view and manage all scheduled jobs in the system. The "View Scheduler" system permission is required. For an overview of Scheduled Jobs and how to use them, see Basic Concepts: Job Scheduler. For how to use scheduled jobs within a Project, see Project: Scheduled Jobs. On this page:

• Scheduler Fields
• Start/Stop/Restart Actions
• All/Scheduled/Running Jobs
• Scheduled Job Detail Page

Scheduler Fields

• Name: The name of the scheduled job. Hovering over the scheduled job name displays the AquaScript associated with this job. Scheduled Job names are hyperlinked to see additional job information.
• Actions: All non-disabled jobs will have an Execute Now  option, allowing the job to be executed immediately. The job is executed in a background thread. 
• Category:  A user-defined field for organizing scheduled jobs.
• Status: Displays status of the current job.
  •  Scheduled: There are additional instances of this scheduled job to be run that will fire in the future. Job that are currently running will also display this status. This status is only displayed if Scheduler is running.
  •  Completed: There are no additional instances of this scheduled job to be run. Only displayed if Scheduler is running.
  •  Disabled: The job has been disabled and hence cannot be executed.
  •  Never: The job's occurrence is set to "None."
  •  Error: An internal error occurred while attempting to execute the job. Please contact AquaFold for further assistance.
• Project: The project the scheduled job belongs to.
• Next Run: The date and time the next instance of this job is scheduled to run. 
• Last Run: The last date and time the job was executed, either manually, using Execute Now, or via the configured scheduled time. 
• Last Exec Duration: For the job's last run, the length of time the job ran, in seconds. 

Start/Stop/Restart Actions

The Start , Stop  and Restart  buttons in the action bar control the state of the Scheduler engine. To the right of these buttons, the Scheduler's current state is displayed. If the Scheduler is stopped, then jobs cannot be executed, neither manually nor via the configured scheduled time.

All/Scheduled/Running Jobs 

All Tab: Displays all jobs in the system, regardless of status.

Scheduled Tab: Displays all jobs that have a status of either "Scheduled" or "Complete." Disabled jobs and jobs with an occurrence of "Never" are not displayed. The scheduler engine must be started in order to display the scheduled jobs.

Running Tab: Display all jobs that are currently executing. The scheduler engine must be started in order to display the running jobs.

Scheduled Job Detail Page

Clicking on a job from any of the Job tabs will navigate you to the Scheduled Job Detail Page. This page provides detailed information about the scheduled job itself as well as the execution history of the job. The Job Details section includes:

• The AquaScript associated with job
• The project that this job is associated with
• The owner of the job. This will usually be the creator of the job unless the creator has left the project or the creator has been removed from the system.
• The job's occurrence schedule.

The execution history shows detailed information about each time the job was executed. This section includes:

• Run At: The date and time the job started executing.
• Duration: The length of time the job ran, in seconds.
• Status: Whether the job completed successfully or not.
  • Completed - the job completed successfully.
  • Error - error encountered while executing the job. Since the job is executing aquascript code, it is possible that the code might generate an uncaught exception and terminate unexpectedly. If this were to happen, Aqua Data Server would log the job's status as error and you could view the result link to see the uncaught error.
• Executor: The person who executed the job. For jobs that are manually invoked, the executor will be the person who clicked on the "Execute Now" button. For jobs that are invoked via the specified occurrence pattern, the executor will be the job owner. 
• Invoke Type: A job can be invoked in one of 2 ways. One way is for a user, with the appropriate permissions, to click on the "Execute Now" button. This is considered a manual invocation, and the Invoke Type will be set to "Manual." The second way to invoke a job is via the occurrence pattern specified for the job. Aqua Data Server's job scheduler will automatically invoke the job and the Invoke Type will be set to "Scheduler."
• Results: Since scheduled jobs run in the background, a mechanism needs to be provided to log any output generated by the AquaScript associated with the job. Aqua Data Server automatically captures any console output generated by an AquaScript and this can be viewed by clicking on the result link. In addition, any error messages that Aqua Data Server would normally show in the "Console Output" section are also captured and displayed in the result page.