Trocar mensagens X12 para integração corporativa B2B usando os Aplicativos Lógicos do Azure e o Enterprise Integration Pack

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

Nos Aplicativos Lógicos do Azure, você pode criar fluxos de trabalho que funcionam com mensagens X12 usando operações X12. Essas operações incluem gatilhos e ações que você pode usar no seu fluxo de trabalho para administrar a comunicação X12. Você pode adicionar gatilhos e ações X12 da mesma maneira que qualquer outro gatilho e ação em um fluxo de trabalho, mas precisa atender a pré-requisitos extras para usar operações X12.

Este artigo descreve os requisitos e as configurações para usar gatilhos e ações X12 no seu fluxo de trabalho. Se você estiver procurando mensagens EDIFACT, examine Trocar mensagens EDIFACT. Se você for novo nos aplicativos lógicos, examine O que são os Aplicativos Lógicos do Azure e Guia de início rápido: Criar um fluxo de trabalho de integração usando Aplicativos Lógicos do Azure de multilocatários e o portal do Azure.

Pré-requisitos

  • Uma conta e uma assinatura do Azure. Caso você ainda não tenha uma assinatura do Azure, inscreva-se em uma conta gratuita do Azure.

  • Um recurso de aplicativo lógico e um fluxo de trabalho em que você deseja usar um gatilho ou ação X12. Para usar um gatilho X12, você precisa de um fluxo de trabalho em branco. Para usar uma ação X12, você precisa de um fluxo de trabalho que tenha um gatilho existente.

  • Uma conta de integração que seja vinculada ao seu recurso de aplicativo lógico. O aplicativo lógico e a conta de integração precisam usar a mesma assinatura do Azure e existir na mesma região ou localização do Azure.

    A sua conta de integração também precisa incluir os seguintes artefatos B2B:

    • Pelo menos dois parceiros comerciais que usam o qualificador de identidade X12.

    • Um contrato do X12 definido entre os seus parceiros comerciais. Para obter informações sobre as configurações a serem usadas ao receber e enviar mensagens, examine Receber Configurações e Enviar Configurações.

      Importante

      Se você estiver trabalhando com esquemas HIPAA (Health Insurance Portability and Accountability Act), precisará adicionar uma seção schemaReferences no seu contrato. Para obter mais informações, examine Esquemas HIPAA e tipos de mensagem.

    • Os esquemas a serem usados para validação XML.

      Importante

      Se você estiver trabalhando com esquemas HIPAA (Health Insurance Portability and Accountability Act), examine Esquemas HIPAA e tipos de mensagem.

Referência de conector

Para obter mais informações técnicas sobre esse conector, como gatilhos, ações e limites, conforme descrito no arquivo Swagger do conector, confira a página de referência do conector.

Observação

Para aplicativos lógicos em um ambiente de serviço de integração (ISE), a versão rotulada do ISE deste conector usa os limites de mensagem B2B para o ISE.

Configurações de Recebimento

Depois de definir as propriedades do contrato entre parceiros comerciais, você poderá configurar como esse contrato identifica e lida com as mensagens que você recebe do seu parceiro por meio desse contrato.

  1. Em Adicionar, selecione Configurações de Recebimento.

  2. Com base no contrato com o parceiro que troca mensagens com você, defina as propriedades no painel Configurações Recebimento, que é organizado nas seguintes seções:

  3. Quando terminar, salve as configurações selecionando OK.

Configurações de Recebimento - Identificadores

Propriedades do identificador para mensagens de entrada

Propriedade Descrição
ISA1 (Qualificador de Autorização) O valor do Qualificador de Autorização que você deseja usar. O valor padrão é 00 - Nenhuma informação de autorização presente.

Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA2.

ISA2 O valor de Informação de Autorização a ser usado quando a propriedade ISA1 não for 00 - Nenhuma informação de autorização presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.
ISA3 (Qualificador de Segurança) O valor do Qualificador de Segurança que você deseja usar. O valor padrão é 00 - Nenhuma informação de segurança presente.

Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA4.

ISA4 O valor de Informação de Segurança a ser usado quando a propriedade ISA3 não for 00 - Nenhuma informação de segurança presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.

Configurações de Recebimento - Confirmação

Confirmação para mensagens de entrada

