Control-M for Azure Synapse

Azure Synapse Analytics enables you to perform data integration and big data analytics.

Control-M for Azure Synapse enables you to do the following:

  • Connect to any Azure Synapse endpoint from a single computer with secure login, which eliminates the need to provide authentication.
  • Integrate Azure Synapse jobs with other Control-M jobs into a single scheduling environment.
  • Execute Azure Synapse pipelines.
  • Monitor the status, results, and output of Azure Synapse jobs in the Monitoring domain.
  • Attach an SLA job to your Azure Synapse jobs.
  • Introduce all Control-M capabilities to Control-M for Azure Synapse including advanced scheduling criteria, complex dependencies, Resource Pools, Lock Resources, and variables.
  • Run 50 Azure Synapse jobs simultaneously per Agent.

Setting up Control-M for Azure Synapse

This procedure describes how to install the Azure Synapse plug-in, create a connection profile, and define an Azure Synapse 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 or later is installed.


  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 ZSY_plugin.Linux
      • Windows: ctm provision image ZSY_plugin.Windows
    • For an upgrade, use the following command:
      ctm provision agent::update
  3. Create an Azure Synapse connection profile in Helix Control-M or Automation API, as follows:
  4. Define an Azure Synapse job in Helix Control-M 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 ZSY062022.

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