Integrações

Páginas filhas
  • Integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR)

Versões comparadas

Versão antiga 144

changes.mady.by.user Carlos Augusto Pereira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vanessa Aparecida Martins de Melo

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Aviso
titleIMPORTANTE
  • A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).

Conteúdo

Âncora
indice
indice
Índice
maxLevel3
exclude.*Conteúdo
stylenone
printablefalse


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

Informações
iconfalse
titleIMPORTANTE
Informações adicionais sobre como será realizada a montagem da carga/sequenciamento da entrega podem ser
consultados em
obtidas no documento:
 
TOTVS Planejamento de Rotas.


2. Instalação / Configuração

Informações
iconfalse
titleATENÇÃO
  • Para instalar esta funcionalidade é obrigatório a contratação da Licença REST TOTVS "i" / ADD ON Webservices.
Informações
iconfalse
titleImportante
Para informações adicionais sobre esta licença, entre em contato com o ESN - Especialista de Soluções de Negócios.
  • Entretanto, já é possível utilizar a mesma estando nos Release é necessário atualizar com os pacotes abaixo mesmo estando no Release 12.1.33 do Protheus, pois basta . Basta baixar os pacotes de Expedição Contínua dos módulos: OMS, TMS e FAT.
Dicionário OMS - Pacote010703.zip e Pacote010786.zip. Pacote13840
    • 14735_12.1.33.zip  (Salva as geolocalizações na tabela DLU para que possam ser utilizadas para análises de resultados)


Após a atualização dos pacotes da expedição contínua, se desejar 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:

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.

24/05/2022 13:42:41

OMS

OMSATPR1.PRW

Envio de pedidos - TPR (Menu).

29

04/

06

01/

2022 16

2023 13:

37

48:

20

41

OMS

OMSATPR1A.PRW

Funções do envio de pedidos - TPR.

29

03/

06

01/

2022 16

2023 11:

37

41:

20

10

OMS

OMSATPR2.PRW

Processamento do callback do retorno das viagens/carga - TPR.

15

03/

06

01/

2022 19

2023 11:

09

41:

30

10

OMS  

OMSATPR3.PRW

Visualização do mapa da carga gerada (OMSA200 > Ações Relacionadas > Visualizar Mapa).

21/
06
10/2022
09
 22:
54
42:
30
49

OMS

OMSATPR4.PRW

Validações para a alteração e estorno de pedidos integrados com o TPR.

24

08/

05

09/2022

13

07:

42

20:

41

50

OMSOMSATPR5.PRWEnvio de roteirização TPR via OMSA200.
29
22/
06
11/2022
16
 11:
37
05:
20
49
OMSOMSATPR6.PRWRecebimento do callback de roteirização via OMSA200.
24
21/
05
10/2022
13
 22:42:
41
49
OMSOMSATPR7.PRWAtualização de rota e carga via callback.
15
08/
06
09/2022
19
07:
09
20:
30
50

OMS

OMSXFUN.PRW

Funções genéricas OMS.

16/11/2021 16:38:22

TMS

TMSAC18.PRW

Métodos de envio - Integração planejamento de rotas.

29

22/

06

11/2022

14

18:

52

37:

09

50

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

29

08/

06

09/2022

14

07:

52

20:

09

50

TMS

TMSAC23.PRW

Controle de Integração Planejamento de Rotas:
Rotina que armazenará as informações enviadas e recebidas.

Toda

Em toda a integração é enviado um arquivo no formato JSON

e esse

, sendo que este arquivo é armazenado na tabela DLU - Controle Integração Roteirizador.

03

08/

01

09/2022

15

07:

11

20:

55

50

TMS

TMSAC24.PRW

Montagem e visualização do mapa.

14

08/

01

09/2022

17

07:

47

20:

30

50

TMS

 TMSAC25.PRW

Montagem e visualização do mapa.

23

08/

05

09/2022

17

07:

38

20:

18

50

TMS

 TMSAO15.PRW

Cadastro de referência geográfica.

24

03/

06

01/

2022

2023 16:12:

06

42

TMS

TMSAO48.PRW

Integração

rota inteligente

Rota Inteligente.

03

23/

03

11/2022

11

 15:

02

46:

53

34

TMS

TMSO46API.PRW

Métodos callback Planejamento de Rotas.

29

21/

06

10/2022

15

 22:

29

42:

12

49

TMS

index.html 

Arquivo para exibição do mapa na pasta Web.

23/05/2022 17:30:42

TMS

tprchannel.js

Arquivo para exibição do mapa na pasta Web. 

18

:

/10

:

/2021 08:22:31

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 conforme documentação: Como atualizar help no Protheusde 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: 

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

Rotina

Menu

OMSATPR1

Envio de Pedidos - TOTVS Planejamento de Rotas (TPR)

TMSA015

Referência Geográfica

TMSAO15

Cadastro Referências Geográficas

TMSAC19

Painel Integração Planejamento de Rotas

TMSAC23

Controle de Integração Planejamento de Rotas

TMSAC20

Configuração Planejamento de Rotas

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.

Bloco de código
titleConfiguração REST
collapsetrue
;************************************
;*** 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. 