Propriedade Descrição
TA1 esperado Retorna uma confirmação técnica (TA1) ao emissor de intercâmbio.
FA esperado Retorna uma confirmação funcional (FA) ao emissor de intercâmbio.

Para a propriedade Versão de FA, com base na versão do esquema, selecione as confirmações 997 ou 999.

Para habilitar a geração de loops AK2 em confirmações funcionais para conjuntos de transações aceitas, selecione Incluir Loop AK2/IK2.

Configurações de Recebimento - Esquemas

Esquemas para mensagens de entrada

Para esta seção, selecione um esquema da sua conta de integração para cada tipo de transação (ST01) e Aplicativo Remetente (GS02). O Pipeline de Recebimento EDI desmonta a mensagem recebida, combinando os valores e o esquema que você define nesta seção com os valores de ST01 e GS02 na mensagem recebida e com o esquema da mensagem recebida. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade Descrição
Versão A versão X12 para o esquema
Tipo de Transação (ST01) O tipo de transação
Aplicativo do Remetente (GS02) O aplicativo do remetente
Esquema O arquivo de esquema que você deseja usar

Configurações de Recebimento - Envelopes

Separadores a serem usados em conjuntos de transações para mensagens de entrada

Propriedade Descrição
Uso de ISA11 O separador a ser usado em um conjunto de transações:

- Identificador padrão: usa um ponto (.) em notação decimal, em vez de uma notação decimal no documento de entrada do Pipeline de Recebimento EDI.

- Separador de repetição: especifica o separador para as ocorrências repetidas de um elemento de dados simples ou uma estrutura de dados repetidos. Por exemplo, geralmente o circunflexo (^) é usado como o separador de repetição. Para esquemas HIPAA, só é possível usar circunflexo (^).

Configurações de Recebimento - Números de Controle

Tratamento de duplicatas de número de controle para mensagens de entrada

Propriedade Descrição
Não permitir duplicatas do número de controle de intercâmbio Bloqueia o intercâmbio de duplicatas. Verifica o número de controle de intercâmbio (ISA13) para o número de controle de intercâmbio recebido. Se uma correspondência for detectada, o Pipeline de Recebimento EDI não processará o intercâmbio.

Para especificar o número de dias para executar a verificação, insira um valor para a propriedade Verificação de ISA13 duplicados a cada (dias) .

Não permitir duplicatas do número de controle de grupo Bloqueia intercâmbios que tenham números de controle de grupo em duplicata.
Não permitir duplicatas do número de controle do conjunto de transações Bloqueia intercâmbios que tenham números de controle de conjunto de transações em duplicata.

Configurações de Recebimento - Validações

Validações para mensagens de entrada

A linha Padrão mostra as regras de validação usadas para um tipo de mensagem EDI. Se você deseja definir regras diferentes, selecione cada caixa em que deseja que a regra seja definida como true. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade Descrição
Tipo de mensagem O tipo de mensagem EDI
Validação de EDI Executa a validação de EDI nos tipos de dados conforme a definição das propriedades de EDI do esquema, restrições de comprimento, elementos de dados vazios e separadores à direita.
Validação Estendida Se o tipo de dados não for EDI, a validação será realizada nos requisitos de elementos de dados e na permissão de repetições, enumerações e validação de tamanho de elementos de dados (mín. ou máx.).
Permitir Zeros à Esquerda/Direita Mantém zeros à esquerda ou à direita adicionais e caracteres de espaço. Não remova esses caracteres.
Cortar Zeros à Esquerda/Direita Remove zeros à esquerda ou à direita e caracteres de espaço.
Política de Separador à Direita Gera separadores à direita.

- Não permitido: proíbe delimitadores e separadores à direita no intercâmbio de entrada. Se o intercâmbio tiver delimitadores e separadores à direita, o intercâmbio é declarado não válido.

- Opcional: aceita intercâmbios com ou sem delimitadores e separadores à direita.

- Obrigatório: o intercâmbio de entrada deve ter delimitadores e separadores à direita.

Configurações de Recebimento - Configurações Internas

Configurações internas para mensagens de entrada

