Árvore de páginas

Versões comparadas

Chave

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

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision6
diagramNameTRE Cancelamento
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth342

Sistemas Envolvidos

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

  • Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.

Integração

  • TOL/TRE

Escopo

  • A interface publishCancelService serve apenas para solicitar ao sistema externo permissão para o cancelamento da carga no TOL\TRE.

    • Para solicitar esta permissão, o TOL\TRE irá mandar uma mensagem ao sistema externo através da estrutura publishCancelService e o sistema externo deverá retornar uma mensagem de resposta ao TOL\TRE na estrutura publishCancelServiceResponse:
      • Se o sistema externo retornar um status de que o cancelamento é possível (campo status=0), o TOL\TRE permitirá ao usuário a alteração da carga.
      • Se o sistema externo retornar um status de que cancelamento não é possível (campo status=1 ou 2 ou 3 ou 4), o TOL\TRE não permitirá ao usuário a alteração da carga.

Escopo

  • Solicitação de cancelamento de viagens ao sistema externo

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

publishCancelService, 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 TRE;Este campo poderá não ser enviado nos casos em que o cancelamento foi feito de forma automática e não manualmente por um usuário através das telas do TRE  (nestes casos, não se pode identificar a cesta do usuário);
Os seguintes exemplos podem gerar mensagens de cancelamento automáticas para o sistema externo sem a informação da cesta do usuário:
- Um Se um usuário que possui viagens não desbloqueadas é removido do TRE e a opção selecionada nesta remoção é de que estas viagens sejam , nesta remoção suas viagens serão canceladas;
- Uma doca associada a viagens não desbloqueadas é removida do TRE e a opção selecionada nesta remoção é de que estas viagens sejam , nesta remoção suas viagens serão canceladas;
- Um pedido é removido do TRE  de forma automática (via integração) fazendo com que viagens não desbloqueadas fiquem sem DUs, forçando que estas sejam canceladas;
trips trip[]SimN/AElemento de agrupamento de todas as viagens do TRE que viagens que se quer reprogramar cancelamento ;Deverá haver pelo menos 1 viagem do TRE nesta viagem nesta lista;
loadsload[]SimN/AElemento de agrupamento de todas as cargas da viagem;

Âncora
trip
trip

trip, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripIdintSim10ID da viagem cuja reprogramação cujo cancelamento está sendo solicitada pelo TRE ao sistema legadosolicitado;

Âncora
load
load

load, tipo de dado utilizado nas integrações do do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadIdintIntegerSim10Identificador de uma carga da viagem;
loadSourceIdstringStringNão30Identificador externo de uma carga da viagem;

Layout de Resposta

Âncora
publishCancelServiceResponse
publishCancelServiceResponse

publishCancelServiceResponse, tipo de dado utilizado nas integrações do do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultresult[]SimN/AElemento de agrupamento de todas as viagens do TRE que viagens que se quer reprogramar cancelamento com os respectivos status das solicitações;Deverá haver pelo menos 1 viagem do TRE nesta nesta lista;
Âncora
result
result
result, tipo de dado utilizado nas integrações do do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdstringStringSim30Identificador da regional;Deve ser uma regional válida;
tripIdintIntegerSim10ID da viagem cuja reprogramação foi solicitada pelo TRE ao sistema legadocujo cancelamento foi solicitado;
statusintIntegerSim1Status da solicitação de reprogramação cancelamento de viagem enviada pelo TRE ao sistema legado;

0=Viagem cancelada com sucesso; 1=Viagem já estava cancelada; 2=Viagem não encontrada; 3=Viagem já despachada; 4=Viagem não pode ser cancelada;

O processo de cancelamento deverá funcionar da seguinte forma: -

Ao solicitar o cancelamento da viagem (ou carga) no TRE  , a interface de notificação de cancelamento de viagens (ou cargas) será executada pelo TRE com o sistema externo; se informará o sistema externo, se o sistema externo confirmar o cancelamento da viagem (ou carga) através dos status 0, 1 ou 2 acima, esta também será cancelada no TOL/TRE;

Importante: as delivery units das viagens canceladas serão sempre devolvidas para a cesta do respectivo usuário;

Catalogo de mensagens

Âncora
catmsg
catmsg

CódigoMensagemDescrição

Anexos

Anexos