Compartilhar via


Acompanhamento de esquemas para mensagens B2B em fluxos de trabalho de Consumo dos Aplicativos Lógicos do Azure

Aplica-se a: Aplicativos Lógicos do Azure (Consumo)

Observação

Este artigo se aplica somente aos fluxos de trabalho do aplicativo lógico de Consumo. Para obter informações sobre como monitorar aplicativos lógicos Padrão, consulte a seguinte documentação:

Os Aplicativos Lógicos do Azure incluem o acompanhamento interno que pode ser habilitado para partes do fluxo de trabalho. Para ajudar no monitoramento de entregas ou recebimentos, erros e propriedades das mensagens B2B (entre empresas), você pode criar e usar esquemas de acompanhamento AS2, X12 e personalizados na conta de integração. Este guia de referência descreve a sintaxe e os atributos desses esquemas de acompanhamento.

AS2

Mensagem AS2 – esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar uma mensagem AS2:

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

Mensagem AS2 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do parceiro para o remetente de mensagens AS2
receiverPartnerName Não fio Nome do parceiro para o destinatário de mensagem AS2
as2To Yes fio Nome do destinatário de mensagem AS2 nos cabeçalhos AS2
as2From Yes fio Nome do remetente de mensagem AS2 nos cabeçalhos de mensagem AS2
agreementName Não fio Nome do contrato AS2 que resolve as mensagens

Mensagem AS2 – propriedadesDaMensagem

Propriedade Obrigatório Tipo Descrição
direction Yes fio Direção do fluxo da mensagem (send ou receive)
messageId Não fio ID da mensagem AS2 nos cabeçalhos de mensagem AS2
dispositionType Não fio Tipo de disposição para o MDN (notificação de disposição de mensagem)
fileName Não fio Nome do arquivo do cabeçalho da mensagem AS2
isMessageFailed Yes booleano Verifica se há falha na mensagem AS2
isMessageSigned Yes booleano Se a mensagem AS2 está assinada
isMessageEncrypted Yes booleano Se a mensagem AS2 está criptografada
isMessageCompressed Yes booleano Se a mensagem AS2 está compactada
incomingHeaders Não Dicionário JToken Detalhes do cabeçalho da mensagem AS2 de entrada
outgoingHeaders Não Dicionário JToken Detalhes do cabeçalho de mensagem AS2 de saída
correlationMessageId Não fio ID da mensagem para correlacionar mensagens AS2 com as MDNs (notificações de disposição de mensagem)
isNrrEnabled Yes booleano Se o NRR (não repúdio de recebimento) estiver habilitado
isMdnExpected Yes booleano Se deve usar o valor padrão, se desconhecido
mdnType Yes Enum Valores permitidos: NotConfigured, Sync e Async

AS2 MDN – esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar um MDN AS2:

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

MDN AS2 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do parceiro para o remetente de mensagens AS2
receiverPartnerName Não fio Nome do parceiro para o sistema receptor de mensagens AS2
as2To Yes fio Nome do destinatário de mensagem AS2 nos cabeçalhos AS2
as2From Yes fio Nome do remetente de mensagem AS2 nos cabeçalhos de mensagem AS2
agreementName Não fio Nome do contrato AS2 que resolve as mensagens

MDN AS2 – messageProperties

Propriedade Obrigatório Tipo Descrição
direction Yes fio Direção do fluxo da mensagem (send ou receive)
messageId Não fio ID da mensagem AS2 nos cabeçalhos de mensagem AS2
originalMessageId Não fio ID da mensagem AS2 original
dispositionType Não fio Tipo de disposição para o MDN (notificação de disposição de mensagem)
isMessageFailed Yes booleano Verifica se há falha na mensagem AS2
isMessageSigned Yes booleano Se a mensagem AS2 está assinada
isNrrEnabled Yes booleano Se o NRR (não repúdio de recebimento) estiver habilitado
statusCode Yes Enum Valores permitidos: Accepted, Rejected e AcceptedWithErrors
micVerificationStatus Yes Enum Valores permitidos: NotApplicable, Succeeded e Failed
correlationMessageId Não fio A ID de correlação, que é a ID da mensagem original em que o MDN foi configurado
incomingHeaders Não Dicionário JToken Detalhes do cabeçalho de mensagem AS2 de entrada
outgoingHeaders Não Dicionário JToken Detalhes do cabeçalho de mensagem AS2 de saída

