InteractionInput
|
N
|
This input schema field is the root node for all the input provided to the activity.
|
mqproperties
|
N
|
The node containing all the message header fields (plus the destination override) that are relevant to input.
- destination: specify a destination here to override the topic name from the configuration panels.
- destqmgr: destination queue manager name. The name of the queue manager on which this topic is located.
Note: A transmission queue and a sender channel must be configured for this queue manager for it to work.
- topicdynamic: the dynamic portion of the topic string. This can be the entire topic string and override any dynamic topic specified on the configuration panel.
- correlationId: to provide a correlation identifier for this message by mapping a byte array to this field. The XPath expression
tib:string-to-base64 ("correlationid") is sufficient to populate this field. This field is only valid if the topic referenced is an administratively defined unmanaged topic. In all other cases, it is ignored by the queue manager.
Consult the IBM WebSphere MQ documentation for descriptions of managed and unmanaged subscriptions.
- messageId: to provide a message identifier for this message by mapping a byte array to this field. The XPath expression
tib:string-to-base64 ("messageId") is sufficient to populate this field. This field is only valid if the topic referenced is an administratively defined unmanaged topic. In all other cases it is ignored by the queue manager.
- characterSet: to set the IBM Coded Characterset ID of this message.
Valid values are:
- 850: The commonly used ASCII codeset.
- 819: The ISO standard ASCII codeset.
- 37: The American EBCDIC codeset.
- 1200: Unicode.
- 1208: UTF-8.
The queue manager might apply this codeset when doing conversions for the purpose of creating report messages.
- alternateUserId: to document the alternate userid used in this operation, if any.
- accountingToken: to provide a binary (base 64 encoded) accounting token to be used on host systems to assist in accounting for resources used by the application.
- applicationIdData: to provide a string that can be used on all end points to identify this application.
- applicationOriginData: to provide information related to the originating application node for this message.
- putApplicationType: to provide either one of the IBM documented application type enumerators for this application or one of your choosing.
See the IBM WebSphere MQ documentation for the meaning of the documented application types.
The documented enumerations are:
MQAT_AIX MQC.MQAT_AIX 0x06
MQAT_CICS MQC.MQAT_CICS 0x01
MQAT_DOS MQC.MQAT_DOS 0X05
MQAT_IMS MQC.MQAT_IMS 0X03
MQAT_MVS MQC.MQAT_MVS 0X02
MQAT_OS2 MQC.MQAT_OS2 0X04
MQAT_OS400 MQC.MQAT_OS400 0X08
MQAT_QMGR MQC.MQAT_QMGR 0X07
MQAT_UNIX MQC.MQAT_UNIX 0X06
MQAT_WINDOWS MQC.MQAT_WINDOWS 0X09
MQAT_JAVA MQC.MQAT_JAVA 0X1C
MQAT_UNKNOWN MQC.MQAT_UNKNOWN -1 or 0XFFFFFFFF
MQAT_NO_CONTEXT MQC.MQAT_NO_CONTEXT 0X00
MQAT_CICS_VSE MQC.MQAT_CICS_VSE 0X0A
MQAT_VMS MQC.MQAT_VMSQ 0X0C
MQAT_GUARDIAN MQC.MQAT_GUARDIAN 0X0D
MQAT_VOS MQC.MQAT_VOS 0X0E
MQAT_DEFAULT MQC.MQAT_DEFAULT 0X1C
MQAT_NSK MQC.MQAT_NSK 0X0D
MQAT_CICS_BRIDGE MQC.MQAT_CICS_BRIDGE 0X15
MQAT_NOTES_AGENT MQC.MQAT_NOTES_AGENT 0X16
MQAT_WINDOWS_NT MQC.MQAT_WINDOWS_NT 0X0B
MQAT_IMS_BRIDGE MQC.MQAT_IMS_BRIDGE 0X13
MQAT_XCF MQC.MQAT_XCF 0X14
- putApplicationName: the name of the application that puts the message. Provide information about the originating application in this field.
- userId: to provide the user ID to be used when authorizing this message as it traverses the messaging system. For operations with report options, this field is mandatory. If a value is not provided here, it is taken from the connection resource if one is available there, and from the environment if it is not.
- replyToQueueName: to specify the name of an existing queue that the target application can use as a destination for its response. This enables the common "request response" pattern.
- replyToQmgrName: destination queue manager name. The name of the queue manager on which this queue is located.
Note: A transmission queue and a sender channel must be configured for this to work.
- format: to describe the nature of the data in the message. It defaults to a space character or MQFMT_NONE. A user defined format can be used to assist the receiving application in decoding the message, for example, in the selection of a Data Conversion parse activity for this message type.
- expiry: to indicate the length of time (in tenths of a second) that the message is kept in the queue before being deleted. Defaults to
-1, which means there is no expiration. This field overrides the configuration value for expiry if it is mapped.
Permissible values are positive integers or
-1.
- priority: the priority (from
1 to
9) of the message. This field overrides a configuration value for priority if it is mapped.
- reportOptionPan: this is the Positive Acknowledgment report field and is provided by the sending application. This report field is not acted upon by the queue manager.
- reportOptionNan: this is the Negative Acknowledgment report field and is provided by the sending application. This report field is not acted upon by the queue manager.
- report: this is the report options field for the message. If nothing is entered, then the report options as configured in the
Advanced tab are used to populate it at run time. However, if a number is mapped here, it is logically OR'ed with the results of processing the report options. It is provided to enable the use of report options not configurable in the
Advanced tab.
- encoding: this is the encoding field for the message and it specifies the representation used for numeric values in the application message data. This applies to binary, packed decimal and floating point data. This encoding is used when processing of fields mapped by a message body schema.
For specific values, see the MQMessage encoding field in the WebSphere MQ documentation.
|
dynamicProperties
|
N
|
- dynamic property: these properties are exactly the same as those mapped through the
appProperties node with the exception that no special schema is required to map them. A
dynamicProperties node is created for each property in the message which was not mapped by the appProperties schema mechanism. If no appProperties schema is in place, all properties are dynamic. Note that the publish and subscribe mechanisms in WebSphere MQ uses message properties in the implementation, you can see the property
mqps.Top and possibly others on all publications.
- name: the name of the property.
- value: the string type value of the property.
- type: the type for the property. The valid types are
"string",
"boolean",
"short",
"integer",
"long",
"float",
"double", and
"byte".
|
bytes
|
N
|
Map the main content of the message body here. In general, this is the output of a Plug-in for Data Conversion render activity, but can be any array of bytes. If string data is to be mapped to this field, use the XPath function
tib:string-to-base64 to convert it to bytes.
This field is only displayed when
Binary is selected in the
Message Content Type area.
|
text
|
N
|
This field contains a text representation of the bytes in the message body as converted using the default Java encoding.
This field is only displayed when
Text is selected in the
Message Content Type area.
|
appProperties
|
N
|
Contains fields that correspond to the schema as it is defined in the application properties resource that is mapped to this activity.
Note: The
appProperties node is only present if a WMQ Properties Resource has been configured for the activity.
|
messageFields
|
N
|
This element is present when
Schema is selected from the
Message Content Type list of the
General tab. The contents of the mapped schema are present in this node for mapping purposes.
|