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):
  1. In the Create Batch page, enter the following Batch Details:
    • Code - Enter a unique alphanumeric code for the new batch/batch group.

      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.

      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.

    • Select Batch to create a new batch or Batch Group to create a new batch group.
    • For new batch groups,select the Batches to be added to the batch group.
    • 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.

    • Enter the complete Cleanup URL and enable the check box, to activate the cleanup URL, before you initiate a batch/batch group restart.

      The complete Cleanup URL : http://fccm-utility-service:8080//fccm-utility-service/cleanupExecutionWatcher

    • Pin Batch/Pin Batch Group: Use this option to pin the batch or batch group to keep it at the top of the list for quick access.

      For information, see Pinning/Unpinning a Batch/Batch Group.

    • Select one of the following options, to get an email notification, based on the selected batch execution status.
      Based on the selected option, an email is sent to the email ID of the logged in user, mentioned in the IAM console.
      • Every Time : An e-mail is triggered irrespective of the batch execution status.
      • Never : No e-mail will be triggered.
      • On Error only : (Default). An e-mail is triggered only when the batch execution has failed.
      • On Interrupt only : An e-mail is triggered if the batch execution is successfully interrupted.
      • The system automatically sends an email to all users mapped to the BATCH_NOTIFY_FUNT function and BATCH_NOTIFY_ROLE role. If a batch is mapped to a user (and their email ID), the batch email notifications will be sent only to that configured batch user. If no batch user is configured, the system follows the default email notification process.

        Note:

        Ensure you have the BATCH_ADMIN function code to use this option. You can configure a maximum of five user mappings per batch or batch group.
  2. For new batches, after entering the Batch Details, provide the following batch parameters.
    From the Batch Parameters pane, 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, $FICMISDATE$ and $BATCHRUNID$ are added as batch Parameters.

    By default, $BATCHDATE$, $BATCHRUNID$ and $RUNSKEY$ are added as batch Parameters.

    Note:

    $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. Enter the following Header Parameter details:
    • Parameter Name - A valid parameter name for the new header parameter.
    • Parameter Value - A valid parameter value required for batch execution.
  4. Click Save. The new batch/batch group is created and displayed in the Scheduler Services (Define Batch) page.
    To view the dependent tasks and their components, click the Dependency Check icon. Upon clicking this icon, the Object Dependency window appears and displays the following:
    • Higher Order Dependencies – Components/batch group that the selected batch depends on. Example: Batch in a batch group will have Batch group as the higher order dependency.
    • Lower Order Dependencies – Any task which is created under a batch and the dependency is established will be shown under this tab.