1. Contexto de Negócio (Introdução)

Com a crescente demanda por otimização nos processos logísticos de distribuição na busca por um melhor aproveitamento dos veículos, tanto na questão de carregamento quanto na roteirização das entregas, tornou-se necessário proporcionar aos cliente do TOTVS OMS uma solução para atender essas necessidades.

Visando esta solução foi realizada a integração entre o TOTVS OMS da linha Protheus  com a funcionalidade TOTVS Otimização Logística por intermédio de arquivos no formato XML, utilizando os WebServices existentes no TOL, sem transformação de mensagens e sem a utilização de Sistemas intermediários (TOTVS EAI, TOTVS ESB, entre outros).

Com esta integração, o TOTVS OMS  passou a utilizar os recursos do TOTVS Otimização Logística, o qual efetuará a roteirização e o arranjo das cargas com base na demanda de transportes enviados pelo TOTVS OMS, devolvendo para este as cargas montadas e roteirizadas.

Para a montagem de carga serão consideradas as configurações das restrições logísticas e as funções-objetivos de otimização registradas no TOTVS Otimização Logística.

São exemplos de funções-objetivo:

• Máxima ocupação dos veículos.
• Diminuição dos prazos de entrega.
• Redução da quantidade de viagens.

2. Sistemas Envolvidos

2.1. TOTVS OMS

A sigla OMS significa Order Management System, ou seja, gerenciamento de Pedidos e serviços que compreende as fases de captação, validação, avaliação, formação de carga e geração de mapa de separação ou, como é também conhecido, lista de separação.

Para obter informações detalhadas, acesse a página TOTVS OMS. no TDN.

2.2. TOTVS OTIMIZAÇÃO LOGÍSTICA

É um Sistema vertical desenvolvido pela Neolog, empresa do ecossistema TOTVS, que dispõe de módulos para Planejamento da Malha de Distribuição, Programação de Transportes e Monitoramento de Cargas.

Para obter informações detalhadas, acesse o link http://www.neolog.com.br/neolog-site/index.php/cockpit-logistico/.

3. Escopo

O escopo desta integração permitirá o envio dos pedidos de venda liberados (crédito / estoque) no TOTVS OMS para a formação das viagens no TOL e o recebimento destas viagens geradas no TOTVS Otimização Logística, por meio de um XML no TOTVS OMS, para a geração das cargas.

Para complementar o escopo do envio dos pedidos será necessário enviar os cadastros envolvidos com as informações dos pedidos, como produtos, clientes, fornecedores, filiais, transportadoras e tipos de veículos.

Faz parte do processo de integração o recebimento das mensagens de publicação de viagens, reprogramação e cancelamento de viagens.

4. Pré-requisitos Instalação / Implantação / Utilização

4.1. TOTVS Otimização Logística

• TOL na versão/release 5.6.1.

• Parâmetros de aquisição ativos (acesso pelo menu em Administração > TOTVS Otimização Logística).

• Web Services ativos.

4.2. Protheus

• Protheus versão  12.1.17 ou superior.

• Parâmetros de integração com o TOL configurados (acesso pelo menu em Atualizações > TOTVS Otimização Logística > Parâmetros Integração).

• Web Service Server para recebimento de mensagens do TOL.

5. Instalação / Configuração

5.1. Configuração Web Service AppServer Protheus

• Para que seja possível receber as viagens do TOTVS Otimização Logística é necessário configurar um Web Service no servidor de aplicação Protheus.

• É recomendado criar um Web Service com as seguintes configurações (modificando o arquivo Appserver.ini):

;Serviço webserver HTTP
[HTTP]
ENABLE=1
PATH=<Caminho_Cache_imagens>;C:\TOTVS\Prottheus\data\web
PORT=<porta>;8080
INSTANCES=<nInicio>,<nMaximo>;1,10
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP
 
;URL de resposta
 [<ip ou nome>:<porta>/neolog]
ENABLE=1
PATH=<Caminho_Cache_imagens>;C:\TOTVS\Prottheus\data\web
ENVIRONMENT=<ambiente>
INSTANCENAME=WS_NEOLOG
RESPONSEJOB=JOB_WS_NEOLOG
DEFAULTPAGE=wsindex.apw
 
;JOB de resposta
[JOB_WS_NEOLOG]
TYPE=WEBEX
ENVIRONMENT=<ambiente>
INSTANCES=<nInicio>,<nMaximo>;1,10
INSTANCENAME=JOB_WS_NEOLOG
ONSTART=OMSXStart
ONCONNECT=OMSXConnect

• Para testar o serviço, inicie um navegador e digite: http://<ip ou nome>:<porta>/neolog/PublishReleasedTrip.APW?WSDL.

• Um WSDL (descrição do serviço em XML) será exibido no navegador..

