IBM MQ Connection
Verb: connectIbmMQ
Available from: <Enterprise>
Connects to the IBM MQ queue server with a manual configuration, or through configurations previously stored in Web Client.
Syntax
connectIbmMQ --queueprovider(String) --address(String) [--queuemanager(String)] [--channel(String)] [--fromconfiguration(Boolean)] [--port(Numeric)] [--timeout(TimeSpan)] (Boolean)=success (QueueConnection)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --queueprovider | Queue Provider | Only whenStoraged Configurations is True | Text | Queue server that should be connected, configured on the Web Client. |
| --address | Address | Only whenStoraged Configurations is False | Text | Address to connect to the server. |
| --queuemanager | Queue Manager | Optional | Text | Instruction to connect to the IBM Queue Manager.
"An instruction for queue managers and the queuing services they provide to applications. A program must have a connection to a queue manager before it can use the services of that queue manager. A program can explicitly establish that connection (using the MQCONN or MQCONNX call) or the connection can be established implicitly (this depends on the platform and the environment in which the program is running)" [IBM's website]. |
| --channel | Channel | Optional | Text | Connection channel for the queue server. |
| --fromconfiguration | Storaged Configurations | Optional | Boolean | When enabled, it allows you to use the settings stored on the Web Client to access IBM MQ. |
| --port | Port | Optional | Number | Port number that should be used in the process. |
| --timeout | Timeout | Optional | Time Span | Maximum waiting time for connection to the server.
If no value is defined in the parameter of type timeout, the execution uses the context time defined by the Set Timeout command. If the script does not use this command, the default time is 5 seconds. |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| success | Success | Boolean | Returns "True", indicating the success of the connection to the server, or "False", indicating the opposite. |
| value | Connection | Queue Connection | Returns the "Queue Connection" variable created when connecting to IBM MQ. |
Example
The command connects to the IBM MQ queue server with the settings stored on the Web Client.
defVar --name connectionSuccess --type Boolean
defVar --name ibmMqConnection --type QueueConnection
// Connects to the IBM MQ server with the stored settings.
connectIbmMQ --queueprovider testQueue --fromconfiguration ibmMqConnection=value connectionSuccess=success
// Displays whether or not you have successfully connected to the server.
logMessage --message "${connectionSuccess}" --type "Info"
For the command to work correctly, it is necessary to have an account configured on the IBM MQ queue server, so that it is filled in directly in the command parameters or stored on the Web Client.
Remarks
It is important to note that the queues used with this queue provider can be created using the Get Queue command, as long as the local user of the script execution machine has permission to perform this action.