Installing the CallAPI for WebSphere MQ (Windows)

The Automation Engine supplies a CallAPI for IBM's WebSphere MQ Queue Manager (known formally as WebSphere MQ is MQSeries). The CallAPI facilitates the execution of AE scripts directly from WebSphere MQ Queue Manager via the API interface.

This page includes the following:

Requirements

To install it, call the installation program SETUP.EXE from the directory of supplied files. If the CallAPI should be activated automatically with each system start use the ServiceManager. Automation Engine Connector for WebSphere MQ Queue Manager can be started and ended as a service in the ServiceManager.

Technical Implementation

These applications place their activation requests for an AE Script to the AE queue of the WebSphere MQ Queue Manager. Connect regularly checks the contents of this queue. If there is a request in the queue, it is forwarded to the Automation Engine. The Automation Engine processes the script and reports the result to Connect for WebSphere MQ. Connect for WebSphere MQ converts this result and forwards it to the Message Queue Manager which then updates the corresponding request and reports status and result to the application.

Installing the CallAPI

Connect for WebSphere MQ must be installed on a system on which a WebSphere MQ Queue Manager Server is running. A WebSphere MQ Queue Manager Server must be available to set and configure the CallAPI queue.

  1. Set up queues for AE with WebSphere MQ Queue Manager Server.

    The setup and configuration of WebSphere MQ components (Queue Manager, Queues, Channels) takes place either with WebSphere MQ Explorer or through command programs.

    1. Set up the Queue Manager with the name queue.manager1: crtmqm -q queue.manager1

    2. Start the Queue Manager: strmqm queue.manager1

    3. Start the command processor for WebSphere MQ commands: runmqsc

      Note: No prompt will be displayed.

    4. Set up the request queue for AE with a maximum message length of 4096 bytes : Define qlocal (UC4CInputQueue) maxmsgl (4096).

    5. Set up reply queue for applications: Define qlocal (UC4CReplyQueue).

  2. Install the AE Connector using SETUP.EXE from the delivery directory.

    1. Start the SETUP.EXE program in the IMAGE:FRAMEWORK\MQSERIES\WINDOWS\Wi3_INTL directory. The drive can be changed if necessary.

    2. Enter the installation BIN directory from WebSphere MQ Queue Manager Server.

    3. Start the installation.

      The AE Connector is entered into the AE program group. If no program group is available, a new one is applied.

  3. Adjust the INI file (UCXBMQSC.in) of the Connect for Websphere MQ according to the WebSphere MQ Queue Manager and the Automation Engine system environment. For more information, see Connect for Websphere MQ

  4. Start the AE Connector for testing.

    • The AE Connector can be called from the AE program group or started directly as a program in the installation directory. If the name of the INI file has been changed, the AE Connector startup call must be expanded in the AE program group with the file name of the current INI file as a parameter ( -I <INI file>).

    • Another way to start AE Connector is to enter the command directly in the Windows Start menu, after clicking Start, and then by clicking Run. For these methods to work properly, it is required that the absolute file names of the EXE- and INI files (with complete directory path specification) are entered.

    • Check the AE Connector log file. It should not contain any error messages.

    • If the AE Connector cannot be started, check the log file, and, if appropriate, the trace file. To conduct an extensive error search, set extra trace flags in the AE Connector INI file. Detailed information in the trace file can help you trace an error to its root cause.

  5. Test a request to the AE via WebSphere MQ Queue Manager by using either resources in WebSphere MQ or an application intended for that purpose. 

    If this request corresponds to a valid AE call, the AE Connector connects to the Automation Engine and forwards the request. The execution of the request is logged in the log file and, when necessary, in a more detailed fashion in the AE Connector trace file where it can be monitored.

    Any errors that occur during processing should be addressed. If the tests were successful, the AE Connector can be closed.

  6. If you want the AE Connector to activate automatically when the system starts, add it to the ServiceManager. For more information, see ServiceManager.

    The simplest way to enter the AE Connector in the ServiceManager is to duplicate an existing service and modify its settings. You need special authorization to do it. It is also possible to enter the AE Connector in the SMD file of the ServiceManager and then to start or restart the ServiceManager service.

    Because the order in which services start during the Windows boot process cannot be modified, you must enter enough time in the Seconds delayed field in the AE Connector settings to ensure that the WebSpere MQ Queue Manager is active before the AE Connector starts.

See also:

CallAPI