Bloco de código
titleConfiguração HTTP
collapsetrue
[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
Informações
iconfalse
titleIMPORTANTE

  • PATH: Diretório dos arquivos index.html e tprchannel.js que foram enviados para a pasta Web.

  • [Ip:Porta/WS]: Informação importante para apresentar o mapa. O IP e a Porta cadastrados nessa seção precisam ser visualizados em toda a rede de acesso Smartclient do ambiente. Caso exista algum bloqueio de rede interna, o mapa não será apresentado no Protheus.

  • Para que o mapa seja exibido, o servidor precisa ter acesso para a Api externa API externa https://planejamentorotas.totvs.com/tpr-client/v1.

2.4.3. Configuração de Portais e Webservices

Link para o documento: Configurar Portais e Webservices.

Bloco de código
titleConfiguração JOB
collapsetrue
[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

Informações
iconfalse
titleIMPORTANTE

Assinale, via SIGACFG, os seguintes campos como usados:

  • DAK_INTTPR: informa se a origem da geração da carga será via TPR.

  • DAK_VIAEXT: informa se a carga gerada é uma viagem extra.

  • DAK_DISROT:  Distância Distância da roteirização em quilômetros.  O campo deve ter tamanho 15, decimal 3 e máscara: @E 99,999,999,999.999.
  • DAK_TIMROT: Tempo total roteirização em horas e minutos.
  • DAK_VALROT: Valor total dos pedágios da roteirização;

2.5.2. Parâmetros

Parâmetro

Descrição

Valor

MV_ROTAINT

Habilita rotas inteligentes.

.T.

MV_TPRCLOG

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 Environment, a chave FWTRACELOG=1.

.F.

MV_OMSLROT

Define se é possível alterar a rota gerada.

.F.

MV_OMSUROT

Define a URL de callback da rota alterada.

URL não obrigatória.
Caso não seja informada , assumimos será assumido o campo DLV_URLCAL + /NEWROUTE.

MV_OMSPROT 

Na integração TPR, ao selecionar o funcionamento de entregas customizadas, define o funcionamento padrão para usuários sem regras de entrega.

Default "1"

"1 " = Sem restrição / "2" (padrão)
2 = Dias úteis /
"3 " = De manhã /
"4 " = À tarde

Se vazio, informa uma inconsistência de integração, caso o usuário não possua haja Janelas de Entregas definidas e o parâmetro do funcionamento das entregas esteja definido como customizado.

MV_HVERAO

Verifique Verifica se o local físico do servidor está em Horário de Verão (MV_HVERAO).

  • .F. - Não 
/
  • .T. - Sim  
(MV_HVERAO)

MV_CDTPOP

Indica qual o código de operação será enviado ao TOTVS GFE, na geração da carga, sendo que o mesmo deve ser cadastrado previamente no TOTVS GFE e vinculado.

Esse parâmetro alimentará o campo DAK_CDTPOP. 

5 (cinco)

MV_CDCLFR

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

Esse parâmetro alimentará o campo DAK_CDCLFR.


MV_OMSENTR

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

Informar Informe o conteúdo padrão igual a 5 (cinco).
MV_PESOCAR Quando o parâmetro MV_PESOCAR estiver como "L" será enviado o campo B1_PESO; caso contrário, B1_PESBRU.L

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

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

  • Realize as parametrizações conforme descrito a seguir:
CampoDescrição
ID Cliente
:

Campo livre para identificação.

URL Callback (REST)
:

Essa URL é enviada do Protheus para a API TPR, ao solicitar a roteirização TPR. Nesta solicitação, a API TPR realizará a rejeição ou confirmação dos Pedidos para planejamento.

Se for confirmado o recebimento, após alguns minutos, a API TPR consumirá a URL Callback (URL REST) do servidor Protheus, para enviar os dados referentes ao cálculo de roteirização. Informe o IP e Porta externa do servidor 

Rest

REST do Protheus (IP:PORTA + /REST/V1/WSTPRNEOLOG/) para utilização no recebimento dos retornos do TOTVS Planejamento de Rotas (TPR) referente a Roteirização.

Informações
iconfalse
title
IMPORTANTE
Importante
  • A URL de callback precisa ser acessada exclusivamente pelo IP do TPR:
35
  • 34.
231
  • 148.
153
  • 87.
141
  • 2.
  • É possível realizar um teste de acesso liberando a URL IP:PORTA + /REST/V1/WSTPRNEOLOG/ para outro computador e acessando via navegador.
  • Caso a liberação de acesso seja realizada corretamente, o retorno abaixo será realizado:
 Token:

Image Modified

  • Bloqueado: Informe 2 - Não.

    • Libere também para acesso externo a URL IP:PORTA + /REST/V1/WSTPRNEOLOG/NEWROUTE/

    Bloqueado

    Informe 2 - Não.

    Token
    Campo não editável. Será preenchido automaticamente no teste de conexão a seguir.
    Data Token
    :
    Campo não editável. Será preenchido automaticamente no teste de conexão a seguir.
    Hora Token
    :
    Campo não editável. Será preenchido automaticamente no teste de conexão a seguir.
    Tipo Retorno
    :

    Informe 1- Callback.

    URL Mapa HTML
    :

    Informe o IP e Porta do servidor Webservice do Protheus (IP:PORTA +

     

    /ws/index.html), para utilização no serviço de Mapa do

     TOTVS

    TOTVS Planejamento de Rotas (TPR). 

    IP e
    porta: informados
    Porta

    Informados no AppServer, em Configurações HTTP

    . Essa informação

    , essa informaçãoé importante para apresentar o mapa.
    O IP e a Porta cadastrados nessa seção precisam ser visualizados em toda a rede de acesso Smartclient do ambiente.
    Caso exista algum bloqueio de rede interna, o mapa não será apresentado no Protheus.

    Roteirizador
    :

    Informe 2 - TPR Neolog.

    URL Token
    :

    URL disponibilizada pelo TPR para controle do Token

    do 

    do TOTVS Planejamento de Rotas (TPR).
    Utilize HTTPS://PLANEJAMENTOROTAS.TOTVS.COM/V1/TPR-TOKEN-CREATION

     

      

    URL Roteirização
    :
    URL disponibilizada pelo TPR para controle dos serviços de Roteirização do
    TOTVS 
    TOTVS Planejamento de Rotas (TPR).
    Utilize HTTPS://PLANEJAMENTOROTAS.TOTVS.COM/V1/TPR-ROUTING
    URL Geocode
    :
    URL disponibilizada pelo TPR para controle dos serviços de Geolocalização
    do TOTVS
    do TOTVS Planejamento de Rotas (TPR).
    Utilize HTTPS://PLANEJAMENTOROTAS.TOTVS.COM/V1/TPR-GEOLOCATION-SYNC
    URL Geo Assi
    :

    URL disponibilizada pelo TPR para controle dos serviços de Geolocalização Assíncrona doTOTVS Planejamento de Rotas (TPR).
    Utilize HTTPS://PLANEJAMENTOROTAS.TOTVS.COM/V1/TPR-GEOLOCATION

    Image Modified

    Os campos

    Token

    ,

    / Data Token

     e 

    / Hora Token

    Estes campos serão preenchidos automaticamente pelo retorno do TOTVS Planejamento de Rotas (TPR).



    Informações
    iconfalse
    titleIMPORTANTE
    Acessar o Protheus com o usuário que possua o e-mail que fará o vínculo com a API TPR.


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

    Informações
    iconfalse
    titleIMPORTANTE

    • Caso possua a haja integração configurada com o Maplink configurada, é necessário desabilitar essa integraçãodesabilitá-la.

    • Para isso, acesse a rotina TMSAO52 (Cadastro Roteirizador) e altere o campo Bloqueado para 1 - Sim.


    3. 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 deseja enviar devem ser enviados para a roteirização.

    • Selecione os veículos que deseja considerar 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 Cadastro do veículoVeí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.

    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 JSONS da integração e as informações de data/hora de envio e data/hora de retorno do processamento.

    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.

    3.5. Como Definir a Geolocalização Exata

    • Acesse a rotina TMSAO15(Cadastro de referências geográficas); TMSA015 (Referência Geográfica).

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

    • Clique em Confirmar.

    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
    •  Caso os eixos não sejam preenchidos os eixos, 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.



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

    3.7. Como

    criar

    Gerar um

    ponto

    Ponto de

    passagem

    Passagem na

    roteirização

    Roteirização

    •  Acesse a rotina OMSA200 - (Montagem 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.

    3.8. Como

    alterar

    Alterar um

    ponto

    Ponto de

    entrega

    Entrega na

    roteirização

    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 que deseja alterar a 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.

    3.9. Como

    alterar

    Alterar a

    ordem

    Ordem das

    entregas

    Entregas na

    roteirização

    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 que deseja alterar a ordem 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.

    3.10. Como

    funcionam

    Funcionam as

    restrições

    Restrições de Janelas de Entrega na

    roteirização

    Roteirização TPR

    • Para ativar

    a funcionalidade é necessário selecionar a opção Funcionamento entregas = Customizado

    • esta funcionalidade, em Outras Ações > Parâmetros do planejamento

    .

    • , selecione a opção Funcionamento entregas = Customizado.

    • Esta opção

    Esta opção Calendários-
    Informações
    titleIMPORTANTE
    • O parâmetro MV_OMSPROT define como será o funcionamento das entregas padrão, caso o usuário não possua Janelas de Entrega cadastradas.
    • Se este parâmetro estiver vazio, o TPR informará que o usuário não possui há Janelas de Entrega para roteirização.


    3.10.1 Cadastro de

    regras para cliente

    Regras Para Cliente(s)

    Image Removed
    •  Informe

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

    •  Selecione

      Selecione ou não um calendário.

       Caso seja

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

       Caso não seja informado o

      • Se não for selecionado um calendário,

      consideramos

      • serão considerados todos os dias da semana com os horários preenchidos.

    •  Informe

      Informe somente o tipo Regra.

    Image Added

    3.10.2 - Cadastro de

    exceções para veículos

    Exceções Para Veículos

    Por padrão, as regras de exceção dos veículos são validados 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.



    •  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, estes este não serão considerados será considerado na roteirização TPR para este usuário ou grupo de usuários.

    3.11.

    É possível cancelar uma roteirização enviada?

    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.

    3.12

    -

    . Como

    restringir

    Restringir a

    alternância de entrega entre estados

    Image Removed

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

    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.

    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:

    Rotina

    Implementação

    TMSAC20 - Configuração Planejamento de Rotas

    Parametrize as URLs e gere o token. 

    MATA030 - Cadastro de Clientes

    Verifique os endereços dos usuários e o País.

    EICA100 - Países 

    Verifique a sigla BRA, para o país Brasil.

    OMSA060 - Veículos

    Informe o novo campo:

      • DA3_VELOC.: se este campo não for preenchido, o TPR considerará 30km/h.
      • DA3_QTDEIX: quantidade de eixos na ida para cálculo do pedágio. Default 6.
      • DA3_QTEIX: quantidade de eixos na volta para cálculo do pedágio. Default 4.

    TMSAO15 - Referência Geográfica

    • Verifique as coordenadas geradas para os usuários e a localização no mapa.
    • A rotina permite que sejam geradas as coordenadas para o usuário, mesmo que este não possua endereço cadastrado.

    Informações
    iconfalse
    titleImportante
    • É possível alterar as coordenadas geradas de um usuário por meio do marcador no mapa.
    • Deste modo, é possível destacar o ponto exato para o endereço, caso não existam formas de geolocalizá-lo via API.

    MATA010 - Produtos

    • Verifique os campos B1_PESO, B1_PESBRU, B5_ALTURLC, B5_LARGLC e B5_COMPRLC.

    MATA410 - Pedidos de Venda 

    • Gere os Pedidos para os usuários.
    • Libere os Pedidos.

    OMSATPR1 - Envio de Pedidos - TOTVS Planejamento de Rotas (TPR)

    • Selecione os Pedidos, os veículos e informe os parâmetros (F6).
    • Ao enviar os Pedidos, o browse de Pedidos será atualizado e os mesmos aparecerão com a situação Pendente.
    • Será gerada uma roteirização na tabela DMR (Roteirização - TPR) e os itens serão identificados na tabela DMS (Itens Roteirização - TPR)
    • Para visualizar esta integração, clique em Integrações do Item, na rotina OMSATPR1 (Envio de Pedidos), ou acesse diretamente a rotina TMSAC19 (Consulta Planejamento de Rotas).

    TMSAC19 - Painel Integração Planejamento de Rotas (TPR)

    • Apresenta a situação da integração, bem como, o resultado de cada item, sendo que os itens são gravados separadamente por meio de cada SC9 do Pedido liberado.
    • Ao realizar a seleção de um Pedido para integração, serão considerados apenas os itens liberados.
    • Os itens poderão ser apresentados nas seguintes situações:
        • Pendente: quando o item foi enviado e está aguardando retorno do planejamento TPR.Processado: quando houve retorno do TPR e foi gerada carga (viagem) para o item. Apresenta o código da carga gerada para o item. Permite visualizar o mapa através da rotina. Existem 2 possibilidades:
            1. Todas as cargas geradas pelo botão do browse superior Visualizar mapa.
            2. Ou apenas a carga relacionada a um item (DMS), clicando em Visualizar mapa, no botão do browse inferior.
        • Rejeitado: quando houve retorno do TPR, mas o mesmo informa que por regra de negócio informada para planejamento é impossível gerar viagem para o item).
          Exemplo: a capacidade do veículo é menor do que qualquer um dos pedidos selecionados.
        • Falha no processamento: quando houve alguma inconsistência no ERP, que não permitiu o processamento com os dados de retorno.
          Apresenta o motivo da rejeição do TPR.
          Exemplo: quando o Protheus não foi configurado corretamente (patch ou dicionários).
    • O TMSAC19 permite o cancelamento do envio para a alteração dos Pedidos por meio do botão Cancelar Envio, sendo que aalteração do envio não será realizada no TPR. Este cancelamento apenas desconsidera qualquer resultado do planejamento.
    • Nessa rotina é possível acionar o JSONS gerados na API de roteirização, por meio da aba Controle de Integração. Esta aba acessa a rotina TMSAC23 (Controle de Integração Planejamento de Rotas).

    TMSAC23 - Controle de Integração

    Apresenta o JSON de envio de Pedidos, no qual o TPR realiza uma validação prévia para processamento e retorna ao Protheus.

    Caso a validação retorne sucesso, o TPR mantém o processamento e retornará um Callback para o Protheus, após alguns minutos.

    Todas essas mensagens são registradas para análise, caso seja necessário.

    OMSA200 - Montagem de Carga

     No sucesso do planejamento TPR serão geradas as cargas, sendo que estas poderão ser visualizadas.

    O campo que apresenta a disponibilização do mapa é o DAK_STROTE, com a informação Integrado com TPR (Mapa disponível).

    Para visualizar o mapa, clique em Outras

    Rotina

    Implementação

    TMSAC20 - Configuração Planejamento de Rotas

    Parametrize as URLs e gere o token. 

    MATA030 - Cadastro de Clientes

    Verifique os endereços dos usuários e o país.

    EICA100 - Países 

    Verifique a sigla BRA, para o país Brasil.

    OMSA060 - Veículos

    Informe o novo campo:

    • DA3_VELOC. Se este campo não for preenchido, o TPR considerará 30km/h.
    • DA3_QTDEIX. Quantidade de eixos na ida para cálculo do pedágio. Default 6.
    • DA3_QTEIXV. Quantidade de eixos na volta para cálculo do pedágio. Default 4.

    TMSAO15 - Coordenadas Geográficas

    Verifique as coordenadas geradas para os usuários e a localização no mapa.

    A rotina permite que sejam geradas as coordenadas para o usuário, mesmo que ele não possua endereço cadastrado.

    Informações
    titleImportante
    • É possível alterar as coordenadas geradas de um usuário por meio do marcador no mapa.
    • Deste modo, é possível destacar o ponto exato para o endereço, caso não existam formas de geolocalizá-lo via API.

    MATA010 - Produtos

    Verifique os campos B1_PESO, B1_PESBRU, B5_ALTURLC, B5_LARGLC e B5_COMPRLC.

    MATA410 - Pedidos

    Gere os Pedidos para os usuários.

    Libere os Pedidos..

    OMSATPR1 - Envio de Pedidos - TOTVS Planejamento de Rotas

    Selecione os Pedidos, os veículos e informe os parâmetros (F6).

    Ao enviar os Pedidos, o browse de Pedidos será atualizado e os mesmos aparecerão com a situação Pendente.

    Será gerada uma roteirização na tabela DMR (Roteirização - TPR) e os itens serão identificados na tabela DMS (Itens Roteirização - TPR).

    Para visualizar esta integração, clique em Integrações do Item, na rotina OMSATPR1 (Envio de Pedidos), ou acesse diretamente a rotina TMSAC19 (Consulta Planejamento de Rotas).

    TMSAC19 - Painel Integração Planejamento de Rotas (TPR)

    Apresenta a situação da integração, bem como, o resultado de cada item, sendo que os itens são gravados separadamente por meio de cada SC9 do Pedido liberado.

    Ao realizar a seleção de um pedido para integração, serão considerados apenas os itens liberados.

    Os itens poderão ser apresentados nas seguintes situações:

    • Pendente: quando o item foi enviado e está aguardando retorno do planejamento TPR.
    • Processado: quando houve retorno do TPR e foi gerada carga (viagem) para o item. Apresenta o código da carga gerada para o item. Permite visualizar o mapa através da rotina. Existem 2 possibilidades: Todas as cargas geradas através do botão do browse superior Visualizar mapa ou apenas a carga relacionada a um item (DMS), clicando em Visualizar mapa no botão do browse inferior.
    • Rejeitado: quando houve retorno do TPR, mas o mesmo informa que por regra de negócio informada para planejamento é impossível gerar viagem para o item). Exemplo: a capacidade do veículo é menor do que qualquer um dos pedidos selecionados.
    • Falha no processamento: quando houve alguma inconsistência no ERP, que não permitiu o processamento com os dados de retorno. Apresenta o motivo da rejeição do TPR. Exemplo: quando o Protheus não foi configurado corretamente (patch ou dicionários).

    O TMSAC19 permite o cancelamento do envio para a alteração dos pedidos por meio do botão Cancelar Envio. A alteração do envio não será realizada no TPR. Este cancelamento apenas desconsidera qualquer resultado do planejamento.

    Nessa rotina é possível acionar o JSONS gerados na API de roteirização, por meio da aba Controle de Integração. Esta aba acessa a rotina TMSAC23 (Controle de Integração).

    TMSAC23 - Controle de Integração

    Apresenta o JSON de envio de Pedidos, no qual o TPR realiza uma validação prévia para processamento e retorna ao Protheus.

    Caso a validação retorne sucesso, o TPR mantém o processamento e retornará um CallBack para o Protheus, após alguns minutos.

    Todas essas mensagens são registradas para análise, caso seja necessário.

    OMSA200 - Montagem de Carga

     No sucesso do planejamento TPR serão geradas as cargas, sendo que estas poderão ser visualizadas.

    O campo que apresenta a disponibilização do mapa é o DAK_STROTE, com a informação Integrado com TPR (Mapa disponível).

    Para visualizar o mapa, clique em Outras Ações > Visualizar Mapa TPR. 

    A visualização do mapa apresenta a ordem de entregasentrega, o tempo de serviço, quilometragem, peso, volume, duração, o retorno para a filial (caso parametrizado), 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).

    Informações
    titleImportante
    • O primeiro ponto será sempre a partida (filial).
    • O retorno para a filial considera mais um ponto de parada.
    • Uma carga roteirizada pode ser alterada, mas perderá o mapa gerado.
    • O estorno na carga liberará os itens dos pedidos Pedidos da carga para serem utilizados em outro planejamento na rotina OMSATPR1 (Envio de Pedidos).
    • O motorista pode ser informado depois da carga gerada.
    • O campo DAK_INTTPR informa se a origem da carga é no TPR.
    • O campo DAK_VIAEXT informa se é uma carga/viagem extra.
    • O campo de time service é calculado via integração com base na subtração da data/hora de saída da entrega - data/hora de saída de chegada na entrega.

    MATA410 - Pedidos

    Ao realizar a alteração de um Pedido que foi enviado para roteirizar, o usuário receberá um alerta sobre o relacionamento.

    Neste caso, o usuário tem a opção de manter o Pedido sem alteração e manter a roteirização ou de continuar a alteração do Pedido e perder os dados de roteirização.

    MATA461 - Preparação dos Documentos de Saída

    Ao confirmar o estorno da liberação de um Pedido que possua roteirização, o usuário receberá um alerta que perdeu a roteirização relacionada ao item.


    4. 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 - essa API acontece em 3 etapas:

      1.  O Protheus envia os pedidosPedidos,

      2.  E recebe  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 (TMSAO15 TMSA015 - Tabela DAR).

    • Exemplo de Envio
    Bloco de código
    titleJSON de Envio ao TPR
    collapsetrue
    {
   "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
    Bloco de código
    titleJSON de Retorno do TPR
    collapsetrue
    {
   "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

    Elemento

    Campo

    Descrição

    identifier

    FwXfilial("SA1") + A1_COD+A1_LOJA ou FwXfilial("SA2")+A2_NOME+A2_LOJA   

    Chave do Cliente ou Fornecedor

    country

    A1_PAIS ou A2_PAIS  (SYA.YA_SIGLA)

    País do Cliente ou Fornecedor (EICA100 - Países) Países.

    state

    A1_EST ou A2_EST  

    Campo do Estado

    city

    A1_MUN ou A2_MUN  

    Campo do Município

    zipCode

    A1_CEP ou A2_CEP  

    Campo do CEP

    address

    A1_END ou A2_END  

    Campo do endereço, número

    4.2. Envio de Pedidos Para Roteirização

    A integração depende dos Pedidos, dos veículos selecionados e dos parâmetros de integração:

    Bloco de código
    titleJSON de Envio ao TPR
    collapsetrue
    {
   "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",
      "routingType":"ROUTING",
      "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\",\"routingType\":\"ROUTING\",\"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"
         }
      }
   ],
   "restrictions":{
      "maxLoadingStops":1,
      "maxUnloadingStops":99,
      "maxDistanceBetweenLoadStops":9000,
      "allowInterleaving":"False",
      "maxDistanceBetweenUnloadStops":3000
   }
}

    • Mensagem de Resposta
    Bloco de código
    titleJSON de Resposta do TPR
    collapsetrue
    {
   "success":true,
   "messages":[
      {
         "messageCode":"TPRRT0000",
         "message":"Sucesso."
      }
   ]
}

    • Mensagem de Retorno
    Bloco de código
    titleJSON de Retorno do TPR
    collapsetrue
    {
   "responseDate":"2021-11-04T13:50:38.000-03:00",
   "version":null,
   "summary":{
      "totalTrips":1,
      "totalDistance":790.2284089297932,
      "totalStops":4,
      "totalVolume":0.27400800000000003,
      "totalWeight":6530.0,
      "totalDuration":3.9160278E7,
      "rejectedOrders":0,
      "rejectedWeight":0.0,
      "rejectedVolume":0.0
   },
   "tripsResults":[
      {
         "sequential":0,
         "distance":790.2284089297932,
         "numberOfStops":5,
         "volume":0.27400800000000003,
         "weight":6530.0,
         "duration":39160278,
         "extraTrip":false,
         "tollValue":0.0,
         "considerReturnDistance":true,
         "vehicle":"  000001",
         "stops":[
            {
               "sequence":0,
               "type":"LOAD",
               "locality":{
                  "identifier":"04-NEPO JUNDIAI - SP-TESTE",
                  "name":"",
                  "country":"BR",
                  "latitude":-19.51692,
                  "longitude":-40.6522,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"2021-11-05T08:00:00.000-03:00",
               "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",
                     "volume":0.019008,
                     "weight":5000.0
                  },
                  {
                     "identifier":"04543526",
                     "volume":0.005,
                     "weight":30.0
                  }
               ],
               "unloadedOrders":[
                  
               ]
            },
            {
               "sequence":1,
               "type":"UNLOAD",
               "locality":{
                  "identifier":"  PFISIC01",
                  "name":"VITÓRIA - ES",
                  "country":"BR",
                  "latitude":-20.30642,
                  "longitude":-40.35072,
                  "operation":"UNRESTRICTED"
               },
               "arrivalTime":"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\"}"
 }

    • Parâmetros Para o Planejamento que Devem Ser Informados no Envio de Pedidos

    TOTVS Planejamento de Rotas (TPR) - Rotina OMSATPR1 - (Grupo OMSATPR1A )

    Descrição

    Elemento

    Regra do elemento

    Exemplo

    Critério da capacidade ?

    TPRRoutingOptions:capacityCriteria

    Tipo de roteirização:

    • Peso,
    • Volume,
    • Ambos.
    Peso

    Planejamento para ?

    TPRRoutingOptions:routingInstantType

    Define o instante a partir do qual as viagens podem ser expedidas:

    • Agora - Início das viagens na primeira hora factível, a partir do momento da roteirização mais uma hora.

    • D+1 - Início das viagens para amanhã, no primeiro horário factível de carregamento.

    D+1

    Qtd. dias limite p/ entregas ?

    TPRRoutingOrders:deliveryTimeWindowEnd

    Quantidade de dias para realizar a entrega.

    Se estiver planejado como D+1, começará a contar a partir do próximo dia.

    2

    Horário de carregamento ?

    TPRRoutingOrders:pickupTimeWindowStart

    Horário inicial da janela de carregamento dos Pedidos.

    08:00

    Funcionamento filial ?

    TPRRoutingLocality:operation

    Informar horário Horário de trabalho da Filial.

    Este parâmetro definirá o início do carregamento dos Pedidos, nas seguintes opções:

    Dias úteis

    Considera retorno p/ filial ?

    TPRRoutingOptions:considerReturnDistance

    Verifica se é para contabilizar a distância de retorno a origem na roteirização.

    Sim

    Qtd. máx. carregamentos ?

    TPRRoutingRestrictions:maxLoadingStops

    Quantidade máxima de paradas de carregamento por viagem.

    1

    Km máx. entre carregamentos ?

    TPRRoutingRestrictions:maxDistanceBetweenLoadStops

    Máxima distância, em Km, entre paradas de carregamento.

    700

    Km máx. entre entregas ?

    TPRRoutingRestrictions:maxDistanceBetweenUnloadStops

    Máxima distância, em Km, entre paradas de entregas.

    700

    Qtd. máx. de entregas ?

    TPRRoutingRestrictions:maxUnloadingStops

    Quantidade máxima de paradas de entregas por viagem.

    4

    Tempo mín. de serviço ?

    TPRRoutingOptions:minServiceDuration

    O montante Montante mínimo do tempo de serviço.

    Caso a soma dos tempos de carregamento e descarregamento não ultrapassem o valor mínimo, este será utilizado.

    Valor padrão: 30m

    00:30

    Tempo máx. de serviço ?

    TPRRoutingOptions:maxServiceDuration

    O montante Montante máximo do tempo de serviço.

    Caso a soma dos tempos de carregamento e descarregamento ultrapassem o valor máximo, este será utilizado.

    Valor padrão: 8h

    04:00

    Horário final das entregas ?

    TPRRoutingOrders:deliveryTimeWindowEnd

    Horário final da janela de entregas.

    18:00

    Funcionamento entregas ?

    TPRRoutingLocality:operation

    Horário das empresas que receberão as entregas.

    Este parâmetro definirá a janela de entregas e possui as seguintes opções:

    Dias úteis
    Calcula pedágio ?tollCalculationSim/Não: Informar se o

    TPR deverá realizar o cálculo do pedágio na roteirização

    .

    :

    • Sim
    • Não
    		Sim
    Entregas ord. por estado(UF)?stateReturnForbidden

    Se Quando informado:

    • Sim, não permitirá que a rota faça alternância de entregas entre Estados.
    • Não, a roteirização buscará pela melhor rota e se necessário haverá alternância de entrega entre Estados.
    		Não

    • Parâmetros Para o Planejamento que Devem Ser Informados no OMSA200 Para Envio de Roteirização TPR

    TOTVS Planejamento de Rotas (TPR) - Rotina OMSA200 - (Grupo OMSATPR5 )

    Descrição

    Elemento

    Regra do elementoElemento

    Exemplo

    Planejamento para ?

    TPRRoutingOptions:routingInstantType

    Define o instante a partir do qual as viagens podem ser expedidas:

    • Agora - Início das viagens na primeira hora factível, a partir do momento da roteirização mais uma hora.

    • D+1 - Início das viagens para amanhã, no primeiro horário factível de carregamento.

    D+1

    Horário de carregamento ?

    TPRRoutingOrders:pickupTimeWindowStart

    Horário inicial da janela de carregamento dos Pedidos.

    08:00

    Funcionamento filial ?

    TPRRoutingLocality:operation

    Informar Deve ser informado o horário de trabalho da Filial.

    Este parâmetro definirá o início do carregamento dos Pedidos, nas seguintes opções:

    • Sem restrição (00:00-23:59 de Dom-Sab)

    • Dias úteis (08:00-17:59 de Seg-Sex)

    • De manhã (08:00-11:59 de Seg-Sex)

    • À tarde (14:00-17:59 de Seg-Sex).

    Dias úteis

    Considera retorno p/ filial ?

    TPRRoutingOptions:considerReturnDistance

    Verifica É verificado se é para contabilizar a distância de retorno a origem na roteirização.

    Sim

    Tempo mín. de serviço ?

    TPRRoutingOptions:minServiceDuration

    O montante Montante mínimo do tempo de serviço.

    Caso a soma dos tempos de carregamento e descarregamento não ultrapassem o valor mínimo, este será utilizado.

    Valor padrão: 30m

    00:30

    Tempo máx. de serviço ?

    TPRRoutingOptions:maxServiceDuration

    O montante máximo do tempo de serviço.

    Caso a soma dos tempos de carregamento e descarregamento ultrapassem o valor máximo, este será utilizado.

    Valor padrão: 8h

    04:00

    Horário final das entregas ?

    TPRRoutingOrders:deliveryTimeWindowEnd

    Horário final da janela de entregas.

    18:00

    Funcionamento entregas ?

    TPRRoutingLocality:operation

    Horário das empresas que receberão as entregas.

    Este parâmetro definirá a janela entregas e possui as seguintes opções:

    Dias úteis
    Calcula pedágio ?tollCalculationSim/Não: Informar se o

    O TPR deverá realizar o cálculo do pedágio na roteirização:

    • Sim
    • Não
    		Sim
    Entregas ord. por estado(UF)?stateReturnForbidden

    Se Quando informado:

    • Sim, não permitirá que a rota faça alternância de entregas entre Estados.
    • Não, a roteirização buscará pela melhor rota e, se necessário, haverá alternância de entrega entre Estados.
    		Não

    • Informações Enviadas dos Veículos (DE / PARA)

    Elemento

    Campo

    Descrição

    identifier

    FwXfilial("DA3") + DA3_COD

    Chave do veículo.

    weightCapacity

    DA3_CAPACM

    Capacidade do veículo, em quilos.

    volumeCapacity

    DA3_VOLMAX

    Capacidade do veículo, em metros cúbicos.

    speed

    DA3_VELOC

    Define a velocidade que dos veículos em uma roteirização.

    quantity

    1

    Quantidade de veículos, semelhantes a este, disponíveis.

    tollAxesDA3_QTDEIXQuantidade de eixos na ida para cálculo do pedágio. Default 6.
    tollReturnAxesDA3_QTEIXVQuantidade de eixos na volta para cálculo do pedágio. Default 4.

    • Informações Enviadas dos Pedidos (DE / PARA)

    Elemento

    Campo

    Descrição

    identifier

    FwXfilial("SC9") + C9_PEDIDO

    Os Pedidos são enviados identificados pela filial + código do pedido.

    weight

    C9_QTDLIB * SB1.B1_PESBRU

    O peso enviado do pedido Pedido é a quantidade liberada multiplicada pelo peso bruto do Pedido liberado.

    volume

    (SB5.B5_ALTURLC * SB5.B5_LARGLC * SB5.B5_COMPRLC)*C9_QTDLIB

    O volume calculado é baseado nos campos de medidas do produto multiplicado pela quantidade liberada do Pedido.

    pickupTimeWindowStart

    Parâmetro Horário de carregamento + Planejamento para ?

    O início da janela de carregamento é o horário inicial da Filial e a data depende do parâmetro Agora ou D+1.

    Se preenchidoQuando informado:

    • Agora, o : o planejamento somará uma hora para as entregas do mesmo dia.
    • D+1,: o carregamento será para o próximo dia, de acordo com a forma de trabalho da Filial (Sem restrição, dias úteis, de manhã, a tarde).
    pickupTimeWindowEnd

    Parâmetro Horário final das entregas ? + Qtd. dias limite p/ entregas ?

    O prazo de carregamento é o limite da entrega.

    deliveryTimeWindowStart

    Parâmetro Horário de carregamento + Planejamento para ?

    O início das entregas depende do Funcionamento entregas ?, que significa o horário de trabalho dos clientes e o início de carregamento da carga. 

    deliveryTimeWindowEnd

    Parâmetro Horário final das entregas ? + Qtd. dias limite p/ entregas ?

    O limite da entrega é considerado pelo horário limite das entregas, prazo em quantidade de dias, planejamento do carregamento (Agora, D+1) e a forma de trabalho do cliente (Sem restrição, dias úteis, de manhã, a tarde).

    origin

    identifier

    SM0->M0_CODFIL - SM0->M0_FILIAL - SM0->M0_NOME

    Identificador para integração e apresentação da Filial no mapa de roteirização.

    name

    SM0->M0_CODFIL - SM0->M0_FILIAL - SM0->M0_NOME

    Identificador para integração e apresentação da Filial no mapa de roteirização.

    country

    		BRAPaís padrão da Filial (Brasil).

    latitude

    		DAR_LATITUInformação de coordenadas da Filial (SM0), mantida na tabela de coordenadas geográficas (DAR).

    longitude

    DAR_LONGIT

    Informação de coordenadas da Filial (SM0), mantida na tabela de coordenadas geográficas (DAR).

    operationParâmetro informado em Funcionamento filial OMSATPR1A

    Parâmetro de funcionamento da Filial (Sem restrição, dias úteis, de manhã, a tarde), informado antes de enviar os Pedidos para o planejamento via OMSATPR1.

    destination

    identifier

    FwXfilial("SA1") + A1_COD+A1_LOJA ou FwXfilial("SA2")+A2_NOME+A2_LOJA  

    Identificador para integração dos cliente ou fornecedores.

    name

    A1_NREDUZ ou A2_NREDUZ

    Nome do cliente ou fornecedor apresentado no mapa de roteirização.

    country

    A1_PAIS ou A2_PAIS

    País cadastrado na entidade.

    latitude

    DAR_LATITU

    Informação de coordenadas do cliente (SA1) ou fornecedor (SA2), mantida na tabela de Coordenadas Geográficas (DAR).

    longitude

    DAR_LONGIT

    Informação de coordenadas do cliente (SA1) ou fornecedor (SA2), mantida na tabela de coordenadas geográficas (DAR).

    operation

    Parâmetro informado em Funcionamento entregas OMSATPR1A

    Parâmetro de funcionamento das entregas (Sem restrição, dias úteis, de manhã, a tarde, customizado), informado antes de enviar os Pedidos para planejamento via OMSATPR1.


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


    6. Fluxograma

    6.1. Processo de Envio de Pedido de Vendas

    draw.io Diagram
    bordertrue
    diagramNameOMSATPR1 - Envio de Pedidos de Venda
    simpleViewerfalse
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth641
    revision3

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

    draw.io Diagram
    bordertrue
    diagramNameOMSATPR2 - Callback Roteirização
    simpleViewerfalse
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth641
    revision2

    6.3. Processo de Alteração de Rota /

    Mapa (em Desenvolvimento)

    Mapa 

    draw.io Diagram
    bordertrue
    diagramNameProcesso de alteração de rota
    simpleViewerfalse
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth611
    revision5

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

    Mapa (em Desenvolvimento)

    Mapa 

    draw.io Diagram
    bordertrue
    diagramNameCallback processo de alteração de rota
    simpleViewerfalse
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth521
    revision4


    Image Added7. Pontos de Entrada


    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

    Bloco de código
    titleExemplo de integração
    collapsetrue
    #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