CallAPI for WebSphere MQ (Windows)

This document describes the installation and configuration process for the Connect for WebSphere MQ on a Windows platform.

To Install Connect for WebSphere MQ on a Windows platform

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

    • Host
    • The setup and configuration of WebSphere MQ (Queue Manager, Queues, Channels) components takes place either with WebSphere MQ Explorer or through command programs.
    • Set up Queue Manager with the name "queue.manager1."

    crtmqm -q queue.manager1

    • Start Queue Manager.

    strmqm queue.manager1

    • Start the command processor for WebSphere MQ commands. Note:  No prompt will be displayed.

    runmqsc

    • Set up the request queue for AE with a maximum message length of 4096 bytes.

    define qlocal ('UC4CInputQueue') maxmsgl (4096)

    • Set up reply queue for applications.

    define qlocal ('UC4CReplyQueue')

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

    • Host
    • Start the SETUP.EXE program in the IMAGE:FRAMEWORK\MQSERIES\WINDOWS\Wi3_INTL directory. The drive can be changed if necessary. Enter the installation BIN directory from WebSphere MQ Queue Manager Server. Start installation by clicking the large button (computer, package and diskette).
    • The AE Connector is entered into the AE program group. If no program group is available, a new one is applied.
  3. Adapt the AE Connector INI file.

    • Host
    • The AE Connector INI file must be re-adjusted according to the WebSphere MQ Queue Manager and the Automation Engine system environments.
  4. Start the AE Connector.

    • Host
    • The AE Connector can now be started 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. In order 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, it 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 AE via WebSphere MQ Queue Manager.
    • Host
    • A request to AE can now be written in the request queue, 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.
    • Execution of the request is logged in the log file and, when necessary, in a more detailed fashion in the AE Connector trace file. It can be monitored there.
    • Any errors that occur during processing should be addressed.
    • If the tests were successful, the AE Connector can be closed.
  6. Enter the AE Connector into the ServiceManager.
    • Host
    • If it is necessary for the AE Connector to activate automatically when the system starts, it should be entered into the ServiceManager.
    • If no ServiceManager is present on the system, it must first be installed.
    • The simplest way to enter the AE Connector in the ServiceManager is to duplicate an existing service and modify its settings. To do this, however, special authorization is necessary. 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:

About the CallAPI