What's new in this version

New elements have been introduced in the JSON syntax of Deploy Descriptors to support new options for manipulating job definitions in JSON files:

• Add: Enables you to add new objects or properties
• Delete: Enables you to delete existing objects or properties

These elements join the Replace and Assign elements that modify existing objects or properties.

Adding

Deleting

And various other information on the same page.

A new group of commands that begin with config server:agent:mft enable you to manage the setup of your integration with Control-M Managed File Transfer (MFT), to enable file transfers to, from, and between remote hosts.

Using Automation API commands, you can configure the following aspects of Control-M MFT:

• SSH settings — generate SSH keys, authorize an SSH host, or authorize an SSH cluster
• PGP templates — add, update, or delete a PGP template, or retrieve details of PGP templates
• z/OS templates — add, update, or delete a z/OS template, or retrieve details of z/OS templates
• MFT configuration — retrieve details of MFT configuration and update MFT configuration
• File Transfer Server (FTS) settings — retrieve details of FTS settings and update FTS settings

Config service

Configuration reference for file transfers to or from remote hosts

Configuring file transfers to and from remote hosts

Full page

Support added for two new types of Hadoop jobs involving Apache Tajo — a job for running a Tajo command from an input file, and a job for running a Tajo query.

Job:Hadoop:Tajo:InputFile

Job:Hadoop:Tajo:Query

Support added for an SAP R/3 job with a CREATE action, that is, a job that creates a new SAP R3 job.

Jobs-as-Code now supports SLA Management jobs, which enable you to identify a chain of jobs that comprise a critical service and must complete by a certain time.

To manage SLA Management jobs, you must have the SLA Management add-on (previously known as Control-M Batch Impact Manager) installed in your Control-M environment.

When registering an agent image using the provision agent::setup command, you can now use two new parameters, serverHostName and serverPort, to override the default server settings. You include these parameters in the optional configuration file. These parameters are required if the user performing agent provisioning uses Role Based Administration authorizations.

Code Reference > Calendars

Services > Deploy service

Full page

Discussion of the following APIs:

• deploy
• deploy calendars::get
• deploy calendar::delete

Two new API commands have been introduced for the management of host groups (groups of Control-M/Agents):

• config server:hostgroup::update enables you to update the list of Control-M/Agents that are in a host group, overwriting the current list of Control-M/Agents. If the specified host group does not exist, a new host group is created. This API command is especially useful if you want to add or remove multiple agents in a host group, all at once, or to create a new host group with multiple associated agents.

• config server:hostgroup::delete enables you to delete a host group from the Control-M/Server.

Services > Config service

config server:hostgroup::update

config server:hostgroup::delete

Several job properties have been added as fields that can be used in query strings of the run jobs:status::get command — held, folderHeld, cyclic, and deleted — all with true|false values.

Responses for the following commands were updated accordingly, to include the cyclic property: run status, run jobs:status::get, and run job:status::get.

run jobs:status::get

as well as run job:status::get and run status

Code Reference > Connection Profiles

The terms used for resource types have been changed:

• Semaphore resources are now called pool resources
• Mutex resources are now called lock resources

Services > Config service

The deploy jobs::get command fails to retrieve details of a folder that contains the node_id property set to a non-default value.

Provisioning of a new agent for product version 9.0.20 on Windows fails due to an issue in password decryption. The Provision service returns an error with exit code 6.

The deploy jobs::get command fails to retrieve details of jobs of type Command, Script, or EmbeddedScript that contain the %%$BMCWAIORIGTYPE variable.

The /run/job/$jobId/rerun REST command fails if the -d option is not included in the request body, and the message "Required request body is missing" is issued. The -d option should be required only for specifying advanced parameters for a z/OS job.

AAPI connections appear in Control-M Reports with an incorrect IP address (127.0.0.1).

The deploy jobs::get command fails to get folder data for a folder that contains a Database job, and returns an error regarding an unsupported over_lib property.

Deployment of a Stored Procedure job (a type of database job) using a connection profile for a non-default agent, job parameters are missing in the job definitions.

