Share:|

Did you know that Control-M allows you to develop your own custom client applications?

Would you like to speed up your development lifecycle by enabling developers to test code in a Control-M environment using continuous integration techniques? Automation API allows you to submit requests from your own applications to Control-M and get the responses as well such as performing job actions and changing Alert status.

 

To learn more about Control-M Automation API and how to use it, join us for a Connect with Control-M live webinar on Wednesday, April 26th  where Ruben Villa will demonstrate:

 

Installation & Configuration API

Job definitions as code

•     Managing active environment through custom DevOps tools

 

This is the link on YouTube for the recorded session:

 

Connect with Control-M: Control-M Automation API - YouTube

 

Here is the Q&A for this webinar (Connect with Control-M: Control-M Automation API)

 

________________________________________________________________

 

Q: Is this Automation API an extra licensed product?

A: No, you can use it since Enterprise Manager Version 9 FixPack 2

________________________________________________________________

 

Q: To access the API cli from the command line, should you be located under a specific path?

A: No.

________________________________________________________________

 

Q: Under the "Defaults" you can define any parameter from the job definition and its value?

A: Yes.

________________________________________________________________

 

Q: Is there any table that shows the references of a field in the job definition so I can refer to that correct name into the code?

A: Yes, you can consult the help documentation with ctm doc get

________________________________________________________________

 

Q: Can the order of the structure in the code can be changed without any impact? Or it has to keep the correct order?

A: Yes you can change the order of the parameters.

________________________________________________________________

 

Q: IS the flow option in AAPI equal to creating job dependencies with conditions?

A: Yes

________________________________________________________________

 

Q: Is this feature integrated with the WLA?

A: Yes, since Enterprise Manager FixPack 2

________________________________________________________________

 

Q: Does it matter what you name the flows?

A: No, you can use the name that you want/need.

________________________________________________________________

 

Q: What would a flow with 2 successors look like?  (2 successors simultaneously.)

A: You can define 2 flows in your JSON file to create 2 successors for the same Job.

________________________________________________________________

 

Q: When you create a job with AAPI, it's that definition inserted to the DB or just in the AJF?

A: Both, you can also modify this.

________________________________________________________________

 

Q: Is it possible to create a flow even if the job ended NOTOK?

A: Yes, you can configure how your flow will follow after a job ends not, e.g. rerun or set ok

________________________________________________________________

 

Q: How case sensitive are these commands (windows typically not case sensitive)

A: ctm commands are not case sensitive.

________________________________________________________________

 

Q: Can we import/export existing definitions to json on the WLA GUI or with exportdeftable or similar utilities? If not, is that planned?

A: This is not something available at the moment, but is planned for the future with AAPI.

________________________________________________________________

 

Q: Do all the API utilities have to be executed from the EM server machine?

A: No, the EM Server is the Endpoint for all the requests.

________________________________________________________________

 

Q: Can we call this JSON API job from a script?

A: Yes you can call the JSON from any other application.

________________________________________________________________

 

Q: Based on what permissions developer can access Control-M environments?

A: AAPI uses ctmcli and needs to get 2 tokens for login.  One from the GUI Server (GSR) and a second from the Control-M Configuration Server (CMS).  Because of this it needs login privileges for both as defined in the CCM under Authorizations for the user that is attempting to login.  Specifically in Privileges for "Control-M Configuration Manager" and "Control-M Workload Automation, Utilities........"

________________________________________________________________

 

Q: The online documentation has a few job types, like Hadoop and databases. Are other job types planned? Filewatcher, mainframe, and PeopleSoft are some of the ones that come to mind. If not, can we specify the parameters for other types as autoedit variables?

A: Currently this feature/product is designed to work in the way it was explained during this session, but

If you consider it could be an enhancement, please open a ticket so we can handle it and assist you properly.

________________________________________________________________

 

Q: Can you use this from a command line in a UNIX environment?

A: Yes, the developer toolkit can be used in a Unix Environment.

________________________________________________________________

 

Q: can we use the API to execute an asynchronous callback to control-m, to control a long-running process that does not return an explicit status?

A: You can use the ctm run status to get the status of any jobs or the full job log.

________________________________________________________________

 

Q: Can the AAPI be used to perform tasks, such as adding a condition?

A: Yes, you can add, delete conditions from AAPI.

________________________________________________________________

 

Q: Does the API code developed will have any dependency with the future enhancements of the product, job schema - as now v7 & v9 job schema has some differences.

A: At this moment AAPI only supports WLA Version 9 and will support the future releases.

________________________________________________________________

 

Q: Can I use the Run option to do an ad-hoc run for jobs that do not exist in the EM DB? Or do I have to Deploy first always?

A: Yes, as long as you define the jobs in the JSON file that you are using.

________________________________________________________________

 

Q: How do you manage who can and who cannot run jobs via AAPI?

A: You need to setup the EM Authorizations for this users, AAPI uses the login credentials and privileges from EM.

________________________________________________________________

 

Q: can we ask the WHY status of a job?

A: This option is not available for the moment, but you can run the status command for this.

________________________________________________________________

 

Q: Why does the user need to have access to the CCM?

A: Because of the configuration that we can do from AAPI regarding Agents.

________________________________________________________________

 

Q: When you run jobs on AJF using API, does it count towards Control-M job license?

A: Yes, as any other job in the AJF.

________________________________________________________________

 

Q: Will our own Application Integrator jobs types be made available as job types for the AAPI?

A: This option is not available for the moment.

________________________________________________________________