Can RTView EMS version show dynamic JMS header?
Article ID: KB0090726
Updated On:
| Products | Versions |
|---|---|
| TIBCO Enterprise RTView | - |
| Not Applicable | - |
Description
Resolution:
For a given JMS message, you should be able to see standard JMS header information, message content (map message, xml payload, etc).
To see custom jms attributes in the message, you will need to set up a JMSALIAS.ini to expose these attributes in the dialog. JMSALIAS.ini
is created manually using any text editor. See docs for more information:
Create JMS Message Alias
NOTE: The JMS data <file:///C:\ERTV_4.7d1\docs\user\packages_intro.html> source may not be licensed in your Enterprise RTView installation.
In the JMSALIAS.ini file, you can create aliases for (top level or nested) messages, message fields and XML data embedded in JMS messages. Once JMSALIAS.ini is saved and Enterprise RTView is restarted, you will be able to access these aliases from the Message Topic drop down menu in the Attach to JMS Data <file:///C:\ERTV_4.7d1\docs\ds\jms\bdata_jms.html> dialog.
To define an alias in JMSALIAS.ini use the following syntax:
aliasName connection topic partialUpdatesOK fieldNameList
aliasName
Create a name to use when selecting this alias from the Attach to JMS Data <file:///C:\ERTV_4.7d1\docs\ds\jms\bdata_jms.html> dialog. NOTE: Alias names cannot contain spaces.
connection
The connection to use when listening for this topic. If the specified connection is not defined, the alias will not be added. If the connection name contains a space, it must be enclosed in single quotes.
topic
JMS message topic. It is possible to use * as a wild card character (e.g.: orders.STATUS.* or *.*.*). NOTE: If a message topic contains a space or a colon, then the topic must be enclosed in single quotes.
partialUpdatesOK
This keyword is optional. If present, new row data will be merged into existing row data when a new message comes in with the same topic. For example, if a message comes in which contains fields FieldA, FieldB and FieldC, then another message with the same topic comes in which contains fields FieldC, FieldD and FieldE, the new row will contain fields FieldA and FieldB from the previous message and FieldC, FieldD and FieldE from the current message.
fieldNameList
Message field names listed in hierarchical order separated by a :: (e.g., fieldName1::fieldName2::fieldName3 ... etc.) ending in the name of the field that contains the data to display. If no fieldNameList is specified, top level message fields will be displayed.
If a message field in this list contains XML data, then add the $xml: prefix to the field name that contains the XML data. (e.g., fieldName1::$xml:fieldName2::fieldName3 ... etc.) The name of the message field containing XML data may be followed by a list of XML tags in hierarchical order that ends in an XML tag with the specific data you would like to display. If the last fieldName listed contains more than one level of XML tags, then all subsequent tags will be converted to column names using the _ symbol.
NOTE: If a field name contains a space or a colon, then the entire fieldNameList must be enclosed in single quotes.
Nested MapMessage Field Aliases
In the alias defined below named allOrders, a message with the topic orders.STATUS.* contains the customer_info MapMessage field, which is nested within the sales MapMessage field. NOTE: Not all JMS providers support nested MapMessages.
allOrders myConnection orders.STATUS.* sales::customer_info
A table attached to allOrders will contain a column for each field in the customer_info message field.
It is also possible to create an alias for a specific field in the customer_info message field.
allNames myConnection orders.STATUS.* sales::customer_info::NAME
A table attached to allNames would contain one column for the NAME field.
Embedded XML Data Aliases
To display XML data embedded within a JMS message, add the $xml: prefix to the field name that contains the XML data. In the alias defined below named OrderInfo, the OrderData message field (containing XML data) is nested within the Production MapMessage field:
OrderInfo myConnection orders.STATUS.* Production::$xml:OrderData
It is also possible to display XML from a TextMessage:
OrderInfo myConnection orders.STATUS.* $xml:<TEXT>
There are several ways that the following XML values and attributes (contained in the message field named OrderData) can be defined in an alias.
<Orders>
<Order Date="March 1, 2004" Time="12:00:00">
<OID>12345</OID>
<Customer>
<Name>John Smith</Name>
<CID>6789</CID>
</Customer>
</Order>
<Order Date="March 1, 2004" Time="12:00:00">
<OID>67891</OID>
<Customer>
<Name>Alice Chen</Name>
<CID>1001</CID>
</Customer>
</Order>
</Orders>
Displaying XML Values
To display all XML values contained within Order tags of the OrderData MapMessage field, you would use the following alias. NOTE: Hierarchical XML tags are converted to column names using the _ symbol (e.g.: Customer_Name, Customer_CID, etc.).
OrderInfo myConnection orders.STATUS.* $xml:OrderData::Orders::Order
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order
You can display specific information contained within Customer tags of the OrderData message field using the following alias:
CustomerInfo myConnection orders.STATUS.* $xml:OrderData::Orders::Order::Customer
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order::Customer
Displaying XML Values and Attributes
To display all XML values and attributes contained within Order tags of the OrderData message field, you would use the following alias. NOTE: Hierarchical XML tags are converted to column names using the _ symbol (e.g.: Customer_Name, Customer_CID, etc.).
OrderInfoAllValuesAndAttribs myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=**
To display the same data from a TextMessage:
$xml:<TEXT>::Orders:Order:$attrib=**
Displaying XML Attributes Only
You can display all of the XML attributes contained within Order tags of the OrderData message field using the following alias:
OrderInfoAllAttribs myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=*
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order:$attrib=*
It is also possible to display only a particular attribute (Date) contained within the Order tags.
OrderInfoDate myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=Date
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order:$attrib=Date
For a given JMS message, you should be able to see standard JMS header information, message content (map message, xml payload, etc).
To see custom jms attributes in the message, you will need to set up a JMSALIAS.ini to expose these attributes in the dialog. JMSALIAS.ini
is created manually using any text editor. See docs for more information:
Create JMS Message Alias
NOTE: The JMS data <file:///C:\ERTV_4.7d1\docs\user\packages_intro.html> source may not be licensed in your Enterprise RTView installation.
In the JMSALIAS.ini file, you can create aliases for (top level or nested) messages, message fields and XML data embedded in JMS messages. Once JMSALIAS.ini is saved and Enterprise RTView is restarted, you will be able to access these aliases from the Message Topic drop down menu in the Attach to JMS Data <file:///C:\ERTV_4.7d1\docs\ds\jms\bdata_jms.html> dialog.
To define an alias in JMSALIAS.ini use the following syntax:
aliasName connection topic partialUpdatesOK fieldNameList
aliasName
Create a name to use when selecting this alias from the Attach to JMS Data <file:///C:\ERTV_4.7d1\docs\ds\jms\bdata_jms.html> dialog. NOTE: Alias names cannot contain spaces.
connection
The connection to use when listening for this topic. If the specified connection is not defined, the alias will not be added. If the connection name contains a space, it must be enclosed in single quotes.
topic
JMS message topic. It is possible to use * as a wild card character (e.g.: orders.STATUS.* or *.*.*). NOTE: If a message topic contains a space or a colon, then the topic must be enclosed in single quotes.
partialUpdatesOK
This keyword is optional. If present, new row data will be merged into existing row data when a new message comes in with the same topic. For example, if a message comes in which contains fields FieldA, FieldB and FieldC, then another message with the same topic comes in which contains fields FieldC, FieldD and FieldE, the new row will contain fields FieldA and FieldB from the previous message and FieldC, FieldD and FieldE from the current message.
fieldNameList
Message field names listed in hierarchical order separated by a :: (e.g., fieldName1::fieldName2::fieldName3 ... etc.) ending in the name of the field that contains the data to display. If no fieldNameList is specified, top level message fields will be displayed.
If a message field in this list contains XML data, then add the $xml: prefix to the field name that contains the XML data. (e.g., fieldName1::$xml:fieldName2::fieldName3 ... etc.) The name of the message field containing XML data may be followed by a list of XML tags in hierarchical order that ends in an XML tag with the specific data you would like to display. If the last fieldName listed contains more than one level of XML tags, then all subsequent tags will be converted to column names using the _ symbol.
NOTE: If a field name contains a space or a colon, then the entire fieldNameList must be enclosed in single quotes.
Nested MapMessage Field Aliases
In the alias defined below named allOrders, a message with the topic orders.STATUS.* contains the customer_info MapMessage field, which is nested within the sales MapMessage field. NOTE: Not all JMS providers support nested MapMessages.
allOrders myConnection orders.STATUS.* sales::customer_info
A table attached to allOrders will contain a column for each field in the customer_info message field.
It is also possible to create an alias for a specific field in the customer_info message field.
allNames myConnection orders.STATUS.* sales::customer_info::NAME
A table attached to allNames would contain one column for the NAME field.
Embedded XML Data Aliases
To display XML data embedded within a JMS message, add the $xml: prefix to the field name that contains the XML data. In the alias defined below named OrderInfo, the OrderData message field (containing XML data) is nested within the Production MapMessage field:
OrderInfo myConnection orders.STATUS.* Production::$xml:OrderData
It is also possible to display XML from a TextMessage:
OrderInfo myConnection orders.STATUS.* $xml:<TEXT>
There are several ways that the following XML values and attributes (contained in the message field named OrderData) can be defined in an alias.
<Orders>
<Order Date="March 1, 2004" Time="12:00:00">
<OID>12345</OID>
<Customer>
<Name>John Smith</Name>
<CID>6789</CID>
</Customer>
</Order>
<Order Date="March 1, 2004" Time="12:00:00">
<OID>67891</OID>
<Customer>
<Name>Alice Chen</Name>
<CID>1001</CID>
</Customer>
</Order>
</Orders>
Displaying XML Values
To display all XML values contained within Order tags of the OrderData MapMessage field, you would use the following alias. NOTE: Hierarchical XML tags are converted to column names using the _ symbol (e.g.: Customer_Name, Customer_CID, etc.).
OrderInfo myConnection orders.STATUS.* $xml:OrderData::Orders::Order
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order
You can display specific information contained within Customer tags of the OrderData message field using the following alias:
CustomerInfo myConnection orders.STATUS.* $xml:OrderData::Orders::Order::Customer
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order::Customer
Displaying XML Values and Attributes
To display all XML values and attributes contained within Order tags of the OrderData message field, you would use the following alias. NOTE: Hierarchical XML tags are converted to column names using the _ symbol (e.g.: Customer_Name, Customer_CID, etc.).
OrderInfoAllValuesAndAttribs myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=**
To display the same data from a TextMessage:
$xml:<TEXT>::Orders:Order:$attrib=**
Displaying XML Attributes Only
You can display all of the XML attributes contained within Order tags of the OrderData message field using the following alias:
OrderInfoAllAttribs myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=*
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order:$attrib=*
It is also possible to display only a particular attribute (Date) contained within the Order tags.
OrderInfoDate myConnection orders.STATUS.* $xml:OrderData::Orders::Order:$attrib=Date
To display the same data from a TextMessage:
$xml:<TEXT>::Orders::Order:$attrib=Date
Issue/Introduction
Can RTView EMS version show dynamic JMS header?
Feedback
Yes
No
Powered by
