Defining a Scheduler Batch Stream Definition
In order to define a Scheduler Batch Stream Definition, from the Admin menu, select Batch Operations, select Scheduler Batch Stream Definition, and select Add.
A Scheduler Batch Stream Definition includes specifying the batch jobs and the order in which they should be run as “Stream Steps”, the user to use to run these batch jobs and a “Schedule” to state when and how often the batch job stream should run. Batch jobs can be setup to run in sequence or in parallel fashion or a combination of both.
Business Date: A Scheduler Batch Stream Definition can be optionally configured to run on a particular business date. When a business date is specified, each of the batch jobs in the stream run with the business date set. The business date can be either a specific business date or a variable business date. For example, business date set to run a day before current date. This ensures every time the stream runs the batch jobs in the stream run with current date – 1.
Run On Activate: A Scheduler Batch Stream Definition can also be optionally configured to run as soon as it’s activated.
Start Schedule Date/Time: It can optionally be configured to specify schedule to be effective in the future by setting a date/time to start schedule. If the start schedule date/time is not provided then the schedule on the Scheduler Batch Stream is effective as of current date.
The batch job to run for each stream step can be either specified directly or via a “Batch Scheduler Batch Control”. A Batch Scheduler Batch Control enables setting custom batch parameters on a Batch Control. When a batch job is submitted for a stream step that has Batch Scheduler Batch Control specified on it, the custom batch parameters are used on the submitted batch job. Refer to Configuring a New Batch Scheduler Batch Control for more details.
A Stream step includes specifying the following details
-
Step Name: the name of the step
-
Batch Control: the batch control to run for that step.
-
Thread Count: the number of threads to use to run this step’s batch control
-
Batch Scheduler Batch Control: the batch scheduler batch control to use for that step. Either a batch control or batch scheduler batch control can be specified but not both
-
Step Conditions: specifies when the current step should run. It includes the following details
-
Step Name: the step that should have run prior to current step
-
Step Status: the status the prior step should be in when its finished
-
Step Condition: indicates how (And/Or) prior step should combine with next subsequent step conditions. For example, if step C should execute after step B and A have ended, then step C’s has two step conditions 1)A Ended And 2)B Ended.
-
A Scheduler Batch Stream Definition’s schedule can be specified using various frequencies.
-
Daily, By Minutes: run every ‘x’ minutes every day except on specified excluded days
-
Daily, By Time: run at certain times every day except on specified excluded days
-
Monthly, By Month Day Number: run on a specific day of the month, at specified time
-
Monthly, By Week Days: run on days of a specific week in a month, at specified time
-
Weekly: run every ‘x’ weeks on specific days, at specified time
-
Yearly, By Month Day Number: run on a day of the month, at given time in specified months
-
Yearly, By Week Days: run on days of a specific week, at given time in specified months
-
Custom: run on a specific date at specified time
- Stream Run has failed.
- Scheduler Batch Stream not started X minutes.
- Scheduler Batch Stream Job Ran Too long (Relative Run).
A Scheduler Batch Stream Definition can also be created without defining a schedule. When activated, it remains activated without a schedule and can be used for any manual runs.
There are custom ways in which a scheduler batch stream definition can be setup. This involves creating a Batch Scheduler Batch Control. Refer to Tips For Setting Up Batch Job Stream Definitions and Batch Scheduler Batch Control for more information.