Histórico da Página

Conteúdo

Image Modified1. 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 - https://tdn.totvs.com/x/LB2XJg que 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

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 maior for a qualidade das informações do endereço, maior a probabilidade de identificar corretamente as coordenadas atreladas ao mesmo.

• Os veículos devem estar cadastrados - Raquel QUAL O Programa?

• Os pedidos devem ter sido gerados e liberados - Raquel, onde libera? qual o status? onde olha

Image Added2. Instalação / Configuração

Image RemovedPré-requisitos Instalação / Implantação / Utilização

Para realizar a integração é necessário possuir os dicionários, novas rotinas ou atualizações das rotinas do Faturamento, OMS e TMS.

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:

Raquel Na tabela abaixo é possível colocar uma versão mínima/data? listar pacotes da expedição contínua

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

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   

[JOB_WS_OMS]
TYPE=WEBEX
ENVIRONMENT=environment1
INSTANCES=1,10               
SESSIONTIMEOUT=60
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

Indica qual código de operação será enviado ao TOTVS GFE, na geração da carga.

O mesmo deve ser cadastrado previamente no TOTVS GFE e vinculado.

Preencha o campo DAK_CDTPOP.

Código da Classificação de Frete Padrão utilizado na importação de Documentos de Carga.

Preencha o campo DAK_CDCLFR.

Define o número de incremento do campo Sequência de Entrega (DAK_SEQENT), na rotina OMSA200 (Montagem de Cargas).

Deve ser informado o conteúdo padrão igual a 5 (cinco).

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               
INSTANCENAME=JOB_WS_OMS
ONSTART=__WSSTART
ONCONNECT=__WSCONNECT
PREPAREIN=All
SIGAWEB=WS

2.5. Campos e Parâmetros Utilizados (SIGACFG)

2.5.1. Campos

• Arquivos Relacionados ao Mapa (Data / Web)

Verifique se os arquivos index.html e tprchannel.js constam na pasta Web, conforme PATH configurado (PATH=C:\Bases\environment1\data\web).

• Atualização do Menu do OMS

SIGAOMS.XNU

• Atualização do Help

hlppor.txt

• Aplicação do Pacote de Dicionários do TMS 009506 - Expedição Contínua

Para que sejam geradas as tabelas DMR e DMS.

O pacote criará os campos nas tabelas DLU e DLV.

• Aplicação do Pacote de Dicionários do OMS 009560 - Expedição Contínua

Para que sejam gerados os campos nas tabelas DA3 e DAK.

O pacote criará o parâmetro MV_TPRCLOG e os campos abaixo:

Campo Novo

Campo

DA3_VELOC

Tipo

Numérico

Tamanho

6

Decimal

0

Formato

Título

Veloc. média

Descrição

Velocidade média

Usado

Sim

Obrigatório

Não

Browse

Sim

Opções

When

Relação

Val. Sistema

Help

Informar a velocidade média do veículo.

Campo Novo

Campo

DAK_INTTPR

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Int. TPR

Descrição

Integração TPR

Usado

Sim

Obrigatório

Não

Browse

Não

Opções

1=Carga gerada pelo TPR

When

Relação

Val. Sistema

Help

Informa se a carga foi gerada através da integração com o TPR (TOTVS Planejamento de Rotas).

Campo Novo

Campo

DAK_VIAEXT

Tipo

Caractere

Tamanho

1

Decimal

0

Formato

Título

Viagem Extra

Descrição

Viagem extra do TPR

Usado

Sim

Obrigatório

Não

Browse

Não

Opções

1=Sim, 2=Não

When

Relação

"2"

Val. Sistema

Help

Indica se a viagem gerada pelo TPR é uma viagem extra.

Uma viagem extra é quando o TPR informa que durante a análise faltaram veículos para todos os pedidos.

Para poder entregar os pedidos, o planejamento sugeriu reutilizar um dos veículos enviados.

Parâmetro Novo

• Configuração das URLs de Integração TPR

Passo a passo TMSAC20

• Após a Geração e Ativação do Token no Passo Anterior Via TMSAC20

Ao alterar um cliente via MATA030 é realizada uma integração para obter a geolocalização, com base no cadastro do endereço. 

• Visualização da Geolocalização

A geolocalização pode ser incluída/alterada ou visualizada pela rotina Referência Geográfica (TMSA015 - SIGATMS).

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

Image Removed Integrações

A integração é realizada em APIS REST. Abaixo segue um resumo das integrações:

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

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

