Copyright © Cloud Software Group, Inc. All Rights Reserved

ROUTING

The ROUTING tab of the Config UI provides the configuration parameters for the following areas:

Facade Operations

A facade operation is any operation provided by the gateway. An operation request is defined as a single type of request sent to the Core Engine. Using the Facade Operations tab, you can add the list of operations supported by the TIBCO API Exchange Gateway.

Add a New Facade Operation

To add a new facade operation, follow these steps:

1.	Click the Facade Operations tab.

2.	Click the Add property icon to create a new facade operation.

3.	Enter the details for the operation, as follows:

Table 51 Facade Operation Configuration Parameters

Parameter	Description
Operation Name	The logical operation name.
SOAP Action	The SOAP Action for this operation. This field is used to identify an operation to which an incoming request is applied to. This must be unique.
Operation URI	The URI for this operation.
Operation Service Name	The logical service name (used for routing).
New ProcessBody Transform	The new XSLT transformation sheet file containing the rules to parse and validate the message. Optional.
ProcessBody Transform	The existing XSLT transformation sheet file containing the rules to parse and validate the message. Optional.
New FaultReport XSLT	The new XSLT transformation used to produce the fault message for the provided fault data.
Existing FaultReport XSLT	The existing XSLT transformation used to produce the fault message for the provided fault data. Optional.
Request Transform	The reference to forward the facade operation mapping. This mapping transforms from requestor API to a canonical request format. If no mapping reference needed, select Pass-Through from the drop-down list. Required.
Response Transform	The reference to reverse northbound mapping. This mapping transforms from a canonical request format to requestor API. If no mapping reference needed, select the value as Pass-Through from the drop-down list. Required.
Operation Method	The HTTP method used to separate REST requests which are made on the same URI but with different operations. Optional.
Operation Features	The list of keywords identifying the features required by the operation. The supported features are as follows: − Validation – The XSD validates northbound request and response. See Validation. − Shaping. See Traffic Shaping. − Proxy. Enables TIBCO API Exchange Gateway to act as Proxy Server. See Proxy Server. − CacheEnabled. Enables the caching of response messages. See Response Caching. • Optional.
Status Code on Error
Enable WSS

Delete an Operation

To delete an existing operation, click the red cross icon located at the top left corner of Operation Name field.

Target Operations

A target operation is defined as a single type of request that the gateway instance sends to back-end systems. The backed-API defines the request structure, and the expected reply structure.

Using the Target Operations tab, you can configure target operation details.

TIBCO API Exchange Gateway supports the following types of target operations:

−

ESB

−

HTTP

−

SOAPJMS

−

HTTPs

Add a New Target Operation

To add a new target operation, follow these steps:

1.	Click the Target Operations tab.

2.	Click the Add property icon to create a new facade operation.

3.	Enter the configuration parameters for target operation, as follows:

Table 52 Target Operation Configuration Parameters

