Carapace Scheduler

Overview

The Scheduler within the CHub runs jobs at the configured times. These jobs can either be Carapace script expressions or methods on a COM object. This allows the job to access other systems or do whatever is required.

The user interface allows great flexibility in the definition of the times when the job must be performed. For example, it allows a job to be scheduled to run at 3:02 a.m. every Tuesday morning in December.

User Interface

The user interface allows you to do the following schedule-related tasks:

define a job ready for scheduling
delete a job which no longer requires scheduling
add/remove a job from the current schedule -- this allows all aspects for a job to be configured without it being actually run by the scheduler
display and modify the details for a currently scheduled job
display the job schedule for any particular day

Job Details

The following details are held for a job:

name a unique name for the job -- this can be a human-readable name

status defines whether the job is:

active -- the job will be run when the time criteria are satisfied
inactive -- the job will never be run but all configuration is held within the system ready for an administrator to make the job active

description a textual description of the job

package if the job to run is defined in Carapace script, this defines the file of commands to load

class defines the class of object used to run the job -- this could be a Carapace script class or a COM ProgID to create

method the method on the class which is invoke to run the job

arguments the arguments supplied to the method when the job is run

schedule the schedule defines the times and dates when the job is to be run

name	a unique name for the job -- this can be a human-readable name
status	defines whether the job is: active -- the job will be run when the time criteria are satisfied inactive -- the job will never be run but all configuration is held within the system ready for an administrator to make the job active
description	a textual description of the job
package	if the job to run is defined in Carapace script, this defines the file of commands to load
class	defines the class of object used to run the job -- this could be a Carapace script class or a COM ProgID to create
method	the method on the class which is invoke to run the job
arguments	the arguments supplied to the method when the job is run
schedule	the schedule defines the times and dates when the job is to be run

Defining a Job Schedule

Combinations of the following attributes define the time when a job is to run:

times individual times of day (hours:minutes) when the job is to be run

time ranges a time range is defined as:

start time (hours:minutes)
end time (hours:minutes)
interval (hours:minutes)

Multiple time ranges can be configured for each job.

days the names of the days when the job is to be run

days in year the day number within the year (1 to 366) when the job is to be run

days in month the day number within the month (1 to 31) when the job is to be run

week numbers the week number within the year (1 to 52) when the job is to be run

months the names of the months when the job is to be run

years the years when the job is to be run

times	individual times of day (hours:minutes) when the job is to be run
time ranges	a time range is defined as: start time (hours:minutes) end time (hours:minutes) interval (hours:minutes) Multiple time ranges can be configured for each job.
days	the names of the days when the job is to be run
days in year	the day number within the year (`1` to `366`) when the job is to be run
days in month	the day number within the month (`1` to `31`) when the job is to be run
week numbers	the week number within the year (`1` to `52`) when the job is to be run
months	the names of the months when the job is to be run
years	the years when the job is to be run

The following are examples of schedules:

times = 12:20, 13:00 the job is scheduled for 12:20 and 13:00 -- since there are no other restrictions, the job will run every day at these two times

times = 12:20, 13:00 days = Mon, Tue, Wed the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday

times = 12:20, 13:00 days = Mon, Tue, Wed month = Dec the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday in December

times = 12:20, 13:00 days = Mon, Tue, Wed month = Dec year = 2001 the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday in December, 2001

range = from 08:00 to 18:12 interval 0:01 days = Mon, Tue, Wed month = Dec year = 2001 the job is scheduled for every 2 minutes from 08:00 and 18:12 for every Monday, Tuesday and Wednesday in December, 2001

Contents Index Current topic: Carapace Hub Related topics: audit

`times = 12:20, 13:00`	the job is scheduled for 12:20 and 13:00 -- since there are no other restrictions, the job will run every day at these two times
`times = 12:20, 13:00 days = Mon, Tue, Wed`	the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday
`times = 12:20, 13:00 days = Mon, Tue, Wed month = Dec`	the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday in December
`times = 12:20, 13:00 days = Mon, Tue, Wed month = Dec year = 2001`	the job is scheduled for 12:20 and 13:00 for every Monday, Tuesday and Wednesday in December, 2001
`range = from 08:00 to 18:12 interval 0:01 days = Mon, Tue, Wed month = Dec year = 2001`	the job is scheduled for every 2 minutes from 08:00 and 18:12 for every Monday, Tuesday and Wednesday in December, 2001