External Interface Component Scheduler Service

Use the EICSchedulerService.sh utility located in the <installed path> mmg-home/bin folder to perform basic scheduler operations.

Prerequisites:

  • Ensure public and private keys are present in the conf folder and the corresponding path is present in application.properties of mmg UI service.
  • You should be aware of the clientId/secret which will be used for basic authentication. (Currently, these values are stored in application.properties as token.clientid and token.secret).

Table 12-5 List of possible flagged arguments to be passed while executing EICSchedulerService.sh

Flag Description Comments
-o Operation Type: The operation the user wants to perform.

A mandatory argument for all type of requests.

Possible Values are:

1 – To trigger an object

2 – To get the current status of a run.

3 – To re-start an execution.

4 – To re-run an execution.

5 – To interrupt an execution.
-u ofs_remote_user A mandatory argument for all the type of requests
-w Workspace Id A mandatory argument for all the type of requests
-c Client Id for authentication

A mandatory argument for all the type of requests

Currently, in mmg-ui application.properties the parameter token.clientid is set to ofsauser
-s Client Secret for authentication

A mandatory argument for all the type of requests

Currently, in mmg-ui application.properties the parameter token.secret is set to secret

-b Object Name Batch or Batch Group Name.
-t Object Type For Batch, it is set to rest and for Batch Group, it is set to group.
-r Batch Execution Id Execution ID of the Batch or Batch Group.
-x External Unique Id The unique ID for every execution. Mandatory for execute and rerun operations.
-i Included Jobs In case of trigger, included jobs can be provided as comma separated values using this flag.
-e Excluded Jobs In case of trigger, excluded jobs can be provided as comma separated values using this flag.
-h Held Jobs In case of trigger, held jobs can be provided as comma separated values using this flag.
-v Dynamic parameter list This is an optional parameter to support passing of dynamic runtime parameters for Batch/Task.

Table 12-6 List of possible exit codes returned by “EICSchedulerService.sh

API Syntax Description Status Code Code Description
Trigger
  • Execute batch “batch1”:
    • Syntax: ./EICSchedulerService.sh -o 1 –u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -x < External Unique Id > -b < Object Name > -t < Object Type>
    • Example: ./EICSchedulerService.sh -o 1 -u scheduser -w WS1 -c ofsauser -s secret -x batch1_1001 -b batch1 -t rests
  • Execute batch “batch1” with the Dynamic Parameter list
    • Syntax: ./EICSchedulerService.sh -o 1 –u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -x < External Unique Id > -b < Object Name > -t < Object Type> -v <Dynamic Runtime parameter list>
    • Example: ./EICSchedulerService.sh -o 1 -u mmgadmin -w CS -c ofsauser -s secret -x 232 -b BatchModel -t rest -v '{"batchParams":{"$FICMISDATE$":"2021-11-30","$BATCHRUNID$":"BATCHRUNID","param_1":"qwert","param_2":"abcde"},"taskRuntimeParams":{"Task1":{"p1":"11102","p2":"22202","abc":"123342","extraP":"wert2y"},"Task2":{"abc":"1233","p3":"3333","extP2":"0983"}}}'

      Note:

      The Task/Batch parameters should be the actual parameter key.
  • Execute batch “batch1” with “task1” and “task2” included:
    • Syntax: ./EICSchedulerService.sh -o 1 –u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -x < External Unique Id > -b < Object Name > -t < Object Type> -I < Included Jobs with comma separated values>
    • Example: ./EICSchedulerService.sh -o 1 -u scheduser -w WS1 -c ofsauser -s secret -x batch1_1001 -b batch1 -t rest -i task1,task2
  • Execute batch “batch1” with “task1” as excluded and “task2” as held:
    • Syntax:./EICSchedulerService.sh -o 1 –u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -x < External Unique Id > -b < Object Name > -t < Object Type> -e < Excluded Jobs> -h < Held Jobs>
    • Example:./EICSchedulerService.sh -o 1 -u scheduser -w WS1 -c ofsauser -s secret -x batch1_1001 -b batch1 -t rest -e task1 -h task2
 To execute a batch or a batch group -4 Invalid arguments passed in request/not enough params in Request body
