WebSphere MQ Non-Intrusive Agent Settings

This dialog box enables you to configure the Service Virtualization WebSphere MQ Non-Intrusive Agent. The agent handles communication between a client and a real or virtual service.

To access
  1. From the main menu, select Tools > Options.
  2. Click Agents.
  3. Under WebSphere MQ Non-Intrusive, select a configuration.
Important information
  • For additional important configuration information, see the task Configure the WebSphere MQ Non-Intrusive Agent.
  • The WebSphere MQ Non-Intrusive Agent is not able to automatically reconnect when a TCP connection to the WebSphere MQ Server is lost. Each service using the agent must be restarted. Alternately, restart the whole application.

  • You can define multiple configurations for each agent.
Relevant tasks
See also Service Virtualization Agents

User interface elements are described below (unlabeled elements are shown in angle brackets):

UI Element Description
<left pane>

Displays the server configured for your project.

Expand the server to display the available agents and configurations.


Enables you to define additional configurations of the agent.

Delete Deletes the selected configuration.

Creates an additional configuration of the agent by copying the selected configuration. You can then modify the configuration settings.

Note: By default, the configuration is created with a sequential unoccupied port number.


Saves the selected agent configuration as a file. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

Export All Exports all agent configurations on the selected server. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

Enables you to select an exported agent configuration file stored on the file system. The file is saved in the .agce file format, and can be imported to any Service Virtualization Server.

If the configuration file you are importing contains multiple configurations, you can select which configurations you want to import.

If you choose to import an agent configuration that is identical to a configuration that already exists on your server, you can choose to overwrite your existing configuration, or create a new, additional configuration.

Agent State The current status of the agent. Values include Running, Not Running.
Test Configuration link Tests the configuration based on the settings you select. If Service Virtualization identifies any problems in your configuration, the details are displayed.
Is Enabled Turns the agent on and off. To enable the agent, the prerequisites must first be met.
Name Enter a name for the configuration or accept the default name.
Non-Intrusive Server Port The unique TCP/IP port on the Service Virtualization Server machine that will be used for accepting incoming connections from the Service Virtualization MQ API Exit library.
Queue Manager Name

The name of the queue manager for the agent to connect to.

Note: The WebSphere MQ Non-Intrusive Agent instance can only use queues from a single Queue manager.

Channel Name

The name of the TCP channel for the agent to use to connect to the Queue Manager.

Note: The WebSphere MQ Non-Intrusive Agent instance can only use a single TCP channel to connect to the Queue Manager.

Host The name of the server hosting the queue manager.
Port The TCP port where the channel listens for client connections.

The character set used by the host.


  • CCSID configuration in the WebSphere MQ Non-Intrusive Agent instance requires that you restart the application.

  • CCSID configuration is global for the whole application. There cannot be two agents with different CCSIDs.


The username and password for connecting to the queue manager.

Note: When you create a new virtual service, you can search WebSphere MQ queues and select a destination, provided the virtual agent has sufficient permissions.

To browse MQ destinations, the specified user must be able to perform the following in the WebSphere MQ client:

  • put and inq operations on the SYSTEM.ADMIN.COMMAND.QUEUE
  • get, inq, and dsp operations on the SYSTEM.DEFAULT.MODEL.QUEUE
  • dsp operations on queues to which the user has access permission

To create or delete a virtual destination, the specified user requires additional permissions, such as administrator permissions.

For details, see Browse Destinations Dialog Box.


The algorithm used for secure SSL communication.

Enter a value or select a value from the list. The CipherSpec value must be the same as the value specified in the WebSphere MQ channel configuration.

Key Repository

The path of the WebSphere MQ SSL key repository, which contains the WebSphere MQ Queue Manager certificate. If you are using mutual authentication, it also contains the certificate and private key of the Service Virtualization MQ Non-Intrusive agent.

Enter the path to the WebSphere MQ key database file (.kdb), but without the file extension. This file is similar to the file specified in the key repository parameter in WebSphere MQ Queue Manager configuration.

Max. Connections The maximum number of cached connections to Queue Manager allowed for sending messages. More connections enable more messages to be sent concurrently.
Advanced Settings
Message Context Mode

Options for accessing the MQ queue.

  • None.
  • Set Identity. Corresponds to the MQC.MQOO_SET_IDENTITY_CONTEXT property.
  • Set All. Corresponds to the MQC.MQOO_SET_ALL_CONTEXT property.
Strip XML Declarations Removes XML declarations (<?xml ...>) from text messages before processing in Service Virtualization. Text messages are in Unicode.
Use UTF Methods

Service Virtualization considers MQ text messages as created by the WriteUTF() method instead of the WriteString() method.

When using an XML service, the message can be either transferred as a string (with a specified character set) or as binary data (UTF). By default, the agent reads and writes messages as a string. Select this option to use binary messages with UTF content instead.

Response Queue Access Mode

Defines how Service Virtualization opens the response queue.

  • Default. Legacy functionality according to Service Virtualization versions earlier than 3.61. The Service Virtualization agent can access a shared queue, and selects messages in the queue according to FIFO methodology.

    Caution: The response queue consumes messages regardless of the correlation mechanism (defined in the Request-Response Matching Mode field below). This can be problematic if the queue is shared. In this case, it is recommended to use the Shared mode.

  • Exclusive. Opens the queue in the MQ Exclusive Queue Access mode. Access is limited to Service Virtualization only, enabling the fastest sequential picking from the queue.
  • Shared. Opens the queue as an MQ shared queue and selects specific responses according to the IDs used for request-response matching mode (request message ID, request correlation ID, or both). Enables you to run several services with one response queue, or run a virtual service with systems where the response queue is shared with other applications.

    Note: This mode is slower than the other modes, as it is selecting specific responses from the queue and not simply the first response.

Listening Timeout (ms)

The length of time Service Virtualization listens for a response or multi-response. If the response does not arrive within the timeout period, Service Virtualization stops the listening process, even if there are multiple responses expected.

Maximum Responses per Request Defines the number of response messages that are expected for each request message. Relevant when the Service Virtualization agent is configured to use Shared Response Queue Access Mode only. When the maximum responses per request are reached, Service Virtualization stops the listening process.
Request-Response Matching Mode

Defines the method used to match a response to the correct request.

  • Request Message ID -> Response Correlation ID. The Message ID of the request is copied to the Correlation ID of the response. This is the default behavior of WebSphere MQ.
  • Request Correlation ID -> Response Correlation ID. The Correlation ID of the request is copied to the Correlation ID of the response.