Tracking schemas for B2B messages in Consumption workflows for Azure Logic Apps

Applies to: Azure Logic Apps (Consumption)

Note

This article applies only to Consumption logic app workflows. For information about monitoring Standard logic apps, see the following documentation:

• Enable or open Application Insights after deployment for Standard logic apps
• Monitor and track B2B transactions in Standard workflows
• Tracking schemas for B2B transactions in Standard workflows

Azure Logic Apps includes built-in tracking that you can enable for parts of your workflow. To help you monitor the successful delivery or receipt, errors, and properties for business-to-business (B2B) messages, you can create and use AS2, X12, and custom tracking schemas in your integration account. This reference guide describes the syntax and attributes for these tracking schemas.

AS2

• AS2 message tracking schema
• AS2 Message Disposition Notification (MDN) tracking schema

AS2 message - tracking schema

The following syntax describes the schema for tracking an AS2 message:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "as2To": "",
      "as2From": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "messageId": "",
      "dispositionType": "",
      "fileName": "",
      "isMessageFailed": "",
      "isMessageSigned": "",
      "isMessageEncrypted": "",
      "isMessageCompressed": "",
      "incomingHeaders": {},
      "outgoingHeaders": {},
      "correlationMessageId": "",
      "isNrrEnabled": "",
      "isMdnExpected": "",
      "mdnType": ""
    }
}

AS2 message - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Partner name for the AS2 message sender
receiverPartnerName	No	String	Partner name for the AS2 message receiver
as2To	Yes	String	Name for the AS2 message receiver in the AS2 headers
as2From	Yes	String	Name for the AS2 message sender in the AS2 message headers
agreementName	No	String	Name for the AS2 agreement that resolves the messages

AS2 message - messageProperties

Property	Required	Type	Description
direction	Yes	String	Message flow direction (send or receive)
messageId	No	String	AS2 message ID in the AS2 message headers
dispositionType	No	String	Disposition type for the Message Disposition Notification (MDN)
fileName	No	String	File name from the AS2 message header
isMessageFailed	Yes	Boolean	Whether the AS2 message failed
isMessageSigned	Yes	Boolean	Whether the AS2 message is signed
isMessageEncrypted	Yes	Boolean	Whether the AS2 message is encrypted
isMessageCompressed	Yes	Boolean	Whether the AS2 message is compressed
incomingHeaders	No	JToken dictionary	Details for the incoming AS2 message header
outgoingHeaders	No	JToken dictionary	Details for the outgoing AS2 message header
correlationMessageId	No	String	Message ID for correlating AS2 messages with Message Disposition Notifications (MDNs)
isNrrEnabled	Yes	Boolean	Whether Non-Repudiation of Receipt (NRR) is enabled
isMdnExpected	Yes	Boolean	Whether to use the default value, if unknown
mdnType	Yes	Enum	Allowed values: NotConfigured, Sync, and Async

AS2 MDN - tracking schema

The following syntax describes the schema for tracking an AS2 MDN:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "as2To": "",
      "as2From": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "messageId": "",
      "originalMessageId": "",
      "dispositionType": "",
      "isMessageFailed": "",
      "isMessageSigned": "",
      "isNrrEnabled": "",
      "statusCode": "",
      "micVerificationStatus": "",
      "correlationMessageId": "",
      "incomingHeaders": {},
      "outgoingHeaders": {}
   }
}

AS2 MDN - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Partner name for the AS2 message sender
receiverPartnerName	No	String	Partner name for the AS2 message receiver
as2To	Yes	String	Name for the AS2 message receiver in the AS2 headers
as2From	Yes	String	Name for the AS2 message sender in the AS2 message headers
agreementName	No	String	Name for the AS2 agreement that resolves the messages

AS2 MDN - messageProperties

