BMC Control-M

To add a BMC Control-M step to your flow:

1.  Go to the Apps tab of the palette, expand the BMC Control-M section, and drag the step you want onto the canvas.
   • For instructions on using the BMC Control-M trigger, see BMC Control-M Job Status trigger.
2. Connect the step to the previous step in the flow. This gives you access to the alert properties and outputs of previous steps when you configure this step's inputs.
3. Double-click the step to edit it, and use the Setup tab to configure the inputs. You can use plain text and input variables (or both). See the following section for detailed information on the inputs, including which are required.
4. On the Endpoint tab, configure the step to point to your BMC Control-M instance.
   • You can select a pre-existing endpoint or configure a new endpoint.

To begin configuring the BMC Control-M plug in, download the following files to an easy-to-find location on your computer.

• xMatters_plugin.ctmai - a configurable Application Integrator Plugin file.
• xMattersConnectionProfile.json - a configurable file that provides connection information between BMC Control-M and xMatters

The following sample files contain the variable declarations required for the plug-in and are referenced in the deployment instructions. We recommend using these files as the basis for your own job files or to test the deployment of your configuration.

• xmCustomersJobSample.json - a sample job a you might run.
• xmattersJobSample.json - a sample of the xMatters that calls the plugin.

Now that you have the configuration files on your system, let's configure them with the appropriate settings.

1. Go to the location of the xMattersConnectionProfile.json file.
2. Open the file in a text editor program.
3. Replace the placeholder text for each variable with valid values for your BMC Control-M instance.

   Variable Name	Description
   AI-triggerURL	The webhook URL you copied from the Control-M trigger in Flow Designer.
   AI-username	Username of the authenticating user.
   AI-password	Password of the authenticating user.
   AI-ctmHost	The specific Control-M host name.
   AI-ctmServerName	The specific Control-M server instance name.
   AI-ctmServerName	Name of the Control-M server instance.
   AI-ctmApiToken	API token used as the x-api-key header on every Control-M request.

4. Save your changes.
5. Open the xmCustomersJobSample.json in a text editor program.
6. Replace the placeholder values for RunAs and Host with valid values for your system.
7. Save your changes.
8. Repeat steps 5 - 7 for the xmattersJobSample.json file.

Now that the configuration files are ready, lets deploy them in BMC Control-M. The following instructions require access to the BMC Control-M Automation API , and Command Line Interface. If you require instructions on the Automation API or Command Line interface, see the BMC Control-M documentation.

1. On the Workbench welcome page, open the Application Integrator.
2. Go to Get Started > Import.
3. Select the xMatters_plugin.ctmai plugin file from its location on your computer and click Open. The plug-in automatically opens in a new tab.
4. Click Publish & Deploy.
5. On the Publish & Deploy panel, select which agent to deploy the plug-in to. You can deploy the plug-in to multiple agents, if required.
6. Click Apply.

BMC Control-M displays a Publish & Deploy status modal that shows you the progress of the plug-in deployement. When deployment is complete, click Close.

7. Open the Command Line Interface.
8. Deploy the configuration files using the following commands: 
   • ctm deploy xmattersConnectionProfile.json
   • ctm deploy xmattersJobSample.json
   • ctm deploy xmCustomersJobSample.json

If the deployment is successful, you will see an output similar to the following for the Connection Profile:

[

{

"deploymentFile": "xmattersConnectionProfile.json",

"deploymentState": "DEPLOYED_CONNECTION_PROFILES",

"deploymentStatus": "ENDED_OK",

"successfulFoldersCount": 0,

"successfulSmartFoldersCount": 0,

"successfulSubFoldersCount": 0,

"successfulJobsCount": 0,

"successfulConnectionProfilesCount": 1,

"successfulDriversCount": 0,

"isDeployDescriptorValid": false,

"deployedConnectionProfiles": [

"XMATTERS_CONNECTION_PROFILE"

]

}

]

Now let's run a job using the job sample file to verify the connection between BMC Control-M and xMatters.

9. In the Command Line Interface, run the following command: ctm run xmCustomersJobSample.json

Once the configuration and deployment are complete, you can create your own job files, or modify the sample files to run jobs.