Routing Key

Use a routing key to forward a facade operation request to a target operation endpoint.

A routing key is used by the Core Engine to select a target operation or target operation group for an incoming facade request. Therefore, the routing key is a key factor to route a facade request for processing. Based on the routing key, a facade request can be routed to any target operation or target operation group.

TIBCO API Exchange Gateway uses routing key in one of the following ways:

  • By default. The default routing key is provided.
  • The preferred routing key.
  • Deriving the routing key from a custom XSLT file.

    A routing key is extracted from the parsing of the facade request message using the transformation (XSLT) files. You can conditionally evaluate the facade request message and parse the data content as well as the context of the request message. To derive a routing key, define a transformation file in the parsing step of the request processing pipeline.

    If no routing key is derived from the parsing of the request message and no preferred routing key is configured, default routing key is used.

The routing key can have the following values:

  • default: default routing key is used:
    • if the ProcessBody transform field for a facade operation does not generate a routing key.
    • if preferred routing key is not configured for a facade operation.
    • if the routing key derived from custom XSLT or specified in Preferred Routing Key field for a facade operation is not configured in the Routing tab.
  • routingKeyValue: indicates a specific value of the routing key derived from an XSLT file. The routingKeyValue is a value populated from the transformation (XSLT) file using the routingKey element tag.
  • Preferred Routing Key: a specific value specified in the Preferred Routing Key field of PARTNER > Facade Access tab.