Copyright © Cloud Software Group, Inc. All Rights Reserved

Mappings and Transformations

TIBCO API Exchange Gateway provides message transformations using the mappings. Using the mappings, you can map the gateway endpoint operation request and response messages to the gateway reference operation request and response messages with another format. The mapping capabilities of TIBCO API Exchange Gateway allows you to decouple the northbound operations interface and southbound services interface by providing a mutual common canonical message format between the operations interface and services interface.

TIBCO API Exchange Gateway supports mappings at various levels and reduces the number of point-to-point mappings between gateway endpoint operations (exposed by the gateway) and gateway reference operations (service clients of the gateway that invoke internal service operations).

TIBCO API Exchange Gateway provides the transformation of request and response messages at the following four points:

−	Facade Request Handler to Router Boundary

After the request has been received by the Facade Request Handler and before it is been passed to the Router.

−	Router to Service Endpoint Handler Boundary

After the request has been routed, but before it is passed to the Service Endpoint Handler.

−	Service Endpoint Handler to Router Boundary

After a response has been received from the Service Endpoint Handler, and before it is passed to the Router.

−	Router to Facade Request Handler

After the response has been routed from the Router to the Facade Request Handler, and before the response is sent back to the original requestor.

You can do the following actions using the mapping transformations:

−	Access the multiple versions and formats of service APIs.

−	Add semantic content validation rules to the incoming requests.

−	Access the fields from the request context and payload.

−	Change the routing of request and response messages based on error handling in case of message validation failures.

−	Protect the service end-points using service validation policies.

TIBCO API Exchange Gateway supports the transformations of both request and response messages as follows:

•	Forward mapping - The transformations are done from request canonical form to back-end service API as per defined mapping.

•	Reverse mapping - The transformations are done from the back-end service API to the response canonical form as per defined mapping.

The mapper of TIBCO API Exchange Gateway provides the six different versions of documents as follows:

−	Northbound request message

−	Canonical request message

−	Southbound request message

−	Southbound response message

−	Canonical response message

−	Nouthbound response message

TIBCO API Exchange Gateway supports mapping at both northbound and southbound sides.

Northbound Mapping

Using the northbound mapping, you can map as follows:

−	Map northbound request message to canonical request

−	Map canonical response to northbound response message

−	Map errors to northbound fault response

Northbound mapping configuration is defined in ROUTING > Facade Operations and PARTNER > Partner Operations tab of the Config UI.

Southbound Mapping

Using the southbound mapping, you can map as follows:

−	Map canonical request to southbound request message

−	Map southbound response message to canonical response

Southbound mapping configuration is defined in ROUTING > Target Operations tab of the Config UI.

Mapping Types

The following types of mapping are supported:

Rendezvous (RV) Mapping

Using the Rendezvous mapping, you can access an external mapping handler as a service using Rendezvous. Rendezvous starter process that calls service endpoint handler and listens to the matched requested subject must exist.

Rendezvous mapping provides external processes to execute mappings between corresponding but not compatible APIs. This provides a set of services called Rendezvous messages that transform the given input message(s) to other message(s). The Core Engine calls the mappers services whenever it transforms messages between the northbound, canonical, and southbound form.

XSLT Mapping

XSLT mapping describes embedded mapping transformation. The transformation of the request and response documents are done according to the XSLT files defined in the mappings configuration. This can be defined for both forward and reverse mappings. See Transformations (XSLT Mapping) for details.

Mapping Configuration

Using the Config UI, you can add the mapping configuration for the northbound and southbound request messages (gateway operation endpoint) as well as southbound response and northbound response messages (gateway reference endpoint).

This section explains the steps to configure mappings for the gateway endpoint operation and the gateway service endpoint.

Rendezvous Mapping Type

1.	Start the GUI, if not already started. See Starting GUI for details.

2.	Click the MAPPING > Mapping tab for a project.

3.	Type the parameters, as follows:

Table 65 RV Mapping Type Configuration

Parameter	Description
Mapping Name	The name of mapping
Type	RV (select from the drop-down list.)
Subject	Specifies the RV subject to send the mapping request to
Transformation Name	The transformation to perform on the message. If it is default, the transformation is determined by mpSubject. Other values force specific transformation.

XSLT Mapping Type

1.	Start the GUI, if not already started. See Starting GUI for details.

2.	Click the MAPPING > Mapping tab for a project.

3.	Type the parameters, as follows:

Table 66 XSLT Mapping Type Configuration

Parameter	Description
Mapping Name	The name of mapping
Type	XSLT (select from the drop-down list.)
New File	The file name containing the transformations (XSLT file)
Existing Files	The file name containing the transformations (XSLT file)
Response Type	The output type from the transformation. This can have the following values: • Payload: the output document from the transformation contains just the payload. • Full: the output document from the transformation contains both the request context and the payload. <Details> (Payload | Full)

Assign to the Gateway Operation Endpoint

After the mappings are registered, they are assigned to the gateway operation endpoint for forward and reverse mappings to be performed for request operations. They are defined in the Facade Operations and Facade Access tab of the GUI. See Facade Operations and Facade Access.

Assign to the Gateway Reference Endpoint

After the mappings are registered, they are assigned to the gateway operation endpoint for forward and reverse mappings to be performed for request operations.They are defined in the Target Operations tab of the GUI. See Add a New Target Operation.

Copyright © Cloud Software Group, Inc. All Rights Reserved