What's new in this version

New developments in this version are divided into the following categories:

New features

The following new features were introduced in the specified versions:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


The new centralized parameter in the definitions of connection profiles enables you to define connection profiles that are stored centrally in the Control-M database and can be used by all your Control-M/Agents.

Code Reference > Connection Profiles

Throughout the page

Authorization configuration through the config service now supports Role-Based Administration (RBA) in several product areas, enabling an administrator to grant non-administrator roles or users the permission to perform certain administrative tasks. The JSON payloads that contain role definitions and user definitions can now include permissions for the following types of administrative tasks:

  • Agent management
  • Plug-in management
  • Connection Profile management
  • Runas Definition management

Services > Config service > User data for authorization configuration


Services > Config service > Role data for authorization configuration

Discussion of the following objects:

  • AgentManagement
  • PluginManagement
  • ConnectionProfileManagement
  • RunasDefinitionManagement
You can now use the config service to manage the setup of your integration with Control-M Managed File Transfer (MFT) Enterprise B2B and enable file transfers to and from external users outside of your organization (such as business partners). Various new API commands were introduced to manage the following objects involved in file transfers to and from external users:
  • Hub
  • Gateway
  • Virtual folders
  • External users
  • Groups (of users)

Services > Config service

Configuring file transfers to and from external users > Config service > Configuration reference for file transfersFull page

You can now manage job archiving, as provided by the Control-M Workload Archiving add-on, through the Automation API.

  • New config archive commands enable you to set up the rules for job archiving, view statistics regarding archived jobs, and delete accumulated data from the Workload Archiving server.
  • The new Archive service enables you to search through job data archived in the Workload Archiving server, as well as to obtain job outputs and job logs for individual jobs.

Services > Config service

Configuring Job Archiving

Services > Config service >
Job Archiving configuration
Full page
Services > Archive serviceFull page

The following API commands have been added to the Deploy service for connection profiles:

  • deploy connectionprofiles:centralized::get — returns the full definitions of centralized connection profiles, based on specified search criteria.
  • deploy connectionprofiles:centralized:status::get — returns a summary of details for centralized connection profiles (including basic properties and metadata, and the current deployment status), based on specified search criteria.
  • deploy connectionprofile:centralized::deploymentstatus — returns deployment status information for a centralized connection profile.
  • deploy connectionprofile:centralized::delete — deletes a centralized connection profile from the Control-M database.

  • deploy connectionprofile::test — Tests the definitions of a connection profile (without deploying it) on a specific Control-M/Server and Control-M/Agent. You provide the definitions of the connection profile through a JSON-format definitions file. > Deploy service
The Reporting service now supports generation of reports in Excel format, as files with the .xslx file extension. > Reporting service

Synchronous report generation (reporting report::get)

Asynchronous report generation (reporting report)

The reporting commands (for either synchronous or asynchronous generation of reports) now enable you to submit a configuration file with additional, customized parameters. This JSON-format configuration file enables you to...

  • Specify the report format through a configuration file, instead of through the API command.
  • Set date and time formats for dates and times that appear in reports.
  • Override filter values defined in the report template in Control-M Reports.

Services > Reporting service

Services > Reporting service > Reporting configuration

Full pages
A new group of API commands in the config service enable you to manage updates of SSL certificates on SSL-configured Control-M/Agents. You can use these API commands to return the expiration date of a certificate on a specified agent, to create a Certificate Signing Request (CSR), and to deploy a signed certificate to the agent. These commands can be combined in scripts to automate SSL certificate updates on your Control-M/Agents.

Services > Config service

Automating SSL certificate updates on Control-M/Agents

config server:agent:crt:expiration::get

config server:agent:csr::create

config server:agent:crt::deploy

The following new optional parameters have been added to the config server:agent::add command:

  • tag — A tag associated with the Control-M/Agent, used in Role-Based Administration (RBA)
  • sslState — The Secure Socket Layer (SSL) status of the Control-M/Agent (Default, Enabled, or Disabled) > Config serviceconfig server:agent::add
You can now use the new run job:statistics::get command to obtain time statistics for the recent runs of a job. The command response provides time statistics for each job run (order date, start and end time, run time, and CPU time), as well as an average of the key time statistics from all runs. If periodic statistics are collected for this job, job run statistics are presented for each period separately. > Run servicerun job:statistics::get
Support for a tag associated with the Control-M/Agent, for use in Role-Based Administration (RBA), was also added as an optional parameter in the configuration file of the provision agent::setup API command. > Provision serviceprovision agent::setup
The File Transfer job now supports several new transfer options, which you can choose as the value of the TransferOption parameter. Reference > Job typesTransferOption

The new run services:sla::get command enables you to retrieve important information about the SLA services associated with SLA jobs (also known as Control-M BIM jobs). Retrieved details include service status, due time, slack time, and completion percentage.

