Tracking Messages in BizTalk Services portal

 

Updated: November 27, 2015

System_CAPS_importantImportant

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

Monitor EDI and AS2 messages, batches, and bridges deployed in a BizTalk Services subscription. The tracking information helps you in the following ways:

  • Determines if a processing delay occurs.

  • Provides specific details of a message’s properties.

  • Helps determine the flow of events when a message is being processing.

System_CAPS_noteNote

To track messages processed by the X12 and AS2 pipelines, you must enable tracking as part of an agreement before you can view tracking data. To enable tracking, see Create an X12 Agreement in Azure BizTalk Services and Create an AS2 Agreement in Azure BizTalk Services.

To track messages processed by the EAI bridges, you must enable tracking as part of the Visual Studio application. See Tracking Messages Processed by the Bridge. Tracking of messages that failed in processing, is enabled by default. However, to track promoted properties and successfully processed messages, you must explicitly enable tracking while configuring the bridges.

You can view and query tacked data using the BizTalk Services Portal. You can use the BizTalk Services Portal to track messages based on three different criterion – messages, protocol (X12 or AS2), and batching.

To view and query tracked data based on messages

  1. Select Tracking on the BizTalk Services Portal home page.

  2. On the Tracking page, select Messages.

  3. Select the drop-down arrow against the Search box to see different fields based on which you can filter the tracking data to be viewed.

    Parameter

    Description

    Request ID

    The request ID of the message sent to the BizTalk Services.

    Track ID

    The ID received in response to sending a message to an endpoint. The tracking ID is same as the request ID that is sent back to the client.

    System_CAPS_noteNote

    By default, the tracking ID you must have received includes a _Gx as a suffix, where x is a numeric number. While looking at tracking information using the tracking ID, you must remove the _Gx suffix.

    Event Level

    The event category (Error or All) that you want to filter in the tracking data.

    Endpoint URL

    The relative endpoint URL where the endpoint is deployed.

    Date From

    The start date/time from which the tracking data must be retrieved.

    Date To

    The end date/time up to which the tracking data must be retrieved.

    System_CAPS_noteNote

    Event Level, Date From, and Date To are always enabled by default in the search filter. However, Date From and Date To must be filled according to local time zone. The default Date To is the current local time and default Date From is the current local time minus 24 hours (1 Day).

  4. Click Search.

To view and query tracked data based on protocol

  1. Select Tracking on the BizTalk Services Portal home page.

  2. On the Tracking page, select Protocol, and then select either X12 or AS2.

  3. Select the drop-down arrow next to the Search box to see different fields based on which you can track the messages.

    Parameter

    Applicable to

    Description

    Sender

    X12 and AS2

    The Sender can be a specific partner or any partner. You can also use < Any *> as a wild card.

    Receiver

    X12 and AS2

    The Receiver can be a specific partner or any partner. You can also use < Any *> as a wild card.

    Message Type

    X12

    The Message Type can be a specific type, like 850–Purchase Order, or any type. You can also use < Any *> as a wild card.

    Interchange ID

    X12

    The interchange ID for the message to be tracked.

    AS2 Message ID

    AS2

    The AS2 message ID for the message to be tracked

    Request ID

    X12 and AS2

    The request ID of the message sent to the BizTalk Services.

    Date From

    X12 and AS2

    The start date/time after which the tracking data must be retrieved.

    Date To

    X12 and AS2

    The end date up to which the tracking data must be retrieved.

    System_CAPS_noteNote

    Date From and Date To are always enabled by default in the search filter. However, values for these filters must be filled according to local time zone. The default value for Date To is the current local time and the default value for Date From is the current local time minus 24 hours (1 Day).

  4. Select Search.

    Once you see the filter tracking data, you can also download the messages from the portal. Click the row in the list and then click Details from the command bar to get an option to download more data. For example, for an X12 tracking row, you can download the EDI message, suspended message, and the corresponding correlated functional acknowledgements. Similarly, for AS2 tracking row, you can download the AS2 message before encoding/decoding and the corresponding correlated MDNs. This is available only with the BizTalk Services Premium edition.

To view and query tracked data based on batching

  1. Select Tracking on the BizTalk Services Portal home page.

  2. On the Tracking page, select Batching, and then select either active batches or completed batches.

  3. Select the drop-down arrow against the Search box to see different fields based on which you can track the messages.

    Parameter

    Applicable to

    Description

    Sender

    Active and completed

    The Sender can be a specific partner or any partner. You can also use < Any *> as a wild card.

    Receiver

    Active and completed

    The Receiver can be a specific partner or any partner. You can also use < Any *> as a wild card.

    Agreement

    Active and completed

    The name of the agreement containing the batch configuration. You can also use < Any *> as a wild card.

    Batch

    Active and completed

    The name of the batch that processes the message. You can also use < Any *> as a wild card.

    Request ID

    Completed

    The request ID of the message sent to the BizTalk Services.

    Completed Time From

    Completed

    The start date after which the batch is released.

    Completed Time To

    Completed

    The end date before which the batch is released.

    System_CAPS_noteNote

    Completed Time From and Completed Time To are always enabled by default in the search filter. However, you must enter the value for these filters according to local time zone. The default value for Completed Time To is the current local time and the default value for Completed Time From is the current local time minus 24 hours (1 Day).

  4. Click Search.

Tracking events are captured up to the X12/AS2 message processing and correlation of the acknowledgements only in the Protocol (X12 or AS2) tracking tabs. If a message fails outside of the Protocol stage, the tracking view still shows the message as successfully processed. In this situation, refer to the Messages tab in Tracking for error details. As a tip, you must copy the Request ID from X12 or AS2 tracking tab and use that ID as a search filter in the Messages tab.

The X12 Receive and Send Settings (Create an X12 Agreement in Azure BizTalk Services) provides information on the Protocol stage.

Show: