This topic contains sections marked as revised for this release
The XSLTransform node transforms an XML message to another message, according to the rules provided by an XSL style sheet.
This topic contains the following sections:
You can specify the location of the style sheet to apply to this transformation in three ways:
An XSLT (Extensible Stylesheet Language for Transformations) compiler is used for the transformation if the style sheet is not embedded within the message, and the node cache level (node property Stylesheet Cache Level) is greater than zero. If the XSLT is cached, the performance is improved because the XSLT is not parsed every time it is used.
If the prologue of the input message body contains an XML encoding declaration, the XSLTransform node ignores the encoding, and always uses the CodedCharSetId in the message property folder to decode the message.
The XSLTransform node is contained in the Transformation drawer of the palette, and is represented in the workbench by the following icon:
For an example of how to use this node, consider two news organizations that exchange information on a regular basis. One might be a television station, the other a newspaper. Although the information is similar, the vocabulary that is used by the two is different. This node can transform one format to the other by applying the rules of the specified style sheet. If you specify the style sheet in the message (either the XML data or the LocalEnvironment), the same node can perform both transformations.
<?xml-stylesheet type="text/xsl" href="foo.xsl"?>and "foo.xsl" would then be used as the name of the style sheet.
This node was available in Version 5.0 and Version 6.0, and element ComIbmXslXmltStylesheetname was used for the name of the style sheet, therefore the current node checks both elements. If both are present, the value in XSL.StyleSheetName takes precedence.
This node was available in Version 5.0 and Version 6.0, and element ComIbmXslXmltOutputcharset was used for the output character set, therefore the current node checks both elements. If both are present, the value in XSL.OutputCharSet takes precedence.
If you set a value for Output Character Set, the value that you enter must be numeric; for example, to encode the output of the transformation as UTF-16, enter 1200.
The XMLNSC parser discards certain information in XML documents, such as processing instructions and comments, if you do not set properties to retain this information in a preceding node. To ensure that the XSLTransform node transforms the message correctly, set the Retain Mixed Content, Retain Comments, and Retain Processing Instructions properties correctly on the preceding node (for example, an MQInput node). The MRM parser also discards this information, but you cannot retain information for this parser, therefore avoid using the MRM domain if such information is vital to your transformation.
Style sheets that are to be deployed must have either .xsl or .xslt as their file extension, and XML files to be deployed must have .xml as their file extension.
Import into an Eclipse workspace project all style sheets and XML files that are to be deployed. Put location-dependent descendant style sheets, or XML files that are to be deployed, in the correct directory structure relative to their parent style sheets. Do not put in the Eclipse workspace location-dependent descendants that you do not want to deploy.
Generally, all references to a deployed style sheet must be made relative, no matter where they appear. A reference to a principal style sheet must be made relative to the root of the relevant Eclipse workspace project.
The only exception is when you specify a principal style sheet as the Stylesheet Name property on an XSLTransform node; you can use an absolute path that points to the correct directory structure in the Eclipse workspace. If the principal style sheet is found, the system resets the node property automatically to the correct relative value.
The system also performs an automatic deployment of the principal style sheet, together with all of its location-dependent descendant style sheets that are available in the relevant Eclipse workspace project. All references to the location-dependent descendant style sheets (or XML files) of a principal style sheet must be made relative to the location of their parent style sheets. For example, if style sheet //project1/a/b.xsl references style sheet //project1/a/c/d.xsl, the reference must be changed to c/d.xsl (or ./c/d.xsl).
Style sheets can refer to other style sheets. If you have a relatively-referenced child style sheet (or XML file) that is not to be deployed, yet its parent is, make sure that the child style sheet is placed in the correct location under workpath/XSL/external (workpath/XML/external), where workpath is the full path to the working directory of the broker.
A broker automatically associates the execution group deployed storage tree, workpath/XSL/external, and workpath/XML/external tree, together. Therefore if, for example, the document b/c.xml is not found in the broker’s deployed storage, the broker automatically searches for a reference to it in the workpath/XML/external/a/b directory in the deployed principal style sheet a/style.xsl. Relative path references must also be used for files that have been deployed but which are not available in the workspace.
Deploy manually only those style sheets or XML files that are not picked up by the system (the Message Broker Toolkit provides warnings about these files). If you click Browse for the node, or provide the full path of the location of the style sheet in the Eclipse workspace, the style sheet is included automatically in the bar file.
To deploy manually, add the files to be deployed to a broker archive. For more information refer to Adding files to a broker archive and Adding keywords to XSL style sheets.
If a style sheet in the workpath/XSL/external directory shares the same path and name with a deployed style sheet, the deployed style sheet is used.
When you have put an instance of the XSLTransform node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view.
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
Configure the XSLTransform node:
You can also specify a user-defined parser if appropriate.
If the domain is either XMLNS or XMLNSC as a result of being set explicitly or having been inherited from the input node, and the style sheet defines the output as XML (achieved by coding <xsl:output method="xml"), the output message is generated directly as a message tree. In all other cases, a bit stream is generated.
These properties set the domain, set, type, and format that you want in the message header of the output message. However, these actions are taken only if suitable headers already exist in the input message. If the input message does not have an MQRFH2 header, the node does not create one.
Leave Message Set, Message Type, and Message Format blank if you have specified the XML, JMS, MIME, or BLOB parser.
If you change a cached style sheet (by redeploying or replacing the file in the file system), the XSLTransform node that is holding the cache replaces the cached version with the modified (latest) version before a new message is processed. However, if you are changing several style sheets, stop relevant message flows before you make any changes. If you do not stop the relevant message flows before you make the changes, the order of the changes cannot be guaranteed by running message flows, which might cause an incompatibility between the style sheets that are changed. Use the mqsireload command to reload a style sheet; however, this command does not prevent incompatibility.
The trace information is written to a trace file XMLTTrace.log:
If you set Trace setting to On for one XSLTransform node, it is on for all nodes in the execution group.
This property is now deprecated. Any relevant trace now goes into the user trace, provided that user debug trace is enabled. The setting of Trace setting in the XSLTransform node does not affect any user trace.
Local environment variable name | Node property name | Permitted values |
---|---|---|
XSL.MessageDomain | Message Domain |
|
XSL.MessageSet | Message Set | |
XSL.MessageType | Message Type | |
XSL.MessageFormat | Message Format | |
XSL.Validate | Validate |
|
XSL.FailureAction | Failure action |
|
XSL.ParseTiming | Parse Timing |
|
XSL.UseXmlnscForXmlnsDomain | Use XMLNSC compact parser for XMLNS domain |
|
XSL.OutputCharSet | Character Set | |
XSL.StyleSheetName | Stylesheet Name |
mqsireportproperties brokerName -e executionGroupLabel
-o ComIbmJVMManager -n jvmMaxHeapSize
Use
the mqsichangeproperties command
to increase the Java Heap size:mqsichangeproperties brokerName -e executionGroupLabel
-o ComIbmJVMManager -n jvmMaxHeapSize -v newSize
In
the above examples, replace brokerName, executionGroupLabel,
and newSize with the appropriate values.The value that you choose for newSize depends on the amount of physical memory that your computer has, and how much you are using Java. A value in the range 512 MB (536870912) to 1 GB (1073741824) is typically sufficient.
When the output message domain is either XMLNS or XMLNSC, particular circumstances apply. If the domain is either XMLNS or XMLNSC as a result of being set explicitly or having been inherited from the input node, and the style sheet defines the output as XML (achieved by coding <xsl:output method="xml"), the output message is generated directly as a message tree. In all other cases, a bit stream is generated. Because WebSphere Message Broker parses message trees to be single-rooted, ensure that, should a multiple-rooted message tree be produced, it is distributed into well-formed message trees if they are to be serialized.
For XMLNSC input messages, ensure that you select the Retain Processing Instructions option on the Input Message Parsing tab so that embedded style sheet name declarations in input messages can be found by the code.
Difference | XMLNS or XMLNSC | Other domains |
---|---|---|
Output format | Message tree | Bit stream |
Parse Timing property | Not applicable | Applied if bit stream is subsequently parsed |
Use XMLNSC compact parser for XMLNS domain property | Applied when the message tree is serialized | Not applicable |
Validate property | Applied when the message tree is serialized | Applied if the bit stream is subsequently parsed |
Failure property | Applied when the message tree is serialized | Applied if the bit stream is subsequently parsed |
The XSLTransform node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts the message for processing by the node. |
Failure | The output terminal to which the original message is routed if an error is detected during transformation. |
Out | The output terminal to which the successfully transformed message is routed. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).
The XSLTransform node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type | The name of the node. |
Short Description | No | No | A brief description of the node. | |
Long Description | No | No | Text that describes the purpose of the node in the message flow. |
The XSLTransform node Stylesheet properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Stylesheet Name | No | Yes | The name of the style sheet, used if the style sheet specification is searched for in node properties. |
The XSLTransform node Advanced properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Stylesheet Directory | No | Yes | The path where the style sheet is located. This path is used by all location methods. | |
Stylesheet Cache Level | No | No | 5 | The number of compiled or parsed style sheets that are stored in this instance of the node. |
Property | M | C | Default | Description |
---|---|---|---|---|
Message Domain | No | No | BLOB | The message domain that is associated with the output message. |
Message Set | No | No | The message set that is associated with the output message. | |
Message Type | No | No | The message type that is associated with the output message. | |
Message Format | No | No | The message format that is associated with the output message. | |
Output Character Set | No | No | The numeric value of the Output Character Set |
Property | M | C | Default | Description |
---|---|---|---|---|
Parse Timing | No | No | On Demand | This property controls when an output message is parsed.
Valid values are On Demand, Immediate, and Complete. For a full description of parsing on demand refer to the related links. |
Use XMLNSC Compact Parser for XMLNS Domain | No | No | No | This property controls whether the XMLNSC Compact Parser is used for output messages in the XMLNS Domain. If you set this property, the message data appears under XMLNSC in nodes that are connected to the output terminal when the input RFH2 header or Domain is XMLNS. |
The XSLTransform node Detail Trace properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Trace Setting | Yes | No | Off | This property controls whether tracing is on or off. If tracing is on, low level tracing is recorded in a file. |
Property | M | C | Default | Description |
---|---|---|---|---|
Validate | No | No | None | This property controls whether validation takes place of the output message. Valid values are None, Content, Content and Value, and Inherit. |
Failure Action | No | No | Exception | This property controls what happens if validation of the output message fails. You can set this property only if you set Validate to Content and Value or Content. Valid values are User Trace, Local Error Log, Exception, and Exception List. |