TryBMC Expert GitLab

Final Version
davrodri authored
15216027
Name Last commit Last update
images Final Version
README.md Final Version

Lab 05 - Run AI REST API JobType in Control-M

Now lets run our AI JobType using REST API in Control-M

This exercise will walk through:

  1. View the Plug-In in Control-M.
  2. Define a Connection Profile for the Plug-in.
  3. Define a workflow in which we execute this new JobType.
  4. View JobType execution

Step 1 - View the Plug-In in Control-M.

  1. First of all we need to relogin into Control-M Web in order to get the new AI JobType. (Logout/Login in Control-M Web)
  2. Go to the Configuration section and select Plug-In to verify that our AI JobType is properly deployed

workspace

  1. Our AI JobType should be listed.

workspace

Step 2 - Define a Connection Profile for the Plug-in.

Before defining our workflow and running it we have to define a connection profile for the AI JobType which will allow us to launch the connection against openweathermap.org.

  1. Under the Configuration section select Centralized Connection Profiles

workspace

  1. Click on Add Connection Profile... and select our new Plug-In AI AAPIWEATHER

workspace

  1. Into the new tab include the following parameters:
    • Connection Profile Name: AI-API-WEATHER
    • key: It should have your API KEY defined into the Application Integrator.
    • RESTHost: It should have your endpoint with the URL of openweathermap (https://api.openweathermap.org/data/2.5/weather)

workspace

  1. Click on Add

Step 3 - Define a workflow to run this new JobType.

  1. Under the Planning domain Add a New Workspace, with the following values and click on Create

workspace

Definition:

workspace

  1. Click on the Folder and into the General tab modify the following values:
    • Folder Name: user01-rest-api
    • Run Method: Manual

workspace

  1. Drag and Drop the new AI Jobtype click on Add Job button:

workspace

  1. Into the General tab add the following paramters.
    • Job name: user01-rest-api-job01
    • Host/Host group: Agent where the AI JobType has been deployed
    • Connection Profile: Click on workspace icon and select the Connection defined into the previous step.
    • Ciudad: Oviedo (or another city of your choice)

workspace

  1. Into the Prerequisites tab enable the option Requires user confirmation

workspace

  1. Check-In the Workspace and Run the WorkSpace

  2. Select the Monitoring domain and under the Viewpoints select the user01_folder defined in previous Labs.

workspace

  1. Into the new Tab select the Job and Confirm to see the execution.

workspace

  1. Click on OutPut tab and see the result of the job execution.

workspace

Summary

In completing this lab, now you have the knowledge to run your Application Integrator JobTypes in Control-M using REST API functions. Please continue to Lab 06 In which we proceed to work with RUNTIME VALUES.