Propriedade Descrição
Converter o formato decimal implícito Nn para o valor numérico de base 10 Converte um número de EDI especificado no formato "Nn" em um valor numérico de base 10.
Criar marcas XML vazias se forem permitidos separadores à direita Faz com que o remetente do intercâmbio inclua marcas XML vazias para separadores à direita.
Dividir intercâmbio como conjuntos de transação – suspender conjuntos de transação com erro Analisa cada conjunto de transações em um intercâmbio dentro de um documento XML separado ao aplicar o envelope apropriado ao conjunto de transações. Suspende somente as transações em que a validação falha.
Dividir intercâmbio como conjuntos de transação – suspender intercâmbio com erro Analisa cada conjunto de transações em um intercâmbio dentro de um documento XML separado ao aplicar o envelope apropriado. Suspende o intercâmbio inteiro se um ou mais conjuntos de transações no intercâmbio falharem na validação.
Preservar intercâmbio – suspender conjuntos de transações com erro Mantém o intercâmbio intacto e cria um documento XML para o intercâmbio em lote inteiro. Suspende somente os conjuntos de transações com falha na validação, mas continua a processar todos os outros conjuntos de transações.
Preservar intercâmbio – suspender intercâmbio com erro Mantém o intercâmbio intacto, cria um documento XML para o intercâmbio em lote inteiro. Suspende o intercâmbio inteiro se um ou mais conjuntos de transações no intercâmbio falharem na validação.

Configurações de Envio

Depois de definir as propriedades do contrato, você pode configurar como este contrato identifica e lida com as mensagens de saída que você envia ao seu parceiro por meio deste contrato.

  1. Em Adicionar, selecione Configurações de Envio.

  2. Configure essas propriedades com base em seu contrato com o parceiro que troca mensagens com você. Para obter as descrições da propriedade, confira as tabelas nesta seção.

    As Configurações de Envio são organizadas nas seguintes seções:

  3. Quando terminar, salve as configurações selecionando OK.

Configurações de Envio - Identificadores

Propriedades do identificador para mensagens de saída

Propriedade Descrição
ISA1 (Qualificador de Autorização) O valor do Qualificador de Autorização que você deseja usar. O valor padrão é 00 - Nenhuma informação de autorização presente.

Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA2.

ISA2 O valor de Informação de Autorização a ser usado quando a propriedade ISA1 não for 00 - Nenhuma informação de autorização presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.
ISA3 (Qualificador de Segurança) O valor do Qualificador de Segurança que você deseja usar. O valor padrão é 00 - Nenhuma informação de segurança presente.

Observação: Se você selecionar outros valores, especifique um valor para a propriedade ISA4.

ISA4 O valor de Informação de Segurança a ser usado quando a propriedade ISA3 não for 00 - Nenhuma informação de segurança presente. Esse valor da propriedade deve ter no mínimo um caractere alfanumérico e no máximo 10.

Configurações de Envio - Confirmação

Propriedades de confirmação para mensagens de saída

Propriedade Descrição
TA1 esperado Retorna uma confirmação técnica (TA1) ao emissor de intercâmbio.

Essa configuração especifica que o parceiro host que está enviando a mensagem solicitou uma confirmação do parceiro convidado no contrato. Essas confirmações são esperadas pelo parceiro host com base nas Configurações de Recebimento do contrato.

FA esperado Retorna uma confirmação funcional (FA) ao emissor de intercâmbio. Para a propriedade Versão de FA, com base na versão do esquema, selecione as confirmações 997 ou 999.

Essa configuração especifica que o parceiro host que está enviando a mensagem solicitou o reconhecimento do parceiro convidado no contrato. Essas confirmações são esperadas pelo parceiro host com base nas Configurações de Recebimento do contrato.

Configurações de Envio - Esquemas

Esquemas para mensagens de saída

Para esta seção, selecione um esquema da sua conta de integração para cada tipo de transação (ST01). Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade Descrição
Versão A versão X12 para o esquema
Tipo de Transação (ST01) O tipo de transação para o esquema
Esquema O arquivo de esquema que você deseja usar. Se você selecionar o esquema primeiro, a versão e o tipo de transação serão definidos automaticamente.

Configurações de Envio - Envelopes

Separadores em um conjunto de transações a ser usado para mensagens de saída

Propriedade Descrição
Uso de ISA11 O separador a ser usado em um conjunto de transações:

- Identificador padrão: usa um ponto (.) em notação decimal, em vez de uma notação decimal no documento de saída do Pipeline de Envio EDI.

