Build Service

The build service allows you to compile definitions of jobs, folders, or calendars and check their validity for your Control-M environment. Control-M validation includes basic Control-M rules, such as field length, valid characters, and mandatory fields. The build service also checks that the JSON is valid.

The system evaluates definitions according to the relevant site standard.

The build command receives a definition file in .json format. For more information, see Code Reference.

CLI Syntax

The following shows the CLI syntax for the build command:

ctm build <definitionsFile> [deployDescriptorFile]

The following table describes the build command parameters.

REST API Syntax

The following example shows the REST API syntax for the build command in cURL:

curl -H "x-api-key: $token" -X POST -F "definitionsFile=@examples/AutomationAPISampleFlow.json" -F "deployDescriptorFile=@examples/deployDescriptor.json" "$endpoint/build"

The following example shows how to use the build command in Python:

token = r_login.json()['token']
 
# -----------------
# Built
uploaded_files = [
('definitionsFile', ('Jobs.json', open('examples/AutomationAPISampleFlow.json', 'rb'), 'application/json'))
]
 
r = requests.post(endPoint + '/build', files=uploaded_files, headers={'x-api-key': + token}, verify=False)
print(r.content)
print(r.status_code)
exit(r.status_code == requests.codes.ok)

For more information, see Control-M Automation REST API Reference.

Response

The response contains the following information:

• The total amount of elements created, such as folders and jobs.

• An indication if the system applied a Deploy Descriptor.

• The following validation messages for site standards when applied:

  • An error message if validations are strictly enforced.

  • A warning message if validations are not strictly enforced.

{
    "deploymentFile": "Folder.json",
    "successfulFoldersCount": 0,
    "successfulSmartFoldersCount": 1,
    "successfulSubFoldersCount": 0,
    "successfulJobsCount": 1,
    "successfulConnectionProfilesCount": 0,
    "successfulDriversCount": 0,
    "isDeployDescriptorValid": false,
    "warnings": [
       {
          "message": "Department has to be from values [HR, DEV, FINANCE] ",
          "id": "Validation10006",
          "file": "Folder.json",
          "line": 3,
          "col": 25
       }
    ]
}