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:

• Connect to any Web Services REST endpoint from a single computer with secure login, which eliminates the need to provide authentication.
• Integrate Web Services REST jobs with other Control-M jobs into a single scheduling environment.
• Execute Web Services REST jobs with any HTTP method.
• 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.

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 Automation API is installed, as described in Setting up the API.
• Verify that Agent version 9.0.21.080 or later 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:

   • Helix Control-M: Creating a Centralized Connection Profile with Web Services REST Connection Profile Parameters
   • Automation API: ConnectionProfile:Web Services REST
4. Define a Web Services REST job in Helix Control-M or Automation API, as follows:
   • Helix Control-M: Creating a Job with Web Services REST Job parameters
   • Automation API: Job:Web Services REST