Transform function
Syntax
Transform({XmlString | &XmlDoc} AE_Program_Name, Initial_Node_Name, Initial_Message__Name, Initial_Message_Version, Result_Node_Name, Result_Message_Name, Result_Message_Version)Description
Use the Transform function to modify one transaction, as specified by the Initial parameters, to another transaction, specified by the Result parameters, using an Application Engine program. This is used with Integration Broker.
Generally using this function implies that you're transforming a message that you're not actually sending or receiving at the current time. By using this method, and specifying the two transactions, it's as if you're defining a relationship, without having to use the relationship component.
Parameters
| Parameter | Description |
|---|---|
|
XmlString | &XmlDoc |
Specify an already populated XmlDoc object, an XML string, or other text that you want transformed. |
|
AE_Program_Name |
Specify the name of the Application Engine program that you want to use for the transformation. |
|
Initial_Node_Name |
Specify the name of the initial node as a string. |
|
Initial_Message_Name |
Specify the name of the initial message. |
|
Initial_Message_Version |
Specify the version of the initial message that you want to use. |
|
Result_Node_Name |
Specify the result, where you want the transformed message to go to. |
|
Result_Message_Name |
Specify the name of the result message, the one to use for the output. |
|
Result_Message_Version |
Specify the version of the result message to be used. |
Returns
An XmlDoc object containing the resulting XML from the transformation. Null is never returned. If you do not want to display an error to the user, place this function inside a try-catch statement.
Considerations Using the Transform Functions
The Transform function uses an existing Application Engine program to do transformations. This enables you to break up the flow of Integration Broker and do transformations when you need to. If you wish to reuse your Application Engine programs, you can invoke them by using this function.
The TransformEx function does not use an Application Engine program to do a transformation. Instead, it does an Extensible Stylesheet Language Transformation (XSLT.) This enables you to dynamically do transformations outside of Integration Broker, such as, performing transformations on pagelets in a portal every time a page is accessed.
The TransformExCache function also does XSLT transformations without using an Application Engine program, outside of Integration Broker. Use TransformExCache when you have a large volume of similar transformations to be done. Caching technology is used with this function. You may see an increase in performance, as well as an increase in memory consumption, using this function.