• Para que seja possível reprogramar/cancelar as viagens do TOTVS Otimização Logística é necessário configurar as informações de conexão com o DBAccess diretamente na seção [Environment] (modificando o arquivo Appserver.ini), conforme exemplo abaixo:

;Nome do Ambiente acessado pelo Web Service
[Environment]
SourcePath=C:\Totvs\Protheus\Apo
RootPath=C:\Totvs\Protheus\Data
StartPath=\system\
. . . ; outras chaves
DBDatabase=MSSQL
DBAlias=PLS101
DBServer=192.168.1.20
DBPort=7890

• Para evitar inconsistências do tipo Failed Handshake SSL recomenda-se incluir a seguinte configuração no Appserver.ini:

[SSLConfigure]
TryProtocols=1
Verbose=1

5.2. Parametrização TOTVS Otimização Logística

Para configurar o envio de viagens do TOL para o Web Service Protheus, acesse o TOL e execute os seguintes passos:

1. Administração > Integração, selecione a pasta Fontes de Dados e clique em Inserir.
2. Digite o código, a descrição e o código da base (sugestão: PROTHEUS).
3. Seção Cancelamento de Viagem Liberada

• • No campo URL, digite http://<ip ou nome>:<porta>/neolog/CancelService.APW.
  • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço (recomendado 30000).

4. Seção Execução da Viagem

• • No campo URL, digite: NA (Não Atribuído).
  • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço (recomendado 1000).

5. Seção Solicitação de liberação de Viagem

• • No campo URL, digite http://<ip ou nome>:<porta>/neolog/PublishReleasedTrip.APW.
  • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço (recomendado 30000).

6. Seção Solicitação de Reprogramação de Viagem

• • No campo URL, digite: http://<ip ou nome>:<porta>/neolog/ReprogramService.APW.
  • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço (recomendado 30000).

7. Clique em Salvar.

5.3. Parametrização TOTVS OMS

• Acesse o menu Atualizações > TOTVS Otimização Logística > Parâmetros Integração (OMSXCPL1).

• Para o correto funcionamento da integração, parametrize o Protheus da seguinte forma:

5.4. Parametrização Adicional Integração

• Algumas parametrizações da integração devem ser realizadas no arquivo de configuração do servidor Protheus (Appserver.ini), pois são utilizadas antes de iniciar qualquer processo de conexão com o SGDB.

• As configurações abaixo devem ser incluídas no arquivo na seção [NEOLOG]:

Configuração integração com o TOTVS Otimização Logística:
[NEOLOG]
DefaultCompany=<empresa>
Debug=1
DebugPath=<caminho relativo> ;logs\neolog

Onde:

• DefaultCompany
  Empresa padrão para integração entre o TOTVS OMS e o TOTVS Otimização Logística.
  Se não for informado não será considerado, sendo sempre enviada nas mensagens nos campos que identificam os códigos, além do próprio código, a concatenação da empresa e do campo Filial do respectivo cadastro/processo.
  Caso esteja parametrizada será enviada apenas a concatenação do código com campo Filial do respectivo cadastro/processo. Clique aqui para obter mais detalhes.
  
  

  Será verificado no cadastro de Filiais Protheus se utiliza o conceito de Gestão de Empresas, será enviado ao invés de Empresa/Filial o modelo Empresa/Unidade/Filial. Exemplo: M SP 01

• Debug
  Indicador de que o processo de gravação dos arquivos XML das mensagens trocadas entre o TOTVS OMS e o TOL está ativo.
  Caso esteja com o valor 1, será considerado ativo; caso contrário, será considerado inativo.
  Caso esta configuração não exista será assumido, por padrão, que o Debug está ativo.
  
  

• DebugPath
  Caminho onde serão gravados os arquivos de log do XML, o qual deve ser sempre relativo a pasta RootPath, pois o processo de integração pode rodar em modo JOB e, desta forma, não tem acesso a diretórios locais da máquina.
  Caso não esteja parametrizado será considerado o caminho padrão system/neolog.
  
  

6. Controle de Versão

O Grupo TOTVS, representado por suas marcas, administrará as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas devem ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

7. Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim, as equipes de suporte dos produtos BackOffice Protheus estarão aptas a efetuar a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

8. Mensagens

9. Fluxo das Informações

Os cadastros devem ser realizados no TOTVS OMS e integrados ao TOTVS Otimização Logística.

A ativação da integração, no entanto, não impede a inclusão, alteração e exclusão de registros no TOL, mas esse procedimento não é recomendado, pois as operações realizadas sobre os cadastros no TOL não são replicadas para os respectivos cadastros no Protheus.

Apenas as operações de inclusão e alteração são consideradas na integração e são efetuadas sempre que ocorrerem, desde que parametrizadas para serem on-line.

