Histórico da Página

Conteúdo

Image Modified

1. Contexto de Negócio

O TOTVS OMS passa a ter uma nova funcionalidade para realizar a montagem das cargas, o sequenciamento das entregas e a visualização do mapa das entregas.

Com base na seleção de um grupo de pedidos Pedidos ou itens de pedidos Pedidos de vendas Vendas liberados, veículos disponíveis e mais algumas configurações serão geradas cargas automaticamente de forma a otimizar a ocupação dos veículos e traçar a melhor rota de entrega dos pedidosPedidos.

Para utilizar essa funcionalidade, basta aderir ao plano (Complemento do termo de uso da TOTVS Store) que mais se adequa ao seu cenário e seguir as orientações descritas na sequência desse deste documento.Mais informações

Exemplo

Image Removed

Image Modified

2. Instalação /

Configuração

Para conferir se a aplicação dos pacotes está correta, na tabela abaixo são listados os fontes e suas versões mínimas:

Após a atualização dos pacotes da expedição contínua, caso seja necessário conferir se a aplicação dos pacotes está correta, na tabela abaixo são listados os fontes e suas versões mínimas:

2.1. Arquivos Relacionados ao Mapa (Data / Web)

Baixe aqui os arquivos index.html e tprchannel.js e salve na pasta Web do seu ambiente Protheus.

Exemplo: C:\Bases\environment\data\web. Estes arquivos serão mencionados novamente na configuração do Appserver.ini (2.4).

2.2. Atualização do Help

Para atualizar o Help de campos é necessário inserir (somente) o arquivo da expedição contínua hlppor.txt na pasta systemload e seguir os passos de acordo com o documento: Atualização de Help.

2.3. Atualização do Menu do OMS

Atualize o menu do Protheus OMS baixando somente o arquivo sigaoms.xnu, de acordo com o seu ambiente: 

• Atualização de menu com Dicionário no Banco: Atualização de menus que estão no Banco de Dados.

• Atualização de menu sem Dicionário no Banco: Atualizar menus dos módulos.

A atualização em questão cadastrará as novas rotinas de menu:

2.4. Configurações no Appserver.ini

Para realizar as integrações com o TPR é necessário possuir a configuração REST no ambiente, sendo possível reutilizar um Appserver ou gerar outro para receber as integrações REST.

Também é necessário realizar 3 blocos de configurações no Appserver.ini, conforme exemplos a seguir.

2.4.1. Configuração do REST do Protheus

Link para o documento: 1. Configuração do REST do Protheus.

;************************************
;*** REST
;************************************
[HTTPV11]
Enable=1
Sockets=HTTPREST
MAXSTRINGSIZE=500

[HTTPREST]
Port=8084
URIs=URIHTML
SECURITY=0

[URIHTML]
URL=/rest
PrepareIn=All
Instances=1,2
CORSEnable=1
AllowOrigin=*

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=environment1

[ONSTART]
JOBS=HTTPJOB
RefreshRate=120

2.4.2. Configuração HTTP

As configurações HTTP servem para a exibição do mapa de roteirizações. 

[HTTP]
ENABLE=1
PATH=C:\Bases\environment\data\web
PORT=8021   
INSTANCES=1,10    
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP

[10.173.11.38:8021/ws]
ENABLE=1
PATH=C:\Bases\environment\data\web
ENVIRONMENT=environment1
INSTANCENAME=WS_OMSCARGA
RESPONSEJOB=JOB_WS_OMS
DEFAULTPAGE=wsindex.apw

2.4.3. Configuração de Portais e Webservices

Link para o documento: Configurar Portais e Webservices.

[JOB_WS_OMS]
TYPE=WEBEX
ENVIRONMENT=environment1
INSTANCES=1,10

 MÓDULO       |   ROTINA                  |     	DESCRIÇÃO                                                                                                                                     |         VERSÃO MÍNIMA         
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Faturamento 		FATXFUN.PRX           	Funções Genéricas FAT                                                                                                                           	05/11/2021 19:21:13
Faturamento       	MATA410.PRX              	Pedidos                                                                                                                                                    	05/11/2021 19:21:13    
Faturamento       MATA461.PRX              	Preparação dos Documentos de Saída                                                                                                   	05/11/2021 19:21:13     
Faturamento       MATV410.PRW             	Funções para o Estorno de Pedidos                                                                                                        	05/11/2021 19:21:13  
OMS                   OMSA200.PRW            	Montagem de Carga                                                                                                                                 	25/11/2021 11:53:05
OMS                   OMSATPR1.PRW         	Envio de Pedidos - TPR (Menu)                                                                                                               	23/11/2021 23:09:29
OMS                   OMSATPR1A.PRW       	Funções do Envio de Pedidos - TPR                                                                                                       	23/11/2021 23:09:29 
OMS                   OMSATPR2.PRW         	Processamento do CallBack do retorno das viagens/carga - TPR                                                          	25/11/2021 11:53:05
OMS                   OMSATPR3.PRW         	Visualização do mapa da carga gerada (OMSA200 > Ações Relacionadas > Visualizar Mapa)            	16/11/2021 16:38:22
OMS                   OMSATPR4.PRW         	Validações para a alteração e estorno de pedidos integrados com o TPR                                             	16/11/2021 16:38:22 
OMS                   OMSXFUN.PRW           	Funções Genéricas WMS                                                           																16/11/2021 16:38:22
TMS                    TMSAC18.PRW            	Métodos de Envio - Integração Planejamento de Rotas																				12/11/2021 17:41:08 
TMS					TMSAC19.PRW			 	Painel Integração Planejamento de Rotas (TPR): Rotina que armazenará as informações 
                                                                 	referentes ao envio de informações para a integração TOTVS Planejamento de Rotas (TPR)					21/10/2021 15:44:14