This new functionality requires Control-M/EM version or later. > Run serviceService Management

Support for the Azure job type, enabling you to automate a select list of Azure services. A new Azure connection profile is available for use by the Azure job type.

Code Reference > Job types

Code Reference > Connection Profiles


A new type of Database job, the SSIS Package job, enables you to execute SQL Server Integration Services (SSIS) packages. A new SSIS connection profile is available for use by the SSIS Package job type.

Code Reference > Job types

Code Reference > Connection Profiles



A new AdditionalParameters object has been added to the JSON definitions of File Transfer connection profiles, enabling you to define additional parameters (name+value) that are specific to your environment and are supported by Control-M for MFT (as listed in Connection profile manual additional parameters, in the Control-M Online Help). Reference > Connection Profiles


The Control-M Workbench now includes the Control-M Application Integrator functionality, allowing users to create and import custom designed job types for deployment to external agents. On the Workbench Home page, a new link is displayed for access to Control-M Application Integrator. Access credentials are the same as for Control-M Automation API (username: workbench; password: workbench). InstallationInstalling the Control-M Workbench 
A new type of Database job enables you to manage a job defined in the SQL server.

Code Reference > Job types



The following changes were made in existing features in the specified versions:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


The following API commands were modified, to indicate that they support only local connection profiles (that is, connection profiles that are associated with a specific Control-M/Server and Control-M/Agent and are stored on the agent):

  • deploy connectionprofiles::get was changed to deploy connectionprofiles:local::get

  • deploy connectionprofile::delete was changed to deploy connectionprofile:local::delete

Services > Deploy service

System parameters that enable the administrator to configure aspects of Control-M Automation API functionality are now provided out of the box during installation of Control-M Configuration Manager (CCM).

The following API-related system parameters are available for configuration in CCM and no longer need to be created manually:

  • SkipAnnotationValidation
  • MaxRecentRunIds Administrator Guide in the Control-M Online Help

Setting annotations as optional in API commands

Configuring maximum number of run IDs saved in the Control-M/EM database

The Passive parameter in the FTP File Transfer connection profile and FTPS File Transfer connection profile was renamed to ConnectionMode, and it now supports a wider range of options for connection mode. Reference > Connection Profiles



The run command now validates the contents of the Job Definitions file (a JSON file) that you provide, to ensure that it contains the definitions of at least one job (and, for example, not just the definitions of a connection profile). > Run servicerun

The run ID returned by the run command or the run order command is now saved in the Control-M/EM database (rather than the local API server). This enables you to check run status (using the run status command) from any API server in a Control-M/EM Distributed installation (which is used for High Availability or for Control-M/EM Distributed behind a firewall).

By default, a maximum of 2000 most recent run IDs are saved in the Control-M/EM database. If necessary, you can raise the maximum number of saved run IDs through the Control-M Configuration Manager, as discussed in the  Control-M Administrator Guide  in the Control-M Online Help. > Run servicerun

Corrected problems

The following table lists issues that have been corrected in the most recent releases:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Tracking #


DRDEV-92When Automation API runs an AWS Lambda job, the job payload is not passed on to the AWS server.

When deploying a connection profile on a Control-M/Agent that does not have the appropriate Control-M plugin installed, the error message does not contain the appropriate information, and instead reports "Failed to encrypt field password. Agent... not found in system topology."

After upgrading Control-M/EM, Automation API calls return the error message "Failed to reach backend server."

The deploy connectionprofiles::get command fails when one of the endpoint types in the connection profile is SFTP. The following error message is issued: "Retrieving as JSON is not fully supported for all types and attributes.... has an unsupported property \"Contype\" = \"2\"."

Deployment of a connection profile fails when a Control-M plugin returns an empty string in response to a version query from Control-M Automation API. The following error message is returned: "For input string: <character>"

When deploying a folder that is defined in XML to a z/OS mainframe, the new folder is not synchronized in the z/OS datacenter.

Agent provisioning commands (provision agent::setup and provision agent::install) fail if the name of the agent contains a period character. Provisioning fails when the provisioning process attempts to disconnect the agent from the Control-M Server.

In an environment where the Control-M/EM has been patched with multiple patches, API commands that require a minimum version of Control-M/EM fail (for example, deployment of Application Integrator jobs, deployment of Site standards, or configuration of authorizations).
DRDEV-80When specifying a secret access key for an AWS connection profile, the SecretAccessKey parameter does not accept the use of Secrets in code.
DRDEV-78After upgrading Control-M, a constant increase is observed in the usage of database sessions due to a problem in the recognition of Control-M Automation API.

After provisioning an agent with the provision agent::install command, the provision upgrade::install command fails to find the agent if the specified agent name contains uppercase characters.
DRDEV-75In reports generated by the Reporting service of Control-M Automation API, the Annotation Description and Annotation Note are reversed.
Was this page helpful? Yes No Submitting... Thank you