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:

  • Execute Web Services SOAP jobs with any HTTP method.
  • Manage Web Services SOAP credentials in a secure connection profile.
  • Connect to any Web Services SOAP endpoint.
  • Integrate Web Services  SOAP  jobs with other Control-M jobs into a single scheduling environment.
  • 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.

Control-M Application Integrator9.0.21.100
Control-M Web9.0.21.100
Control-M Automation API9.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.


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.


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

  2. Download the Web Services SOAP plug-in from the Control-M for Web Services SOAP download page in the EPD site.
  3. Install the Web Services SOAP plug-in via one of the following methods:
    • (9.0.21 or higher) Use 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 (within several minutes, the job type appears in Control-M Web):
        • 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_SOAP_plugin.Linux
        • Windows: ctm provision image Web_Services_SOAP_plugin.Windows
    • ( or lower) Use the Automation API Deploy service, as described in deploy jobtype.
  4. Create a Web Services SOAP connection profile in Control-M Web or Automation API, as follows:
  5. Define a Web Services SOAP job in Control-M Web or Automation API, as follows:


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

Was this page helpful? Yes No Submitting... Thank you