Skip to Content

Control-M for Web Services REST

Web Services REST jobs enable you to design and execute single REST API calls.

Control-M for Web Services REST enables you to do the following:

  • Execute Web Services REST jobs with any HTTP method.
  • Manage Web Services REST credentials in a secure connection profile.
  • Connect to any Web Services REST endpoint.
  • Integrate Web Services REST jobs with other Control-M jobs into a single scheduling environment.
  • Attach an SLA job to your Web Services REST jobs.
  • Introduce all Control-M capabilities to Control-M for Web Services REST including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.
  • Run 100 Web Services REST jobs simultaneously per Agent.

Setting up Control-M for Web Services REST

This procedure describes how to install the Web Services REST plug-in, create a connection profile, and define a Web Services REST job in Helix Control-M and Automation API.

Before you Begin

  • Verify that Control-M Automation API 9.0.21.305 or higher is installed, as described in Setting up the API.
  • Verify that Control-M/Agent 9.0.21.300 or higher is installed.
  • Verify that Control-M Application Integrator 9.0.21.301 or higher is installed.

Begin

  1. On the Agent host, set the Java environment variable by running one of the following commands through a command line:
    • Linux:
      • Bourne Shell/Bash: export BMC_INST_JAVA_HOME=<java_11_directory>
      • CSH/TCSH: setenv BMC_INST_JAVA_HOME <java_11_directory>
    • Windows: set BMC_INST_JAVA_HOME="<java_11_directory>"
  2. Run one of the following API commands:
    • For a fresh installation, use the provision image command:
      • Linux: ctm provision image Web_Services_REST_plugin.Linux
      • Windows: ctm provision image Web_Services_REST_plugin.Windows
    • For an upgrade, use the following command:
      ctm provision agent::update
  3. Create a Web Services REST connection profile in Helix Control-M or Automation API, as follows:
  4. Define a Web Services REST job in Helix Control-M or Automation API, as follows:
Warning

Note

To remove this plug-in from an Agent, see Removing a Plug-in. The plug-in ID is RST062023.

Change Log

The following table provides details about changes that were introduced in new versions of this plug-in:

Plug-in Version

Details

1.0.01

Added resolve on rerun capabilities to the following job properties: 

  • URL Request Path
  • Body
  • URL Parameters
  • HTTP Headers

Control-M variables can be utilized as values in the relevant job properties. 

1.0.00

Initial release

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Control-M