Tracking Messages Processed by the Bridge
Important
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:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
Within a bridge, a message undergoes processing under various stages and can be routed to configured endpoints. Specific details of the message (like transport properties, message properties, and so on) need to be tracked and queried separately by the bridge developers to keep a track of message processing. Additionally, while a message is being processed by the bridge, there can be failures of many types. These failures must be propagated back to the bridge developers/administrators or the message-sending client so that appropriate actions can be taken to fix these errors.
Bridges provide support for tracking the messages thereby enabling the bridge developer and message sending clients to track message properties defined during the bridge configuration. You can configure the bridge to track the messages using options available from the Bridge Configuration surface.
In this topic:
How Tracking Works?
How to View Tracked Properties?
Configure Tracking
How Tracking Works?
There are two parts to tracking a message – what gets tracked and when it gets tracked. Through the bridge configuration, you can define (to some extent) what properties get tracked. Properties specific to the FTP source (if available as part of a message flow) are always tracked and can’t be opted out. When these properties get tracked depends on certain events that are transparent to the user. These events, in turn, depend on what stage of the bridge the message is at. For example:
The following list details “what” can be tracked:
X_PIPELINE_MESSAGE TYPE and X_PIPELINE_REQUESTMESSAGETYPE properties. These properties are always promoted on a message processed by the bridge.
All properties that are promoted at the Enrich stage of a bridge.
If a message flow includes an FTP source, the following FTP-specific data is also tracked:
Source name (name of the FTP source on the itinerary designer)
When an FTP source is started/stopped.
Filename
FTP server
FTP folder path
FTP username
The following list details “when” these properties get tracked:
Even when you do not select any properties to be tracked, the following events are always tracked:
Activity faulted (for all activities)
Stage faulted (for all stages)
Pipeline faulted
Route destination
When you select the properties to be tracked, the following events are tracked:
All events in bullet 1 along with selected message properties
Route stage started along with selected message properties
SendReply stage started along with selected message properties
When you opt to track message processing events, the following events are tracked:
All events in bullet 1 along with selected message properties
Pipeline started/completed
Artifact retrieved/not found
How to View Tracked Properties?
You can view the tracking data from the BizTalk Services Portal. See Tracking Messages in BizTalk Services portal.
Configure Tracking
Create a BizTalk Service project, as described in Get started with a Visual Studio project.
From the Toolbox, drag and drop a bridge component (XML One-Way Bridge, XML Request-Reply Bridge, or Pass-Through Bridge) to the BizTalk Service project design surface.
Right-click the bridge component that you added, and in the Properties window click the ellipsis (…) against Track Properties.
In the Track Properties dialog box, do the following:
Select the Track message processing events check box to track detailed information such as when a stage starts, completes, or faults; when an activity within a stage starts, completes, or faults; whether an artifact gets retrieved, etc.
Select the Track all message properties check box to track all the message properties. If you promoted any properties within the bridge Enrich stages, those properties are also tracked along with default properties – XPIPELINE_MESSAGETYPE and XPIPELINE_REQUESTMESSAGETYPE. The default properties are implicitly promoted by the bridge itself.
- OR -
Select the specific properties that you want to track.
Click OK.
You can view the tracking data in the BizTalk Services portal. For more information, see Tracking Messages in BizTalk Services portal.
The following table describes how the selections you make in the Track Properties dialog box change what gets tracked:
Selection |
What Gets Tracked |
|---|---|
No selection |
Even if you do not select any options in the dialog box, the pipeline state, the stage state, whether the route destinations are successfully ascertained, and the activity state are tracked for any message processing faults. This means that by default, any faults in any of the stages or activities will get tracked. |
When Track all message properties or specific properties are selected |
The properties you selected are tracked as part of the faulted event for a pipeline state, the stage state, or the activity state. This means that if you select this option, every time there is a fault in the message processing, the values of the selected properties are captured as part of the tracked data. Over and above this, the properties are also tracked before the Route Action (routing the message to the intended receiver) and the Reply Action (sending the response back the message sender). |
When Track message processing events is selected |
The pipeline state, the stage state, or the activity state. Over and above this, the following is also tracked:
|