Páginas filhas
  • Integração TOTVS OMS x TOTVS Otimização Logística (Planejamento)

Versões comparadas

Chave

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

Pickup

Âncora
indice
indice
Índice
maxLevel3
outlinetrue
stylenone
printablefalse

Integração OMS Protheus x Cockpit Logístico NeologContexto de Negócio (Introdução)

Com a crescente demanda por otimização nos processos logísticos de distribuição na busca por um melhor aproveitamento dos veículos, tanto na questão de carregamento quanto na roteirização das entregas, tornou-se necessário proporcionar aos cliente do OMS Protheus uma solução para atender essas necessidades.

Visando esta solução foi realizada a integração entre o módulo Gestão de Distribuição (SIGAOMS) da linha Microsiga Protheus  com a funcionalidade Programação de Transportes do Cockpit Logístico da Neolog, por intermédio de arquivos no formato XML, utilizando os Web Services existentes do Cockpit Logístico, sem transformação de mensagens e sem a utilização de sistemas intermediários (TOTVS EAI, TOTVS ESB, entre outros).

Com esta integração o OMS passou a utilizar os recursos do Cockpit Logístico, o qual efetuará a roteirização e o arranjo das cargas com base na demanda de transportes enviados pelo OMS, devolvendo para este as cargas montadas e roteirizadas.

Para a montagem de carga serão consideradas as configurações das restrições logísticas e as funções-objetivos de otimização registradas no Cockpit Logístico.

São exemplos de funções-objetivo:

  • Máxima ocupação dos veículos.
  • Diminuição dos prazos de entrega.
  • Redução da quantidade de viagens.


Integração OMS Protheus x Cockpit Logístico NeologSistemas Envolvidos

TOTVS Gestão de Distribuição (SIGAOMS)

A sigla OMS significa Order Management System, ou seja, gerenciamento de pedidos e serviços que compreende as fases de captação, validação, avaliação, formação de carga e geração de mapa de separação ou, como é também conhecido, lista de separação.

Para obter mais detalhes sobre o OMS TOTVS, acesse o link:Gestão de Distribuição (SIGAOMS).

Cockpit Logístico Neolog

O Cockpit Logístico é um sistema vertical desenvolvido pela Neolog, empresa do ecossistema TOTVS, que dispõe de módulos para Planejamento da Malha de Distribuição, Programação de Transportes e Monitoramento de Cargas.

Para obter mais detalhes sobre o Cockpit Logístico Neolog, acesse o link: http://www.neolog.com.br/neolog-site/index.php/cockpit-logistico/


Integração OMS Protheus x Cockpit Logístico NeologEscopo

O escopo desta integração permitirá o envio dos pedidos de venda liberados (crédito / estoque) no OMS para a formação das viagens no Cockpit Logístico e o recebimento dessas viagens geradas no Cockpit Logístico por meio de um XML no OMS, para a geração das cargas.

Para complementar o escopo do envio dos pedidos será necessário enviar os cadastros envolvidos com as informações dos pedidos, como produtos, clientes, fornecedores, filiais, transportadoras e tipos de veículos.

Faz parte do processo de integração o recebimento das mensagens de publicação de viagens, reprogramação e cancelamento de viagens.

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameFluxo Integração OMS x CPL
simpleViewerfalse
linksauto
tbstyleinline
lboxtrue
diagramWidth412
revision8

¹ Para o cadastro de fornecedores existem particularidades que serão detalhadas nos próximos tópicos.

Para as entidades envolvidas na integração, estes são os pontos de integração que farão parte do escopo dessa integração: 

EntidadePontos de Integração
Empresas/Filiais
  • Carga de Dados.
Cliente
  • Cadastro de Cliente.
  • Edição de Cliente.
  • Carga de Dados.
Fornecedor
  • Cadastro de Fornecedores.
  • Edição de Fornecedor.
  • Carga de Dados.
Transportadora
  • Cadastro de Transportadoras.
  • Edição Transportadoras.
  • Carga de Dados.
Produto
  • Cadastro de Produto.
  • Edição de Produto.
  • Carga de Dados.
Tipo de Veículo
  • Carga de Dados.
Pedidos de Venda
  • Envio dos Pedidos de Vendas ao Cockpit Logístico.
  • Cancelamento dos Pedidos de Vendas (via rotina de Envio de Pedidos)
Viagens
  • Geração da Viagem no Cockpit Logístico.
  • Liberação da Viagem no Cockpit Logístico.
  • Liberar Viagem no OMS.
  • Cancelamento da Viagem no Cockpit Logístico
  • Reprogramação da Viagem no Cockpit Logístico



Integração OMS Protheus x Cockpit Logístico NeologPré-requisitos Instalação / Implantação / Utilização

Cockpit Logístico

  • Cockpit Logístico na versão/release 5.6.1.
  • Parâmetros de aquisição ativos (acesso pelo menu em Administração > Cockpit Logístico).
  • Web Services ativos.

Protheus

  • Protheus versão  12.1.17 ou superior.
  • Parâmetros de integração com Cockpit Logístico configurados (acesso pelo menu em Atualizações > Cockpit Logístico > Parâmetros Integração).
  • Web Service Server para recebimento de mensagens do Cockpit Logístico.

Informações
iconfalse
titleAtenção!
  • Não é escopo desse documento descrever a instalação do ERP Protheus e do Cockpit Logístico Neolog, nem suas configurações básicas. 
  • Para utilização da integração entre o módulo SIGAOMS e o Cockpit Logístico na versão 12.1.17 (ou superior) do Protheus é necessário estar com o ambiente atualizado com a última versão de RPO e o dicionário disponível na Central de Downloads TOTVS.
  • Para obter mais informações sobre como atualizar o dicionário de dados do Protheus 12, clique aqui.


Integração OMS Protheus x Cockpit Logístico NeologInstalação/Configuração

Configuração Web Service AppServer Protheus

Para que seja possível receber as viagens do Cockpit Logístico, é necessário configurar um Web Service no servidor de aplicação Protheus.

Nota
titleAtenção!

A configuração do JOB do Web Service para ser utilizado nesta integração não utiliza os métodos padrões do Framework Protheus, sendo assim as rotinas ONSTART e ONCONNECT são específicas do modulo, portanto os métodos disponíveis neste WS não são listados no WS do Protheus.

É recomendado criar um Web Service com as seguintes configurações (modificando o arquivo appserver.ini):

Bloco de código
languageactionscript3
titleappserver.ini
collapsetrue
;Serviço webserver HTTP
[HTTP]
ENABLE=1
PATH=<Caminho_Cache_imagens>;C:\TOTVS\Prottheus\data\web
PORT=<porta>;8080
INSTANCES=<nInicio>,<nMaximo>;1,10
SESSIONTIMEOUT=60
INSTANCENAME=WS_HTTP
 
;URL de resposta
 [<ip ou nome>:<porta>/neolog]
ENABLE=1
PATH=<Caminho_Cache_imagens>;C:\TOTVS\Prottheus\data\web
ENVIRONMENT=<ambiente>
INSTANCENAME=WS_NEOLOG
RESPONSEJOB=JOB_WS_NEOLOG
DEFAULTPAGE=wsindex.apw
 
;JOB de resposta
[JOB_WS_NEOLOG]
TYPE=WEBEX
ENVIRONMENT=<ambiente>
INSTANCES=<nInicio>,<nMaximo>;1,10
INSTANCENAME=JOB_WS_NEOLOG
ONSTART=OMSXStart
ONCONNECT=OMSXConnect

Para testar o serviço, basta iniciar um navegador e digitar: http://<ip ou nome>:<porta>/neolog/PublishReleasedTrip.APW?WSDL

Um WSDL (descrição do serviço em xml) deve exibir no navegador.

Para que seja possível reprogramar/cancelar as viagens do Cockpit Logístico, é necessário configurar as informações de conexão com o DBAccess diretamente na seção [Environment] (modificando o arquivo appserver.ini), conforme exemplo abaixo:

Bloco de código
languageactionscript3
titleappserver.ini
collapsetrue
;Nome do Ambiente acessado pelo Web Service
[Environment]
SourcePath=C:\Totvs\Protheus\Apo
RootPath=C:\Totvs\Protheus\Data
StartPath=\system\
. . . ; outras chaves
DBDatabase=MSSQL7
DBAlias=PLS101
DBServer=192.168.1.20
DBPort=7890

Parametrização Cockpit Logístico

Para configurar o envio de viagens do cockpit ao Web Service Protheus, entre no Cockpit Logístico e acesse:

  1. Administração > Integração, selecione a pasta Fontes de Dados e clique em Inserir.
  2. Digite o Código, a Descrição e o Código da base.
    Sugestão: PROTHEUS
  3. Seção Cancelamento de Viagem Liberada
    • No campo URL da seção, digite: http://<ip ou nome>:<porta>/neolog/CancelService.APW 
    • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço.
      Recomendado 30000.

4. Seção Execução da Viagem

    • No campo URL, digite: NA (Não Atribuído)
    • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço.
      Recomendado 1000.

5. Seção Solicitação de liberação de Viagem

    • No campo URL, digite: http://<ip ou nome>:<porta>/neolog/PublishReleasedTrip.APW
    • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço.
      Recomendado 30000.

6. Seção Solicitação de Reprogramação de Viagem

    • No campo URL, digite: http://<ip ou nome>:<porta>/neolog/ReprogramService.APW
    • No campo Tempo Máximo de Espera por Resposta, informe o timeout do serviço.
      Recomendado 30000.

7. Clique em Salvar.

Parametrização SIGAOMS

Por meio do menu Atualizações > CockPit Logístico > Parâmetros Integração (OMSXCPL1), o Protheus deve ser parametrizado para o correto funcionamento da integração conforme abaixo:

CampoDescriçãoParâmetroOpçõesValor para IntegraçãoValidação
Integração Cockpit Logístico?Indica se a integração com o Cockpit Logístico está ativa.MV_CPLINT1-Sim / 2-Não1-Sim

Integração Suspensa?

Indica se a integração com o Cockpit Logístico está temporariamente suspensa.MV_CPLSTP1-Sim / 2-Não2-Não
Integrar Clientes On line?Indica se ao incluir ou alterar um cliente no Protheus deverá efetuar a replicação automaticamente no Cockpit Logístico (Localidades).MV_CPLCLI1-Sim / 2-Não1-Sim
Integrar Fornecedores On line?Indica se ao incluir ou alterar um fornecedor no Protheus deverá efetuar a replicação automaticamente no Cockpit Logístico (Localidades).MV_CPLFOR1-Sim / 2-Não1-Sim
Integrar Transportadora On line?Indica se ao incluir ou alterar um transportador no Protheus deverá efetuar a replicação automaticamente no Cockpit Logístico.MV_CPLTRA1-Sim / 2-Não1-Sim
Integrar Produtos On Line?Indica se ao incluir ou alterar um produto no Protheus deverá efetuar a replicação automaticamente no Cockpit Logístico.MV_CPLPRO1-Sim / 2-Não1-Sim
Integrar Tipos de Veículos On line?Indica se ao incluir ou alterar um tipo de veículo no Protheus deverá efetuar a replicação automaticamente no Cockpit Logístico.MV_CPLTPV

1-Sim / 2-Não

1-Sim
Tipo Veículo Otimização?