A operação de eliminação sobre os registros de cadastros não é integrada, pois não é possível verificar a integridade referencial no sistema de destino para considerá-la como restrição de eliminação dos registros no Protheus.

O sucesso das operações de inclusão e alteração de registros pode ser verificado acessando o programa de consulta no menu do TOL em: Interface - Log.

O sistema de origem dos dados não recebe o status do processamento dos registros enviados, por isso, considera integrado com base apenas na confirmação de recepção da mensagem de integração.

9.1. Filiais

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística.

• Mensagem: LocalityAcquisitionService

• O envio de empresas/filiais ou empresas/unidade/filiais não é automático, ou seja, ao cadastrar no Protheus uma nova empresa/filial, para que essas informações sejam replicadas para o TOTVS Otimização Logística é necessário executar a carga de dados disponível em: SIGAOMS > Atualizações > TOTVS Otimização Logística > Carga de dados, assinalando a opção SM0 - Cadastro de Filiais.

• Os dados serão enviados ao TOTVS Otimização Logística por meio do método updateLocalities.

• Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no CPL em: Cadastro > Localidades.
  
  

9.2. Clientes

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística.

• Mensagem: LocalityAcquisitionService

• Ao cadastrar um cliente no Protheus, quando a integração estiver ativa os dados serão enviados ao TOTVS Otimização Logística por meio do método updateLocalities.

• Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no TOL em: Cadastro > Localidades.

• Fornecedores

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística.

• Mensagem: LocalityAcquisitionService ou CarrierAcquisitionService

• Ao cadastrar um fornecedor no Protheus, quando a integração estiver ativa os dados serão enviados ao TOTVS Otimização Logística por meio do método updateLocalities (conforme parametrização do cadastro SA2, de acordo com o comentado acima).

• Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no TOL em: Cadastro > Localidades.

9.3. Transportadores

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística.

• Mensagem: CarrierAcquisitionService

• Ao cadastrar um transportador no Protheus, quando a integração estiver ativa os dados serão enviados ao TOTVS Otimização Logística por meio do método CarrierAcquisitionService.

• Esses dados, por sua vez, serão salvos como transportadoras e poderão ser visualizados no TOL em: Cadastro > Transportadoras.

9.4. Produtos

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística.
• Mensagem: ProductAcquisitionService
• Ao cadastrar um produto no Protheus, quando a integração estiver ativa os dados serão enviados ao TOTVS Otimização Logística por meio do método ProductAcquisitionService.
• Esses dados, por sua vez, serão salvos como produtos simples e poderão ser visualizados no TOL em: Cadastro > Produtos Simples.

9.5. Tipos de Veículo

• Tipo de Fluxo: TOTVS Otimização Logística

• Mensagem: VehicleAcquisitionService

• Ao cadastrar um tipo de veículo no Protheus, quando a integração estiver ativa os dados serão enviados ao TOTVS Otimização Logística por meio do método VehicleAcquisitionService.

• Esses dados, por sua vez, serão salvos como veículos e poderão ser visualizados no TOL em: Cadastro > Veículos.

9.6. Pedidos de Venda

• Tipo de Fluxo: Protheus > TOTVS Otimização Logística
• Mensagem: OrderAcquisitionService

9.6.1. Envio de Pedidos

Ao cadastrar um Pedido de venda no Protheus, quando a integração estiver ativa os dados são enviados ao TOTVS Otimização Logística por meio do método OrderAcquisitionService.

Esses dados, por sua vez, geram no TOTVS Otimização Logística o pedidos de transporte e poderão ser visualizados em: Programação > Análise; deve-se filtrar os dados da cesta geral.

No TOTVS OMS foi disponibilizada a rotina OMSXCPL6 (Envio de Pedido de Venda), que permite selecionar uma lista com os pedidos de venda para envio ao TOTVS Otimização Logística, sendo que estes pedidos são filtrados conforme as seguintes premissas:

• O pedido deve montar carga (C5_TPCARGA).
• O pedido não deve estar faturado (C9_NFISCAL).
• O pedido deve respeitar o range de dados dos filtros da rotina.
• Se o sistema estiver parametrizado para não permitir o envio de pedidos sem liberação (MV_CPLPELB = '2'), os pedidos retornados não devem possuir bloqueios de estoque (C9_BLEST) e crédito (C9_BLCRED). 
• Se o sistema estiver parametrizado para permitir o envio de pedido sem liberação (MV_CPLPELB = '1'), será permitido o envio de toda a quantidade do pedido (C6_QTDVEN), mesmo que existam bloqueios.

Após os pedidos serem filtrados, a rotina OMSXCPL6 (Envio de Pedido de Venda) ainda permite alterar as quantidades para a integração pelo botão Alterar Quantidade da Integração - F10, sendo que, por seu intermédio é possível informar quais quantidades do pedido serão integradas, onde cada integração do pedido gera um sequência de integração diferente.

