Editing Batch Definitions
To create a new Batch Definition, go to Services > Batch > Batch Definitions. This page contains a list of Batch Definitions on the Manager, plus a blank box for entering the name of a new Batch Definition. When you select a Batch Definition, click the Action list, and you can select View/Edit Batch Definition to edit a Batch Definition, Rename Batch Definition to rename a Batch Definition, Copy Batch Definition to copy a Batch Definition, Delete Batch Definition to remove a Batch Definition, Export Batch Definition to save an XML file of the Batch Definition, or Schedule Batch Definition to place a Batch Definition in the Manager’s Batch queue. You can also select Batch View to display a graphical representation of the Batch Definition in a new window.
The Batch Definition window
To edit a Batch Definition, either select View/Edit Batch Definition from an existing Batch Definition’s Action list, or type the name of a new Batch Definition in the empty box at the end of the list and click Add. This opens the Batch Definition window containing parameters for your new Batch Definition. You can then change the values of parameters, and click Save to save the values as a Batch Definition on the Manager, or click Cancel to exit and discard any changes you have made.
The Batch Definition parameters are as follows:
Batch Definition Parameters
Batch Component
|
|
Name
|
The name of the Batch Definition. If this is a new Batch Definition, this is the name you initially typed in the blank box prior to selecting Add, and is not editable. (You can rename a Batch Definition by selecting the Rename action from the Batch Definitions page.) If an additional Batch component is added to a Batch Definition, you can set its name.
|
|
Description
|
Sets the description of the Batch, that appears on the Batch Manager page.
|
|
Type
|
Determines how a Batch Definition is run, either in serial or parallel. If set to parallel, all Batch components are executed when the Batch Definition is scheduled. If set to serial, Batch components are executed in the order in which they were added. If any of the components fail, it prevents the Batch from continuing, and the Batch fails. The default is serial.
|
Schedule Component
|
|
Type
|
Sets the type of the Schedule. If Immediate, the Batch Definition runs when scheduled.When Absolute, the Batch Definition runs once according to the date set in startTime. If Relative, the Batch Definition runs after the specified number of minutes in minuteDelay as well as repeating or executing immediately with respect to repeat and runNow. If Cron, the Batch Definition runs according to the values set in the cron entry. (The same cron format is used as in database configuration; see “Cron Format” for more information.) When set to Manager Startup, the Batch Definition runs when the Manager first initializes.
|
|
Add component
|
Adds a component to the Batch Definition. A Batch Definition can contain one or more components.
|
