Data types for elements in the DestinationData subtree

The DestinationData subtree is part of the Destination subtree in the LocalEnvironment. LocalEnvironment trees are created by input nodes when they receive a message and, optionally, by compute nodes. When created, they are empty but you can create data in them by using ESQL statements coded in any of the SQL nodes.

The Destination subtree consists of subtrees for zero or more protocols, for example WebSphere MQ and WebSphere MQ Everyplace, or a subtree for routing destinations (RouterList), or both.

The protocol tree has two children:

LocalEnvironment tree structure includes a picture of a typical tree, showing a Destination tree that has both protocol and RouterList subtrees.

The structure of data within the DestinationData folder is the same as that in Defaults for the same protocol, and can be used to override the default values in Defaults. You can therefore set up Defaults to contain values that are common to all destinations, and set only the unique values in each DestinationData subtree. If a value is set neither in DestinationData, nor in Defaults, the value that you have set for the corresponding node property is used.

The fields, data type, and valid values for each element of Defaults and DestinationData subtrees for WebSphere MQ are shown in the following table. MQOutput node describes the corresponding node properties.

Refer to Accessing the LocalEnvironment tree for information about using DestinationData.

Data type of the element Represented as Corresponding node property Valid values
queueManagerName CHARACTER Queue Manager Name  
queueName CHARACTER Queue Name  
transactionMode CHARACTER Transaction Mode no, yes, automatic
persistenceMode CHARACTER Persistence Mode no, yes, automatic, asQdef
newMsgId CHARACTER New Message ID no, yes
newCorrelId CHARACTER New Correlation ID no, yes
segmentationAllowed CHARACTER Segmentation Allowed no, yes
alternateUserAuthority CHARACTER Alternate User Authority no, yes
replyToQMgr CHARACTER Reply-to queue manager  
replyToQ CHARACTER Reply-to queue  

Case-sensitivity for data types and values

When you create these fields in the DestinationData folder, you need to enter the data type and value exactly as shown in the table . If any variations in spelling or case are used then these fields or values are ignored in the DestinationData records and the next available value is used.

For example, the following ESQL samples could result in unexpected output:

SET OutputLocalEnvironment.Destination.MQ.DestinationData[1].persistenceMode = 'YES';
SET OutputLocalEnvironment.Destination.MQ.DestinationData[2].PersistenceMode = 'yes';

In each case the DestinationData folder might not write a persistent message for these destinations. In the first example the persistenceMode field has been given a value of 'YES', which is not one of the valid values listed in the table above and this value is ignored. In the second example, the field named 'PersistenceMode' is specified incorrectly and is ignored. Either the persistenceMode value of the Defaults folder, or the value of the associated attribute on the MQOutput node will be used. If this causes a value of 'no' or 'automatic' to be used, a persistent message will not be written.

If a DestinationData folder is producing unexpected output, you should check that you have used the correct case and spelling in the fields and values used.

Related concepts
Message flows overview
LocalEnvironment tree structure
Related tasks
Creating destination lists
Accessing the LocalEnvironment tree
Related reference
Element definitions for message parsers
Data types of fields and elements
Data types of the fields in the WebSphere MQ headers
Data types for elements in the Properties subtree
Data types for elements in an MRM message
Data types for an unstructured (BLOB) message