- Separador de repetição: especifica o separador para as ocorrências repetidas de um elemento de dados simples ou uma estrutura de dados repetidos. Por exemplo, geralmente o circunflexo (^) é usado como o separador de repetição. Para esquemas HIPAA, só é possível usar circunflexo (^).

Configurações de Envio - Número de Versão de Controle

Número de versão de controle para mensagens de saída

Para esta seção, selecione um esquema da sua conta de integração para cada intercâmbio. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade Descrição
Número de Versão de Controle (ISA12) A versão do padrão X12
Indicador de Uso (ISA15) O contexto de um intercâmbio, que consiste em dados de Teste, dados de Informações ou dados de Produção
Esquema O esquema a ser usado para gerar os segmentos GS e ST para um intercâmbio de codificação X12 que ele envia para o Pipeline de Envio EDI.
GS1 Opcional, seleciona o código funcional.
GS2 Opcional, especifica o remetente do aplicativo.
GS3 Opcional, especifica o receptor do aplicativo.
GS4 Opcional, selecionar CCYYMMDD ou YYMMDD.
GS5 Opcional, selecionar HHMM, HHMMSS ou HHMMSSdd.
GS7 Opcional, selecionar um valor para a agência responsável.
GS8 Opcional, especifica a versão do documento de esquema.

Configurações de Envio - Números de Controle

Números de controle para mensagens de saída

Propriedade Descrição
Número de Controle de Intercâmbio (ISA13) O intervalo de valores para o número de controle de intercâmbio, que pode ter um valor mínimo de 1 e um valor máximo de 999999999
Número de Controle de Grupo (GS06) O intervalo de valores para o número de controle de grupo, que pode ter um valor mínimo de 1 e um valor máximo de 999999999
Número de Controle de Conjunto de Transações (ST02) O intervalo de valores para o número de controle do conjunto de transações, que pode ter um valor mínimo de 1 e um valor máximo de 999999999

- Prefixo: Opcional, um valor alfanumérico
- Sufixo: Opcional, um valor alfanumérico

Configurações de Envio - Conjuntos de Caracteres e Separadores

Delimitadores para tipos de mensagem em mensagens de saída

A linha Padrão mostra o conjunto de caracteres usado como delimitadores para um esquema de mensagens. Se não quiser usar o conjunto de caracteres Padrão, você pode inserir um conjunto diferente de delimitadores para cada tipo de mensagem. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Dica

Para fornecer valores de caractere especial, edite o contrato como JSON e forneça o valor ASCII para o caractere especial.

Propriedade Descrição
Conjunto de Caracteres a ser usado O conjunto de caracteres X12, que é Básico, Estendido ou UTF8.
Esquema O esquema que você deseja usar. Depois de selecionar o esquema, selecione o conjunto de caracteres que deseja usar, com base nas descrições do separador abaixo.
Tipo de Entrada O tipo de entrada para o conjunto de caracteres.
Separador de Componente Um único caractere que separa elementos de dados compostos.
Separador de Elemento de Dados Um único caractere que separa elementos de dados simples nos dados compostos.
Separador de Caracteres de Substituição Um caractere de substituição que substitui todos os caracteres separadores dos dados de conteúdo ao gerar a mensagem X12 de saída.
Terminador de Segmento Um único caractere que indica o final de um segmento EDI.
Suffix O caractere a ser usado com o identificador de segmento. Se especificar um sufixo, o elemento de dados de terminador de segmento poderá ser esvaziado. Se o terminador de segmento for deixado vazio, será necessário designar um sufixo.

Configurações de Envio - Validação

Propriedades de validação para mensagens de saída

A linha Padrão mostra as regras de validação usadas para um tipo de mensagem EDI. Se você deseja definir regras diferentes, selecione cada caixa em que deseja que a regra seja definida como true. Depois de concluir cada linha, uma nova linha vazia é exibida automaticamente.

Propriedade Descrição
Tipo de mensagem O tipo de mensagem EDI
Validação de EDI Executa a validação de EDI nos tipos de dados conforme a definição das propriedades de EDI do esquema, restrições de comprimento, elementos de dados vazios e separadores à direita.
Validação Estendida Se o tipo de dados não for EDI, a validação será realizada nos requisitos de elementos de dados e na permissão de repetições, enumerações e validação de tamanho de elementos de dados (mín. ou máx.).
Permitir Zeros à Esquerda/Direita Mantém zeros à esquerda ou à direita adicionais e caracteres de espaço. Não remova esses caracteres.
Cortar Zeros à Esquerda/Direita Remove zeros à esquerda ou à direita e caracteres de espaço.
Política de Separador à Direita Gera separadores à direita.