Exemplo

Sendo assim, a identificação do pedido será sempre a combinação da empresa+filial+sequência de integração+pedido.
Exemplo: 0301000001000096

Caso os dados da filial protheus seja do tipo Gestão de Empresas, será enviada a concatenação empresa+unidade de negócio+filial+sequência de integração+pedido.
Exemplo:MSP01000001000096

Ao efetivar o envio, as seguintes tabelas sofrem alterações/inclusões:

• DK3 - Tabela de Sequência de Integração do Pedido
  Gravará a quantidade enviada ao TOL, incluindo as informações de pedido e a sequência de integração.
  As sequências de integração que encontram-se efetivamente integradas com o TOL possuem o status (DK3_STATUS) 1 - Integrado.
  
  
• SC6 - Itens do Pedido de Venda
  Gravará o status (C6_INTROT) 2 - Integrado, para pedidos totalmente integrados e 4 - Integrado Parcial, para pedidos que ainda possuem quantidades a serem integradas.

9.6.2. Cancelamento de Pedidos

O cancelamento de pedidos ocorre apenas pela rotina OMSXCPL6 (Envio de Pedidos de Venda), na qual estão disponíveis as seguintes opções:

• Desatualizar Pedido Posicionado
  Permite selecionar a sequência que terá a integração cancelada.
  Também permite  efetuar o cancelamento parcial de uma sequência de integração pela digitação da Qtd. Cancelamento.
  
  

• Desatualizar Pedido(s) Selecionado(s):
  Permite efetuar o estorno de todas as sequências de integração, de todos os pedidos selecionados no browse.
  

  Caso o parâmetro MV_CPLATVG (Atualiza viagem no TOL ao cancelar a integração do pedido?) estiver ativo em conjunto com as devidas parametrizações do TOTVS Otimização Logística, todas as viagens das sequências de integração selecionadas serão canceladas automaticamente. Por este motivo, recomenda-se cautela ao utilizar a opção de cancelamento de todos os pedidos selecionados.

  
  Ao efetivar o cancelamento, as seguintes tabelas sofrerão alterações/inclusões:

• DK3 - Tabela de Sequência de Integração do Pedido
  Alterará o status da sequência de integração (DK3_STATUS) para 3 - Cancelado Parcial, quando apenas parte da sequência é estornada, ou então para 2 - Cancelado, quando toda a quantidade da sequência é cancelada do TOL.
  
  
• SC6 - Itens do Pedido de Venda
  Gravará o status (C6_INTROT) igual a 1 - Não Integrado, quando apenas parte do item teve a integração cancelada, ou então,  gravará o status igual a 4 - Integrado Parcial, quando parte da quantidade do item permanecerá integrada.

9.7. Viagens

• Tipo de Fluxo: TOTVS Otimização Logística > Protheus

• Mensagem: ReleaseTripPublishRequestService

• O TOL envia as viagens geradas para o TOTVS OMS, para a formação das cargas, sendo que o envio é realizado pela chamada do Web Service ReleaseTripPublishRequestService. 
  Para isso, foi disponibilizada a rotina OMSXCPL7 (Monitor de Cargas), que será responsável pelo gerenciamento das cargas em questão.

• Ao receber uma viagem com o campo Placa (DK0_PLACA) preenchido é realizada uma busca pela placa no cadastro de veículos (DA3).
  Se encontrado algum registro, o veículo será associado a carga. Para que isso ocorra é essencial que a placa recebida do TOL seja idêntica a placa cadastrada no Protheus.

• Ao receber a viagem no TOTVS OMS serão gravadas as tabelas DK0 (Viagem CPL) e DK1(Itens da Viagem CPL) com suas respectivas quantidades recebidas do TOL. Além disso, é registrado o código da viagem na tabela auxiliar de Sequência de Integração TOL  (DK3), quando esta existir, mais especificamente no campo DK3_VIAGID.

• Já no processo de geração da carga, que pode ocorrer de forma automática no momento da geração da viagem ou posteriormente via rotina OMSXCPL7 (Monitor de Cargas) serão avaliadas as quantidades liberadas do Pedido (C9_QTDLIB) para a gravação do código da carga, visto que a rotina de OMSXCPL6 (Envio de Pedidos de Venda), permite a integração de quantidades não liberadas e a montagem da carga necessita, obrigatoriamente, de quantidades liberadas do Pedido.

• No próximo tópico são listadas as correspondências entre os campos de cada entidade e a respectiva tag XML da mensagem de integração.
  
  

10. Detalhamento das Mensagens

10.1. Mensagem de Integração dos Registros do Cadastro de Filiais

10.2. Mensagem de Integração dos Registros do Cadastro de Clientes

10.3. Mensagem de Integração dos Registros do Cadastro de Fornecedor Como Localidade

