Control‑M/Enterprise Manager (Control-M/EM) API is an open interface for external applications that enables you to use the capabilities of Control‑M. It is a set of Java classes that allows you to send requests from your own applications to the Control-M. Installation includes a sample GUI client, which you can use to familiarize with the API before you develop your own custom client applications. It enables you to use Control-M/EM API, submit requests and get the responses. See Running sample GUI client.
Control‑M/EM API enables users of your application to perform various functions in the Control‑M Business Integrated Scheduling environment, such as creating jobs and SMART Folders in Control‑M Active Jobs, ordering jobs and SMART folders, performing job actions and changing Alert status. For practical examples, see Control-M/EM API flowchart.
The following topics describe how to install, upgrade and uninstall Control-M/EM-API, send requests and receive responses from Control-M/EM, and error codes and exceptions.
Control-M/EM API Installation: Enables you install Control‑M/EM API on Microsoft Windows and UNIX. This topic also includes a sample GUI client which you can use to familiarize with the API or with EMAPI before you develop your own custom client application.
Control-M/EM API Class references: Defines class reference information about the functions that you can access when using Control‑M/EM API in your project.
Control-M/EM API requests: Defines the different methods for creating, sending, and handling requests together with responses received from Control-M/EM.
Request and response parameters: Defines the Control-M/EM API request and response parameters. Requests are sent using the invoke method of EMXMLInvoker or EMBasicXMLInvoker.
Diagnostics and troubleshooting: Enables you to analyze the Control‑M/EM API product’s performance and prevent conflicts before they arise.
Error codes and exceptions: Defines the errors and exceptions, which may occur when the Control‑M/Enterprise Manager API is being used.
