Defining a Control-M for Web Services REST job

This procedure describes how to define a Control-M for Web Services REST job, which enables you to run Web Services jobs and reports on a Control-M for WJM server.

Before You Begin

Ensure that you have met the following requirements:

• A configured REST connection profile, as described for the Connection profile management.
• Successful completion of Accessing the WJM job properties pane.

To define a Control-M for Web Services job:

1. From the Connection Profile field, type the connection profile, or click .

   The Connection Profile Selection dialog box appears.

2. Select the connection profile that you want to use to run a Control-M for Web Services job or report, and click OK.

   The Connection Profile field is set.

3. Complete the following fields:
   1. In the URL field, type the required URL name or click .
   2. In the Method field type the required object or click .
   3. In the Path field type the required path.

   NOTE: Certain paths require values to be specified for input parameters.

4. In the Use parameters from input file, type the input file, located on the Agent machine where Control-M for WJM is installed which contains the body of the REST request (mostly applicable to POST and PUT methods).
5. (Optional) To generate your own SOAP request, do the following:
   • Click Edit Request Body.

     The Request Body - Webpage Dialog box appears.

   • Click Generate.
   • Type the expected value where the question mark "?" appears.

   NOTE: Control-M for Web Services uses this request body with the job.

6. In the Input Parameters section, do one more of the following:
   • If you want to add a parameter to the job click Add parameter and do the following:
     • In the table, type the Name of the parameter and Value.
   • If you want to add an HTTP header to the job click Add Header and do the following:
     • In the table, type the Name of the header and Value.
   • If you want to remove a parameter or header, highlight the parameter and header and click Remove.
   • If you want to remove all parameters and headers click Remove all.
7. In the Output Parameters section, do one or more of the following:
   • If you want to specify the outcome of output parameters that exist once a job has been run, click Add a Parameter and from the table, type the following:
     1. The HTTP code criteria, which the output parameter setting is to be applied.
     2. The parameter name, XPath, variable or URI Type to extract to
     3. If you want to delete a parameter, highlight the parameter and click Remove.
     4. If you want to delete all parameters, click Remove all.
     5. In the Advanced Output Setting field, if you want to exclude job output or do not want an output banner, select the required options.

   For more information about job output, see: Job output information.

8. Type one or more of the following:
   • Override URL endpoint
   • Preemptive authentication
   • Override CONTENT-TYPE
   • Override connection timeout (sec)
9. Continue to define a job, as described in Using Control-M Workload Automation.

   For more information about Control-M for Web Service parameters, see Control-M for Web Services parameters.