10.4. Mensagem de Integração dos Registros do Cadastro de Fornecedor Como Transportadora

10.5. Mensagem de Integração dos Registros do Cadastro de Transportadora

10.6. Mensagem de Integração dos Registros do Cadastro de Tipos de Veículos

10.7. Mensagem de Integração dos Registros do Cadastro de Produto

10.8. Mensagem de Integração dos Registros do Cadastro de Pedido de Venda

² Para o combinação da filial para os cadastros serão aplicadas as seguintes regras:

• Utilizando a configuração de gestão de empresas e esta possua em sua máscara a empresa:

  • Será enviado apenas o retorno da função xFilial( <TAB> ), onde TAB representa a tabela do Protheus.

• Utilizando a  configuração de gestão de empresas, sem possuir a empresa na máscara, ou não utilizando a configuração de gestão de empresas:

  • Caso exista uma empresa padrão (DefaultCompany) configurada na seção [NEOLOG] do INI do servidor de aplicação será enviado apenas o retorno da função xFilial( <TAB> ), onde TAB representa a tabela do Protheus.

  • Não existindo a empresa padrão será enviada a concatenação da função FWGrpCompany() + xFilial( <TAB> ), onde TAB representa a tabela do Protheus.

• Sempre que o retorno não for branco, este será precedido por um "-" (hífen), caso a função não receba o valor .F. no segundo parâmetro. 

* Poderá ocorrer deste valor permanecer em branco, em função de algumas parametrizações e configuração da tabela ser compartilhada.

11. Configurações Complementares

11.1. Configuração Para Envio Automático de Pedidos de Venda (Schedule)

• Os pedidos de venda gerados no módulo TOTVS OMS podem ser enviados automaticamente ao TOTVS Otimização Logística.

• Para isso, deve ser configurada a execução automática (Schedule) da rotina OMSXCPL6 (Envio de Pedidos de Venda).

• Esta configuração pode ser executada conforme descrito em Schedule Protheus.

• No arquivo Appserver.ini é necessário inserir a seguinte configuração:

[OnStart]
jobs=FWSCHDMANAG,FWSCHDQUEUE
RefreshRate=60

[FWSCHDMANAG]
Main=FWSCHDMANAG
Environment=<ambiente>

[FWSCHDQUEUE]
Main=FWSCHDQUEUE
Environment=<ambiente>

11.2. Cadastro de Fator de Conversão Para KG

• O TOL possuí como característica o tratamento de peso apenas em KG, portanto, para que o TOTVS OMS envie o valor convertido é necessário cadastrar as unidades de medidas utilizadas e associar seu valor em KG.

• Para realizar esse cadastro acesse SIGAOMS > Atualizações > TOTVS Otimização Logística > Fator de Conversão (OMSA140), sendo necessário realizar esse cadastro para todas as unidades de medidas dos produtos que serão utilizadas na integração, cuja relação de peso não seja em KG.

• Exemplo de cadastro:

  Unidade de Medida (DK2_CODUM) → TL (tonelada), Peso em KG (DK2_PESOKG) → 1000. Isso significa que a cada uma tonelada são 1000 kg.

11.3. Modo de Compartilhamento Tabelas Viagem x Carga

• Para ambientes que utilizam diversas filiais e/ou empresas é necessário garantir que as tabelas de viagem DK0 e DK1 possuam a mesma  configuração de modo de acesso das tabelas de carga DAK e DAI.

• Exemplo:
  Se as tabelas de carga estiverem configuradas com os modos de acesso Ac. Filial = 2-Exclusivo, Ac. Unidade = 2-Exclusivo, Ac. Empresa = 2-Exclusivo, logo, as tabelas de viagem deverão possuir configuração idêntica. Esse detalhe é imprescindível para garantir a adequada ligação entre a viagem do TOL e a carga gerada pelo TOTVS OMS.

• Este ajuste deve ser realizado por meio do configurador do Protheus (SIGACFG).

12. Funcionalidades Não Contempladas

¹ _{É possível que uma viagem no TOTVS Otimização Logística contenha pedidos de diferentes empresas/filiais, para que este processo seja refletido no lado Protheus, é necessário que o Protheus esteja configurado para ser utilizado no modelo de Gestão de Empresas, parametrizando o TOTVS OMS para trabalhar no conceito de Operador Logístico, onde uma empresa/filial permanece como centralizadora das informações. Caso contrário poderá ocorrer de uma viagem que possuir pedidos de diferentes empresas/filiais seja quebrada em várias no Protheus, gravando cada parte da respectiva viagem, na empresa/filial dos pedidos, ou seja, uma viagem do TOL poderá gerar uma ou mais cargas no TOTVS OMS, não havendo nenhuma interface que permita ao usuário consultar este relacionamento.}

13. Informações Complementares

