Control-M for Web Services SOAP

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

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

Connect to any Web Services SOAP endpoint from a single computer with secure login, which eliminates the need to provide authentication.
Integrate Web Services SOAP jobs with other Control-M jobs into a single scheduling environment.
Execute Web Services SOAP jobs with any HTTP method.
Attach an SLA job to your Web Services SOAP jobs.
Introduce all Control-M capabilities to Control-M for Web Services SOAP including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.

Control-M for Web Services SOAP Compatibility

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

Component	Version
Control-M/EM	9.0.21.100
Control-M/Agent	9.0.21.100
Control-M Application Integrator	9.0.21.100
Control-M Web	9.0.21.100
Control-M Automation API	9.0.21.125

Control-M for Web Services SOAP is supported on Control-M Web and Control-M Automation API, but not on 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 SOAP

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

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

Before you Begin

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

Begin

Create a temporary directory to save the downloaded files.
Download the Web Services SOAP plug-in from the Control-M for Web Services SOAP download page in the EPD site.
Install the Web Services SOAP plug-in via one of the following methods:
- (For version 9.0.21.or later) Use the Provision service of Automation API:
  1. As an administrator on the Control-M/EM Server, store the downloaded zip file in the following location.
    Within several minutes, the zip file is available in all Control-M interfaces associated with the Control-M/EM.
    - Linux: $HOME/ctm_em/AUTO_DEPLOY
    - Windows: <EM_HOME>\AUTO_DEPLOY
  2. As an application user on the Agent machine, run the provision image command, as follows:
    - Linux: ctm provision image Web_Services_SOAP_plugin.Linux
    - Windows: ctm provision image Web_Services_SOAP_plugin.Windows
- (For versions lower than 9.0.21) Use the Deploy service of Automation API, as described in deploy jobtype.
Create a Web Services SOAP connection profile in Control-M Web or Automation API, as follows:
- Web: Creating a Centralized Connection Profile with Web Services SOAP Connection Profile Parameters
- Automation API: ConnectionProfile:Web Services SOAP
Define a Web Services SOAP job in Control-M Web or Automation API, as follows:
- Web: Creating a Job with Web Services SOAP Job parameters
- Automation API: Job:Web Services SOAP

Note

To remove this plug-in from an Agent, follow the instructions in Removing a Plug-in. The plug-in ID is SOP072023.