Logística - Linha Protheus - OMS - Validação de XML na Integração dos TOTVS OMS e TOL/TRE

Tempo aproximado para leitura: 00:03:30 min

Dúvida
Na Integração dos TOTVS OMS  e TOL/TRE, como configurar o Sistema para impedir que ocorram inconsistências no Protheus devido a XML's mal formatados?

Ambiente
TOTVS Logística - TOTVS OMS (Linha Protheus) - Gestão de Distribuição (SIGAOMS) - Todas as versões

Solução
Para impedir que ocorram inconsistência no Protheus por XML's mal formatados, foi desenvolvida a funcionalidade de validar XML's, baseadas em XSD - XML Schema Definition.

Ao consumir o WebService do Protheus com as mensagens de Liberação de Viagem - publishReleasedTripService, Reprogramação de Viagem - publishReprogrammingService e Cancelamento de Viagem - publishCancelService, os XML's passarão por uma pré-valiação de estrutura.

1. Estrutura Para Pré-validação
Inclua a pasta xsd dentro da system, com os seguintes arquivos:

• envelope.xsd
• publishCancelService.xsd
• publishReleasedTripService.xsd
• publishReprogrammingService.xsd

Os arquivos acima estão ao final desse artigo, na sessão Anexos.

2. As falhas ocorridas durante o processo de integração serão retornadas para o XML de Resposta ou Log Appserver:

• AAAA-MM-DD T09:39:25.122000-03:00 10084 OMSXWS - OMSValXSD - Verificando as configurações de validação de XML baseada em Schema XSD.
• AAAA-MM-DD T09:39:25.123000-03:00 10084 OMSXWS - OMSValXSD - Validação do XML de entrada através de XSD não executada por não existir o diretório \system\xsd com os xsds no servidor.
• AAAA-MM-DD T09:39:25.123000-03:00 10084 OMSXWS - OMSValXSD - Análise das configurações de validação de baseada em Schema XSD concluída.
• AAAA-MM-DD T09:39:43.890000-03:00 10084 OMSXWS - OMSXConnect - Conteúdo de cErro:
  Opening and ending tag mismatch - ns2:publishReprogrammingService line 1 and tagParaErro:
  Opening and ending tag mismatch - soap:Body line 1 and ns2:publishReprogrammingService
  Opening and ending tag mismatch - soap:Envelope line 1 and soap:Body
  Extra content at the end of the document

3. Falha na Liberação da Viagem
Caso ocorra falha na liberação da viagem, será retornado N para a TOL/TRE e a inconsistência de estrutura estará no log do Protheus:

 4. Falha de Reprogramação ou Cancelamento
Se forem falhas de reprogramação ou cancelamento será retornada a inconsistência no XML de resposta e também para o log:

 5. Se Não Estiver Habilitado
Estas mensagens serão exibidas no log e processo de validação será descartado:

• AAAA-MM-DD T10:42:29.347000-03:00 10292 OMSXWS - OMSValXSD - Verificando as configurações de validação de XML baseada em Schema XSD.
• AAAA-MM-DD T10:42:29.347000-03:00 10292 OMSXWS - OMSValXSD - Validação do XML de entrada através de XSD não executada por não existir o diretório \system\xsd com os XSDS no servidor.
• AAAA-MM-DD T10:42:29.347000-03:00 10292 OMSXWS - OMSValXSD - Análise das configurações de validação de baseada em Schema XSD concluída.

Importante
Esse tratamento destina-se a XML padrão.

6. Função Para Gerar Mensagens Auxiliares Para o Log
Para auxiliar na análise de inconsistências foi desenvolvida uma função para gerar mensagens auxiliares
para o log, sendo que ela insere informações como queries e conteúdos de variáveis. Para habilitar são necessários três parâmetros em todos os ambientes:

LOGCPLOMS=.T.
FWFRAME_TRACELOG=1
LOGTIPOMS= CONSOLE

O parâmetro LOGTIPOMS, define a forma de saída das mensagens.
Como default o Sistema irá gerar no Console.log do Appserver.
Caso desejar separar as mensagens e salvar com o nome de omscpl.log dentro da pasta system, informe ARQUIVO.

Saiba mais
Mais informações sobre a geração do Log poderão ser acessadas do link:
Logística - Linha Protheus - OMS - Como habilitar Log de integração do TOTVS OMS e TOL/TRE

Glossário
TOL - TOTVS Otimização Logística
TRE - TOTVS Roteirização e Entrega
TOTVS OMS - Order Management System

Anexos