Correlation ID

TIBCO API Exchange Gateway supports correlation ID to help the users in auditing and debugging the message transactions. The correlation ID is used to group the related message requests and responses.

When the detail level logging is enabled for the Central Logger, the correlation id is logged in the TRN_GUID column of ASG_TRANSACTIONS table. A correlation ID is passed as the HTTP header in the facade request and added to the headers of the target operation. By default, the HTTP header name for the correlation ID is X-Request-ID.

Note:
  • If the correlation id is not set in the incoming request, TIBCO API Exchange Gateway generates an id dynamically and assigns to the request.
  • The correlation id is forwarded as the HTTP header to the target operation.
  • The correlation id is added to the header of response message from the target operation.