Por uma questão técnica, em função de poderem ser enviadas informações de diversas empresas/filiais do TOTVS OMS para o TOTVS Otimização Logística, porém, este trata tudo como uma única origem de dados, dependendo de configurações poderá gerar viagens com dados de diferentes empresas/filiais.

Sendo assim foi necessário criar no Protheus, de forma fixa, uma tabela que grave este relacionamento das viagens do TOL com as empresas/filiais do TOTVS OMS.

Esta tabela será criada automaticamente na primeira integração de viagem recebida.

A estrutura desta tabela (VIAGEM_OMSxCPL) é apresentada a seguir:

Não existe uma interface de consulta para esta tabela.

Ela será utilizada em processos internos para busca da empresa/filial em que a viagem está gravada para as solicitações de reprogramação e cancelamento recebidas do TOTVS Otimização Logística.

14. Quebras de Pedidos 

A integração encontra-se preparada para tratar a realização de quebras no pedido no TOTVS Otimização Logística, sendo que as quebras de pedidos no TOL ocorrem quando um pedido precisa ser dividido em mais de uma viagem e cada quebra gera um identificador único dentro do sistema.

O Protheus é informado dessas quebras no momento do recebimento da viagem, mais especificamente no XML de Publicação de Viagem (publishReleasedTrip) na tag orderBreakParts, conforme o exemplo:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soap:Body>
		<ns2:publishReleasedTrip xmlns:ns2="urn:neolog:cockpit:TripReleaseRequestPublishingService">
			<messageId>10082</messageId>
			<orderBreakParts>
				<orderBreakPart>
					<regionSourceId>DEFAULT</regionSourceId>
					<orderBreakPartId>81</orderBreakPartId>
					<orderSourceId>0101-000002-PED169</orderSourceId>
					<orderTypeSourceId>Padrao</orderTypeSourceId>
					<orderItemSourceId>0101-000002-PED169-01</orderItemSourceId>
					<loadId>1097</loadId>
					<shipmentUnitId>1</shipmentUnitId>
					<quantShipmUnits>10.0</quantShipmUnits>
					<quantProdUnits>10.0</quantProdUnits>
				</orderBreakPart>
			</orderBreakParts>
			<tripReleaseRequests>
				<tripReleaseRequest>
					<regionSourceId>DEFAULT</regionSourceId>
					<identifier>50316</identifier>
					<freightValue>0.0</freightValue>
					<carrierId>DEF</carrierId>
					<vehicleId>Padrao</vehicleId>
					<vehicleDescription>Veículo Padrão</vehicleDescription>
					<loads>
						<load>
							<identifier>1097</identifier>
							<serviceTypeId>1</serviceTypeId>
							<serviceTypeDescription>FULL_TRUCK_LOAD</serviceTypeDescription>
							<loadMode>2</loadMode>
							<modal>1</modal>
							<distance>460.92184</distance>
							<freight>0.0</freight>
							<stops>
								<stop>
									<identifier>1234</identifier>
									<localitySourceId>FIL-01-01</localitySourceId>
									<transportZoneId>Agrupador Padrão.ZT</transportZoneId>
									<transportZoneDescription>Agrupador Padrão.ZT</transportZoneDescription>
									<sequenceOnLoad>1</sequenceOnLoad>
									<subStops>
										<subStop>
											<identifier>1288</identifier>
											<arrivalTime>2019-07-15T00:01:00.000-03:00</arrivalTime>
											<startServiceTime>2019-07-15T00:01:00.000-03:00</startServiceTime>
											<endServiceTime>2019-07-15T00:16:00.000-03:00</endServiceTime>
											<departureTime>2019-07-15T00:16:00.000-03:00</departureTime>
											<loadedShipmentUnits>
												<shipmentUnit>
													<identifier>1494</identifier>
													<shipmentUnitCategoryId>1</shipmentUnitCategoryId>
													<shipmentUnitDescription>Fardo</shipmentUnitDescription>
													<shipmentUnitQty>10.0</shipmentUnitQty>
													<weight>10.0</weight>
													<volume>0.3025</volume>
													<length>0.55</length>
													<width>0.25</width>
													<height>0.22</height>
													<palletHeightTotal>0.0</palletHeightTotal>
													<deliveryUnitList>
														<deliveryUnit>
															<identifier>1494</identifier>
															<orderSourceId>0101-000002-PED169</orderSourceId>
															<orderTypeSourceId>Padrao</orderTypeSourceId>
															<orderItemSourceId>0101-000002-PED169-01</orderItemSourceId>
															<productSourceId>OMS001-0101</productSourceId>
															<quantity>10.0</quantity>
															<price>100.0</price>
															<deliveryDate>2019-07-15T00:16:00.000-03:00</deliveryDate>
															<integrationSource>DEFAULT</integrationSource>
														</deliveryUnit>
													</deliveryUnitList>
												</shipmentUnit>
											</loadedShipmentUnits>
										</subStop>
									</subStops>
								</stop>
								<stop>
									<identifier>1235</identifier>
									<localitySourceId>CLI-000001-01-01</localitySourceId>
									<transportZoneId>Agrupador Padrão.ZT</transportZoneId>
									<transportZoneDescription>Agrupador Padrão.ZT</transportZoneDescription>
									<sequenceOnLoad>2</sequenceOnLoad>
									<subStops>
										<subStop>
											<identifier>1289</identifier>
											<arrivalTime>2019-07-15T00:16:00.000-03:00</arrivalTime>
											<startServiceTime>2019-07-15T00:16:00.000-03:00</startServiceTime>
											<endServiceTime>2019-07-15T00:31:00.000-03:00</endServiceTime>
											<departureTime>2019-07-15T00:31:00.000-03:00</departureTime>
											<unloadedShipmentUnits>
												<shipmentUnit>
													<identifier>1494</identifier>
													<shipmentUnitCategoryId>1</shipmentUnitCategoryId>
													<shipmentUnitDescription>Fardo</shipmentUnitDescription>
													<shipmentUnitQty>10.0</shipmentUnitQty>
													<weight>10.0</weight>
													<volume>0.3025</volume>
													<length>0.55</length>
													<width>0.25</width>
													<height>0.22</height>
													<palletHeightTotal>0.0</palletHeightTotal>
													<deliveryUnitList>
														<deliveryUnit>
															<identifier>1494</identifier>
															<orderSourceId>0101-000002-PED169</orderSourceId>
															<orderTypeSourceId>Padrao</orderTypeSourceId>
															<orderItemSourceId>0101-000002-PED169-01</orderItemSourceId>
															<productSourceId>OMS001-0101</productSourceId>
															<quantity>10.0</quantity>
															<price>100.0</price>
															<deliveryDate>2019-07-15T00:16:00.000-03:00</deliveryDate>
															<integrationSource>DEFAULT</integrationSource>
														</deliveryUnit>
													</deliveryUnitList>
												</shipmentUnit>
											</unloadedShipmentUnits>
										</subStop>
									</subStops>
								</stop>
							</stops>
						</load>
					</loads>
				</tripReleaseRequest>
			</tripReleaseRequests>
		</ns2:publishReleasedTrip>
	</soap:Body>
