TOTVS Roteirização e Entregas

Árvore de páginas

Versões comparadas

Versão antiga 7

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision3
diagramNameTRE_reprogramação
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth342

Sistemas Envolvidos

Integração

  • TOTVS Otimização Logística / TOTVS Roteirização e Entrega

  • Sistema Externo: ERPs que se conectam ou pretendem se conectar com TOL/TRE

Escopo

A interface PublishReprogrammingService serve apenas para solicitar ao sistema externo permissão para a reprogramação da carga no TOL/TRE.

  • Para solicitar esta permissão, o TOL/TRE irá mandar uma mensagem ao sistema externo através da estrutura publishReprogrammingServiceRequestpublishReprogrammingService e o sistema externo deverá retornar uma mensagem de resposta ao ao TOL/TRE na estrutura publishReprogrammingServiceResponse:
    • Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o
    TRE permitirá ao usuário a alteração da carga.Se o sistema externo retornar um status de que reprogramação não é possível (campo status=1 ou 2 ou 3), o TRE não
    • TOL/TRE permitirá ao usuário a alteração da carga.
      • Caso o sistema externo retorne que a reprogramação é possível (campo status=0), após a reprogramação da carga no TOL/TRE,
    o 
      • o TOL/TRE irá enviar novamente ao sistema externo (através da interface publishReleasedTrip) uma mensagem de publicação de viagens com as alterações feitas pelo usuário na reprogramação.
      • Neste cenário, quando o sistema externo permitir a reprogramação da carga, é importante que o sistema externo volte o status do documento de transporte para uma condição que permita uma futura edição pelo TOL/TRE
     
    • Se o sistema externo retornar um status de que reprogramação não é possível (campo status=1 ou 2 ou 3), o TOL/TRE não permitirá ao usuário a alteração da carga.

Pré-requisitos instalação/implantação/utilização

  • Versões mínimas

    • TOL/TRE:  6.4.0

    • Protheus:  ?

    • Datasul: ?

  • Esta integração não demanda instalações ou atualizações adicionais.

Layout de Requisição

Âncora
publishReprogrammingServiceRequestpublishReprogrammingServicepublishReprogrammingServiceRequest
publishReprogrammingService

publishReprogrammingServiceRequest, Integração SOAP, Síncrona
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdstringStringSim30Identificador da regional;Deve ser uma regional válida;
basketSourceIdstringStringNão30ID da cesta onde esta operação foi realizada manualmente pelo usuário no CPL;Este campo poderá não ser enviado nos casos em que a solicitação de reprogramação foi feita de forma automática e não através da tela do CPL  (nestes casos, não se pode identificar a cesta do usuário);
trips trip[]SimN/AElemento de agrupamento de todas as viagens do CPL que se quer reprogramar;Deverá haver pelo menos 1 viagem do CPL nesta viagem nesta lista;
loadsload[]SimN/AElemento de agrupamento de todas as cargas da viagem;

Âncora
trip
trip

int
trip, tipo de dado utilizado nas integrações do TOL/TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripIdIntegerSim10ID da viagem cuja reprogramação está sendo solicitada pelo CPL ao sistema legado;

Âncora
load
load

load, tipo de dado utilizado nas integrações
do
do TOL/TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadId
int
IntegerSim10Identificador de uma carga da viagem;
loadSourceId
string
StringNão30Identificador externo de uma carga da viagem;

Layout de Resposta

Âncora
publishReprogrammingServiceResponse
publishReprogrammingServiceResponse

publishReprogrammingServiceResponse, tipo de dado utilizado nas integrações
do result (início)Lista
do TOL/TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
publishReprogrammingServiceResponse (início)EntidadeSimN/AElemento de agrupamento das respostas às solicitações de reprogramação de viagens do CPL ao sistema legado;
resultresult[]
SimN/AElemento de agrupamento de todas as viagens
do CPL que
do que se quer reprogramar com os respectivos status das solicitações;Deverá haver pelo menos 1
viagem do CPL nesta
viagem nesta lista;
Âncora
result
result
result, tipo de dado utilizado nas integrações do TOL/TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceId
Alfanumérico
StringSim30Identificador da regional;Deve ser uma regional válida;
tripId
Numérico (inteiro)
IntegerSim10ID da viagem cuja reprogramação foi solicitada
pelo CPL ao sistema legado
;
status
Numérico (inteiro)
IntegerSim1Status da solicitação de reprogramação de viagem
enviada pelo CPL ao sistema legado
;0=Reprogramação autorizada; 1=Viagem cancelada; 2=Viagem não encontrada; 3=Viagem já despachada/Reprogramação não autorizada;

Importante:
- Se o sistema externo retornar o código 0, a viagem será colocada no seu último status antes da liberação (Observação: notar que alguns destes status podem não permitir a reprogramação
!
Ex.: "Viagem Ofertada");
- Se o sistema externo retornar o código 1, será efetuado o
CPL irá efetuar o
cancelamento da viagem automaticamente
e o
. O sistema externo não será novamente notificado
deste cancelamento pelo CPL (como foi o sistema externo que informou que a viagem já está cancelada, esta notificação extra do CPL é desnecessária
;
- Se o sistema externo retornar os códigos 2 ou 3, não será possível reprogramar a viagem
no CPL;result (fim)ListaSimN/AElemento de agrupamento de todas as viagens do CPL que se quer reprogramar com os respectivos status das solicitações;Deverá haver pelo menos 1 viagem do CPL nesta lista;publishReprogrammingServiceResponse (fim)EntidadeSimN/AElemento de agrupamento das respostas às solicitações de reprogramação de viagens do CPL ao sistema legado
;

Catalogo de mensagens

Âncora
catmsg
catmsg

CódigoMensagemDescrição

Anexos

Anexos