Quando for 1 = Impedir: No vínculo do veículo na carga, se o usuário informar um tipo de veículo diferente do que consta na viagem do Cockpit Logístico, não permitimos, sendo apresentado um Help. 

Se for 2 = Alertar: O sistema avisa que o tipo informado é diferente do tipo da viagem no Cockpit Logístico e o usuário define se permite o vinculo ou não.

MV_CPLTVO

1-Impedir

2-Alterar

2-Alertar (padrão)
Endereço Web ServiceEndereço do Web Service do Cockpit Logístico.MV_CPLURL

Conforme cliente.

Exemplo:
http://<ip ou nome>:<porta>/cockpit-gateway/integration/services

Deve ser obrigatoriamente preenchido quando MV_CPLINT == "1"
Endereço Web Service de Autenticação

Endereço do Web Service de Autenticação do Cockpit Logístico.

Este endereço fornecerá um token de autenticação que deverá ser utilizado nas requisições efetuadas ao Cockpit Logístico, quando este estiver parametrizado para solicitar autenticação.

MV_CPLUAUT

Conforme cliente.

Exemplo:
http://<ip ou nome>:<porta>/cockpit-gateway/ws/authentication


Usuário de Autenticação do Web ServiceUsuário utilizado para efetuar login no Cockpit Logístico para obtenção do token.

MV_USRCPL


Conforme clienteDeve ser obrigatoriamente preenchido quando possuir URL de autenticação.
Senha de Autenticação do WebServiceSenha do usuário utilizado para efetuar login no Cockpit Logístico para obtenção do token.

MV_PSWCPL


Conforme clienteDeve ser obrigatoriamente preenchido quando possuir URL de autenticação.
Quantidade de Horas para Considerar que o Token ExpirouIndica a quantidade de horas que devem ser consideradas para que um token esteja expirado.
Enquanto este limite não for atingido, o mesmo token recebido na primeira solicitação será reutilizado para envio das próximas mensagens.

MV_EXPTOK


Conforme cliente
RegionalRegional enviada para o Cockpit Logístico.MV_CPLREG
Conforme clienteDeve ser obrigatoriamente preenchido quando MV_CPLINT == "1"
Embarcador

Código de um Embarcador do Cockpit Logístico.

Todos os Produtos integrados do OMS para o Cockpit Logístico serão relacionados a um mesmo Embarcador no Cockpit Logístico, pois no OMS a relação variável de produto x cliente é utilizada (opcionalmente) apenas na importação de Notas Fiscais de Cliente pelo EDI.

MV_CPLEMB
Conforme clienteDeve ser obrigatoriamente preenchido quando MV_CPLINT == "1"
Categoria de Produto?

Para o Cockpit Logístico, categorias de produto são agrupamentos relevantes de produtos com características logísticas semelhantes.

Com esse parâmetro é possível determinar se a categoria dos produtos integrados do OMS para o Cockpit Logístico:

  1. Grupo Produto: será o código do grupo do produto do OMS; ou
  2. Padrão Cockpit: será informada por alteração manual, em cada produto no Cockpit Logístico. Com essa opção é necessário cadastrar as Categorias de Produtos no Cockpit Logístico com os mesmos códigos dos Grupos de Produtos do OMS, pois não há Web Service de integração para essa tabela.
MV_CPLCAT

1-Grupo Produto
2-Padrão Cockpit

2=Padrão Cockpit.


Invólucro Padrão

Código de um Invólucro (embalagem) do Cockpit Logístico.

Todos os itens de Pedidos de Transporte recebidos do OMS no Cockpit Logístico serão associados a esse invólucro, pois não há uma entidade no OMS que corresponda exata e obrigatoriamente a esse dado do Cockpit Logístico.

Recomenda-se informar um invólucro cujas medidas sejam obtidas do item do pedido (essa característica é parametrizada no Cockpit Logístico).

MV_CPLINV
Conforme cliente
Origem dos DadosDefine o nome do ERP que origina os dados enviados ao Cockpit Logístico.MV_CPLIDS

Deve ser informada a fonte de dados criada dentro do Cockpit Logístico.

Ex: Protheus

Deve ser obrigatoriamente preenchido quando MV_CPLINT == "1"
E-mail do AdministradorE-mail do administrador para notificações de falha de conexão.MV_CPLMAL
Conforme cliente
UM a Considerar?

Este parâmetro permite indicar a unidade de medida a ser considerada na integração dos Itens dos Pedidos de Venda com o Cockpit Logístico, onde:

  1.  1ª UM;
  2. 2ª UM dos produtos.
MV_CPLUMIT1 - 1ª UM
2 - 2ª UM
1 - 1ª UM (padrão)
Geração das Cargas

Quando for 1 = Automático: Para as viagens vindas do Cockpit Logístico o OMS gera a carga automaticamente.
Quando for 2 = Manual: Para as viagens deve ser gerada manualmente a carga.

Nota!

Este parâmetro implica na necessidade da liberação ser automática (MV_CPLLVA), pois somente é permitido a montagem de cargas de viagens liberadas.

MV_CPLAUT1-Automático
2-Manual
2-Manual (padrão)
Liberação automática da viagem?

O uso deste parâmetro ocorre somente para o OMS.

Quando habilitado, ao realizar a integração da viagem vinda do Cockpit Logístico, o sistema realizará o envio da liberação de viagens de forma automática.

MV_CPLLVA1-Sim / 2-Não2-Não (padrão)

Parametrização Adicional Integração

Algumas parametrizações da integração devem ser realizadas no arquivo de configuração do do servidor Protheus (appserver.ini), pois são utilizadas antes de iniciar qualquer processo de conexão com o SGDB.

As configurações abaixo devem ser incluídas no arquivo na seção [NEOLOG]:

Bloco de código
languageactionscript3
titleappserver.ini
collapsetrue
;Configuração integração com o Cockpit Logístico
[NEOLOG]
DefaultCompany=<empresa>
Debug=1
DebugPath=<caminho relativo> ;logs\neolog

Âncora
RetornoDefaultCompany
RetornoDefaultCompany

Onde:

  • DefaultCompany: Empresa padrão para integração entre o OMS e o Cockpit Logístico. Se não for informado não será considerado, sendo sempre enviada nas mensagens nos campos que identificam os códigos, além do próprio código, a concatenação da empresa e do campo Filial do respectivo cadastro/processo. Caso esteja parametrizada, será enviada apenas a concatenação do código com campo Filial do respectivo cadastro/processo. Clique aqui para obter mais detalhes.
  • Debug: Indicador de que o processo de gravação dos arquivos XML das mensagens trocadas entre o OMS e o Cockpit Logístico está ativo. Caso esteja com o valor 1, será considerado ativo, caso contrário será considerado inativo. Caso não exista esta configuração será assumido que o Debug está ativo por padrão.
  • DebugPath: Caminho onde deverão ser gravados os arquivos de log do XML. Este caminho deve ser sempre relativo a pasta RootPath, pois o processo de integração pode rodar em modo JOB e desta forma, não tem acesso a diretórios locais da máquina. Caso não esteja parametrizado, será considerado o caminho padrão "system/neolog".

Informações
iconfalse
titleImportante!

Deverá ser parametrizado via algum processo do sistema operacional do servidor, uma rotina que efetue exclusão programada dos arquivos log da pasta definida no DebugPath, deixando apenas os mais atuais.


Integração OMS Protheus x Cockpit Logístico NeologControle de Versão

O grupo TOTVS, representado por suas marcas, administrará as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.


Integração OMS Protheus x Cockpit Logístico NeologSuporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim, as equipes de suporte dos produtos BackOffice Protheus estarão aptas a efetuar a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Informações
iconfalse
titleNota!

Este modelo de suporte está sendo revisado pela TOTVS. 


Integração OMS Protheus x Cockpit Logístico NeologMensagens

MétodoDescriçãoOrigemDestinoXSD

Cadastros

Empresas/FiliaisProtheusCockpit LogísticoLocalityAcquisitionService
ClienteProtheusCockpit LogísticoLocalityAcquisitionService
FornecedorProtheusCockpit LogísticoLocalityAcquisitionService ou CarrierAcquisitionService
TransportadoraProtheusCockpit LogísticoCarrierAcquisitionService
ProdutosProtheusCockpit LogísticoProductAcquisitionService
Tipo de Veículo SIGAOMSCockpit LogísticoVehicleAcquisitionService

Processos

Pedido de Vendas

SIGAOMS

Cockpit Logístico

OrderAcquisitionService

Cancelar Pedido de VendasSIGAOMSCockpit LogísticoOrderAcquisitionService
Publicar ViagensCockpit LogísticoSIGAOMSPublishReleasedTrip
Liberar ViagensSIGAOMSCockpit LogísticoUnblockReleasedTripAcquisitionService
Cancelar ViagensCockpit LogísticoSIGAOMS

CancelService

Reprogramar ViagensCockpit LogísticoSIGAOMSReprogramService


Integração OMS Protheus x Cockpit Logístico NeologFluxo das Informações

Os cadastros devem ser realizados no OMS Protheus e integrados ao Cockpit Logístico.

A ativação da integração, no entanto, não impede a inclusão, alteração e exclusão de registros no Cockpit Logístico, mas esse procedimento não é recomendado, pois as operações realizadas sobre os cadastros no Cockpit Logístico não são replicadas para os respectivos cadastros no Protheus.

Apenas as operações de inclusão e alteração são consideradas na integração e são efetuadas sempre que ocorrerem, desde que parametrizadas para serem on-line.

A operação de eliminação sobre os registros de cadastros não é integrada, pois não é possível verificar a integridade referencial no sistema de destino para considerá-la como restrição de eliminação dos registros no Protheus.

O sucesso das operações de inclusão e alteração de registros pode ser verificado acessando o programa de consulta no menu do Cockpit Logístico em: Interface - Log.

O sistema de origem dos dados não recebe o status do processamento dos registros enviados, por isso, considera integrado com base apenas na confirmação de recepção da mensagem de integração.

Entidade (s) ProtheusCódigo (Alías)Web ServiceMétodoEntidade CockpitObservações
FilialSM0LocalityAcquisitionServiceupdateLocalitiesLocalidade

As filiais assumem o papel de localidade quando são locais de carga ou descarga.

Quando MV_CPLEX == "2" não integrar a filial cuja unidade de federação não faça parte da lista de unidades de federação do Brasil.

ClienteSA1LocalityAcquisitionServiceupdateLocalitiesLocalidadeQuando MV_CPLEX == "2" não integrar cliente com país informado diferente de 105 (Brasil).
FornecedorSA2

LocalityAcquisitionService ou CarrierAcquisitionService

updateLocalities ou updateCarriers

Localidade 

Os fornecedores serão integrados como localidade quando atender os seguintes requisitos:

  1. Campo A2_TRANSP (Cód. Transportadora) em branco;
  2. Campo A2_RNTRC (Reg. Nac. Tr. Rod. Cargas) em branco;
  3. Campo A2_PAGGFE (Pagamento pelo SIGAGFE) igual a '2-Não'.

Caso contrário, o fornecedor será integrado como transportadora.

TransportadoraSA4CarrierAcquisitionServiceupdateCarriersTransportador
ProdutoSB1 e SB5ProductAcquisitionServiceupdateProductsProduto
Tipo de VeículoDUTVehicleAcquisitionServiceupdateVehiclesVeículo
Pedido de VendaSC5 / SC6 / SC9 / SB1 / SB5OrderAcquisitionService