Parameter	Description
Type: No Operation Specifies an empty target operation. This does not accept any messages. This type is used for the operations that use the information retrieved during customer validation.
Operation Name	The name of the target operation.
Type	The type of transport to use when accessing the target operation. For example, No Operation.
Target Operation Group	The name of the Target Operation group. See Target Operation Groups to configure a target operation group.
Timeout	Timeout (in milliseconds) to use when accessing the target operation.
Request Transform	The mapping from request canonical form to the target operation API. The mapping details are defined in MAPPING > Mapping tab.
Response Transform	The mapping from back-end service API to response canonical form. The mapping details are defined in MAPPING > Mapping tab.
Monitor(s)	Throttle chain to be applied when invoking the back-end service. You can add one or more throttle names. The details of the throttles are defined in the MONITORING > Monitors tab.
Type: ESB When the JMS transport is used to invoke the target operation, configure the following parameters specific to JMS transport:
ESB Channel	The number of predefined ESB channels. By default, three ESB channels are supported, this field can have the values as 0, 1,2. You can add more ESB Channels by customizing ASG_DefaultImplementation project.
ESB Service	The name of the ESB service to call. This is an additional header value added to the outgoing JMS message if specified. The header name in the JMS message is mentioned as Service.
Service Instance	The identity of service instance to call. This is an additional header value added to the outgoing JMS message if specified. The header name in the JMS message is mentioned as ServiceInstance.
ESB Operation	Specifies the ESB called operation. This is an additional header value added to the outgoing JMS message if specified. The header name in the JMS message is mentioned as Operation. Note that this tuple determines SOAP Action used by ESB as: "/esb/service//operation”
Destination Name	The name of the queue or topic for the JMS channel used to override the default JMS destination. The default destination is specified by the global variables tibco.clientVar.ASG/Endpoint/ESB0/requestQueue, tibco.clientVar.ASG/Endpoint/ESB1/requestQueue, tibco.clientVar.ASG/Endpoint/ESB2/requestQueue in ASG_CONFIG_HOME/asg.properties file respectively. Optional.
Destination Type	The type of the destination for JMS channel. The default value is queue. Optional.
Mode	Specifies a mode for a back-end JMS service. The valid values are SYNC/ASYNC. For the sync mode, the gateway waits for the southbound response from the target operation after the southbound request is sent to the target operation. This is the default mode. For the async mode, the gateway does not wait for the southbound response from the target operation after the southbound request is sent to the target operation. A default northbound response payload is created after the async request is sent to the target operation.
Type: HTTP When the HTTP transport is used to invoke the target operation, configure the following parameters specific to HTTP transport:
SOAP Action	The value of the SOAP Action as defined by the WSDL of the target operation API.
URI	Specifies the URI to use when invoking the target operation.
Host	The IP address or hostname of the target operation implementation when invoked over HTTP.
Port	The TCP port of the target operation implementation when invoked over HTTP.
Username	The username with BASIC authentication.
Password	The password with BASIC authentication.
Headers To Forward	Using this field, you can copy the HTTP headers information from the northbound incoming request (operation) and forward it to the service call at the southbound side. This field can contain: • A comma separated list of named HTTP header names. • * as the wildcard symbol to forward all HTTP headers from the facade service request to the target reference request. • * as the wildcard symbol in combination with a comma separated list of named HTTP header names prefixed with the - sign to drop these specific HTTP headers from the list of headers to forward. For example, − If the value of Headers To Forward field is specified as “*”, then all the headers are copied. − If the Headers To Forward field contains "*,-SoapAction", any incoming SOAP Action header is removed from the incoming headers and the value set on the endpoint is ignored.
Method	Specifies the method to be used as an HTTP method for sending a southbound request over the HTTP transport. The following methods are available for the HTTP transport: OPTIONS, GET, HEAD, POST, PUT,DELETE,TRACE,CONNECT,PATCH The default value is POST
Retry Count	The number of retries.
Retry Interval	The interval between the HTTP connection retries. A value of 0 indicates no retry.
Retry Timeout	The timeout value on each attempt of HTTP connection. This value is specified in milliseconds. A value of 0 indicates no timeout.
Type: SOAPJMS When the SOAPJMS transport is used to invoke the back-end service, configure the following parameters specific to SOAPJMS transport:
SOAP Action	The value of the SOAP Action as defined by the WSDL of target operation.
JMS Priority	The value of JMSPriority header to set in the outgoing JMS message.
JMS Expiration	The value of JMSExpiration header to set in the outgoing JMS message.
Destination Name	The name of the destination on JMS server.
Destination Type	The type of the destination (TOPIC/QUEUE).
Target Service	The name of the service to call.
Content Type	The value of JMSType header to set in the outgoing JMS message
Is Async
Type: HTTPs When the HTTPs transport is used to invoke the target operation, configure the following parameters specific to HTTPs transport:
SOAP Action	The value of the SOAP Action as defined by the WSDL of the target operation.
URI	The URI to use when invoking the target operation.
Host	The IP address or hostname of the target operation implementation when invoked over the HTTPs.
Port	The TCP port of the target operation implementation when invoked over HTTPs.
Username	Username with BASIC authentication.
Password	Password with BASIC authentication.
Headers To Forward	This field allows the users to copy headers information from the northbound incoming request and forward it to the southbound side. If the value of Headers To Forward is specified as “*”, all the headers are copied. If the Headers To Forward contains "*,-SoapAction", any incoming SOAP Action header is removed from the incoming headers and the value set on the endpoint is ignored.
Method	Specifies the method to be used as a HTTP method for sending a southbound request over the HTTPs transport. The following methods are available for the HTTPs transport: OPTIONS, GET, HEAD, POST, PUT,DELETE,TRACE,CONNECT,PATCH The default value is POST
Retry Count	The number of retries.
Retry Interval	The interval between the HTTP(s) connection retries. A value of 0 indicates no retry.
Retry Timeout	The timeout value on each attempt of the HTTP connection. This value is specified in milliseconds. A value of 0 indicates no timeout.
New Property File	Specifies the DSS properties file to use the HTTPs transport for target operation. See Define DSS Properties for Services.
Existing Property Files	Specifies an existing DSS property file from the drop-down list if the file exists in the wss directory of the project configuration.
Is Anonymous	This field is a boolean field and determines if the client authentication is required or not. The client authentication, also known as mutual SSL authentication is required if the Is Anonymous flag is set to false. If the Is Anonymous flag is set to true,the service does not require the authentication of the client. See Configure Secure Services with TIBCO API Exchange Gateway for details.

 

Target Operation Groups

Using the Target Operation Groups tab, you can define a target operation group with a load balancing policy type which refers to a routing algorithm. A service group can have multiple target operations so that they can participate in the load balancing functionality. See Configure a Target Operation Group for details.

To define a target operation group, configure the following fields:

Table 53 Target Operation Groups Configuration Parameters

Parameter	Description
Service Groups Configuration
Group Name	• The user defined name of the target operation group. • Required.
Description	The user defined description.
Type	• Specifies the type of the target operation group. See Types of Target Operations Group for details. • The supported types of target operation group are as follows: − LoadBalanced − RoundRobin − RoundRobinWithFaiOver − WeightedRoundRobin − WeightedRoundRobinWithFaiOver − StickyResourceAffinity
Target Operations	Specifies the list of configured target operations within a target operation group. The target operations must be configured in the ROUTING > Target Operations tab of the Config UI. You can add the target operations by clicking the "+" icon sign, and selecting a target operation from the drop-down list.

Routing

Using the Routing tab, you can configure the routing information for the Core Engine. The routing provides the binding between a facade operation and a target operation.

To add a new routing configuration, follow these steps:

1.	Click the Routing tab.

2.	Enter the following parameters:

Table 54 Routing Configuration Parameters

Parameter	Description
Operation Name	The name of the facade operation. This is defined in the Facade Operations tab.
Routing Type	Specifies the type of routing which indicates if the request is routed to a target operation or target operation group. The possible values are as follows: − Target Operation − Target Operation Group
Routing Key	Evaluated routing key for the given operation. See Routing Key.
Type: Target Operation When the routing type is specified as Target Operation, configure the following parameters specific to the target operation:
Target Operation Version	The version number of the target operation.
Target Operation.	The name of the target operation. The target operation must be defined in the Target Operation tab.
Type: Target Operation Group When the routing type is specified as Target Operation Group, configure the following parameters specific to target operation group:
Target Operation Group	The name of the target operation group used for load balancing of requests for target operations. See Target Operation Groups to configure a target operation group.

Copyright © Cloud Software Group, Inc. All Rights Reserved