Configuring the response timeout

By default, the IBM® MQ Console and REST API times out if the time taken to send a response back to a client is longer than 30 seconds. You can configure the IBM MQ Console and REST API to use a different timeout value by using the setmqweb command.

Before you begin

To complete this task, you must be a user with certain privileges so that you can use the dspmqweb and setmqweb commands:

• On z/OS®, you must have authority to run the dspmqweb and setmqweb commands, and write access to the mqwebuser.xml file.
• On all other operating systems, you must be a privileged user.
• If the mqweb server is part of a stand-alone IBM MQ Web Server installation, you must have write access to the mqwebuser.xml file in the IBM MQ Web Server data directory.

Attention:

Before you issue either the setmqweb or dspmqweb commands on z/OS, you must set the WLP_USER_DIR environment variable so that the variable points to your mqweb server configuration.

To set the WLP_USER_DIR environment variable, issue the following command:

export WLP_USER_DIR=WLP_user_directory

where WLP_user_directory is the name of the directory that is passed to crtmqweb. For example:

export WLP_USER_DIR=/var/mqm/web/installation1

For more information, see Create the mqweb server.

Attention:

Before you issue either the setmqweb or dspmqweb commands in a stand-alone IBM MQ Web Server installation, you must set the MQ_OVERRIDE_DATA_PATH environment variable to the IBM MQ Web Server data directory.

• View the current configuration of the request timeout by using the following command:

  dspmqweb properties -a

  The mqRestRequestTimeout field shows the current value for the response timeout. For more information, see dspmqweb properties.
• Set the request timeout by using the following command:

  setmqweb properties -k mqRestRequestTimeout -v timeout

  where timeout specifies the time, in seconds, before the time out.

• Reset the request timeout to the default value of 30 seconds by using the following command:

  setmqweb properties -k mqRestRequestTimeout -d