createOrders

Pedidos de TransporteO pedido de venda deve possuir, obrigatoriamente, montagem de carga.

Filiais

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: LocalityAcquisitionService

O envio de empresas/filiais não é automático, ou seja, ao cadastrar no Protheus uma nova empresa/filial, para que essas informações sejam replicadas para o Cockpit Logístico é necessário executar a carga de dados disponível em: SIGAOMS > Atualizações > Cockpit Logístico > Carga de dados, assinalando a opção SM0 - Cadastro de Filiais.

Os dados serão enviados ao Cockpit Logístico por meio do método updateLocalities.

Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no CPL em: CADASTRO > Localidades.

Clientes

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: LocalityAcquisitionService

Ao cadastrar um cliente no Protheus, quando a integração estiver ativa os dados serão enviados ao Cockpit Logístico por meio do método updateLocalities.

Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no CPL em: Cadastro > Localidades.

Fornecedores

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: LocalityAcquisitionService ou CarrierAcquisitionService

Ao cadastrar um Fornecedor no Protheus, quando a integração estiver ativa os dados serão enviados ao Cockpit Logístico por meio do método updateLocalities (conforme parametrização do cadastro SA2, de acordo com o comentado acima).

Esses dados, por sua vez, serão salvos como localidade e poderão ser visualizados no CPL em: Cadastro > Localidades.

Transportadores

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: CarrierAcquisitionService

Ao cadastrar um Transportador no Protheus, quando a integração estiver ativa os dados serão enviados ao Cockpit Logístico por meio do método CarrierAcquisitionService.

Esses dados, por sua vez, serão salvos como Transportadoras e poderão ser visualizados no CPL em: Cadastro > Transportadoras.

Produtos

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: ProductAcquisitionService

Ao cadastrar um Produto no Protheus, quando a integração estiver ativa os dados serão enviados ao Cockpit Logístico por meio do método ProductAcquisitionService.

Esses dados, por sua vez, serão salvos como Produtos Simples e poderão ser visualizados no CPL em: Cadastro > Produtos Simples.

Tipos de Veículo

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: VehicleAcquisitionService

Ao cadastrar um Tipo de veículo no Protheus, quando a integração estiver ativa os dados serão enviados ao Cockpit Logístico por meio do método VehicleAcquisitionService.

Esses dados, por sua vez, serão salvos como Veículos e poderão ser visualizados no CPL em: Cadastro > Veículos.

Pedidos de Venda

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: OrderAcquisitionService

Ao cadastrar um Pedido de venda no Protheus, quando a integração estiver ativa os dados são enviados ao Cockpit Logístico por meio do método OrderAcquisitionService.

Esses dados, por sua vez, geram no Cockpit Logístico pedidos de transporte e poderão ser visualizados emProgramação > Analise; deve-se filtrar os dados da cesta geral.

No OMS foi disponibilizado um programa (OMSXCPL6) que permite selecionar uma lista com os pedidos de venda para envio ao Cockpit Logístico, sendo que estes pedidos devem estar liberados por crédito e estoque e com o campo "Carga" igual a 1 = Utiliza.

O cancelamento do pedido no Cockpit Logístico pode ser efetuado por meio de duas rotinas:

1) Cancelamento via rotina Preparação dos Documentos de Saída (MATA460A):

    • Quando houver o cancelamento de uma liberação do pedido de venda por meio da rotina Preparação dos Documentos de Saída, opção Ações Relacionadas > Estor. Docas, na confirmação da exclusão do registro é realizado o envio do cancelamento ao Cockpit Logístico.

2) Cancelamento via rotina Pedido de Venda (MATA410):

    • Alteração de um pedido de venda já liberado na rotina Pedido de Venda (MATA410):
      Ao confirmar a alteração, o sistema realiza a exclusão do registro liberado, assim é realizado o envio do cancelamento ao Cockpit Logístico.

    • Alteração de pedido de venda já liberado e com nova liberação na própria rotina (MATA410):
      Ao confirmar a alteração com nova liberação, o sistema exclui o registro anterior e recria um novo registro com as informações da alteração. Assim, é realizado o envio do cancelamento para o Cockpit Logístico e o envio de um novo pedido liberado.

Viagens

Tipo de Fluxo: Cockpit Logístico > Protheus

Mensagem: ReleaseTripPublishRequestService

O Cockpit Logístico envia as viagens geradas para o OMS para a formação das cargas, sendo que o envio é realizado pela chamada do Web Service ReleaseTripPublishRequestService. Para isso foi disponibilizado um programa monitor para receber estas viagens (OMSXCPL7).

Ao receber uma viagem com o campo Placa (DK0_PLACA) preenchido é realizada uma busca pela placa no cadastro de veículos (DA3). Se encontrado algum registro, o veículo será associado à carga. Para que isso ocorra é essencial que a placa recebida do CPL seja idênticaa placa cadastrada no Protheus.

A rotina oferece a opção de marcação dos registros e o botão Gera Carga, para geração das Cargas no OMS.  

No próximo tópico são listadas as correspondências entre os campos de cada entidade e a respectiva tag XML da mensagem de integração.


Integração OMS Protheus x Cockpit Logístico NeologDetalhamento das Mensagens

Mensagem de Integração dos Registros do Cadastro de Filiais

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
identifier 

"FIL-" + FWCodFil()
ou
"FIL-" + FWGrpCompany() + "-" + FWCodFil()

Código 

O envio da concatenação de empresa + filial permanece condicionado ao fato de não existir uma empresa padrão para integração do OMS com o Cockpit Logístico.

Esta empresa padrão deve ser informada no arquivo de configuração do servidor Protheus (appserver.ini) na seção [NEOLOG] na chave DefaultCompany.

