10.1 Default Driver Parameters

The driver import file defines some basic functionality in the driver. How the driver handles this information for each channel is explained in the tables below.

Table 10-1 Driver Settings

Parameter

Sub-Parameter

Description

Default JMS version

 

Specify the API version this driver should use when communicating with message brokers. If you are uncertain, 1.0.2 is the more widely adopted standard.

This setting is global for all message brokers.

Broker ID

 

Specify an identifier for this broker by which it will be known in the Identity Manager namespace.

Show connection-related parameters

 

Displays connection-related parameters such as JNDI connection factory names and usernames or passwords.

 

Queue connection factory name

Specify the JNDI name of the connection factory used to create connections to queues.

 

Topic connection factory name

Specify the JNDI name of the connection factory used to create connections to topics.

 

Username

Specify the username used to authenticate to the message broker.

 

Password

The password used to authenticate to the message broker.

After entering the password, you need to re-enter it for validation.

Show standard JNDI context parameters

 

Displays standard JNDI context properties for this message broker. These properties are primarily used to specify the URL, username, and password used to connect to or authenticate with this broker.

 

INITIAL_CONTEXT_ FACTORY

The name that uniquely identifies this JNDI context property.

 

Value

The name of the Java class used to create a JNDI context for this message broker.

 

PROVIDER_URL

The name that uniquely identifies this JNDI context property

 

Value

The URL of this message broker. A URL usually contains a protocol, an IP address, and a port number.

For example: jnp://140.67.155.9:1099

 

SECURITY_ CREDENTIALS

The name that uniquely identifies this JNDI context property.

 

Value

The password used to authenticate to this message broker.

 

SECURITY_ PRINCIPAL

The name that uniquely identifies this JNDI context property.

 

Value

The username used to authenticate to this message broker.

 

URL_PKG_PREFIXES

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

Show remaining standard properties

Displays remaining, less commonly used standard JNDI context properties

 

APPLET

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

BATCHSIZE

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

DNS_URL

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

LANGUAGE

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

OBJECT_FACTORIES

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

REFERRAL

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

SECURITY_ AUTHENTICATION

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

SECURITY_ PROTOCOL

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

 

STATE_FACTORIES

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

Show vendor-specific JNDI context properties

 

Displays vendor-specific JNDI context properties.

 

Name

The name that uniquely identifies this JNDI context property.

 

Value

The value of this JNDI context property.

Table 10-2 Subscriber Channel

Parameter

Sub-Parameter

Description

Disable subscriber

 

Select yes to prevent this channel from sending messages to JMS providers.

Show default message parameters

 

Displays parameters that are global to all messages.

 

Default message expiration (milliseconds)

How long messages should live after they reach a destination. Specify the time duration in milliseconds. This setting is global for all sent messages.

A value of 0 specifies that the message lives indefinitely.

 

Default message priority

Specifies the message priority.

0-4 indicates normal delivery 5-9 indicates expedited delivery

Specifying expedited delivery can result in “out-of-order” message processing. This setting is global for all sent messages.

 

Default message type

Specifies the default message type as text or bytes. This setting is global for all sent messages.

 

Show default message properties

Specifies whether to display parameters that show the properties sent with messages.

Message properties can be used to prevent message loopback or to pass application-specific information in messages.

These properties are global for all sent messages.

 

Name

Message property names beginning with “JMS” must match those defined by the JMS specification or third-party providers.

Property names fall into three general categories:

1. Standard JMS properties (begin with “JMS” or “JMSX”) 2. Provider-specific properties (begin with “JMS_”) 3. Application-specific (anything else)

 

Value

Message property value.

Show default destination parameters

 

Display parameters global to all destinations.

 

Default destination type

Specifies whether all destinations are queues or topics by default. This setting is global for all destinations.

 

Default omit message envelope

Specifies whether the JMS message envelope should be omitted from received messages. This setting is global to all destinations.

 

Default receive timeout (seconds)

