What's new in this version
New developments in this version are divided into the following categories:
The following new features were introduced in the specified versions:
|9.0.20.000||Throughout the page|
Authorization configuration through the
Discussion of the following objects:
|You can now use the ||9.0.20.000||Configuring file transfers to and from external users|
|9.0.20.000||Services > Config service > Configuration reference for file transfers||Full page|
You can now manage job archiving, as provided by the Control-M Workload Archiving add-on, through the Automation API.
|Services > Config service > |
Job Archiving configuration
|Services > Archive service||Full page|
The following API commands have been added to the Deploy service for connection profiles:
|9.0.20.000||Services > Deploy service|
|The Reporting service now supports generation of reports in Excel format, as files with the .xslx file extension.||9.0.20.000||Services > Reporting service|
|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.||9.0.20.000|
The following new optional parameters have been added to the
|9.0.20.000||Services > Config service||config 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.||9.0.20.000||Services > Run service||run 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.||9.0.20.000||Services > Provision service||provision agent::setup|
|The File Transfer job now supports several new transfer options, which you can choose as the value of the TransferOption parameter.||9.0.20.000||Code Reference > Job types||TransferOption|
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 22.214.171.124 or later.
|126.96.36.199||Services > Run service||Service 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.
|188.8.131.52||Code Reference > Connection Profiles||ConnectionProfile:Azure|
|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.|
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).
|184.108.40.206||Code 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).
|220.127.116.11||Installation||Installing the Control-M Workbench|
|A new type of Database job enables you to manage a job defined in the SQL server.||18.104.22.168||Job:Database:MSSQL:AgentJob|
The following changes were made in existing features in the specified versions:
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):
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:
|9.0.20.000||Control-M Administrator Guide in the Control-M Online Help|
|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.||22.214.171.124||Code 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).
|126.96.36.199||Services > Run service||run|
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.
|188.8.131.52||Services > Run service||run|
The following table lists issues that have been corrected in the most recent releases:
|DRDEV-92||When Automation API runs an AWS Lambda job, the job payload is not passed on to the AWS server.||9.0.20.000|
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-80||When specifying a secret access key for an AWS connection profile, the SecretAccessKey parameter does not accept the use of Secrets in code.||184.108.40.206|
|DRDEV-78||After 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.||220.127.116.11|
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-75||In reports generated by the Reporting service of Control-M Automation API, the Annotation Description and Annotation Note are reversed.||18.104.22.168|