When using the deploy jobs::get command, excluded rule-based calendars are returned with an erroneous exclamation character - ! - at the beginning of the name of each excluded calendar.

When a connection profile for a file transfer that uses the FTPS (FTP over SSL) communication protocol is set with ConnectionMode=Passive, details returned by the deploy connectionprofiles:centralized::get command display ConnectionMode set to the default of Active.

The Control-M Automation API yaml file for version 9.0.20.030 or 9.0.20.035 fails to import into Postman.

During provisioning of an Agent of version 9.0.20, the connectionInitiator parameter from the configuration file is not set correctly if the specified parameter value is AgentToServer or ServerToAgent.

When deploying jobs in a subfolder, combinations of WeekDays schedules and periodic calendars are defined incorrectly.

After upgrading Control-M, a constant increase is observed in inactive database sessions from the Automation API Server when Control-M/EM uses the Oracle database.

Scheduling settings in a job within a subfolder are changed during deployment. This occurs when WeekDays, Months, and MonthDays are all set to None, and during deployment the Months and MonthDays properties are changed to ALL. As a result, the job runs every day.

Deployment fails when the SpecificDates scheduling property is used in a job within a subfolder.

The deploy jobs::get command fails when folder definitions were configured through the Control-M GUI. This occurs when a value was entered in a field, but a subsequent change in another field made that value obsolete.

Building, deploying, or running a folder causes a "No site standard set to folder" validation error when Folder Strictness is set to true, even if the Enforce Site Standard option is set to false.

When a deploy jobs::get command returns details of a cyclic folder with defined specific times to run, the specific times (which should be defined by the At parameter under the RerunSpecificTimes object) are not returned in the response.

When a deploy jobs::get command returns details of a cyclic folder with a defined interval sequence, the sequence of intervals (which should be defined by the Intervals parameter under the RerunIntervals object) is not returned in the response.

Several commands in the run service time out after 10 minutes, with no user control over the timeout definitions.

To resolve this issue:

1. In the automation-api.properties file, add the thrift_gui_callback_timeout parameter, and set it to a value that is longer than the default 600000 milliseconds (10 minutes).

2. For the new setting to take effect, restart the API process (the emrestsrv process).

When a folder contains two or more levels of nested subfolders with the same name, the deploy jobs::get command does not return all subfolders.

SLA Management jobs are not deployed correctly if the defined Service Actions include two actions of the same type and an additional action of a different type in between them.

Specific dates specified for Service Actions in an SLA Management job are replaced by the order date (the default value) during deployment.

The deploy jobs::get command fails when it is run on a folder that contains definitions of a rule-based calendar with specific dates. The error message "date_str not supported" is issued.

In an environment where Control-M/EM has been patched with multiple patches, configuration of authorizations fails due to the requirement of a minimum version of Control-M/EM.

The run job::get command fails, with an error message regarding unsupported property type em_stat_cal_ctm, em_stat_cal, or em_stat_period.

When a job of type EmbeddedScript is defined with "RunAsDummy": true, the job is deployed as a job of type Dummy instead of an Embedded Script job.

API requests end with a server error (error 500) due to a short timeout definition. The error message does not provide sufficient information.

To resolve this issue, the server timeout setting was changed from a default of 10 seconds to a default of 10 minutes. A new error messages now provides more information when the issue occurs.

The XML property DAYSCAL was not ignored when defined in a SMARTFOLDER element, as expected, and it caused the retrieval of the job to fail.

Deployment in XML format does not synchronize the folder with Control-M/Server when the XML file contains a defjob element.

When you run deploy jobs::get set to JSON format on a folder that contains multiple jobs with the same name, the output includes only one of those jobs.

For the resolution of this issue, an error message notifies you that a folder cannot be extracted into JSON format if the folder contains multiple jobs with the same name.

Deployment in XML format fails when the XML file contains special characters and the encoding at the target environment differs from Latin-1.

Business fields of a Site Standard are not populated when deployed under a simple folder.

WBL-110587

At times of high load, API calls might result in a "not found" (HTTP 404) error.