Property	Required	Type	Description
direction	Yes	String	Message flow direction (send or receive)
messageId	No	String	AS2 message ID in the AS2 message headers
originalMessageId	No	String	Original AS2 message ID
dispositionType	No	String	Disposition type for the Message Disposition Notification (MDN)
isMessageFailed	Yes	Boolean	Whether the AS2 message failed
isMessageSigned	Yes	Boolean	Whether the AS2 message is signed
isNrrEnabled	Yes	Boolean	Whether Non-Repudiation of Receipt (NRR) is enabled
statusCode	Yes	Enum	Allowed values: Accepted, Rejected, and AcceptedWithErrors
micVerificationStatus	Yes	Enum	Allowed values: NotApplicable, Succeeded, and Failed
correlationMessageId	No	String	Correlation ID, which is the ID for the original message that has the MDN configured
incomingHeaders	No	JToken dictionary	Details for the incoming AS2 message header
outgoingHeaders	No	JToken dictionary	Details for the outgoing AS2 message header

X12

• X12 transaction set tracking schema
• X12 transaction set acknowledgment tracking schema
• X12 interchange tracking schema
• X12 interchange acknowledgment tracking schema
• X12 functional group tracking schema
• X12 functional group acknowledgment tracking schema

X12 transaction set - tracking schema

The following syntax describes the schema for tracking an X12 transaction set:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "functionalGroupControlNumber": "",
      "transactionSetControlNumber": "",
      "correlationMessageId": "",
      "messageType": "",
      "isMessageFailed": "",
      "isTechnicalAcknowledgmentExpected": "",
      "isFunctionalAcknowledgmentExpected": "",
      "needAk2LoopForValidMessages": "",
      "segmentsCount": ""
   }
}

X12 transaction set - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 transaction set - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
interchangeControlNumber	No	String	Interchange control number for the functional acknowledgment
functionalGroupControlNumber	No	String	Functional group control number for the functional acknowledgment
transactionSetControlNumber	No	String	Control number for the transaction set
correlationMessageId	No	String	Message correlation ID, which combines these values: {agreementName}{interchange-or-functionalGroup-ControlNumber}{transactionSetControlNumber}
messageType	No	String	Transaction set or document type
isMessageFailed	Yes	Boolean	Whether the X12 message failed
isTechnicalAcknowledgmentExpected	Yes	Boolean	Whether the technical acknowledgment is configured in the X12 agreement
isFunctionalAcknowledgmentExpected	Yes	Boolean	Whether the functional acknowledgment is configured in the X12 agreement
needAk2LoopForValidMessages	Yes	Boolean	Whether the AK2 loop is required for a valid message
segmentsCount	No	Integer	Number of segments in the X12 transaction set

X12 transaction set acknowledgment - tracking schema

The following syntax describes the schema for tracking an X12 transaction set acknowledgment:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "functionalGroupControlNumber": "",
      "isaSegment": "",
      "gsSegment": "",
      "respondingFunctionalGroupControlNumber": "",
      "respondingFunctionalGroupId": "",
      "respondingTransactionSetControlNumber": "",
      "respondingTransactionSetId": "",
      "statusCode": "",
      "processingStatus": "",
      "correlationMessageId": "",
      "isMessageFailed": "",
      "ak2Segment": "",
      "ak3Segment": "",
      "ak5Segment": ""
   }
}

X12 transaction set acknowledgment - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 transaction set acknowledgment - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
interchangeControlNumber	No	String	Interchange control number for the functional acknowledgment. This value populates only for the sender when a functional acknowledgment is received for the messages sent to the partner.
functionalGroupControlNumber	No	String	Functional group control number for the functional acknowledgment. This value populates only for the sender when a functional acknowledgment is received for the messages sent to the partner.
isaSegment	No	String	The Interchange Control Header (ISA) segment for the X12 message. This value populates only for the sender when a functional acknowledgment is received for the messages sent to the partner.
gsSegment	No	String	GS segment in the X12 message. This value populates only for the sender when a functional acknowledgment is received for the messages sent to the partner.
respondingFunctionalGroupControlNumber	No	String	Control number for the responding functional group
respondingFunctionalGroupId	No	String	ID for the responding functional group that maps to AK101 in the acknowledgment
respondingTransactionSetControlNumber	No	String	Control number for the responding transaction set
respondingTransactionSetId	No	String	ID for the responding transaction set that maps to AK201 in the acknowledgment
statusCode	Yes	Boolean	Acknowledgment status code for the transaction set
processingStatus	Yes	Enum	Processing status for the acknowledgment with these permitted values: Received, Generated, and Sent
correlationMessageId	No	String	Message correlation ID, which combines these values: {agreementName}{interchange-or-functionalGroup-ControlNumber}{transactionSetControlNumber}
isMessageFailed	Yes	Boolean	Whether the X12 message failed
ak2Segment	No	String	Acknowledgment for a transaction set in the received functional group
ak3Segment	No	String	Reports errors in a data segment
ak5Segment	No	String	Reports whether the transaction set identified in the AK2 segment is accepted or rejected, and why

