Control-M

Prerequisites

Before you can create a Control-M integration in Databand, you must have the following:

• Control-M Enterprise Manager (EM) URL
  • You can find the Control-M EM URL in the address bar of your web browser when you are logged in to your Control-M environment. Alternatively, you can find it in the Configuration section of the Control-M interface. For Databand Self-Hosted users, the default URL is https://localhost:8443. For SaaS users, the URL you provide must be accessible through the internet.
• Control-M environment with an automation API installed
• Control-M API token with a role permission of Automation API
  • To create the necessary role and token:
    1. In your Control-M environment, click Configuration > Roles > Add role.
    2. Give a Role name that helps you identify the role, for example, Databand.
    3. Optional: Provide a description for the role and choose which organizational groups you want to be able to use this role.
    4. In the Interface access section, choose Automation API.
    5. Next, edit the role that you just created. Click the role, in this example Databand, > Access control > toggle Monitoring on.
    6. Expand the menu under Monitoring, then under Job permissions > Access Level make sure that only the default value View is selected.
    7. Go to Configuration > API token > Add token.
    8. Enter a name for the token and proceed to the Roles section.
    9. By default, all roles are selected. Remove all the selected roles, except for the role you created earlier. For example, if you named your role in step 2 Databand, make sure that Databand is the only role that is selected. By removing all other unnecessary roles, you ensure that Databand has only the minimum necessary access to your Control-M environment.
    10. Click Generate, then copy the token to your keyboard. You are now ready to begin creating your Control-M integration in the Databand UI.

Creating a Control-M integration

Follow these steps to create a Control-M integration in the Databand UI:

1. Click Integrations in the navigation menu.
2. Click Add integration.
3. Select Control-M as the integration type.
4. In the Integration details step, provide the following information:

   Integration name

   The name that you want to call your integration. This name becomes the Server name throughout the Databand UI.

   Control-M EM URL

   This URL functions as an API endpoint. For more information about how to locate the EM URL, see the previous Prerequisites section.

   API token

   The API token connects your Control-M system to Databand so that you can enable the collecting of your metadata by Databand. This is the token that you created by following the steps in the Prerequisites section.

5. Optional: Click the checkbox to enable SSL verification.
6. Click Next.
7. In the Select assets step, select the servers that you want to sync.
8. Click Save. You can now view your saved integration in the Integrations page of the Databand UI.

Editing a Control-M integration

Follow these steps to edit your Control-M integration.

If you want to edit your integration name or view your EM URL:

1. Click Integrations in the navigation menu.
2. Locate the integration that you want to edit. Click Edit twice or click Edit > Edit details.
3. In the Integration details step, you can change your integration name and view the EM URL. The EM URL is read-only and the API token is hidden.
4. Click Next.
5. Optional: Edit the assets that you want to sync with Databand.
6. Click Save. You can now view your updated integration in the Integrations page of the Databand UI.

If you want to edit only the assets you are syncing with Databand:

1. Click Integrations in the navigation menu.
2. Locate the integration that you want to edit. Click Edit or the Options icon > Edit assets to go to the Select assets step.
3. Click Save. You can now view your updated integration in the Integrations page of the Databand UI.

Deleting a Control-M integration

Follow these steps to delete your Control-M integration:

1. Click Integration in the navigation menu.
2. Locate the integration that you want to delete. Click the Options icon > Delete.
3. Click Delete. You can now see that the integration was deleted from the Integrations page.

Known issues

While you can integrate your Control-M environment with Databand, there are some differences in terms or abilities. The following table shows a selection of Control-M terms or capabilities, whether or not Databand has equivalent capabilities, and what their equivalent is:

Table 1. Control-M terms or capabilities and their Databand equivalent, if any

Control-M term or capability	Databand support	Databand equivalent
Sub-application		Synced as a pipeline
Creation of sub-applications with multiple jobs and no common parent job		Synced as an equivalent number of separate pipelines
Folders		No equivalent, not synced
Runs that contain cyclic jobs		No equivalent, not synced
Duplicate jobs with the same name, folder, and job type in the same pipeline		No equivalent, not synced

A few other differences between Control-M and Databand must be noted:

• Databand can sync a maximum of 10,000 job statuses in a 15-minute period.
• Run duration is determined by the start time of the first job and the end time of the last job.
• Run state in Databand is determined on the basis of every Control-M job in a run, meaning that a run is only successful if every job within the run is successful. If one job fails, the entire run fails.