Informações
iconfalse
titleNota!
Para a localidade de filial não existe influência sobre o fato de estar usando a configuração de empresas na concatenação das informações.
name M0_FILIAL Nome 
description M0_NOMECOM Descrição 
addressStreet M0_ENDENT Endereço Obter o conteúdo usando a função LjFiGetEnd sobre o campo M0_ENDENT
addressNumber 
Nº Obter o conteúdo usando a função LjFiGetEnd sobre o campo M0_ENDENT
addressComplement M0_COMPENT Complemento 
addressDistrict M0_BAIRENT Bairro 
addressZipCode M0_CEPENT CEP 
addressCityM0_CIDENT Cidade 
addressStateAcronym M0_ESTENTUF Quando a UF pertencer a lista das UFs brasileiras, será considerado a mesma, caso contrário "EX".
addressCountryAcronym "BR" ou "EX" País Quando a UF pertencer a lista das UFs brasileiras, será considerado "BR", caso contrário "EX".
logisticRoleId "1" Tipo 1=Ambos

Mensagem de Integração dos Registros do Cadastro de Clientes

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
identifier"CLI-" + RTrim(SA1->A1_COD) + "-" + RTrim(SA1->A1_LOJA) + OMSGETFIL("SA1") ²Código
nameA1_NREDUZNome
descriptionA1_NOMEDescrição
addressStreetA1_ENDEndereçoObter o conteúdo usando a função LjFiGetEnd sobre o campo A1_END
addressNumber
Obter o conteúdo usando a função LjFiGetEnd sobre o campo A1_END
addressComplementA1_COMPLEMComplemento
addressDistrictA1_BAIRROBairro
addressZipCodeA1_CEPCEP
addressCity

CC2_MUN

CidadeAcessa a tabela CC2 através dos campos A1_ESTE e A1_CODMUNE.
addressStateAcronymA1_ESTUFQuando a UF pertencer a lista das UFs brasileiras será considerada a mesma, caso contrário "EX".
addressCountryAcronym"BR" ou YA_SIGLAPaís

Acessar a tabela SYA pelo campo A1_PAIS.

Quando A1_PAIS estiver em branco ou igual a 105, atribuir "BR".

logisticRoleId"2"Tipo2=Destino (por orientação da Neolog para gerar menos combinações de rota).

Mensagem de Integração dos Registros do Cadastro de Fornecedor Como Localidade

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
identifier"FOR-" + RTrim(SA2->A2_COD) + "-" + RTrim(SA2->A2_LOJA) + OMSGETFIL("SA2") ²CódigoSerá adicionada a sigla "FOR" para composição do código para identificação que se trata de um fornecedor para uso como uma localidade, devido aos pedidos de beneficiamento do OMS.
nameA2_NREDUZNome
descriptionA2_NOMEDescrição
addressStreetA2_ENDEndereçoObter o conteúdo usando a função LjFiGetEnd sobre o campo A2_END
addressNumber
Obter o conteúdo usando a função LjFiGetEnd sobre o campo A2_END
addressComplementA2_COMPLEMComplemento
addressDistrictA2_BAIRROBairro
addressZipCodeA2_CEPCEP
addressCity

CC2_MUN

CidadeAcessar a tabela CC2 pelo campo A2_MUN.
addressStateAcronymA2_ESTUFQuando a UF pertencer a lista das UFs brasileiras será considerada a mesma, caso contrário "EX".
addressCountryAcronym"BR" ou YA_SIGLAPaísAcessar a tabela SYA pelo campo A2_PAIS. Quando A2_PAIS estiver em branco ou igual a 105, atribuir "BR".
logisticRoleId"2" Tipo2=Destino (por orientação da Neolog para gerar menos combinações de rota).

Mensagem de Integração dos Registros do Cadastro de Fornecedor Como Transportadora

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
identifierA2_COD + OMSGETFIL("SA2") ²Código
nameA2_NREDUZNome da Transportadora
descriptionA2_NOMEDescrição da Transportadora
email

A2_EMAIL

E-mail da Transportadora

Mensagem de Integração dos registros do cadastro de Transportadora

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
identifierA4_COD + OMSGETFIL("SA4") ²Código
nameA4_NREDUZNome da Transportadora
descriptionA4_NOMEDescrição da Transportadora
email

A4_EMAIL

E-mail da Transportadora

Mensagem de Integração dos Registros do Cadastro de Tipos de Veículos

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
identifierDUT_TIPVEI+ OMSGETFIL("DUT") ²Código
nameDUT_DESCRINome
descriptionDUT_DESCRIDescrição
priority0PrioridadeValor fixo
similarity0SimilaridadeValor fixo

Mensagem de Integração dos Registros do Cadastro de Produto

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
shipperIdMV_CPLEMBEmbarcador
identifierB1_COD + OMSGETFIL("SB1") ²Código
descriptionB1_DESCDescrição
productCategoryIdB1_GRUPOCategoria
heightB5_ALTURLCAlturaPasta Logística
lengthB5_LARGLCComprimentoPasta Logística
widthB5_COMPRLCLarguraPasta Logística
weightB1_PESO ou B1_PESBRUPeso

1. Quando o parâmetro MV_PESOCAR estiver como "L" será enviado o campo B1_PESO, caso contrário B1_PESBRU.

2. Quando o parâmetro MV_CPLUMIT estiver informado para enviar a primeira unidade de medida, o peso enviado será:

Peso → Campo de Peso Protheus * Fator de Conversão para KG.

3. Quando o parâmetro MV_CPLUMIT estiver informado para enviar a segunda unidade de medida, o peso enviado será:

Se o tipo de conversão (B1_TIPCONV) for Divisor:

Peso → (Campo de Peso Protheus * Fator de Conversão para KG) * Fator de Conversão (B1_CONV)