X12 interchange - tracking schema

The following syntax describes the schema for tracking an X12 interchange:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "isaSegment": "",
      "isTechnicalAcknowledgmentExpected": "",
      "isMessageFailed": "",
      "isa09": "",
      "isa10": "",
      "isa11": "",
      "isa12": "",
      "isa14": "",
      "isa15": "",
      "isa16": ""
   }
}

X12 interchange - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 interchange - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
interchangeControlNumber	No	String	Interchange control number
isaSegment	No	String	The ISA segment for the X12 message
isMessageFailed	Yes	Boolean	Whether the X12 message failed
isTechnicalAcknowledgmentExpected	Yes	Boolean	Whether the technical acknowledgment is configured in the X12 agreement
isa09	No	String	X12 document interchange date
isa10	No	String	X12 document interchange time
isa11	No	String	X12 interchange control standards identifier
isa12	No	String	X12 interchange control version number
isa14	No	String	X12 acknowledgment is requested
isa15	No	String	Indicator for test or production
isa16	No	String	Element separator

X12 interchange acknowledgment - tracking schema

The following syntax describes the schema for tracking an X12 interchange acknowledgment:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "isaSegment": "",
      "respondingInterchangeControlNumber": "",
      "isMessageFailed": "",
      "statusCode": "",
      "processingStatus": "",
      "ta102": "",
      "ta103": "",
      "ta105": ""
   }
}

X12 interchange acknowledgment - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 interchange acknowledgment - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
interchangeControlNumber	No	String	Interchange control number for the technical acknowledgment that is received from partners
isaSegment	No	String	The ISA segment for the technical acknowledgment that is received from partners
respondingInterchangeControlNumber	No	String	Interchange control number for the technical acknowledgment that is received from partners
isMessageFailed	Yes	Boolean	Whether the X12 message failed
statusCode	Yes	Enum	Interchange acknowledgment status code with these permitted values: Accepted, Rejected, and AcceptedWithErrors
processingStatus	Yes	Enum	Processing status for the acknowledgment with these permitted values: Received, Generated, and Sent
ta102	No	String	Interchange date
ta103	No	String	Interchange time
ta105	No	String	Interchange note code

X12 functional group - tracking schema

The following syntax describes the schema for tracking an X12 functional group:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "functionalGroupControlNumber": "",
      "gsSegment": "",
      "isTechnicalAcknowledgmentExpected": "",
      "isFunctionalAcknowledgmentExpected": "",
      "isMessageFailed": "",
      "gs01": "",
      "gs02": "",
      "gs03": "",
      "gs04": "",
      "gs05": "",
      "gs07": "",
      "gs08": ""
   }
}

X12 functional group - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 functional group - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
interchangeControlNumber	No	String	Interchange control number
functionalGroupControlNumber	No	String	Functional group control number
gsSegment	No	String	GS segment in the X12 message
isTechnicalAcknowledgmentExpected	Yes	Boolean	Whether the technical acknowledgment is configured in the X12 agreement
isFunctionalAcknowledgmentExpected	Yes	Boolean	Whether the functional acknowledgment is configured in the X12 agreement
isMessageFailed	Yes	Boolean	Whether the X12 message failed
gs01	No	String	Functional group identifier code
gs02	No	String	Application sender code
gs03	No	String	Application receiver code
gs04	No	String	Functional group date
gs05	No	String	Functional group time
gs07	No	String	Responsible agency code
gs08	No	String	Identifier code for the version, release, or industry

X12 functional group acknowledgment - tracking schema

The following syntax describes the schema for tracking an X12 functional group acknowledgment:

