Create a procedure for the Liberty server

If you installed the IBM MQ for z/OS® Unix System Services Web Components, and want to use the MQ Console, or the REST API, you need to create a cataloged procedure to start the Liberty mqweb server.

  • You need to perform this task once for each z/OS system where you want to run IBM MQ.
  • You need a Liberty server instance for each version of IBM MQ that is running. For example, a started task called MQWB0901 for queue managers at Version 9.0.1 and a started task called MQWB0902 for queue managers at Version 9.0.2.

    If we have only one queue manager, we can run a single Liberty server started task, and change the libraries it uses when you migrate your queue manager.

  • You might need to modify the cataloged procedure when migrating from a previous version.
Carry out the following procedure to create a cataloged procedure:
  1. Copy the sample started task procedure thlqual.SCSQPROC(CSQ4WEBS) to your procedure library.

    Name the procedure according to the standards of your enterprise.

    For example MQWB0901, indicating that this is the cataloged procedure for Liberty for IBM MQ Version 9.0.1

  2. Tailor the procedure to your requirements using the instructions in the sample procedure CSQ4WEBS.

    Note that the Liberty user directory is the directory specified when the crtmqweb.sh script was run to create the mqweb server definition.

    See Create the Liberty server definition for details.

  3. Authorize the procedure to run under your external security manager.
  4. Use the S procname command to start the procedure.

    This should produce message +CWWKE0001I: The server mqweb has been launched.

    If the server does not start successfully, review the messages.

    When the procedure starts, the output is stored in files under the USERDIR parameter. For example, if the user directory is /u/mq/mqweb, check /u/mq/mqweb/servers/mqweb/logs.

    The files are written in ASCII, so you can use your normal system tools to view the files.

  5. Use IBM Workload Manager (WLM) to classify this address space.

    The Liberty server is an IBM MQ application, and users interact with this application. The application does not need to be high importance in WLM, and a service class of STCUSER might be suitable.

  6. use the P procname command to stop the procedure.Notes:
    1. Ensure that you specify Caps off when you edit the member, as the file has lowercase data.
    2. The web server can take a considerable time to start up or shut down, for example, more than a minute.


What to do next

Configure users and roles