Se o tipo de conversão (B1_TIPCONV) for Multiplicador:

Peso → (Campo de Peso Protheus * Fator de Conversão para KG) / Fator de Conversão (B1_CONV)

shape"1"Forma1=Caixa

Mensagem de Integração dos Registros do Cadastro de Pedido de Venda

Tag XMLCampo ProtheusCampo Cockpit LogísticoObservações
regionSourceIdMV_CPLREGRegional
integrationDataSourceMV_CPLIDSIntegração
orderTypeSourceIdNilTipo do PedidoTAG não enviada
identifier

RTrim( OMSXGETFIL("SC5",.F.) + "-" +RTrim(SC5->C5_NUM)



codeRTrim( OMSXGETFIL("SC5",.F.) + "-" +RTrim(SC5->C5_NUM)Código do Ped. Transp.
priority"0"Prioridade
erpCreationDtDate()Data CorrenteData de criação do pedido.
pickupStart( C6_DATAEMB ou Data Atual ) + hora fixa "00:01:00" para determinar o início do dia.Janela Embarque
deliveryEnd( C5_FECENT ou C6_ENTREG ou Data Atual ) + hora fixa "23:59:59" para determinar o fim do dia.Janela Entrega
orderIdRTrim( OMSXGETFIL("SC5",.F.) + "-" +RTrim(SC5->C5_NUM)ID do Pedido de Transporte
sourceId

orderId + "-" + C6_ITEM

Código do Item Ped. Transp.Concatenação do campo anterior com o item de sequência do pedido.
productIdC6_PRODUTO + OMSGETFIL("SB1") ²ProdutoConforme o código enviado na mensagem de produtos.
quantityC9_QTDLIB ou C9_QTDLIB2Quantidade total de unid.

Depende do parâmetro MV_CPLUMIT.

Quando estiver parametrizado para enviar na 2ª UM e o produto possui um fator de conversão (B1_CONV) maior que 0 (zero) será enviado o valor do campo C9_QTDLIB2, caso contrário será enviado sempre o campo C9_QTDLIB .

price

C6_VALOR

Valor Total de unid. De prod.
originId"FIL-" + FWCodFil()
ou
"FIL-" + FWGrpCompany() + "-" + FWCodFil()
Origem InicialConforme o código enviado na mensagem de localidades para os registros de filiais.
destinationId

"FOR-" + RTrim(SC5->C5_CLIENT)+ "-" + RTrim(SC5->C5_LOJAENT) + OMSGETFIL("SA2") ²
ou
"CLI-" + RTrim(SC5->C5_CLIENT)+ "-" + RTrim(SC5->C5_LOJAENT) + OMSGETFIL("SA1") ²

ID da Localidade de destino do Pedido

Pode ser enviado o código do cliente ou do fornecedor conforme enviado na mensagem de localidades.

Para pedidos do tipo B ou D (C5_TIPO) será enviado o código do fornecedor, para os demais será enviado o código do cliente.

quantityInShipmentUnitsC9_QTDLIB ou C9_QTDLIB2

Depende do parâmetro MV_CPLUMIT

Quando estiver parametrizado para enviar na 2ª UM e o produto possui um fator de conversão (B1_CONV) maior que zero, será enviado o valor do campo C9_QTDLIB2, caso contrário será enviado sempre o campo C9_QTDLIB .

heightB5_ALTURLC

Quando houver relacionamento com o B1_PRODUTO, quando vazio será enviado por padrão o contéudo = 0.001

widthB5_LARGLC
Quando vazio, por padrão o contéudo enviado será = 0.001
lengthB5_COMPRLC
Quando vazio, por padrão o contéudo enviado será = 0.001
weightB1_PESO ou B1_PESBRU

1. Quando o parâmetro MV_CPLUMIT estiver informado para enviar a primeira unidade de medida, o peso enviado será:

Peso → Campo de Peso Protheus * Fator de Conversão para KG.

2. Quando o parâmetro MV_CPLUMIT estiver informado para enviar a segunda unidade de medida, o peso enviado será:

Se o tipo de conversão (B1_TIPCONV) for Divisor:

Peso → (Campo de Peso Protheus * Fator de Conversão para KG) * Fator de Conversão (B1_CONV)

Se o tipo de conversão (B1_TIPCONV) for Multiplicador:

Peso → (Campo de Peso Protheus * Fator de Conversão para KG) / Fator de Conversão (B1_CONV)

shipperIdMV_CPLEMBID do Embarcador
modal"1"ID do modal do pedido de transporteEnviar valor fixo 1 - Rodoviário.
incotermC5_TPFRETE
Sendo o conteúdo C = 1 e F = 0 para o CPL; quando o campo for vazio passaremos sempre 1.
shipmentUnitWrapperCodeMV_CPLINVInvólucro de embarque

Âncora
DefaultCompany
DefaultCompany

² Para o combinação da filial para os cadastros serão aplicadas as seguintes regras:

  • Utilizando a configuração de gestão de empresas e esta possua em sua máscara a empresa:
    • Será enviado apenas o retorno da função xFilial( <TAB> ), onde TAB representa a tabela do Protheus.
  • Utilizando a  configuração de gestão de empresas, sem possuir a empresa na máscara, ou não utilizando a configuração de gestão de empresas:
    • Caso exista uma empresa padrão (DefaultCompany) configurada na seção [NEOLOG] do INI do servidor de aplicação será enviado apenas o retorno da função xFilial( <TAB> ), onde TAB representa a tabela do Protheus.
    • Não existindo a empresa padrão será enviada a concatenação da função FWGrpCompany() + xFilial( <TAB> ), onde TAB representa a tabela do Protheus.

Sempre o retorno não for branco, o retorno será precedido por um "-" (hífen), caso a função não receba o valor .F. no segundo parâmetro. 

* Poderá ocorrer deste valor permanecer em branco, em função de algumas parametrizações e configuração da tabela ser compartilhada.


Integração OMS Protheus x Cockpit Logístico NeologConfigurações Complementares

Configuração Para Envio Automático de Pedidos de Venda (Schedule)

Os pedidos de venda gerados no módulo SIGAOMS podem ser enviados automaticamente ao Cockpit Logístico. Para isso, deve ser configurada a execução automática (Schedule) da rotina Envio de Pedidos de Venda (OMSXCPL6). Esta configuração pode ser executada conforme descrito no link: http://tdn.totvs.com/display/framework/Schedule+Protheus.

No arquivo appserver.ini é necessário inserir a configuração abaixo:

Bloco de código
languagejava
themeEclipse
titleappserver.ini
collapsetrue
[OnStart]
jobs=FWSCHDMANAG,FWSCHDQUEUE
RefreshRate=60

[FWSCHDMANAG]
Main=FWSCHDMANAG
Environment=<ambiente>

[FWSCHDQUEUE]
Main=FWSCHDQUEUE
Environment=<ambiente>

Cadastro de Fator de Conversão Para KG (OMSA140)

O Cockpit Logístico possuí como característica o tratamento de peso apenas em KG, portanto, para que o SIGAOMS envie o valor convertido é necessário cadastrar as unidades de medidas utilizadas e associar seu valor em KG.

Para realizar esse cadastro acesse SIGAOMS > Atualizações > Cockpit Logístico > Fator de Conversão, sendo necessário realizar esse cadastro para todas as unidades de medidas dos produtos que serão utilizadas na integração, cuja relação de peso não seja em KG.

Exemplo de cadastro:

Unidade de Medida (DK2_CODUM) → TL (tonelada), Peso em KG (DK2_PESOKG) → 1000. Isso significa que a cada uma tonelada são 1000 kg.

Modo de Compartilhamento Tabelas Viagem x Carga

Para ambientes que utilizam diversas filiais e/ou empresas é necessário garantir que as tabelas de viagem DK0 e DK1 possuam a mesma configuração de modo de acesso das tabelas de carga DAK e DAI. Exemplo: se as tabelas de carga estiverem configuradas com os modos de acesso Ac. Filial = 2-Exclusivo, Ac. Unidade = 2-Exclusivo, Ac. Empresa = 2-Exclusivo, logo, as tabelas de viagem deverão possuir configuração idêntica. Esse detalhe é imprescindível para garantir a adequada ligação entre a viagem do Cockpit Logístico e a carga gerada pelo OMS.

Esse ajuste deve ser realizado por meio do configurador do Protheus (sigacfg).


Integração OMS Protheus x Cockpit Logístico NeologFuncionalidades Não Contempladas

Informações
iconfalse

A integração entre o SIGAOMS e o Cockpit Logístico possuí as seguintes restrições:

  • Não é possível realizar quebra da quantidade do pedido, tanto no Cockpit Logístico quanto no SIGAOMS.
  • Não é possível integrar pedidos faturados (restrição já existente na geração da carga).
  • É possível selecionar vários registros para a integração de uma única vez, seja de cliente, produto ou fornecedor, porém, o envio das mensagens XML é realizado uma por vez (e não em lote).

  • Não existe uma forma de visualizar o gerenciamento do relacionamento das viagens do Cockpit Logísitico com o SIGAOMS, quando as viagens possuírem pedidos de mais de uma empresa/filial e quando não for utilizada a Gestão de Empresas. ¹

¹ É possível que uma viagem no Cockpit Logísitico contenha pedidos de diferentes empresas/filiais, para que este processo seja refletido no lado Protheus, é necessário que o Protheus esteja configurado para ser utilizado no modelo de Gestão de Empresas, parametrizando o OMS para trabalhar no conceito de operador logístico, onde uma empresa/filial fica como centralizadora das informações. Caso contrário poderá ocorrer de uma viagem que possuir pedidos de diferentes empresas/filiais seja quebrada em várias no Protheus, gravando cada parte da respectiva viagem, na empresa/filial dos pedidos, ou seja, uma viagem do Cockpit Logístico poderá gerar uma ou mais cargas no OMS, não havendo nenhuma interface que permita ao usuário consultar este relacionamento.


Integração OMS Protheus x Cockpit Logístico NeologInformações Complementares

Por uma questão técnica, em função de poderem ser enviadas informações de diversas empresas/filiais do SIGAOMS para o Cockpit Logístico, porém, este trata tudo como uma única origem de dados, dependendo de configurações poderá gerar viagens com dados de diferentes empresas/filiais.

Sendo assim foi necessário criar no Protheus, de forma fixa, uma tabela que grave este relacionamento das viagens do Cockpit Logístico com as empresas/filiais do SIGAOMS. Esta tabela será criada automaticamente na primeira integração de viagem recebida.

A estrutura desta tabela (VIAGEM_OMSxCPL) é apresentada a seguir:

NomeTipoTamanhoObservações
EMPRESACaractere

Len(FWGrpCompany())

Padrão 2
FILIALCaractereFwFilialSize()
CPLMSGIDNumérico10Identificador da Mensagem do Cockpit Logístico
VIAGEMCaractereTamSx3("DK0_VIAGID")[1]Identificador da Viagem do Cockpit Logístico
RECNOVIAGNumérico10Recno() da Viagem do Protheus DK0->(Recno())
DATAINTCaractere8Data da Integração - Date()
HORAINTCaractere8Hora da Integração - Time()


Não existe uma interface de consulta para esta tabela.  

Ela será utilizada em processos internos para busca da empresa/filial em que a viagem está gravada para as solicitações de reprogramação e cancelamento recebidas do Cockpit Logístico.