-5 Invalid Request Headers
-9 Duplicate External Unique Id
-3 Batch or Batchgroup does not exist.
-6 No executable job is present. Batch with no task.
0 Batch or BatchGroup execution is success
-1 Batch or BatchGroup execution is failed.
Status
  • Get status of execution having runid = MMG_R1_2022-09-07_1662557327886_1:
    • Syntax:./EICSchedulerService.sh -o 2–u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -r < Batch Execution Id>
    • Example:./EICSchedulerService.sh -o 2 -u scheduser -w WS1 -c ofsauser -s secret -r MMG_R1_2022-09-07_1662557327886_1
 To check the status -3 Batch or Batchgroup Run Id does not exist.
-4 Invalid arguments passed in request/not enough params in Request body
-5 Invalid Request Headers
0 Batch or batchgroup status is success
-1 Batch or batchgroup status is failed or API failed internally to return valid response status code.
-2 Batch or batchgroup status is interrupted.
1 Batch or batchgroup status is not started.
2 Batch or batchgroup status is ongoing.
5 Batch or batchgroup status is held.
Restart
  • Restart execution for batch “MMG_R1” having runid = MMG_R1_2022-09-07_1662557327886_1:
    • Syntax:./EICSchedulerService.sh -o 3–u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -b < Object Name> -r < Batch Execution Id>
    • Example:./EICSchedulerService.sh -o 3 -u scheduser -w WS1 -c ofsauser -s secret -b MMG_R1 -r MMG_R1_2022-09-07_1662557327886_1
 To restart failed execution -4 Invalid arguments passed in request/not enough params in Request body
-5 Invalid Request Headers
-3 Batch or Batchgroup Run Id does not exist.
-6 No executable job is present. Batch with no task.
0 Batch or BatchGroup restart is success
-1 Batch or BatchGroup restart is failed.
Rerun
  • Rerun execution for batch “batch1” having runid = batch1 -r batch1_2022-09-01_1662011065557_1:
    • Syntax:./EICSchedulerService.sh -o 4–u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -x < External Unique Id > -b < Object Name> -r < Batch Execution Id>
    • Example:./EICSchedulerService.sh -o 4 -u scheduser -w WS1 -c ofsauser -s secret -x batch1_1002 -b batch1 -r batch1_2022-09-01_1662011065557_1
 To rerun the batch execution -4 Invalid arguments passed in request/not enough params in Request body
-5 Invalid Request Headers
-3 Batch or BatchgroupId or Run Id does not exist.
0 Batch or BatchGroup rerun is success
-1 Batch or BatchGroup rerun is failed.
-9 Duplicate External Unique Id
Interrupt
  • Interrupt execution for batch “batch1” having runid = batch1_2022-09-07_1662530601924_1:
    • Syntax:./EICSchedulerService.sh -o 5–u < ofs_remote_user > -w < Workspace Id > -c < Client Id for authentication > -s < Client Secret for authentication > -b < Object Name> -r < Batch Execution Id>
    • Example:./EICSchedulerService.sh -o 5 -u scheduser -w WS1 -c ofsauser -s secret -b batch1 -r batch1_2022-09-07_1662530601924_1
 To Interrupt the ongoing execution -3 Batch or Batchgroup Run Id does not exist.
-4 Invalid arguments passed in request/not enough params in Request body
-5 Invalid Request Headers
0 Batch or BatchGroup interrupt is success
-1 Batch or BatchGroup interrupt is failed
-7 Batch or BatchGroup status is not ongoing or already interrupted.

Note:

  • The status code -10 can be a general code if the scheduler service APIs are unreachabale.
  • On successful request for execute/rerun, the batchrunid corresponding to external unique id will be stored in the AAICL_SS_EXT_BATCH_RUN_ID_MAPPING table.
  • External Unique ID is required only in case of execute/rerun request.

  • Invalid UserID status for EICSchedulerService.sh Utility

    If the EICSchedulerService.sh utility fails with status as -5, then its due to invalid user. The error can be observed in the mmg-service.logs.