The XLST transformation file used in the parse step of request processing has a predefined input document as well as a predefined output document.
Input Document
The input document used by the XSLT transformation file of the parse step has the same structure as the input document used by the other mapping and transformation steps in TIBCO API Exchange Gateway. The structure of this generic transformation and mapping input document in the
Mapping Schemas section.
Output Document
The output document is unique for the XSLT transformation file of the parse step as it supports the specific behavior of TIBCO API Exchange Gateway.
Elements and Attributes of Parsing Output Document
XML Node
Type
Required
Description
/output
Sequence of Complex Type
Yes
Root element for the document.
/output/requester
String
No
This value is stored in the RequestorId attribute of the TIBCO API Exchange Gateway transaction object.
This is currently not used.
/output/serviceInterface /Version
String
No
This value is stored in the ServiceInterfaceVersion attribute of the TIBCO API Exchange Gateway transaction object.
This is currently not used.
/output/referenceId
String
No
The value in this field is stored by the Central Logger in the TRN_TRANSACTION_ID column of the main ASG_TRANSACTIONS table. It may be used to store an external transaction ID or reference key that is extracted from the payload message of the received request.
/output/serviceId
String
No
This is currently not used.
/output/timestamp
String
No
This is currently not used.
/output/correlationId
String
No
This is currently not used.
/output/identityId
String
No
This is currently not used.
/output/opCoId
String
No
This value is stored in the OpCo attribute of the TIBCO API Exchange Gateway transaction object.
This is currently not used.
/output/partnerId
String
No
This element is used to perform content-based identity mapping for the requester. It must contain the partner name as configured in the Config UI.
/output/routingKey
String
No
If routingKey element is present, its value is used to set the routing key for the request to determine which target operation or target group the request should be routed to.
/output/stickyRoutingKey
String
No
This element is used to set the sticky key for a request for a load-balancing policy with StickyResourceAffinity target operation type.
/output/monitor
Sequence of Complex Type
No
This is a node element for defining a content-based throttle monitor configuration.
/output/monitor/metricName
String
Yes
Specifies a throttle name for which a content-based counter increment needs to be set.
/output/monitor/metricIncrement
Integer
Yes
Specifies content-based counter increment value that is applied to the throttle as defined in the metricName element of the monitor.
/output/key
String
No
This is a repeating element that may be used to store business keys extracted from the received request. The keys can be accessed by custom extensions and are also logged to the transaction database by the Central Logger component.
/output/key@type
String
No
Specifies the key used to store the contextual information in the Central Logger database. Its value is stored in the KEY_TYPE column of the ASG_TRANSACTION_KEYS table.
/output/key@log
Boolean
No
This is a Boolean field used to suppress the logging of a key in the Central Logger database. This attribute is useful when the key is used to pass parameters to custom policies that are not required to be logged.
The default value is True, including when you omit the attribute and do not set it.
This is applicable when you set the value to False.
/output/tns:context
Complex Type
No
This is currently not used.
/output/errorCode
String
Yes
If the parse step returns an errorCode, further processing of the request is terminated and the response is generated by the fault mapper. If this value is registered in the
Error Maps
of the Config UI and a
FaultReport XSLT is defined on the
Facade Operation
tab, the mapping succeeds. Otherwise a default value of 1001 is used.
Use of the errorCode and errorMessage elements are mutually exclusive with the other elements in the output document of the parse step XSLT transformation.
/output/errorMessage
String
Yes
Specifies the detailed error description, which indicates that the validation check has been violated.