Specifies how long a channel should wait to receive a response to a sent message. The default value is 10 seconds. Permitted values canrange from 1-25.

This setting is global to all destinations.

 

Default message filter

Specifies how destinations filter received messages.

This setting is global to all destinations.

 

Default message selector

Specify a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses such as JMSCorrelationID LIKE '%01=whatever%'.

The % wildcard character can be used to disregard content before or after the part of a header or property value you're interested in filtering on. When used in tandem with a message filter, the message selector is appended to the end of the filter by using an AND operator.

Show destination

 

Display parameters for this selected destination.

 

Destination unique id

Specify the identifier for this destination by which it is known in the IDM namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).

 

Destination JNDI name

Specify the identifier for this destination that is known in the JNDI namespace. This might not be the name the destination is known by to the broker. This value does not need to be unique.

 

Destination type

Specifies whether this destination is a queue or a topic.

 

Message type

Specifies whether messages are sent as text or bytes.

 

Destination mode

Specifies whether the destination is used to send or receive messages.

 

Show message properties

Specifies whether to display message properties sent with messages. Message properties can be used to prevent message loopback or pass provider or application-specific information along with messages.

Show destination

 

Display parameters for this selected destination.

 

Destination unique id

Specify the identifier for this destination that it is known by in the IDM namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).

 

Destination JNDI name

Specify the identifier for this destination that it is known by in the JNDI namespace. This might or might not be the name the destination is known by to the message broker.

This value does not have to be unique.

 

Destination type

Specifies whether the destination is a queue or a topic.

 

Message type

Specifies whether messages should be sent as text or bytes.

 

Destination mode

Specifies whether the destination is used to send or receive messages.

 

Omit message envelope

Specifies whether the JMS message envelope is omitted from messages received by this destination.

 

Receive timeout (seconds)

Specifies how long a channel should wait to receive a response to a sent message. The default value is 10 seconds. Permitted values can range from 1-25.

 

Message filter

Specifies how the destination receives filtered messages.

 

Message selector

Specify a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses (for example, JMSCorrelationID = 'whatever'. When used in tandem with a message filter, the message selector is appended to the end of the filter using an AND operator.

 

Is durable

Specifies whether messages are cached at the broker when the driver isn't running. This setting is only effective for topic destinations; queues are durable by definition.

Table 10-3 Publisher Channel

Parameter

Sub-parameter

Description

Disable publisher

 

Select yes to prevent this channel from receiving messages from JMS providers.

Show default message parameters

 

Displays parameters global to all messages.

 

Default message expiration (milliseconds)

Specifies how long messages live after they reach a destination.

Specify the time duration in milliseconds. 0 means the messages live indefinitely. This setting is global for all sent messages.

 

Default message priority

Specifies the message priority.0-4 indicates normal delivery 5-9 indicates expedited deliverySpecifying expedited delivery can result in “out-of-order” message processing. This setting is global for all sent messages.

 

Default message type

Specifies whether messages are text or byte. This setting is global for all sent messages.

 

Show default message properties

Displays the parameters that specify the properties sent with messages.

Message properties can be used to prevent message loopback or pass application-specific information in messages.

These properties are global for all sent messages.

Show default session parameters

 

Displays parameters that are global to all sessions.

 

Default message acknowledgment threshold

Specifies how many messages are received by a monitored destination before an acknowledgment is sent to the broker.

Show default destination parameters

 

Displays parameters that are global to all destinations.

 

Default destination type

Specifies whether destinations are topics or queues by default.

This setting is global for all destinations.

 

Default omit message envelope

Specifies if the JMS message envelope is omitted from received messages.

This setting is global for all destinations.

 

Default receive timeout (seconds)

Specifies how long a channel waits to receive a response to a sent message. The default is 10 seconds. Permitted values range from 1-25 seconds.

This setting is global for all destinations.

 

Default message filter

Specifies how destinations filter received messages.

This setting is global for all destinations

 

Default message selector

Specify a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses for example, JMSCorrelationID LIKE '%01=whatever%'.

The % wildcard character is used to disregard content before or after the part of a header or property value you're interested in filtering on. When used in tandem with a message filter, the message selector is appended to the end of said filter using an AND operator.

 

Default polling interval (milliseconds)

Specifies how often destinations are polled for new messages (in milliseconds.)

This setting is global for all destinations.

Show destination

 

Displays parameters for this selected destination.

 

Destination unique id

Specify the identifier for this destination by which it is known in the IDM namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).

 

