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.

  • Introduce all Control-M capabilities to Control-M for Web Services REST, including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.

  • Integrate Web Services REST jobs with other Control-M jobs into a single scheduling environment.

  • Monitor the status, results, and output of Web Services REST jobs.

  • Attach an SLA job to the Web Services REST jobs.

  • Run 100 Web Services REST jobs simultaneously per Agent.

Control-M for Web Services REST Compatibility

The following table lists the prerequisites that are required to use the Web Services REST plug-in, each with its minimum required version.

Component

Version

Control-M/EM

9.0.21.300

Control-M/Agent

9.0.21.300

Control-M Application Integrator

9.0.21.301

Control-M Automation API

9.0.21.305

Control-M for Web Services REST is supported on Control-M Web and Control-M Automation API, but not on the Control-M client.

To download the required installation files for each prerequisite, see Obtaining Control-M Installation Files.

Setting up Control-M for Web Services REST

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

Integration plug-ins released by BMC require an Application Integrator installation. However, these plug-ins are not editable and you cannot import them into Application Integrator. To deploy these integrations to your Control-M environment, import them directly into Control-M with Control-M Automation API.

Before You Begin

Verify that Automation API is installed, as described in Automation API Installation.

Begin

  1. Create a temporary directory to save the downloaded files.

  2. Download the Web Services REST plug-in from the Control-M for Web Services REST download page in the EPD site.

  3. Install the Web Services REST plug-in with the Automation API Provision service:

    1. Log in to the Control-M/EM Server machine as an Administrator and store the downloaded zip file in the one of the following locations:

      • Linux: $HOME/ctm_em/AUTO_DEPLOY

      • Windows: <EM_HOME>\AUTO_DEPLOY

    2. Log in to the Control-M/Agent machine and run the provision image command, as follows:

      • Linux: ctm provision image Web_Services_REST_plugin.Linux

      • Windows: ctm provision image Web_Services_REST_plugin.Windows

  4. Create a Web Services REST connection profile in Control-M Web or Automation API, as follows:

  5. Define a Web Services REST job in Control-M Web or Automation API, as follows:

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 version