TMS					TMSAC20.PRW				Configuração Planejamento de Rotas: Rotina principal para realizar o cadastro e habilitar a 
																	integração TOTVS Planejamento de Rotas (TPR)																						24/11/2021 08:36:16
TMS					TMSAC23.PRW				Controle de Integração Planejamento de Rotas: Rotina que armazenará as informações 
																	enviadas e recebidas. Toda a integração é enviado um arquivo no formato JSON e esse arquivo 
																	é armazenado na tabela DLU - Controle Integração Roteirizador.																18/10/2021 08:31:30
TMS					TMSAC24.PRW				Montagem e visualização do Mapa																											10/11/2021 10:57:59
TMS					TMSAC25.PRW				Montagem e visualização do Mapa																											08/11/2021 17:15:43
TMS					TMSAO15.PRW				Cadastro de Referência Geográfica																											08/11/2021 17:14:03
TMS					TMSAO48.PRW				Integração Rota Inteligente																															04/11/2021 19:11:31
TMS					TMSO46API.PRW			Métodos CallBack Planejamento de Rotas																									18/10/2021 09:29:54
TMS					index.html						Arquivo para exibição do mapa na pasta Web																							03/12/2021 15:51:41
TMS					tprchannel.js					Arquivo para exibição do mapa na pasta Web																							18:10:2021 08:22:31

Para que a integração ocorra é necessário realizar algumas configurações no Appserver.ini.

• Configuração do REST do Protheus (Appserver.ini)

Link para o documento: 1. Configuração do REST do Protheus

;************************************
;*** REST
;************************************
[HTTPV11]
Enable=1
Sockets=HTTPREST
MAXSTRINGSIZE=500

[HTTPREST]
Port=8084
URIs=URIHTML
SECURITY=0

[URIHTML]
URL=/rest
PrepareIn=All
Instances=1,2
CORSEnable=1
AllowOrigin=*

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=environment1

[ONSTART]
JOBS=HTTPJOB
RefreshRate=120

• Configurações HTTP (Appserver.ini)

[HTTP]
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
PORT=8021   
INSTANCES=1,10    
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP

[10.173.11.38:8021/ws] (Informação importante para apresentar o mapa. O campo URL Mapa HTML do programa TMSAC20, é realizado com "http://" + "10.173.11.38:8021/ws" + "/index.html").
ENABLE=1
PATH=C:\Bases\environment1\data\web  (Pasta que contém os arquivos index.html e tprchannel.js)
ENVIRONMENT=environment1
INSTANCENAME=WS_OMSCARGA
RESPONSEJOB=JOB_WS_OMS
DEFAULTPAGE=wsindex.apw

O IP e a Porta "10.173.11.38:8021" são exemplos para o cadastro.

O IP e a Porta cadastrados nessa seção precisam ser visualizados em toda a rede de acesso Smartclient. Caso exista algum bloqueio de rede, o mapa não será apresentado no Protheus.

• Configuração de Portais e Webservices (Appserver.ini)

Link para o documento: Configurar Portais e Webservices

[JOB_WS_OMS]
TYPE=WEBEX
ENVIRONMENT=environment1
INSTANCES=1,10               
INSTANCENAME=JOB_WS_OMS
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=All
SIGAWEB=WS

• Parâmetros Utilizados (SIGACFG)

Define a visualização do log de operações do TPR no ConsoleFile configurado.

Informe .F. após a implantação. 

Inclua no ini do REST, na seção do Enviroment, a chave FWTRACELOG=1

INSTANCENAME=JOB_WS_OMS
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=All
SIGAWEB=WS

2.5. Campos e Parâmetros Utilizados (SIGACFG)

2.5.1. Campos

2.5.2. Parâmetros

2.6. Configuração das URLs de Integração TPR

2.6.1. Configuração de E-mail do Usuário Para Utilização do TPR

• Acesse o SIGACFG > Usuário > Senhas > Usuários e selecione um usuário para receber o token de ativação TPR.
  
• Este token será enviado após a configuração do TPR na rotinaTMSAC20 (Config. Planejamento de Rotas).
  
  

Image Added

2.6.2. Acesse Atualizações > Planejamento de Rotas > Config. Planejamento de Rotas (TMSAC20)

• Realize as parametrizações conforme descrito a seguir:

• Após ser realizada a inclusão do registro, clique em Outras Ações > Testar Conexão para obter os dados do token do TPR.
  
• Esta ação enviará um e-mail e será necessário clicar em Ativar Token:
  
  

Image Added

Image Added3. Processo de Utilização

3.1. Premissas

• É necessário preencher o endereço completo dos clientes (endereço com número, CEP, bairro, cidade, estado e país) ou gerar as geolocalizações para as entidades na rotina TMSA015 (Referência Geográfica). 

• Quanto melhor for a qualidade das informações do endereço, maior a probabilidade de identificar corretamente as coordenadas atreladas ao mesmo.

• Também será possível verificar no mapa as coordenadas geolocalizadas e, caso as mesmas não representem o ponto exato, pode ser ajustado manualmente o marcador para a posição exata.

• Os veículos devem estar cadastrados na rotina OMSA060 (Cadastro de Veículos).

• Os pedidos de vendas (MATA410 - Pedidos de Venda) devem ter sido gerados e liberados (MATA440 - Liberação de Pedidos de Venda).
  

3.2. Como Enviar Pedidos Para a Roteirização

• Execute  a rotina OMSATPR1 (Envio de Pedidos) - TOTVS Planejamento de Rotas (TPR).

• Na tela Filtro para os Pedidos, informe os filtros para a exibição dos Pedidos de Venda e clique em OK.

• Selecione os Pedidos que devem ser enviados para a roteirização.

• Selecione os veículos que devem ser considerados no cálculo para utilização.

• Informe a quantidade de eixos para o cálculo do pedágio de cada veículo selecionado. Caso não sejam preenchidos os eixos, a quantidade será obtida por meio do Cadastro do Veículo.

• Informe os parâmetros para a roteirização.

• Clique em Enviar.

• Neste momento, os Pedidos e a roteirização permanecerão na situação Pendente, até o retorno da roteirização.

• Caso necessário, clique em Integrações do Item para visualizar a situação do envio e todos os itens de Pedidos enviados para a roteirização.
  
  

Image Added

3.3. Como Consultar o Status dos Pedidos Enviados e o Status da Integração

• Acesse a rotina TMSAC19 (Painel Integração Planejamento de Rotas (TPR)).

• A tabela superior apresenta a identificação da roteirização e seustatus.

• A tabela inferior apresenta os itens de pedidos enviados e a carga relacionada a cada item.

• No exemplo abaixo, foi necessária a geração de uma carga somente.

• Ao clicar em Controle de Integração serão visualizados os JSONS da integração e as informações de data/hora de envio e data/hora de retorno do processamento.
  
  

Image Added

3.4. Como Visualizar as Roteirizações

• Acesse a rotina OMSA200 (Montagem de Carga).

• Informe os parâmetros para a visualização das cargas;