{
   "agreementProperties": {
      "senderPartnerName": "",
      "receiverPartnerName": "",
      "senderQualifier": "",
      "senderIdentifier": "",
      "receiverQualifier": "",
      "receiverIdentifier": "",
      "agreementName": ""
   },
   "messageProperties": {
      "direction": "",
      "interchangeControlNumber": "",
      "functionalGroupControlNumber": "",
      "isaSegment": "",
      "gsSegment": "",
      "respondingFunctionalGroupControlNumber": "",
      "respondingFunctionalGroupId": "",
      "isMessageFailed": "",
      "statusCode": "",
      "processingStatus": "",
      "ak903": "",
      "ak904": "",
      "ak9Segment": ""
   }
}

X12 functional group acknowledgment - agreementProperties

Property	Required	Type	Description
senderPartnerName	No	String	Name for the partner X12 message sender
receiverPartnerName	No	String	Name for the partner X12 message receiver
senderQualifier	Yes	String	Qualifier for the partner X12 message sender
senderIdentifier	Yes	String	Identifier for the partner X12 message sender
receiverQualifier	Yes	String	Qualifier for the partner X12 message receiver
receiverIdentifier	Yes	String	Identifier for the partner X12 message receiver
agreementName	No	String	Name for the X12 agreement that resolves the messages

X12 functional group acknowledgment - messageProperties

Property	Required	Type	Description
direction	Yes	Enum	Message flow direction (send or receive)
functionalGroupControlNumber	No	String	Functional group control number for the technical acknowledgment. This value populates for the sender when a technical acknowledgment is received from partners.
interchangeControlNumber	No	String	Interchange control number. This value populates for the sender when a technical acknowledgment is received from partners.
isaSegment	No	String	Same as interchangeControlNumber, but populates only in specific cases
gsSegment	No	String	Same as functionalGrouControlNumber, but populates only in specific cases
respondingFunctionalGroupControlNumber	No	String	Control number for the original functional group
respondingFunctionalGroupId	No	String	Maps to AK101 in the acknowledgment functional group ID
isMessageFailed	Yes	Boolean	Whether the X12 message failed
statusCode	Yes	Enum	Acknowledgment status code with these permitted values: Accepted, Rejected, and AcceptedWithErrors
processingStatus	Yes	Enum	Processing status for the acknowledgment with these permitted values: Received, Generated, and Sent
ak903	No	String	Number of received transaction sets
ak904	No	String	Number of accepted transaction sets in the identified functional group
ak9Segment	No	String	Whether the functional group identified in the AK1 segment is accepted or rejected, and why

Custom

You can set up custom tracking that logs events from the start to the end of your logic app workflow. For example, you can log events from layers that include your workflow, SQL Server, BizTalk Server, or any other layer. The following section provides custom tracking schema code that you can use in the layers outside your workflow.

The following syntax describes the schema for custom tracking:

{
   "sourceType": "",
   "source": {
      "workflow": {
         "systemId": ""
      },
      "runInstance": {
         "runId": ""
      },
      "operation": {
         "operationName": "",
         "repeatItemScopeName": "",
         "repeatItemIndex": ,
         "trackingId": "",
         "correlationId": "",
         "clientRequestId": ""
      }
   },
   "events": [
      {
         "eventLevel": "",
         "eventTime": "",
         "recordType": "",
         "record": {}
      }
   ]
}

Property	Required	Type	Description
sourceType	Yes	String	Type for the run source with these permitted values: Microsoft.Logic/workflows, custom**
source	Yes	String or JToken	If the source type is Microsoft.Logic/workflows, the source information must follow the described schema. If the source type is custom, the schema has JToken type.
systemId	Yes	String	The system ID for the logic app
runId	Yes	String	The run ID for the logic app
operationName	Yes	String	Name for the operation, for example, action or trigger
repeatItemScopeName	Yes	String	Repeat the item name if the action is in a foreach or until loop
repeatItemIndex	Yes	Integer	Repeated item index number to indicate that the action is in a foreach or until loop
trackingId	No	String	Tracking ID to correlate the messages
correlationId	No	String	Correlation ID to correlate the messages
clientRequestId	No	String	Client can populate this property to correlate messages
eventLevel	Yes	String	Event level
eventTime	Yes	DateTime	Event time in UTC format: YYYY-MM-DDTHH:MM:SS.00000Z
recordType	Yes	String	Track record type with this permitted value only: custom
record	Yes	JToken	Custom record type in JToken format only

Related content

• Monitor B2B messages with Azure Monitor logs