Output Handling Rules

You can define how the output should be handled for a command line, Web Service or REST API operation step. You can select which parameter the output applies and what occurs if the output contains certain characters. The output can be used in the following ways:

  • Retaining data: Enables you to retain the data, which is generated from the output or response, so it can be used in subsequent operations as parameters. For example to obtain the job ID from a command line output and use it to monitor the job.

  • Exposing runtime parameters in the Monitoring domain: Enables you to monitor the job, which appears in Active Jobs in the Monitoring domain in Control-M. For more information, see Monitoring.

  • Failing jobs: Enables you to fail the job if the output contains for example, ERR. Some command lines only start specific transaction when a job is running, but some command lines are synchronous, so when a job ends, the output or return code affects the job status.

When you have defined job output, the action appears in the Output Handling area but it does not automatically appear in Runtime Parameters View field in the Designer area. You can decide whether the Output Handling rule appears in Control-M, by adding the parameter in Runtime Parameters View field in the Designer area. For more information, see Runtime Parameters View.

If you select Fail the job, the parameter does not appear in the Runtime Parameters View field in the Designer area.

For Web Service and REST API output handling rules, you can add several response elements with different values to determine the success or failure of an execution step. You can decide whether these elements are dependent on each other by selecting AND or OR. For Web Service you can also have multiple output rules for different response XML elements, which are retrieved from the Application.

The following procedures describe how to add and delete a job output rule for Command Line, Web Services and REST API.

You can also move the priority of an Output Handling rule by selecting or .