• Encontre a carga gerada pelo TPR (INTEGRADO COM TPR (MAPA DISPONÍVEL) e clique em Visualizar Mapa TPR.
  
  

Image Added

3.5. Como Definir a Geolocalização Exata

• Acesse a rotina TMSA015 (Referência Geográfica).

• Inclua ou altere a geolocalização de um usuário.

• Clique em Confirmar.
  
  

Image Added

3.6. Como Realizar a Roteirização Via OMSA200

•  Acesse a rotina OMSA200 (Montagem de Carga), com a carga montada, e clique em Carregamento > Associar Veículo.
•  Informe o veículo da carga.
•  Informe a quantidade de eixos para o cálculo do pedágio do veículo selecionado, clicando em Outras Ações > Qtd. de Eixos Roteirização TPR.
•  Caso os eixos não sejam preenchidos, a quantidade será obtida pelo cadastro do veículo.
•  Informe os parâmetros para o planejamento da rota em Outras Ações > Parâmetros Roteirização TPR.
•  Clique em Outras Ações > Planejar Roteirização TPR.
•  Aguarde alguns minutos.
• Se a filial e os usuários não estiverem geolocalizadas, o Sistema efetuará a busca das coordenadas no envio do planejamento para o TPR.
  
  

Image Added

• Após aguardar alguns minutos, a roteirização será finalizada e apresentada com os pedágios e os pontos de paradas de cada cliente.
• Na roteirização abaixo foi considerado o retorno para a Filial, totalizando 5 pontos de parada do caminhão:
  
  

Image Added

3.7. Como Gerar um Ponto de Passagem na Roteirização

•  Acesse a rotina OMSA200 (Montagem de Carga).
•  Clique na carga roteirizada e, após, selecione a opção Outras Ações > Visualizar Mapa TPR.
•  Clique em Novo ponto e selecione o intervalo de paradas.
•  Clique duas vezes na área do mapa para adicionar o ponto de passagem e confirme.
•  Aguarde alguns segundos e clique em Atualizar ou pressione a tecla F5, para atualizar os dados da roteirização.
  
  

Image Added

3.8. Como Alterar um Ponto de Entrega na Roteirização

•  Acesse a rotina OMSA200 (Montagem de Carga).
•  Clique na carga roteirizada e, após, selecione a opção Outras Ações > Visualizar Mapa TPR.
•  No mapa, clique em Alterar localidade.
•  Mova o ponto do mapa cuja localidade exata deve ser alterada e confirme.
•  Aguarde alguns segundos e clique em Atualizar ou pressione a tecla F5 para atualizar os dados da roteirização.
  
  

Image Added

3.9. Como Alterar a Ordem das Entregas na Roteirização

•  Acesse a rotina OMSA200 (Montagem de Carga).
•  Clique na carga roteirizada e, após, selecione a opção Outras Ações > Visualizar Mapa TPR.
•  No mapa, clique em Trocar ordem das paradas.
•  Selecione as paradas cuja ordem deve ser alterada e confirme.
•  Aguarde alguns segundos e clique em Atualizar ou pressione a tecla F5 para atualizar os dados da roteirização.
  
  

Image Added

3.10. Como Funcionam as Restrições de Janelas de Entrega na Roteirização TPR

• Para ativar esta funcionalidade, em Outras Ações > Parâmetros do planejamento, selecione a opção Funcionamento entregas = Customizado.

• Esta opção deve ser selecionada na tela de Envio de Pedidos - TOTVS Planejamento de Rotas (TPR) ou na rotina OMSA200 (Montagem de Carga).

• Para a integração, o cadastro das regras e exceções nas rotinas OMSA120 (Cadastro de Regras de Entregas) e OMSA350 (Calendário de Janelas de Entregas) é limitado.

• São consideradas as regras para os usuários e as exceções para os veículos.
  
  

3.10.1 Cadastro de Regras Para Cliente(s)

• Informe o grupo de usuáriosou o cliente/loja da regra.

• Selecione ou não um calendário.

  • Se for selecionado um calendário, este deve ser do tipo Semanal, no qual são informados os dias da semana de trabalho.

  • Se não for selecionado um calendário, serão considerados todos os dias da semana com os horários preenchidos.

• Informe somente o tipo Regra.
  
  

Image Added

3.10.2 - Cadastro de Exceções Para Veículos

Por padrão, as regras de exceção dos veículos são validadas nas integrações TPR via Envio de Pedidos - TOTVS Planejamento de Rotas (TPR) (OMSATPR1) ou OMSA200 (Montagem de Carga).

Sendo assim, não é necessário selecionar a opção Funcionamento entregas = Customizado, para validar os veículos.

Image Added

•  Informe o grupo de usuários ou o usuário/loja da regra ou exceção para os veículos.
•  Ao informar o veículo, este não será considerado na roteirização TPR para este usuário ou grupo de usuários.
•  Ao informar o grupo de veículos, este não será considerado na roteirização TPR para este usuário ou grupo de usuários.

3.11. Como Cancelar Uma Roteirização Enviada

É possível desconsiderar o retorno da roteirização enviada, mas não cancelar a roteirização solicitada.

Ou seja, o ticket de integração será contabilizado, mas o retorno será desconsiderado no Protheus.

Image Added

3.12. Como Restringir a Alternância de Entrega Entre Estados

Image Added

3.13. Como Obter os Resultados da Busca de Geolocalizações

O log de integração é salvo quando a busca da geolocalização é realizada pela rotina OMSA200 (Montagem de Carga) ou OMSATPR1 (Envio de Pedidos - TPR).

Se o cliente/fornecedor já possui geolocalização (TMSA015), a busca não será realizada novamente.

• Para buscar, efetue a exclusão da entidade na rotina TMSAO15 (Referência Geográfica) e realize a roteirização.
• Após, acesse a rotina TMSAC23 (Controle de Integração Planejamento Rotas).
  
  

Image Added

• Gere um filtro para localizar o registro de integração desejado.
• Para o caso abaixo é Chave Entid. igual a "  00000501"  (Filial da entidade + Código da entidade + Loja da Entidade).
  
  

Image Added

• Filtre o registro desejado.
  
  

Image Added

• Clique em Visualizar.
• O conteúdo do campo Msg Envio (DLU_ENVIO) é o Json de envio para obter as coordenadas geográficas.
• E o conteúdo do campo Retorno Post (DLU_RETENV) é a resposta da API para a solicitação realizada.
  
  

Image Added

• Mais informações sobre as rotinas podem ser consultadas na tabela abaixo:

Image Added4. Informações Técnicas Sobre as Integrações - Incluindo Exemplos das Mensagens Trafegadas

A integração é realizada em APIS REST. 

Abaixo segue um resumo das integrações:

• Geração do Token (gerado na instalação). Documentação API: Criação de token.

• Geolocalização síncrona (realizada ao alterar clientes ou no envio de pedidos, quando o cliente não possui geolocalização). Documentação API: Integração de Geolocalização - Síncrona.

• Roteirização - essa API acontece em 3 etapas:

  1.  O Protheus envia os Pedidos,

  2.  Recebe uma resposta do recebimento do TPR.

  3.  Após o recebimento, o TPR retornará as viagens geradas em alguns minutos (3). Documentação API: Integração de Roteirização - ERPs

Segue o detalhamento das integrações:

4.1. Geolocalização

Retorna as coordenadas geográficas, de acordo com o endereço do usuário cadastrado (MATA030 - Cadastro de Clientes).

Integração executada ao alterar o usuário via MATA030 (Cadastro de Clientes) ou via Envio de Pedidos - TPR (OMSATPR1), quando o usuário não possui coordenadas geradas (TMSA015 - Tabela DAR).

• Exemplo de Envio
  

{
   "address":{
      "identifier":"  MG000101",
      "address":"AVENIDA CONTORNO, 6283       

{
   "address":{
      "identifier":"  MG000101",
      "address":"AVENIDA CONTORNO, 6283                                                          ",
      "state":"MG",
      "zipCode":"30110931",
      "country":"BRA",
      "city":"BELO HORIZONTE                                              "
   },
   "callbackAuthenticationType":"NONE",
   "dateCall":"2021-10-28T22:46:14",
   "callbackURL":"HTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
   "version":"7.00.191205P-20210601",
   "qualifiers":"{\"usuario\":\"Administrador\"}",
   "callbackAuthenticationValue":"",
   "system":"OMS"
}

{
   "dateCall":"2021-10-29T01:46:32.413Z",
   "version":"",
   "geolocationResult":{
      "identifier":"  MG000101",
      "success":true,
      "latitude":-19.9405175,
      "longitude":-43.9359666,
      "messages":[
         {
            "messageCode":"TPRGS0000",
            "message":"Sucesso."
         }
      ]
   }
}

{
   "vehicles":[
      {
         "identifier":"  000001",
         "speed":80,
         "weightCapacity":11000,
         "volumeCapacity":58,
         "quantity":1
      },
      {
         "identifier":"  PAM001",
         "speed":60,
         "weightCapacity":3220,
         "volumeCapacity":96,
         "quantity":1
      },
      {
         "identifier":"  000002",
         "speed":80,
         "weightCapacity":12500,
         "volumeCapacity":57,
         "quantity":1
      }
   ],
   "routingOptions":{
      "capacityCriteria":"WEIGHT",
      "routingInstantType":"D+1",
      "minServiceDuration":900000,
      "maxServiceDuration":7200000,
      "driverRestTimes":"Default",
      "considerReturnDistance":"True",
      "tollCalculation":"False"
   },
   "callbackAuthenticationType":"NONE",
   "dateCall":"2021-11-04T16:50:38",
   "callbackURL":"HTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
   "qualifiers":"{\"sistema\":\"PROTHEUS\",\"identifier\":\"04000000108\",\"usuario\":\"Administrador\",\"modulo\":\"OMS\",\"empresa\":\"99\",\"filial\":\"04\"}",
   "orders":[
      {
         "identifier":"04543517",
         "pickupTimeWindowEnd":"2021-11-12T18:00-03:00",
         "deliveryTimeWindowStart":"2021-11-05T08:00-03:00",
         "deliveryTimeWindowEnd":"2021-11-12T18:00-03:00",
         "serviceLoadDuration":null,
         "serviceUnloadDuration":null,
         "destination":{
            "identifier":"  CLISC101",
            "latitude":-18.85791,
            "longitude":-41.942810000000001,
            "name":"CL GOV. VALADARES MG",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         },
         "weight":1500,
         "volume":0.25,
         "pickupTimeWindowStartstate":"2021-11-05T08:00-03:00MG",
         "originzipCode":{"30110931",
      "country":"BRA",
      "identifiercity":"04-NEPOBELO JUNDIAIHORIZONTE - SP-TESTE",
            "latitude":-19.516919999999999,
            "longitude":-40.652200000000001,
            "name":"",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         }
      },
      {
         "identifiercallbackAuthenticationType":"04543520NONE",
         "pickupTimeWindowEnddateCall":"2021-1110-12T1828T22:00-0346:0014",
         "deliveryTimeWindowStartcallbackURL":"2021-11-05T08:00-03:00",
      HTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
   "deliveryTimeWindowEndversion":"2021-11-12T18:00-03:007.00.191205P-20210601",
         "serviceLoadDuration":null,
      "qualifiers":"{\"usuario\":\"Administrador\"}",
   "serviceUnloadDurationcallbackAuthenticationValue":null"",
         "destinationsystem":{
            "identifier":"  00458501""OMS"
}

{
   "dateCall":"2021-10-29T01:46:32.413Z",
   "version":"",
   "geolocationResult":{
      "latitudeidentifier":-19.361229999999999"  MG000101",
      "success":true,
      "longitudelatitude":-4019.0506099999999999405175,
      "longitude":-43.9359666,
      "namemessages":"CLIENTE LINHARES -ES",[
            "country":"BRA",{
            "operationmessageCode":"UNRESTRICTEDTPRGS0000",
         },
         "weightmessage":5000,"Sucesso."
         "volume":0.019008,}
      ]
   }
}

{
   "vehicles":[
      {
         "identifier":"  000001",
   "pickupTimeWindowStart":"2021-11-05T08:00-03:00",
         "origin":{
            "identifier":"04-NEPO JUNDIAI - SP-TESTE",
            "latitude":-19.516919999999999,
            "longitude":-40.652200000000001,
            "namespeed":""80,
            "countryweightCapacity":"BRA"11000,
            "operationvolumeCapacity":"UNRESTRICTED"58,
         }"quantity":1
      },
      {
         "identifier":"04543526  PAM001",
         "pickupTimeWindowEndspeed":"2021-11-12T18:00-03:00"60,
         "deliveryTimeWindowStartweightCapacity":"2021-11-05T08:00-03:00"3220,
         "deliveryTimeWindowEndvolumeCapacity":"2021-11-12T18:00-03:00"96,
         "serviceLoadDurationquantity":null,1
         "serviceUnloadDuration":null},
         "destination":{
            "identifier":"  PFISIC01000002",
            "latitudespeed":-20.30641999999999980,
            "longitudeweightCapacity":-40.35072000000000312500,
            "namevolumeCapacity":"VITÓRIA - ES"57,
            "countryquantity":"BRA",1
      }
   ],
   "operationroutingOptions":"UNRESTRICTED"{
      "capacityCriteria":"WEIGHT",
   },
   "routingInstantType":"D+1",
      "weightminServiceDuration":30900000,
         "volumemaxServiceDuration":0.0057200000,
         "pickupTimeWindowStartdriverRestTimes":"2021-11-05T08:00-03:00Default",
         "originconsiderReturnDistance":{"True",
            "identifierroutingType":"04-NEPO JUNDIAI - SP-TESTEROUTING",
             "latitude":-19.516919999999999,   "tollCalculation":"False"
         },
   "longitudecallbackAuthenticationType":-40.652200000000001"NONE",
            "namedateCall":"2021-11-04T16:50:38",
            "countrycallbackURL":"BRAHTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
       
       "operationqualifiers":"{\"UNRESTRICTED"
   sistema\":\"PROTHEUS\",\"identifier\":\"04000000108\",\"usuario\":\"Administrador\",\"modulo\":\"OMS\",\"empresa\":\"99\",\"routingType\":\"ROUTING\",\"filial\":\"04\"}",
   "orders":[
      }{
      }
   ]"identifier":"04543517",
   "restrictions":{
      "maxLoadingStopspickupTimeWindowEnd":1"2021-11-12T18:00-03:00",
      "maxUnloadingStops":99,
   "deliveryTimeWindowStart":"2021-11-05T08:00-03:00",
         "deliveryTimeWindowEnd"maxDistanceBetweenLoadStops":9000,
:"2021-11-12T18:00-03:00",
         "allowInterleavingserviceLoadDuration":"False"null,
         "maxDistanceBetweenUnloadStopsserviceUnloadDuration":3000null,
   }
}

{
   "success":true,
   "messagesdestination":[{
      {
         "messageCodeidentifier":"TPRRT0000  CLISC101",
            "messagelatitude":"Sucesso."-18.85791,
      }
      ]
}

{
"longitude":-41.942810000000001,
            "responseDatename":"2021-11-04T13:50:38.000-03:00CL GOV. VALADARES MG",
   "version":null,
   "summary":{
      "totalTripscountry":1"BRA",
      "totalDistance":790.2284089297932,
      "totalStopsoperation":4,"UNRESTRICTED"
      "totalVolume":0.27400800000000003,
   },
   "totalWeight":6530.0,
      "totalDurationweight":3.9160278E71500,
         "rejectedOrdersvolume":0.25,
      "rejectedWeight":0.0,
      "rejectedVolume":0.0
   },
   "pickupTimeWindowStart":"2021-11-05T08:00-03:00",  
         "tripsResultsorigin":[{
      {
      "identifier":"04-NEPO JUNDIAI - "sequential":0SP-TESTE",
            "distancelatitude":790-19.2284089297932516919999999999,
            "numberOfStopslongitude":5-40.652200000000001,
            "volumename":0.27400800000000003"",
            "weightcountry":6530.0"BRA",
            "durationoperation":39160278,"UNRESTRICTED"
         "extraTrip":false,}
      },
   "tollValue":0.0,
   {
         "considerReturnDistanceidentifier":true"04543520",
         "vehiclepickupTimeWindowEnd":"  0000012021-11-12T18:00-03:00",
         "stopsdeliveryTimeWindowStart":["2021-11-05T08:00-03:00",
            {
      "deliveryTimeWindowEnd":"2021-11-12T18:00-03:00",
         "sequenceserviceLoadDuration":0null,
               "typeserviceUnloadDuration":"LOAD"null,
               "localitydestination":{
                  "identifier":"04-NEPO JUNDIAI - SP-TESTE00458501",
                  "name":"""latitude":-19.361229999999999,
                  "country":"BR",
      "longitude":-40.050609999999999,
            "latitudename":-19.51692,
      "CLIENTE LINHARES -ES",
            "longitudecountry":-40.6522"BRA",
                  "operation":"UNRESTRICTED"
         },
        } "weight":5000,
         "volume":0.019008,
         "arrivalTimepickupTimeWindowStart":"2021-11-05T08:00:00.000-03:00",
         "origin":{
            "departureTimeidentifier":"2021-11-05T08:15:00.000-03:0004-NEPO JUNDIAI - SP-TESTE",
               "tollValuelatitude":0-19.0516919999999999,
               "distancelongitude":0-40.0652200000000001,
            "name":"",
            "loadedOrderscountry":[
"BRA",
            "operation":"UNRESTRICTED"
         {}
      },
      {
         "identifier":"0454351704543526",
         "pickupTimeWindowEnd":"2021-11-12T18:00-03:00",
            "volume":0.25"deliveryTimeWindowStart":"2021-11-05T08:00-03:00",
            "deliveryTimeWindowEnd":"2021-11-12T18:00-03:00",
         "weightserviceLoadDuration":1500.0null,
         "serviceUnloadDuration":null,
         },"destination":{
            "identifier":"  PFISIC01",
    {
         "latitude":-20.306419999999999,
            "identifierlongitude":"04543520"-40.350720000000003,
            "name":"VITÓRIA - ES",
            "volumecountry":0.019008"BRA",
            "operation":"UNRESTRICTED"
         "weight":5000.0},
         "weight":30,
         }"volume":0.005,
         "pickupTimeWindowStart":"2021-11-05T08:00-03:00",
         "origin":{
                "identifier":"04-NEPO JUNDIAI - SP-TESTE",
     "identifier":"04543526",
         "latitude":-19.516919999999999,
            "volumelongitude":0-40.005652200000000001,
            "name":"",
            "weightcountry":30.0"BRA",
             "operation":"UNRESTRICTED"
     }
    }
        }
   ],
   "restrictions":{
      "maxLoadingStops":1,
      "unloadedOrdersmaxUnloadingStops":[99,
      "maxDistanceBetweenLoadStops":9000,
      "allowInterleaving":"False",
      "maxDistanceBetweenUnloadStops":3000
       }
}

{
   "success":true,
   "messages":[
   ]
   {
         }"messageCode":"TPRRT0000",
            {"message":"Sucesso."
      }
   ]
}

{
   "responseDate":"2021-11-04T13:50:38.000-03:00",
   "sequenceversion":1null,
   "summary":{
      "totalTrips":1,
      "typetotalDistance":"UNLOAD"790.2284089297932,
         "totalStops":4,
      "localitytotalVolume":{0.27400800000000003,
      "totalWeight":6530.0,
      "totalDuration":3.9160278E7,
      "identifierrejectedOrders":"  PFISIC01"0,
      "rejectedWeight":0.0,
      "rejectedVolume":0.0
   },
   "nametripsResults":"VITÓRIA - ES",[
         {
         "countrysequential":"BR"0,
         "distance":790.2284089297932,
         "latitudenumberOfStops":-20.306425,
         "volume":0.27400800000000003,
         "longitudeweight":-406530.350720,
          "duration":39160278,
         "operationextraTrip":"UNRESTRICTED"false,
         "tollValue":0.0,
      },
   "considerReturnDistance":true,
            "arrivalTimevehicle":"2021-11-05T10:00:37.292-03:00  000001",
         "stops":[
            "departureTime":"2021-11-05T10:15:37.292-03:00",{
               "tollValuesequence":0.0,
               "distancetype":140.82872152560284"LOAD",
               "loadedOrderslocality":[{
                  
   "identifier":"04-NEPO JUNDIAI - SP-TESTE",
            ],
               "unloadedOrders":["name":"",
                  {
   "country":"BR",
                  "identifierlatitude":"04543526"-19.51692,
                     "volumelongitude":0-40.0056522,
                     "weightoperation":30.0
  "UNRESTRICTED"
                },
               ]"arrivalTime":"2021-11-05T08:00:00.000-03:00",
            },
            {   "departureTime":"2021-11-05T08:15:00.000-03:00",
               "sequencetollValue":20.0,
               "typedistance":"UNLOAD"0.0,
               "localityloadedOrders":{[
                  {
 "identifier":"  00458501",
                  "nameidentifier":"CLIENTE LINHARES -ES04543517",
                     "countryvolume":"BR"0.25,
                     "latitudeweight":-191500.36123,0
                  "longitude":-40.05061},
                  "operation":"UNRESTRICTED"
{
                     }"identifier":"04543520",
                     "arrivalTimevolume":"2021-11-05T12:04:01.970-03:00"0.019008,
               "departureTime":"2021-11-05T12:19:01.970-03:00",
            "weight":5000.0
         "tollValue":0.0,
               "distance":144.54840026439211},
               "loadedOrders":[
   {
               
         "identifier":"04543526",
      ],
               "unloadedOrdersvolume":[0.005,
                  {
   "weight":30.0
                  "identifier":"04543520",}
                     "volume":0.019008],
                     "weightunloadedOrders":5000.0[
                  }
               ]
            },
            {
               "sequence":31,
               "type":"UNLOAD",
               "locality":{
                  "identifier":"  CLISC101PFISIC01",
                  "name":"CLVITÓRIA GOV. VALADARES MG- ES",
                  "country":"BR",
                  "latitude":-1820.8579130642,
                  "longitude":-4140.9428135072,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T1505T10:5700:5737.551292-03:00",
               "departureTime":"2021-11-05T1605T10:1215:5737.551292-03:00",
               "tollValue":0.0,
               "distance":291140.901807944205182872152560284,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  {
                     "identifier":"0454351704543526",
                     "volume":0.25005,
                     "weight":150030.0
                  }
               ]
            },
            {
               "sequence":42,
               "type":"LOADUNLOAD",
               "locality":{
                  "identifier":"04-NEPO JUNDIAI - SP-TESTE00458501",
                  "name":"CLIENTE LINHARES -ES",
                  "country":"BR",
                  "latitude":-19.5169236123,
                  "longitude":-40.652205061,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T1805T12:5204:4001.278970-03:00",
               "departureTime":"2021-11-05T1805T12:5219:4001.278970-03:00",
               "tollValue":0.0,
               "distance":212144.949479195593254840026439211,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  {
               ]
      "identifier":"04543520",
      }
         ]
      }
"volume":0.019008,
    ],
   "rejections":[
      
   ],
     "messagesweight":[
5000.0
                  }
               ]
            },
            {
               "qualifierssequence":"{\"sistema\":\"PROTHEUS\",\"identifier\":\"04000000108\",\"usuario\":\"Administrador\",\"modulo\":\"OMS\",\"empresa\":\"99\",\"filial\":\"04\"}"
}

3,
               "type":"UNLOAD",
               "locality":{
                  "identifier":"  CLISC101",
                  "name":"CL GOV. VALADARES MG",
                  "country":"BR",
                  "latitude":-18.85791,
                  "longitude":-41.94281,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T15:57:57.551-03:00",
               "departureTime":"2021-11-05T16:12:57.551-03:00",
               "tollValue":0.0,
               "distance":291.9018079442051,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  {
                     "identifier":"04543517",
                     "volume":0.25,
                     "weight":1500.0
                  }
               ]
            },
            {
               "sequence":4,
               "type":"LOAD",
               "locality":{
                  "identifier":"04-NEPO JUNDIAI - SP-TESTE",
                  "name":"",
                  "country":"BR",
                  "latitude":-19.51692,
                  "longitude":-40.6522,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T18:52:40.278-03:00",
               "departureTime":"2021-11-05T18:52:40.278-03:00",
               "tollValue":0.0,
               "distance":212.9494791955932,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  
               ]
            }
         ]
      }
   ],
   "rejections":[
      
   ],
   "messages":[
      
   ],
   "qualifiers":"{\"sistema\":\"PROTHEUS\",\"identifier\":\"04000000108\",\"usuario\":\"Administrador\",\"modulo\":\"OMS\",\"empresa\":\"99\",\"routingType\":\"ROUTING\",\"filial\":\"04\"}"
 }

Exemplo

Peso

D+1

2

08:00

Dias úteis

Sim

1

700

700

4

00:30

04:00

18:00

Dias úteis

Exemplo

D+1

08:00

Dias úteis

Sim

00:30

04:00

18:00

Dias úteis

pickupTimeWindowEnd

deliveryTimeWindowStart

deliveryTimeWindowEnd

identifier

name

Image Added5. Funcionalidades Não Atendidas

5.1. Alocação de Veículos

Como a seleção de veículos é baseada na rotina OMSA230 (Alocação de Veículos), não são realizadas validações em veículos.     

5.2. Operador Logístico

No momento, a funcionalidade para Operador Logístico ainda não foi implementada na integração.

Image Added6. Fluxograma

6.1. Processo de Envio de Pedido de Vendas

6.2. Processo de Callback da Roteirização (Rotina em JOB)

6.3. Processo de Alteração de Rota / Mapa 

6.4. Callback Processo de Alteração de Rota / Mapa 

Image Added7. Pontos de Entrada

• DT PE OMSTPR01 - Permite alterar os dados de roteirização enviados ao TPR via OMSA200 (Processo de Sequenciamento)

• DT PE OMSTPR02 - Permite alterar os dados da geolocalização da origem no processo de roteirização TPR via OMSA200 (processo de sequenciamento)
• DT PE OM200PES - Cálculo do peso do produto

Image Added8. Customizações Disponíveis

8.1 Como Executar a API de Geolocalização Via User Function

É possível gerar as geolocalizações das entidades de forma customizada. Da mesma forma, ao enviar os Pedidos para integração via OMSATPR1 ou OMSA200, a geolocalização a ser considerada será cadastrada na tabela DAR. Caso contrário, poderá ser utilizado o Ponto de Entrada OMSTPR01 para alterar a geolocalização das entidades de entrega.

Segue a documentação oficial da API: Integração de Geolocalização - Síncrona.

Exemplo de Utilização da API em ADVPL

#include 'totvs.ch' 
#include "tbiconn.ch"


User Function XGETGEO()
	Local cEmpLog 	:= "99"
	Local cFilLog 	:= "01"
	Local cModLog 	:= "OMS"
	Local oJson 	:= JsonObject():New() 
	Local oQualif 	:= JsonObject():New()
	Local oAddress 	:= JsonObject():New()
	Local oResp 	:= Nil
	Local aHeader 	:= {} 
	Local cQualif 	:= ""
	Local cParams 	:= ""
	Local oRest 	:= FwRest():New('https://planejamentorotas.totvs.com/')
	Local lRet 	:= .F.


	PREPARE ENVIRONMENT EMPRESA cEmpLog FILIAL cFilLog MODULO cModLog

		//-- Elemento livre para controle interno
		oQualif["elementolivre1"]  := "conteudo para controle Y"
		oQualif["elementolivre2"]  := "conteudo A"
		oQualif["elementolivre3"]  := "conteudo X"
		cQualif := oQualif:ToJson()

		//Monta header
		Aadd(aHeader, "Accept: application/json" )
		Aadd(aHeader, "Content-Type: application/json" )

        //cole seu token aqui ou faça um seek para obter a DLV_TOKEN
		Aadd(aHeader, "TPR_AUTHORIZATION: " + '321f3-f32f32-f32-9cdd-e6d9f10ca60943f64ec1-e9f8-f32f32-a0b2-f' ) 

		oJson["dateCall"]                   := FwTimeStamp(3,dDataBase, Time() ) 
		oJson["system"]                     := cModulo
		oJson["qualifiers"]                 := cQualif

		//Endereco a ser pesquisado
		oAddress["identifier"]:= 'Código do cliente'
		oAddress["country"]	  := 'BRA'
		oAddress["state"]     := 'SC'
		oAddress["city"]      := 'JOINVILLE'
		oAddress["zipCode"]   := '89218-100'
		oAddress["address"]   := 'Avenida Santos Dumont, 831'
		oJson["address"]                := oAddress

		cParams := oJson:ToJson()

		oRest:SetPath( "v1/tpr-geolocation-sync" ) 
		oRest:SetPostParams( EncodeUTF8(cParams) )

		lRet := oRest:Post( aHeader )

		If lRet
			oResp := JSonObject():New()
			oResp:fromJson(Decodeutf8(oRest:GetResult()))
			conout(oResp["geolocationResult"]["latitude"])     //Retorno da latitude
			conout(oResp["geolocationResult"]["longitude"]) //Retorno da longitude
		Else
			conout(oRest:GetLastError())
			conout(oRest:GetResult())
		EndIf

	RESET ENVIRONMENT

Return

Operações em Pedidos que Possuem Roteirização (Validações)