X12

Conjunto de transações X12 – esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar um conjunto de transações X12:

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

Conjunto de transações X12 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens X12 do parceiro
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Conjunto de transações X12 – messageProperties

Propriedade Obrigatório Tipo Descrição
direction Yes Enumeração Direção do fluxo da mensagem (send ou receive)
interchangeControlNumber Não fio Número de controle de intercâmbio para a confirmação funcional
functionalGroupControlNumber Não fio Número de controle de grupo funcional para a confirmação funcional
transactionSetControlNumber Não fio Número de controle do conjunto de transações
correlationMessageId Não fio ID de correlação de mensagem, que combina estes valores: {agreementName}{interchange-or-functionalGroup-ControlNumber}{transactionSetControlNumber}
messageType Não fio Tipo de documento ou conjunto de transações
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
isTechnicalAcknowledgmentExpected Yes booleano Verifica se a confirmação técnica está configurada no contrato X12
isFunctionalAcknowledgmentExpected Yes booleano Verifica se a confirmação funcional está configurada no contrato X12
needAk2LoopForValidMessages Yes booleano Verifica se o loop AK2 é necessário para uma mensagem válida
segmentsCount Não Número Inteiro Número de segmentos no conjunto de transações do X12

Confirmação do conjunto de transações X12 – esquema de rastreamento

A sintaxe a seguir descreve o esquema para acompanhar uma confirmação do conjunto de transações X12:

{
   "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": ""
   }
}

Confirmação do conjunto de transações X12 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens X12 do parceiro
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Confirmação do conjunto de transações X12 – messageProperties

Propriedade Obrigatório Tipo Descrição
direction Yes Enum Direção do fluxo da mensagem (send ou receive)
interchangeControlNumber Não fio Número de controle de intercâmbio para a confirmação funcional. Esse valor é preenchido somente para o remetente quando uma confirmação funcional é recebida para as mensagens enviadas ao parceiro.
functionalGroupControlNumber Não fio Número de controle de grupo funcional para a confirmação funcional. Esse valor é preenchido somente para o remetente quando uma confirmação funcional é recebida para as mensagens enviadas ao parceiro.
isaSegment Não fio O segmento ISA (Cabeçalho de Controle de Intercâmbio) da mensagem X12. Esse valor é preenchido somente para o remetente quando uma confirmação funcional é recebida para as mensagens enviadas ao parceiro.
gsSegment Não fio Segmento GS na mensagem X12. Esse valor é preenchido somente para o remetente quando uma confirmação funcional é recebida para as mensagens enviadas ao parceiro.
respondingFunctionalGroupControlNumber Não fio Número de controle para o grupo funcional de resposta
respondingFunctionalGroupId Não fio ID do grupo funcional de resposta que mapeia para AK101 na confirmação
respondingTransactionSetControlNumber Não fio Número de controle do conjunto de transações de resposta
respondingTransactionSetId Não fio ID do conjunto de transações de resposta que mapeia para AK201 na confirmação
statusCode Yes booleano Código de status de confirmação para o conjunto de transações
processingStatus Yes Enumeração Status de processamento para a confirmação com estes valores permitidos: Received, Generated e Sent
correlationMessageId Não fio ID de correlação de mensagem, que combina estes valores: {agreementName}{interchange-or-functionalGroup-ControlNumber}{transactionSetControlNumber}
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
ak2Segment Não fio Confirmação de um conjunto de transações no grupo funcional recebido
ak3Segment Não fio Relata erros em um segmento de dados
ak5Segment Não fio Relata se o conjunto de transações identificado no segmento do AK2 foi aceito ou rejeitado e o porquê