3. Roteirização. Essa API acontece em 3 etapas: O Protheus envia os pedidos (1) e recebe uma resposta do recebimento do TPR (2). 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:

• Geolocalização
  

  Retorna as coordenadas geográficas de acordo com o endereço do cliente cadastrado (MATA030).
  Integração executada ao alterar o cliente via MATA030 (Cadastro de Clientes) ou via Envio de Pedidos - TPR (OMSATPR1), quando o Cliente não possui coordenadas geradas (TMSAO15 - Tabela DAR).

            Exemplo de Envio

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

Exemplo de Retorno

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

De / Para Campos

{
   "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,
         "pickupTimeWindowStart":"2021-11-05T08:00-03:00",
         "origin":{
            "identifier":"04-NEPO JUNDIAI - SP-TESTE",
            "latitude":-19.516919999999999,
            "longitude":-40.652200000000001,
            "name":"",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         }
      },
      {
         "identifier":"04543520",
         "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":"  00458501",
            "latitude":-19.361229999999999,
            "longitude":-40.050609999999999,
            "name":"CLIENTE LINHARES -ES",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         },
         "weight":5000,
         "volume":0.019008,
         "pickupTimeWindowStart":"2021-11-05T08:00-03:00",
         "origin":{
            "identifier":"04-NEPO JUNDIAI - SP-TESTE",
            "latitude":-19.516919999999999,
            "longitude":-40.652200000000001,
            "name":"",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         }
      },
      {
         "identifier":"04543526",
         "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":"  PFISIC01",
            "latitude":-20.306419999999999,
            "longitude":-40.350720000000003,
            "name":"VITÓRIA - ES",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         },
         "weight":30,
         "volume":0.005,
         "pickupTimeWindowStart":"2021-11-05T08:00-03:00",
         "origin":{
            "identifier":"04-NEPO JUNDIAI - SP-TESTE",
            "latitude":-19.516919999999999,
            "longitude":-40.652200000000001,
            "name":"",
            "country":"BRA",
            "operation":"UNRESTRICTED"
         }
      } ",
   ],
   "restrictionsstate":{"MG",
      "maxLoadingStopszipCode":1"30110931",
      "maxUnloadingStopscountry":99"BRA",
      "maxDistanceBetweenLoadStopscity":9000,
"BELO HORIZONTE      "allowInterleaving":"False",
      "maxDistanceBetweenUnloadStops":3000
   }
}

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

