Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The ability to schedule, automate and execute mainframe batch jobs running in AWS Mainframe Modernization Service via Stonebranch Universal Controller
  • Monitor Application’s batch processes from the Stonebranch Universal Controller
  • Start/Restart/Rerun/Cancel batch processes automatically or manually from the Stonebranch Universal Controller
  • Synchronous and asynchronous batch execution from Stonebranch Universal Controller
  • Retrieve the results of the AWS Mainframe Modernization Batch processes
  • Capture the AWS Cloudwatch logs of the executed jobs in Stonebranch Universal Controller.

...

FieldInput typeDefault valueTypeDescription
ActionRequiredList EnvironmentsChoiceAction performed upon the task execution. Available actions are as follows.
  • List Environments
  • List Applications
  • List Batch Jobs
  • Start Application
  • Start Batch
  • Fetch Logs
  • Cancel Batch Execution
  • Stop Application
RegionOptional-Text

Region for the Amazon Web Service.

AWS CredentialsOptional-Credentials

The Credentials definition should be as follows.

  • AWS Access Key ID as "Runtime User".
  • AWS Secret Access Key as "Runtime Password".
End PointOptional-TextOptional field. If not provided the endpoint will be generated using the Region filed value. 
ApplicationOptional-Dynamic Choice

The application name on which the action will be performed.

The user can dynamically fetch the application name from AWS.

Visible only when Action is:

  • Start Application
  • Start Batch
  • Fetch Logs
  • Cancel Batch Execution
  • Stop Application
  • List Batch Jobs

Required when visible

Force StopOptionalfalseBoolean

Initiate a force-stop action toward an application

Visible only when Action is:

  • Stop Application
Execution IdOptional-Text

Batch execution Id to be canceled. 

Visible only when Action is:

  • Cancel Batch Execution

Required when visible

Filter PatternOptional-Text

A pattern that will be used as a filter during logs fetching.

Visible only when Action is:

  • Fetch Logs
Log Stream NameOptional"*"Text

Log stream name to be fetched.

Visible only when Action is:

  • Fetch Logs
Fetch Log FormatOptional"Text"ChoiceFormat of log to be fetched.
  • JSON
  • Text

Visible only when Action is:

  • Fetch Logs
JCL File NameOptional-Text

Name of the JCI File to be executed.

Visible only when Action is:

  • Start Batch
CL File Name (Temp)Optional-Text

Name of the JCI File to be executed. This field value will overwrite the value of "JCL File Name" for the current execution (used in case of re-run).

Visible only when Action is:

  • Start Batch
Wait for Success or FailureOptionaltrueBoolean

If selected, the task will continue running until Job reaches the "SUCCEDED" or "FAILED" state.

Visible only when Action is:

  • Start Application
  • Start Batch
  • Cancel Batch Execution
  • Stop Application
Polling IntervalOptional10Integer

The polling interval in seconds between checking for the Job status.

Visible only when "Wait for Success or Failure" is True

Fetch Execution LogsOptionaltrueBoolean

Fetch logs from cloud-watch when the task is completed.

Visible only when "Wait for Success or Failure" is True

Log FormatOptional"Text"Choice

Format of fetched logs.

Visible only when "Fetch Execution Logs" is True

Re-run Step NameOptional-Text

Step name to re-run batch job.

Visible only when Action is:

  • Start Batch

Not supported in the current version

Re-run Proc Step NameOptional-Text

Procedure step name to re-run batch job.

Visible only when Action is:

  • Start Batch

Not supported in the current version

Templib


Templib to be used on batch re-run.

Visible only when Action is:

  • Start Batch

Not supported in the current version

Task Examples

Start Batch Job

Image Added

Start Batch Job result example:

Code Block
STDERR:
2022-10-11 16:09:23,131 - 06692 MainThread          - extension.py[222] DEBUG: extension_start fields: {'execution_id': '', 'fetch_logs': True, 'log_format': ['json'], 'log_stream_name': '', 'credentials.password': '****', 'force_stop': False, 'jcl_file_name': 'JOB1.jcl', 'credentials.keyLocation': '', 'jcl_file_name_temp': '', 'interval': 10, 'procstep_name': '', 'credentials.user': 'TESTCREDENTIALS', 'action': ['start-batch'], 'credentials.pasphrase': '', 'region': 'us-east-1', 'fetch_log_format': [''], 'application': [' Workflow Demo (6f3juxz75vgibndemj6nkloqt4)'], 'wait': True, 'step_name': '', 'end_point': 'https://m2.us-east-1.amazonaws.com', 'credentials.token': '', 'filter_pattern': '', 'templib': ''}
2022-10-11 16:09:23,137 - 06692 MainThread          - extension.py[226] INFO: Extension Information: aws-m2-1.3.8
2022-10-11 16:09:23,139 - 06692 MainThread          - extension.py[229] INFO: System Information: Python Version: 3.7.6 (tags/v3.7.6:43364a7ae0, Dec 19 2019, 00:42:30) [MSC v.1916 64 bit (AMD64)], system: Windows, release: 10, version: 10.0.17763, machine type: AMD64
2022-10-11 16:09:23,141 - 06692 MainThread          - extension.py[235] INFO: FIELDS: {'application': ' Workflow Demo (6f3juxz75vgibndemj6nkloqt4)', 'credentials': {'user': 'TESTCREDENTIALS', 'password': '****'}}
2022-10-11 16:09:23,158 - 06692 MainThread          - extension.py[432] DEBUG: application_id = 6f3juxz75vgibndemj6nkloqt4
2022-10-11 16:09:23,159 - 06692 MainThread          - extension.py[442] DEBUG: Payload is {'batchJob': {'jclFileName': 'JOB1.jcl'}}
2022-10-11 16:09:23,161 - 06692 MainThread          - extension.py[211] INFO: Signed request for https://m2.us-east-1.amazonaws.com/applications/6f3juxz75vgibndemj6nkloqt4/batch-job with header {'Content-Type': 'application/json'} and data {"batchJob": {"jclFileName": "JOB1.jcl"}}
2022-10-11 16:09:23,339 - 06692 MainThread          - extension.py[449] DEBUG: Response = {"executionId":"esk3stwrnze5voziq6nduay35y"}
2022-10-11 16:09:23,341 - 06692 MainThread          - extension.py[211] INFO: Signed request for https://m2.us-east-1.amazonaws.com/applications/6f3juxz75vgibndemj6nkloqt4/batch-job-executions/esk3stwrnze5voziq6nduay35y with header {'Content-Type': 'application/x-amz-json-1.1', 'Accept': 'application/json'} and data None
2022-10-11 16:09:33,408 - 06692 MainThread          - extension.py[211] INFO: Signed request for https://m2.us-east-1.amazonaws.com/applications/6f3juxz75vgibndemj6nkloqt4/batch-job-executions/esk3stwrnze5voziq6nduay35y with header {'Content-Type': 'application/x-amz-json-1.1', 'Accept': 'application/json'} and data None
2022-10-11 16:09:33,477 - 06692 MainThread          - extension.py[211] INFO: Signed request for https://logs.us-east-1.amazonaws.com/ with header {'Content-Type': 'application/x-amz-json-1.1', 'Accept': 'application/json', 'X-Amz-Target': 'Logs_20140328.FilterLogEvents'} and data {"logGroupName": "/aws/vendedlogs/m2/6f3juxz75vgibndemj6nkloqt4/ConsoleLog", "logStreamName": "*", "filterPattern": "esk3stwrnze5voziq6nduay35y"}
2022-10-11 16:09:33,901 - 06692 MainThread          - extension.py[585] DEBUG: Response = {"events":[],"nextToken":"Bxkq6kVGFtq2y_MoigeqscPOdhXVbhiVtLoAmXb5jCqYTdzkmNEVSoQKc4X3bPn4pUE3AI-JOdP_U-XHRDMtOsx-q4juLXKgxPk0z6YBa4AUt6eMSPRQN8HfmvfgVeJk9lHlRhVNR1ng67hn8I6YW5PXlelzYroTS0N2XbbjtFTY22JcstlEkhfq6Klm5FDDsWJA7jobotyqquLVuCkiLvy-wLu6s4Zu26Kp2E-ff6SVM7vORAVhW5K98FvomBG7e5SssM7yPq-J5l_J0hMz8A","searchStatistics":{"approximateTotalLogStreamCount":1,"completedLogStreamCount":0},"searchedLogStreams":[]}
2022-10-11 16:09:33,903 - 06692 MainThread          - extension.py[587] INFO: Log format = json
2022-10-11 16:09:33,907 - 06692 MainThread          - extension.py[111] INFO: extension_start function ended with rc = 0

STDOUT

{
    "events": [],
    "nextToken": "Bxkq6kVGFtq2y_MoigeqscPOdhXVbhiVtLoAmXb5jCqYTdzkmNEVSoQKc4X3bPn4pUE3AI-JOdP_U-XHRDMtOsx-q4juLXKgxPk0z6YBa4AUt6eMSPRQN8HfmvfgVeJk9lHlRhVNR1ng67hn8I6YW5PXlelzYroTS0N2XbbjtFTY22JcstlEkhfq6Klm5FDDsWJA7jobotyqquLVuCkiLvy-wLu6s4Zu26Kp2E-ff6SVM7vORAVhW5K98FvomBG7e5SssM7yPq-J5l_J0hMz8A",
    "searchStatistics": {
        "approximateTotalLogStreamCount": 1,
        "completedLogStreamCount": 0
    },
    "searchedLogStreams": []
}

EXTENSION

Task completed successfully.


List Applications

List Batch Jobs

Start Application and wait for execution

Cancel Batch Execution

Fetch logs

Task Output

Output Only Fields

...

The extension output will include the status description of the exit code. Example:Image Removed

Integration Modifications

...