Intercâmbio X12 – esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar um intercâmbio X12:

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

Intercâmbio X12 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens X12 do parceiro
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Intercâmbio X12 – propriedadesDaMensagem

Propriedade Obrigatório Tipo Descrição
direction Yes Enumeração Direção do fluxo da mensagem (send ou receive)
interchangeControlNumber Não fio Número de controle de intercâmbio
isaSegment Não fio O segmento ISA da mensagem X12
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
isTechnicalAcknowledgmentExpected Yes booleano Verifica se a confirmação técnica está configurada no contrato X12
isa09 Não fio Data de intercâmbio do documento X12
isa10 Não fio Hora de intercâmbio do documento X12
isa11 Não fio Identificador de padrões de controle de intercâmbio X12
isa12 Não fio Número de versão de controle de intercâmbio X12
isa14 Não fio A confirmação do X12 é solicitada
isa15 Não fio Indicador de teste ou produção
isa16 Não fio Separador de elementos

Confirmação do intercâmbio X12 – Esquema de acompanhamento

A seguinte sintaxe descreve o esquema para acompanhar uma confirmação de intercâmbio X12:

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

Confirmação de intercâmbio X12 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens do parceiro X12
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Confirmação de troca X12 - propriedades da mensagem

Propriedade Obrigatório Tipo Descrição
direction Yes Enum Direção do fluxo da mensagem (send ou receive)
interchangeControlNumber Não fio Número de controle de intercâmbio para a confirmação técnica recebida dos parceiros
isaSegment Não fio O segmento ISA para a confirmação técnica recebida de parceiros
respondingInterchangeControlNumber Não fio Número de controle de intercâmbio para a confirmação técnica recebida dos parceiros
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
statusCode Yes Enum Código de status da confirmação de intercâmbio com estes valores permitidos: Accepted, Rejected e AcceptedWithErrors
processingStatus Yes Enum Status de processamento para a confirmação com estes valores permitidos: Received, Generated, e Sent
ta102 Não fio Data do intercâmbio
ta103 Não fio Hora do intercâmbio
ta105 Não fio Código da observação do intercâmbio

Grupo funcional X12 – esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar um grupo funcional X12:

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

Grupo funcional X12 – propriedadesDoAcordo

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens X12 do parceiro
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Grupo funcional X12 – messageProperties

Propriedade Obrigatório Tipo Descrição
direction Yes Enumeração Direção do fluxo da mensagem (send ou receive)
interchangeControlNumber Não fio Número de controle de intercâmbio
functionalGroupControlNumber Não fio Número de controle de grupo funcional
gsSegment Não fio Segmento GS na mensagem X12
isTechnicalAcknowledgmentExpected Yes booleano Verifica se a confirmação técnica está configurada no contrato X12
isFunctionalAcknowledgmentExpected Yes booleano Verifica se a confirmação funcional está configurada no contrato X12
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
gs01 Não fio Código do identificador de grupo funcional
gs02 Não fio Código do remetente do aplicativo
gs03 Não fio Código do receptor do aplicativo
gs04 Não fio Data do grupo funcional
gs05 Não fio Hora do grupo funcional
gs07 Não fio Código da agência responsável
gs08 Não fio Código de identificação da versão, do lançamento ou do setor

Confirmação do grupo funcional X12 – Esquema de acompanhamento

A sintaxe a seguir descreve o esquema para acompanhar uma confirmação de grupo funcional X12:

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

Confirmação de grupo funcional X12 – agreementProperties

Propriedade Obrigatório Tipo Descrição
senderPartnerName Não fio Nome do remetente de mensagens X12 do parceiro
receiverPartnerName Não fio Nome do destinatário da mensagem do parceiro X12
senderQualifier Yes fio Qualificador para o remetente de mensagens X12 do parceiro
senderIdentifier Yes fio Identificador do remetente de mensagens do parceiro X12
receiverQualifier Yes fio Qualificador para o destinatário de mensagem X12 do parceiro
receiverIdentifier Yes fio Identificador do receptor de mensagem X12 do parceiro
agreementName Não fio Nome do contrato X12 que resolve as mensagens