{
"callbackAuthenticationType":"NONE",
   "responseDatedateCall":"2021-1110-04T1328T22:50:38.000-03:0046:14",
   "callbackURL"version":null:"HTTP://179.223.161.99:8084/REST/V1/WSTPRNEOLOG/",
   "summaryversion":{
      "totalTrips":1,
 "7.00.191205P-20210601",
     "totalDistance":790.2284089297932,
 qualifiers":"{\"usuario\":\"Administrador\"}",
     "totalStopscallbackAuthenticationValue":4"",
   "system":"OMS"
}

{
   "dateCall"totalVolume:":0.274008000000000032021-10-29T01:46:32.413Z",
   "version":"",
   "totalWeightgeolocationResult":6530.0,{
      "totalDurationidentifier":3.9160278E7"  MG000101",
      "rejectedOrderssuccess":0true,
      "rejectedWeightlatitude":0-19.09405175,
      "rejectedVolumelongitude":0-43.09359666,
   },
   "tripsResultsmessages":[
         {
         "sequential":0,
          "distancemessageCode":790.2284089297932,
         "numberOfStops":5,
         "volume":0.27400800000000003,
"TPRGS0000",
            "weightmessage":6530"Sucesso.0,"
         "duration":39160278,}
      ]
   }
}

{
   "vehicles":[
      {
         "identifier"extraTrip":false,
         "tollValue":0.0,
         "considerReturnDistance":true,
         "vehicle":"  000001",
         "stopsspeed":[80,
         "weightCapacity":11000,
   {
      "volumeCapacity":58,
         "sequencequantity":01
      },
      {
         "typeidentifier":"LOAD  PAM001",
               "localityspeed":{60,
         "weightCapacity":3220,
         "identifiervolumeCapacity":"04-NEPO JUNDIAI - SP-TESTE"96,
         "quantity":1
         "name":""},
         {
         "countryidentifier":"BR  000002",
         "speed":80,
         "latitudeweightCapacity":-19.5169212500,
         "volumeCapacity":57,
         "longitudequantity":-40.6522,1
      }
   ],
   "routingOptions":{
      "operationcapacityCriteria":"UNRESTRICTEDWEIGHT",
      "routingInstantType":"D+1",
         }"minServiceDuration":900000,
        "maxServiceDuration":7200000,
       "arrivalTimedriverRestTimes":"2021-11-05T08:00:00.000-03:00Default",
               "departureTime"considerReturnDistance":"2021-11-05T08:15:00.000-03:00True",
               "tollValueroutingType":0.0"ROUTING",
      "tollCalculation":"False"
         },
   "distancecallbackAuthenticationType":0.0"NONE",
               "loadedOrders":[
                  {
                     "identifier":"04543517",
                     "volume":0.25,
      "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\",\"routingType\":\"ROUTING\",\"filial\":\"04\"}",
   "orders":[
      {
         "weightidentifier":1500.0"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,
           "identifierdestination":"04543520",{
            "identifier":"  CLISC101",
            "volumelatitude":0-18.01900885791,
                     "weightlongitude":5000-41.0942810000000001,
            "name":"CL GOV. VALADARES MG",
   },
         "country":"BRA",
         {
   "operation":"UNRESTRICTED"
         },
         "identifierweight":"04543526"1500,
                     "volume":0.00525,
         "pickupTimeWindowStart":"2021-11-05T08:00-03:00",   
         "weightorigin":30.0{
            "identifier":"04-NEPO JUNDIAI     }- SP-TESTE",
               ]"latitude":-19.516919999999999,
               "unloadedOrderslongitude":[-40.652200000000001,
            "name":"",
      
      "country":"BRA",
         ]
   "operation":"UNRESTRICTED"
         },
      },
      {
               "sequence"identifier":1"04543520",
               "typepickupTimeWindowEnd":"UNLOAD2021-11-12T18:00-03:00",
               "locality":{"deliveryTimeWindowStart":"2021-11-05T08:00-03:00",
         "deliveryTimeWindowEnd":"2021-11-12T18:00-03:00",
         "identifierserviceLoadDuration":"  PFISIC01"null,
         "serviceUnloadDuration":null,
         "namedestination":"VITÓRIA - ES",
     {
             "countryidentifier":"BR  00458501",
                  "latitude":-2019.30642361229999999999,
                  "longitude":-40.35072050609999999999,
            "name":"CLIENTE LINHARES -ES",
    "operation        "country":"UNRESTRICTEDBRA",
            "operation":"UNRESTRICTED"
   },
      },
         "arrivalTimeweight":"2021-11-05T10:00:37.292-03:00"5000,
         "volume":0.019008,
         "departureTimepickupTimeWindowStart":"2021-11-05T10:15:37.29205T08:00-03:00",
         "origin":{
            "tollValueidentifier":0.0,
   "04-NEPO JUNDIAI - SP-TESTE",
            "distancelatitude":140-19.82872152560284516919999999999,
               "loadedOrderslongitude":[-40.652200000000001,
                  "name":"",
               ]"country":"BRA",
               "unloadedOrdersoperation":["UNRESTRICTED"
         }
      },
   {
   {
         "identifier":"04543526",
         "identifierpickupTimeWindowEnd":"045435262021-11-12T18:00-03:00",
         "deliveryTimeWindowStart":"2021-11-05T08:00-03:00",
            "volume":0.005"deliveryTimeWindowEnd":"2021-11-12T18:00-03:00",
            "serviceLoadDuration":null,
         "weightserviceUnloadDuration":30.0null,
                  }"destination":{
            "identifier":"   ]PFISIC01",
            }"latitude":-20.306419999999999,
            {"longitude":-40.350720000000003,
            "name":"VITÓRIA -  "sequenceES":2,
               "typecountry":"UNLOADBRA",
               "localityoperation":{"UNRESTRICTED"
         },
         "identifierweight":"  00458501"30,
         "volume":0.005,
         "namepickupTimeWindowStart":"CLIENTE LINHARES -ES2021-11-05T08:00-03:00",
         "origin":{
            "countryidentifier":"BR04-NEPO JUNDIAI - SP-TESTE",
                  "latitude":-19.36123516919999999999,
                  "longitude":-40.05061652200000000001,
                  "operation"name":"UNRESTRICTED",
               }"country":"BRA",
               "arrivalTimeoperation":"2021-11-05T12:04:01.970-03:00",UNRESTRICTED"
         }
      "departureTime":"2021-11-05T12:19:01.970-03:00",}
   ],
      "restrictions":{
      "tollValuemaxLoadingStops":0.01,
      "maxUnloadingStops":99,
         "distance"maxDistanceBetweenLoadStops":144.548400264392119000,
         "allowInterleaving":"False",
      "loadedOrdersmaxDistanceBetweenUnloadStops":[3000
   }
}

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

{
   "responseDate":"2021-11-04T13:50:38.000-03:00",
   "version":null,
   "summary":{
      "totalTrips":1,
         "totalDistance":790.2284089297932,
      "identifiertotalStops":"04543520"4,
      "totalVolume":0.27400800000000003,
         "totalWeight":6530.0,
      "volumetotalDuration":03.0190089160278E7,
      "rejectedOrders":0,
       "rejectedWeight":0.0,
        "weightrejectedVolume":50000.0
   },
   "tripsResults":[
      {
      }
   "sequential":0,
            ]"distance":790.2284089297932,
            }"numberOfStops":5,
         "volume":0.27400800000000003,
   {
      "weight":6530.0,
         "sequenceduration":339160278,
               "typeextraTrip":"UNLOAD"false,
               "localitytollValue":{0.0,
         "considerReturnDistance":true,
         "identifiervehicle":"  CLISC101000001",
         "stops":[
         "name":"CL GOV. VALADARES MG",
   {
               "countrysequence":"BR"0,
                  "latitudetype":-18.85791"LOAD",
                  "longitudelocality":-41.94281,{
                  "operationidentifier":"UNRESTRICTED"
               },
04-NEPO JUNDIAI - SP-TESTE",
                  "arrivalTimename":"2021-11-05T15:57:57.551-03:00",
                  "departureTimecountry":"2021-11-05T16:12:57.551-03:00BR",
                  "tollValuelatitude":0-19.051692,
                  "distancelongitude":291-40.90180794420516522,
                  "loadedOrdersoperation":["UNRESTRICTED"
                  },
               ]"arrivalTime":"2021-11-05T08:00:00.000-03:00",
               "unloadedOrders"departureTime":"2021-11-05T08:15:00.000-03:00",
               "tollValue":0.0,
               "distance":0.0,
               "loadedOrders":[
                  {
                     "identifier":"04543517",
                     "volume":0.25,
                     "weight":1500.0
                  },
               ]
   {
         },
            {
 "identifier":"04543520",
                     "sequencevolume":40.019008,
                     "typeweight":"LOAD",
5000.0
                  "locality":{},
                  "identifier":"04-NEPO JUNDIAI - SP-TESTE",
{
                     "nameidentifier":"04543526",
                     "countryvolume":"BR"0.005,
                     "latitudeweight":-1930.51692,0
                  "longitude":-40.6522,}
               ],
    "operation":"UNRESTRICTED"
           "unloadedOrders":[
    },
               "arrivalTime":"2021-11-05T18:52:40.278-03:00",

               ]
         "departureTime":"2021-11-05T18:52:40.278-03:00",
   },
            "tollValue":0.0,{
               "distancesequence":212.94947919559321,
               "loadedOrderstype":["UNLOAD",
               "locality":{
     
             "identifier":"  ]PFISIC01",
                  "unloadedOrdersname":["VITÓRIA - ES",
                  "country":"BR",
               ]
   "latitude":-20.30642,
         }
         ]
"longitude":-40.35072,
        }
       ],
   "rejectionsoperation":["UNRESTRICTED"
      
         ]},
   "messages":[
      
   ],
   "qualifiersarrivalTime":"{\"sistema\":\"PROTHEUS\",\"identifier\":\"04000000108\",\"usuario\":\"Administrador\",\"modulo\":\"OMS\",\"empresa\":\"99\",\"filial\":\"04\"}"
}

2021-11-05T10:00:37.292-03:00",
               "departureTime":"2021-11-05T10:15:37.292-03:00",
               "tollValue":0.0,
               "distance":140.82872152560284,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  {
                     "identifier":"04543526",
                     "volume":0.005,
                     "weight":30.0
                  }
               ]
            },
            {
               "sequence":2,
               "type":"UNLOAD",
               "locality":{
                  "identifier":"  00458501",
                  "name":"CLIENTE LINHARES -ES",
                  "country":"BR",
                  "latitude":-19.36123,
                  "longitude":-40.05061,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T12:04:01.970-03:00",
               "departureTime":"2021-11-05T12:19:01.970-03:00",
               "tollValue":0.0,
               "distance":144.54840026439211,
               "loadedOrders":[
                  
               ],
               "unloadedOrders":[
                  {
                     "identifier":"04543520",
                     "volume":0.019008,
                     "weight":5000.0
                  }
               ]
            },
            {
               "sequence":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.