Configuring the coordination queue manager for the REST API for MFT

Before you can use the REST API for MFT, you must configure a queue manager to act as the coordination queue manager for the MFT transactions. You can set which queue manager is the coordination queue manager by using the setmqweb command.

Before you begin

Note: If the mqweb server runs in a stand-alone IBM® MQ Web Server installation, this task is not applicable. The REST API for MFT is not available in a stand-alone IBM MQ Web Server installation.

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.

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.

Procedure

View the current configuration of the REST API for MFT by using the following command:
```
dspmqweb properties -a
```
The mqRestMftCoordinationQmgr field shows the name of the coordination queue manager.
Configure the coordination queue manager by using the following command:
```
setmqweb properties -k mqRestMftCoordinationQmgr -v qmgrName
```
where qmgrName is the name of the coordination queue manager. The coordination queue manager must be on the machine where the mqweb server is running. By default, this queue manager name is blank. If a value is not set, the REST API for MFT does not work.
Restart the mqweb server by entering the following commands:
```
endmqweb
strmqweb
```

What to do next

Ensure that the REST API for MFT is enabled. For more information, see Enabling the REST API for MFT.
If you want to use the REST API for MFT to submit create requests, you must set the command queue manager name. For example, if you want to use a REST API command such as create transfer, you must set the command queue manager name. For more information, see Configuring the command queue manager for the REST API for MFT.
You can configure the REST API for MFT timeout values. The default timeout is 30 minutes. For more information, see Configuring the REST API for MFT timeout values.
To use the REST API for MFT, a user must be authenticated to the mqweb server and must be a member of one or more of the MFTWebAdmin, or MFTWebAdminRO roles. For more information about configuring users, see Configuring users and roles for the REST API.