Confirmação de grupo funcional X12 – messageProperties

Propriedade Obrigatório Tipo Descrição
direction Yes Enumeração Direção do fluxo da mensagem (send ou receive)
functionalGroupControlNumber Não fio Número de controle de grupo funcional para a confirmação técnica. Esse valor é preenchido para o remetente quando uma confirmação técnica é recebida de parceiros.
interchangeControlNumber Não fio Número de controle de intercâmbio. Esse valor é preenchido para o remetente quando uma confirmação técnica é recebida de parceiros.
isaSegment Não fio O mesmo que interchangeControlNumber, mas popula apenas em casos específicos
gsSegment Não fio O mesmo que functionalGrouControlNumber, mas popula apenas em casos específicos
respondingFunctionalGroupControlNumber Não fio Número de controle do grupo funcional original
respondingFunctionalGroupId Não fio Mapeia para AK101 na ID do grupo funcional de confirmação
isMessageFailed Yes booleano Verifica se houve falha na mensagem X12
statusCode Yes Enum Código de status de confirmação com estes valores permitidos: Accepted, Rejected e AcceptedWithErrors
processingStatus Yes Enum Status de processamento para a confirmação com estes valores permitidos: Received, Generated e Sent
ak903 Não fio Número de conjuntos de transações recebidos
ak904 Não fio Número de conjuntos de transações aceitos no grupo funcional identificado
ak9Segment Não fio Se o grupo funcional identificado no segmento AK1 foi aceito ou rejeitado e o porquê

Personalizado

Você pode configurar o acompanhamento personalizado, que registra eventos do início ao fim do fluxo de trabalho do aplicativo lógico. Por exemplo, você pode registrar eventos de camadas que incluem o fluxo de trabalho, do SQL Server, do BizTalk Server ou de qualquer outra camada. A seção a seguir fornece o código do esquema de acompanhamento personalizado que você pode usar nas camadas fora do fluxo de trabalho.

A sintaxe a seguir descreve o esquema para acompanhamento personalizado:

{
   "sourceType": "",
   "source": {
      "workflow": {
         "systemId": ""
      },
      "runInstance": {
         "runId": ""
      },
      "operation": {
         "operationName": "",
         "repeatItemScopeName": "",
         "repeatItemIndex": ,
         "trackingId": "",
         "correlationId": "",
         "clientRequestId": ""
      }
   },
   "events": [
      {
         "eventLevel": "",
         "eventTime": "",
         "recordType": "",
         "record": {}
      }
   ]
}
Propriedade Obrigatório Tipo Descrição
sourceType Yes fio Digite para a origem de execução com estes valores permitidos: Microsoft.Logic/workflows, custom**
source Yes Cadeia de caracteres ou JToken Se o tipo de origem for Microsoft.Logic/workflows, as informações de origem deverão seguir o esquema descrito. Se o tipo de origem for custom, o esquema terá o tipo JToken.
systemId Yes fio O ID do sistema para o aplicativo de lógica
runId Yes fio A ID de execução do aplicativo lógico
operationName Yes fio Nome da operação, por exemplo, ação ou gatilho
repeatItemScopeName Yes fio Repita o nome do item se a ação estiver em um loop foreach ou until.
repeatItemIndex Yes Número Inteiro Número de índice de item repetido para indicar que a ação está em um loop foreach ou until
trackingId Não fio A ID de rastreamento para correlacionar as mensagens
correlationId Não fio A ID de correlação para correlacionar as mensagens
clientRequestId Não fio O cliente pode popular essa propriedade para correlacionar mensagens
eventLevel Yes fio Nível de evento
eventTime Yes Data e Hora Hora do evento no formato UTC: YYYY-MM-DDTHH:MM:SS.00000Z
recordType Yes fio Acompanhe o tipo de registro somente com este valor permitido: custom
record Yes JToken Tipo de registro personalizado somente no formato JToken