</soap:Envelope>

O TOTVS Otimização Logística aguarda a aprovação destas quebras, por conta disso, ao enviar a mensagem de Desbloqueio de Viagem (doUnblockReleasedTrip), o TOTVS OMS envia a tag orderBreakResponses. 

Observe que neste momento o identificador do pedido também é alterado para concatenar o ID da quebra, desta forma, o identificador que antes era 0101-000002-PED169 se torna 0101-000002-PED169-81. No Protheus, o ID da quebra é armazenado na tabela de Sequência de Integração no campo DK3_QUEBID e na tabela de Itens da Viagem, no campo DK1_QUEBID.

A divisão do Pedido de Venda (SC9), para refletir a quebra ocorrida no TOL, será realizada no momento da montagem da carga.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header/>
	<soapenv:Body>
		<unb:doUnblockReleasedTrip xmlns:unb="http://www.neolog.com.br/cpl/acquisition/unblockRelTrip/" xmlns:erp="http://www.neolog.com.br/cpl/acquisition/eRPMessageResponse/" xmlns:ord="http://www.neolog.com.br/cpl/acquisition/orderBreakRemovalRequest/" xmlns:ord1="http://www.neolog.com.br/cpl/acquisition/orderBreakId/" xmlns:ord2="http://www.neolog.com.br/cpl/acquisition/orderBreakResponse/" xmlns:trip="http://www.neolog.com.br/cpl/acquisition/tripReleaseResponse/" xmlns:trip1="http://www.neolog.com.br/cpl/acquisition/tripLoadsSourceId/">
			<unb:unblockReleasedTrips>
				<unb:unblockReleasedTrips>
					<unb:unblockReleasedTrip>
						<unb:identifier>10082</unb:identifier>
						<unb:regionSourceId>DEFAULT</unb:regionSourceId>
						<unb:orderBreakResponses>
							<ord2:orderBreakResponses>
								<ord2:orderBreakResponse>
									<ord2:breakId>81</ord2:breakId>
									<ord2:orderId>0101-000002-PED169-81</ord2:orderId>
									<ord2:orderItemId>0101-000002-PED169-81-01</ord2:orderItemId>
									<ord2:regionSourceId>DEFAULT</ord2:regionSourceId>
									<ord2:status>1</ord2:status>
								</ord2:orderBreakResponse>
							</ord2:orderBreakResponses>
						</unb:orderBreakResponses>
						<unb:tripReleaseResponses>
							<trip:tripReleaseResponseList>
								<trip:tripReleaseResponses>
									<trip:tripReleaseResponse>
										<trip:itemId>0101-000002-PED169-01         </trip:itemId>
										<trip:orderSourceId>0101-000002-PED169            </trip:orderSourceId>
										<trip:regionSourceId>DEFAULT</trip:regionSourceId>
										<trip:status>1</trip:status>
										<trip:tripCode>50316</trip:tripCode>
									</trip:tripReleaseResponse>
								</trip:tripReleaseResponses>
							</trip:tripReleaseResponseList>
						</unb:tripReleaseResponses>
					</unb:unblockReleasedTrip>
				</unb:unblockReleasedTrips>
			</unb:unblockReleasedTrips>
		</unb:doUnblockReleasedTrip>
	</soapenv:Body>