- Não permitido: proíbe delimitadores e separadores à direita no intercâmbio de saída. Se o intercâmbio tiver delimitadores e separadores à direita, o intercâmbio é declarado não válido.

- Opcional: envia intercâmbios com ou sem delimitadores e separadores à direita.

- Obrigatório: o intercâmbio de saída deve ter delimitadores e separadores à direita.

Tipos de mensagens e esquemas HIPAA

Ao trabalhar com esquemas HIPAA e os tipos de mensagem 277 ou 837, é necessário executar algumas etapas adicionais. Os números de versão do documento (GS8) para esses tipos de mensagens têm mais de nove caracteres, por exemplo, "005010X222A1". Além disso, alguns números de versão do documento são mapeados para tipos de mensagens variantes. Se você não fizer referência ao tipo de mensagem correto no seu esquema e no seu contrato, receberá esta mensagem de erro:

"The message has an unknown document type and did not resolve to any of the existing schemas configured in the agreement."

Esta tabela lista os tipos de mensagens afetados, quaisquer variantes e os números de versão do documento que são mapeados para esses tipos de mensagens:

Tipo ou variante de mensagem Descrição Número da versão do documento (GS8)
277 Notificação de status de informações de assistência médica 005010X212
837_I Declaração de assistência médica institucional 004010X096A1
005010X223A1
005010X223A2
837_D Declaração de assistência médica dental 004010X097A1
005010X224A1
005010X224A2
837_P Declaração de assistência médica profissional 004010X098A1
005010X222
005010X222A1

Também é preciso desativar a validação EDI ao usar esses números de versão do documento, pois eles resultam em um erro que indica que o comprimento do caractere é inválido.

Para especificar esses números de versão de documento e tipos de mensagens, siga estas etapas:

  1. No esquema HIPAA, substitua o tipo de mensagem atual pelo tipo de mensagem variante do número da versão do documento que você deseja usar.

    Por exemplo, suponha que você queira usar o número de versão do documento 005010X222A1 com o tipo de mensagem 837. No seu esquema, substitua cada valor "X12_00501_837" pelo valor "X12_00501_837_P".

    Para atualizar o esquema, siga estas etapas:

    1. No portal do Azure, vá para sua conta de integração. Localize e faça download do seu esquema. Substitua o tipo de mensagem e renomeie o arquivo de esquema e faça upload do esquema revisado para sua conta de integração. Para obter mais informações, confira Editar um esquema.

    2. Nas configurações de mensagem do contrato, selecione o esquema revisado.

  2. No objeto schemaReferences do seu contrato, adicione outra entrada que especifique o tipo de mensagem variante que corresponde ao número da versão do documento.

    Por exemplo, suponha que você queira usar o número de versão do documento 005010X222A1 com o tipo de mensagem 837. Seu contrato tem uma seção schemaReferences com essas propriedades e valores:

    "schemaReferences": [
       {
          "messageId": "837",
          "schemaVersion": "00501",
          "schemaName": "X12_00501_837"
       }
    ]
    

    Nesta seção schemaReferences, adicione outra entrada que tenha estes valores:

    • "messageId": "837_P"
    • "schemaVersion": "00501"
    • "schemaName": "X12_00501_837_P"

    Ao concluir, sua seção schemaReferences ficará assim:

    "schemaReferences": [
       {
          "messageId": "837",
          "schemaVersion": "00501",
          "schemaName": "X12_00501_837"
       },
       {
          "messageId": "837_P",
          "schemaVersion": "00501",
          "schemaName": "X12_00501_837_P"
       }
    ]
    
  3. Nas configurações de mensagem do seu contrato, desative a validação EDI desmarcando a caixa de seleção Validação EDI para cada tipo de mensagem ou para todos os tipos de mensagem, se você estiver usando os valores Padrão.

    Desabilitar a validação para todos os tipos de mensagem ou cada tipo de mensagem

Próximas etapas