Setting up a Scheduler task includes the specification of:
• the Scheduler Action to be performed,
• the catalogs on which the Scheduler Action will be performed,
• the Scheduler instance that shall perform the task (required if you have one or more Scheduler instances with unique Instance Names installed. Must be left empty if only if there is one Scheduler instance in your Cumulus system, without a specified Instance Name).
• when the Scheduler Action will be performed.
The Scheduler Actions are selected from a list and can be configured. The Scheduler Actions available depend on the Cumulus Server you are connected to. Available actions are stored in a special folder.
How to install and configure the Scheduler Server Application is described in the Installation Guide.
The Scheduler Manager utility is included in the Cumulus Server Console. To work with the Scheduler Manager, a user /role must have the appropriate Scheduler Task Permissions (part of the Server Permissions of the respective user/role).
To set up a Scheduler Task with the Scheduler Manager:
1. Select the File > Administration > Server Console, or connect to the Web Server Console via a Web browser.
2. The Server Console is started. Log on as Cumulus Administrator (or the user who has the Scheduler Administrator permission) to the Cumulus Server that manages the catalogs you want to have Scheduler Tasks performed on.
3. Select Scheduler Manager. A window opens that lists all Scheduler Tasks.
4. To set up a new task, click the Create button. You are prompted to give the new Task a name. Subsequently, the Add Task dialog opens.
5. Select the Scheduler Action you want to be performed. If the selected action can be configured, the Configure button is activated and you can configure the action to your needs. (For more information see “Provided Scheduler Actions” .)
6. Determine where the action is to be performed. Click Add to choose the catalogs. The list of catalogs is displayed that are managed by the Cumulus Server you are connected to. Select the desired catalogs in the list and click OK.
7. Specify the Scheduler instance you want to perform this task by entering its Instance Name.
NOTE: This instance name must match with an existing Scheduler instance name, as defined in the Scheduler’s config.xml file (for details, see the Installation Guide). – If there is only one Scheduler installed, with no instance name specified, this field must be left empty!
8. Specify when the action is to be performed. Under Schedule define:
• date and time for the first run.
• the Repeat Interval. You can choose to have it repeated on specific days or use cron notation for more specific time data. If you decide on certain days, simply activate the check box(es) for the corresponding day(s). Cron notation should be used by specialists only.
9. Decide whether and about what you want to be notified via email concerning the run of the Scheduler task under Notifications:
NOTE: Notifications are sent only if the Notification option is activated in the Mail Manager. Also check there whether the email address of the intended recipient is included.
10. Click OK to save your settings. Your new Scheduler Task is added to the list.
11. To activate the task, click the Activate button. – On activated tasks, the button changes to Deactivate.
All activated tasks are performed by the Scheduler Server Application at the time defined in the task. You need only make sure that the Scheduler Server Application is running and that the computer running it is online and can access the Cumulus Server.
From time to time you should check the status of the tasks, as it cannot be granted that they could be executed.
Use the Run Now button to execute any Scheduler task immediately. This is very handy when testing, when you don’t want a task to run at intervals, or when you need a task to run just once.