Running sample GUI client

This procedure describes how to run a sample GUI client, which is included in Control-M/EM API installation. This enables you to familiarize with API before developing your own custom client application and allows you to submit requests and receive responses.

The sample GUI client is supplied as a source code and is located in emapi-900\examples\EMAPIClient.

To run the sample GUI client:

1. Install and configure Control-M/EM API by completing the steps in Control-M/EM API Installation and Control-M/EM API configuration.

   You should have access to an ANT installation.

2. Open command prompt window and change the directory to emapi-900\examples\EMAPIClient.
3. Copy the file copy..\..\ctmemapi.properties to the directory created in step 2.
4. Run the Control-M/EM API client by typing the following command:

   %ANT_HOME%/bin/ant run

   The GUI client appears.

5. Do one or more of the following:
   • Select either the EMXMLInvoker or EMBasicInvoker to initiate and send requests. For more information, see EMBasicXMLInvoker and EMXML Invoker class.
   • Complete the following fields:
     • User
     • Response
     • OrderID
     • CTM

     You can complete these fields or they can be completed when a relevant request is submitted (such as register_request).

   • In the Request pane, type the XML request to submit. You can use the following variables in the XML request which is translated as a specified field in the window:
     • $USER_TOKEN$ - Defines user token for the request
     • $RESPONSE_TOKEN$
     • $CONTROL_M$ - Enables Control-M to submit the request
     • $ORDER_ID$ - Indicates job order id to submit the request

     For an example of XML request, see Sample GUI client XML variables

   NOTE: You can use some predefined requests, such as Register, Unregister, Poll and Create_Simple_Job for distributed systems. To use one of these requests, select it and click Invoke predefined.

   The predefine register request, uses emuser as user and empass as the password.