1. Using Studio
  2. Using Orchestration
  3. Scheduler Service
  4. Define Batch
  5. Creating a Batch/Batch Group

5.1.2.1 Creating a Batch/Batch Group

Create a batch/batch group, to execute a group of background tasks together, on a specific date and time, when the resources are available for batch processing.

To create a batch/batch group from the Scheduler Service (Define Batch), follow these steps:
  1. Click Create. The Create pane is displayed.
  2. Enter the Batch Details as described in the following table.

    Table 5-1 Create Batch - Field Description

    Field Description
    Code Enter a unique alphanumeric code for the new batch/batch group.

    Note: The code must start with alphabets, should not contain any spaces, and must not exceed 60 characters. Special characters are not allowed except underscore (_).

    Name Enter a unique name for the new batch/batch group.

    Note: The name should start with alphabets, should not contain any spaces, and must not exceed 60 characters. Special characters are not allowed except underscore (_).

    Description The description/details for the batch/batch group.

    The description should start with an alphabet and must not exceed 250 characters.
    Batch/Batch Group Select Batch to create a new batch or Batch Group to create a new batch group.
    Service URL Name Select the Service URL name from the drop-down list, if it is available.

    To add a new service URL, enter a name to identify the new Service URL Name and enter the proper Service URL. You can give partial URL here and the complete URL in the Task Service URL.

    Note: Leave this field as empty.

    Service URL This field will be auto-populated based on the selected Service URL Name.

    Note: Leave this field as empty.

    Cleanup URL Enter the complete Cleanup URL and enable the check box, to activate the cleanup URL, before you initiate a batch/batch group restart.
    Notify on mail From the drop-down list, select the any one of the following options to get an email notification, based on the selected batch execution status. The available options are:
    • Every Time: An e-mail is triggered irrespective of the batch execution status.
    • Never: No e-mail will be triggered.
    • On Error only: An e-mail is triggered only when the batch execution has failed. By default, this option is selected.
    • On Interrupt only: An e-mail is triggered if the batch execution is successfully interrupted.

    Based on the selected option, an email is sent to the email ID of the logged in user, mentioned in the IAM console.
    Batch Parameters Click Add to add a new batch parameter, in the following format:
    • Parameter Name: A valid parameter name for the new Batch parameter.
    • Parameter Value: A valid parameter value required for Batch execution.

    Note: Enclose the Parameter Value for a Run time with $ symbol. For example, $paramName$. By default, $BATCHDATE$, $BATCHRUNID$ and $RUNSKEY$ are added as batch Parameters.

    $RUNSKEY$ parameter is added only if you are creating a new batch or copying from an existing batch. It is not supported for existing batches.

    To delete a batch parameter, click Delete next to that parameter details.

  3. Click Save. The new batch/batch group is created and displayed in the Scheduler Service (Define Batch) page.