Destination JNDI name

Specify the identifier for this destination by which it is known in the JNDI namespace. This might not be the name the destination is known by to the broker. This value does not need to be unique.

 

Destination type

Specify whether this destination is a queue or topic.

 

Message type

Specify whether messages are sent in text or byte format.

 

Destination mode

Specify whether this destination sends or receives messages.

 

Show message properties

Displays the parameters that specify the properties sent with messages.

Message properties can be used to prevent message loopback or pass application-specific information along with messages.

Show destination

 

Displays parameters for this selected destination.

 

Destination unique id

Specify the identifier for this destination that it is known by in the IDM namespace. This name is also the durable subscription name for topics.

This value must be unique per channel (Subscriber/Publisher).

 

Destination JNDI name

Specify the identifier for this destination that it is known by in the JNDI namespace. This might or might not be the name the destination is known by to the broker. This value does not need to be unique.

 

Destination type

Specifies whether the destination is a queue or a topic.

 

Message type

Specifies whether messages should be sent as text or byte.

 

Destination mode

Specifies whether this destination sends or receives messages.

 

Omit message envelope

Whether the JMS message envelope be omitted from messages received by this destination.

 

Receive timeout (seconds)

Specifies how long this channel waits to receive a response from a destination. The default is 10 seconds. Permitted values range from 1-25 seconds.

 

Message filter

Specifies how this destination filters messages.

 

Message selector

Specify a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses (or example, JMSCorrelationID = 'whatever). When used in tandem with a message filter, the message selector is appended to the end of the filter using an AND operator.

 

Is durable

Specifies whether messages are cached at the message broker when the driver isn’t running.

This setting is only effective for topic destinations; queues are durable by default.

 

Actively monitor

Specify if you want the channel to periodically monitor this destination for messages.

Heartbeat interval (minutes)

 

How many minutes of inactivity should elapse before this channel sends a heartbeat document.

10.1.1 Showing Additional Destinations

The default configuration includes the ability to show two destinations each for the Publisher and Subscriber channels.

To add more destinations:

  1. In iManager, on the Driver Parameter’s page, click Edit XML.

  2. Look for a <group> element. Within the group, look for an element that begins with <definition display-name="Show destination". . .>

  3. Copy the entire contents of the <group> element and paste it after the other entries for Show destination.

  4. Within the Show destination element, there’s an entry for “name=singorex” or “name=pignorex” (signore is for Subscriber channel destinations; pignore is for Publisher channel destinations). You should look for the highest number and increment the number.

  5. Scroll down through the copied XML and locate the <definition display-name="Destination unique id" gcv-ref="destination_1.unique-id"> element. You also need to increment the destination_x number to be the same number as the signore, pignore value.

  6. Save your XML.

    You can repeat this process as many times as needed to add additional destinations for the Publisher or Subscriber channel.

10.1.2 Considerations When Removing the Driver

If you decide to delete the driver for a Publish/Subscribe configuration using durable subscription, there are several steps you must manually complete to ensure the subscription is removed.

  1. In iManager, edit the driver object. For every destination, you must delete the Destination Unique ID and Destination JNDI Name.

  2. Restart the driver.

  3. Open the driver object, then click General > Other.

  4. Select the DirXML-DriverStorage attribute, then click Edit.

  5. Confirm that there are no child elements of <subscription/>. If none exist, the durable subscription has been removed from the message system.