Understanding the TransformData Class
This chapter provides an overview of the TransformData class and discusses:
Creating a TransformData object.
TransformData class properties.
Understanding the TransformData Class
When Integration Broker invokes a Application Engine transform program, it inserts the message content into a PeopleCode system variable, %TransformData, which remains in scope throughout the Application Engine program. Each program step can access the variable in turn and modify its content, which then becomes available to the next step.
In the Application Engine program, XSLT steps and PeopleCode steps access %TransformData differently:
In XSLT, the data is automatically made available to your program. The XSLT program is literally a presentation of the output structure and data, which includes XSL tags that reference, process, and incorporate the input data into the output structure. There’s no need to explicitly refer to %TransformData, which automatically receives the interpreted result of the XSLT step.
In PeopleCode, use the PeopleCode %TransformData system variable to access the TransformData object. You access the XML data as the XmlDoc property of the TransformData object, which you then assign to an XmlDoc object and process normally. Because the XmlDoc object is a reference to the data portion of %TransformData, your modifications are automatically passed back to the system variable.
See Also
Applying Filtering, Transformation and Translation
Creating a TransformData Object
A TransformData object is returned from the system variable %TransformData. You cannot create a TransformData object directly.
When Integration Broker invokes a Application Engine transform program, it inserts the message content into the %TransformData system variable.
TransformData Class Properties
In this section, the TransformData class properties are presented in alphabetical order.
DestMsgName
Description
This property returns the name of the message at the receiving node as a string.
This property is read-only.
DestMsgVersion
Description
This property returns the name of the message version at the receiving node as a string.
This property is read-only.
DestNode
Description
This property returns the name of the node receiving the message as a string.
This property is read-only.
RejectTransform
Description
Use this property to terminate asynchronous transactions (asynchronous physical transformations only).
Use the following system constant to set this property: %IB_Transform_Rejected.
If this property is set within a transform program for an inbound asynchronous transaction, the result will be that no subscription contract is created. On the Service Operation Monitor Details page for the transaction, an informational message will be part of the error message link indicating that the transaction was terminated.
If this property is set within a transform program for an outbound asynchronous transaction, the publication contract status will be updated to done. The outbound message will not be sent. In addition, on the Service Operation Monitor Details page for the transaction, an informational message will be part of the error message link indicating that the transaction was terminated.
This property is read-write.
RoutingDefnName
Description
This property returns the routing definition name as a string. You can use this property to retrieve the connector’s routing properties.
This property is read-only.
See Also
SourceMsgName
Description
This property returns the name of the message at the sending node as a string.
This property is read-only.
SourceMsgVersion
Description
This property returns the name of the message version at the sending node as a string.
This property is read-only.
SourceNode
Description
This property returns the name of the node sending the message as a string.
This property is read-only.
Status
Description
Use this property to communicate the success or failure of the transform program step to Integration Broker. Use the following values to set this property:
|
Integer Value |
System Constant |
Description |
|
0 (default) |
— |
Indicates success. |
|
1 |
— |
Indicates that the message failed a filtering step. |
|
2 |
%IB_Transform_Error |
Indicates that an error occurred. |
This property is read-write.
See Also
Applying Filtering, Transformation and Translation.
XmlDoc
Description
This property contains the XML message data.
You can assign this to an XmlDoc object and process the data using the XmlDoc class methods and properties.
This property is read-write.
See Also