</soapenv:Envelope>

15. Pontos de Entrada Relacionados

• DT PE OMSCPL6A - Permite alterar validações na desatualização de pedidos do TOL

• DT PE OMSCPL6B - Permite inserir validações no envio do pedido para o TOL

• DT PE OMSCPL7C - Permite a manipulação da carga gerada para viagem TOL

• DT PE OMSCPLAV - Permite a manipulação das tabelas da viagem (DK0 e DK1)

• DT PE OMSXCPL1 - Permite alterar o XML antes do envio para o TOL

• DT PE OSCP6QRY - Filtro dos pedidos que serão exibidos na rotina de Envio de Pedido para o TOL

• DT PE OMSTOL01 - Permite interromper a inclusão/alteração de registros das tabelas relacionadas ao processo de liberação de viagens pelo TOL (Totvs Otimização Logística)

16. Teste de Conexão Fora do Protheus

Para verificar se o problema de conexão está no Protheus ou no TOTVS Otimização Logística, é possível realizar uma requisição para o servidor do TOL por uma ferramenta externa, exemplo: SoapUI, Postman, entre outras.

Para tanto, é possível utilizar a Endereço WebService de Autenticação, informado no parâmetro MV_CPLUAUT, junto com os usuário e senha de acesso,

Exemplo

• Tipo de requisição: POST
• URL: URL Informada no parâmetro MV_CPLUAUT
• Body da requisição: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aut="http://www.neolog.com.br/cpl/gateway/authentication/">
<soapenv:Header/>
<soapenv:Body>
	<aut:credentials>
		<username>[email protected]</username>
		<password>ABC123</password>
	</aut:credentials>
</soapenv:Body>
</soapenv:Envelope>

O TOTVS Otimização Logística retornará com a informação do token de acesso.

Exemplo

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns3:authenticationToken xmlns:ns3="http://www.neolog.com.br/cpl/gateway/authentication/">
            <successful>true</successful>
            <token>f28b0bc763d1481aaa7f714c43660196</token>
        </ns3:authenticationToken>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

17. Validação de XMLS

Para impedir que ocorram inconsistência no Protheus por XMLS mal formatados, foi desenvolvida a funcionalidade de validar XMLS, baseadas em XSD.

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 XMLS passarão por uma pré-validação de estrutura.

17.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

17.1. Falhas de Estrutura

As falhas ocorridas durante o processo serão retornadas para o XML de Resposta e/ou Log Appserver:

• XXXX-XX-XXT09:39:25.122000-03:00 10084|OMSXWS > OMSValXSD > Verificando as configurações de validação de XML baseada em Schema XSD.

• XXXX-XX-XXT09: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.

• XXXX-XX-XXT09:39:25.123000-03:00 10084|OMSXWS > OMSValXSD > Análise das configurações de validação de baseada em Schema XSD concluída.

• XXXX-XX-XXT09: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

17.2. Falha na Liberação da Viagem

Caso ocorra falha na liberação da viagem, será retornado "N" para a Neolog-TOL e a inconsistência de estrutura estará no log do Protheus:

17.3. 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:

17.4. Se Não Estiver Habilitado

Estas mensagens serão exibidas no log e processo de validação será descartado:

• XXXX-XX-XXT10:42:29.347000-03:00 10292|OMSXWS > OMSValXSD > Verificando as configurações de validação de XML baseada em Schema XSD.
• XXXX-XX-XXT10: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.
• XXXX-XX-XXT10:42:29.347000-03:00 10292|OMSXWS > OMSValXSD > Análise das configurações de validação de baseada em Schema XSD concluída.

18. Geração de Logs

18.1. 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 terceiro parâmetro, LOGTIPOMS, define a forma de saída das mensagens.
• Para separar as mensagens e salvar com o nome de omscpl.log dentro da pasta system, informe ARQUIVO.
• Para salvar no log do Appserver (console.log), não coloque o parâmetro LOGTIPOMS no Appserver.ini ou informe como LOGTIPOMS=CONSOLE