INTEGRAÇÃO OMS Protheus X Cockpit Logístico Neolog

Contexto de negócio (Introdução)

Integrar o módulo de Gestão de Distribuição (SIGAOMS) 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 já existentes do Cockpit Logístico, sem transformação de mensagens e sem utilização de sistemas intermediários (TOTVS EAI, TOTVS ESB, etc.).
Para esta integração foram consideradas as alterações necessárias para que o planejamento das montagens de cargas do módulo Gestão de Distribuição (SIGAOMS) da linha Microsiga Protheus utilize os recursos de Programação de Transportes do Cockpit Logístico. A Programação de Transportes fará a roteirização e o arranjo das cargas com base na demanda de transportes enviadas pelo SIGAOMS considerando 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 e redução da quantidade de viagens.
Para tanto, são utilizados os cadastros básicos já disponibilizados na integração entre o SIGATMS x Cockpit Logístico, sendo eles: 

...

Foi disponibilizado apenas um novo cadastro para a integração "Transportadoras". O cadastro de fornecedor foi ajustado permitindo que quando a integração OMS x CPL estiver habilitado o mesmo seja enviado como uma "Localidade", para o Cockpit Logístico.
Além dos cadastros, foi realizado a integração dos pedidos de venda que utilizam as "Cargas", os pedidos de venda são enviados para o Cockpit Logístico gerando "Pedidos de Transportes", para estes, o Cockpit Logístico realiza a análise e geração da viagem. 
Após a geração da viagem no Cockpit Logístico, este se integra com o SIGAOMS para a geração das Cargas.

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• TOTVS Gestão de Distribuição (SIGAOMS)  A sigla OMS significa Order Management System, ou seja, gerenciamento de pedidos e serviços e 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 saber mais sobre o OMS TOTVS clique no link: https://www.totvs.com/mktfiles/tdiportais/helponlineprotheus/portuguese/sigaoms.htm
• 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 saber mais sobre o Cockpit Logístico Neolog clique no link: http://www.neolog.com.br/neolog-site/index.php/cockpit-logistico/

Integração

O objetivo é integrar o módulo de Gestão de Distribuição (SIGAOMS) 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 já existentes do Cockpit Logístico, sem transformação de mensagens e sem utilização de sistemas intermediários (TOTVS EAI, TOTVS ESB, etc.).

Escopo

O escopo desta integração permitirá o envio dos pedidos de venda liberados (crédito / estoque) no SIGAOMS 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 SIGAOMS para a geração das CARGAS. 
As entidades e os pontos de integração que farão parte do escopo dessa integração são: 

Pré-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 11.8 ou superior. Parâmetro de integração com Cockpit Logístico ativo (MV_CPLINT == .T.) Web Service de integração válido informado (MV_CPLURL)
Todos os parâmetros citados encontram-se no programa Parâm Integração  (OMSXCPL1) que pode ser acessado pelo menu Atualizações - Cockpit Logístico.
 
Atençã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.
É imprescindível a atualização do Protheus 11.8 por meio da execução do compatibilizador OMSP11R1.
Para ver o documento técnico referente a esta integração utilize este link: DT_Integracao_OMS_Neolog
Para que a integração possa funcionar corretamente, o ambiente deve conter o módulo SIGAOMS e o Cockpit Logístico devidamente configurados.
Parametrização SIGAOMS
Por meio do menu Atualizações > CockPit Logístico > Param Integração, deve ser parametrizado o Protheus para correto funcionamento da integração conforme abaixo:

Onde:

...

[OnStart]
jobs=FWSCHDMANAG,FWSCHDQUEUE
RefreshRate=60
[FWSCHDMANAG]
Main=FWSCHDMANAG
Environment=<ambiente>
[FWSCHDQUEUE]
Main=FWSCHDQUEUE
Environment=<ambiente>

Instalação/Atualização

Vide tópico Pré-requisitos instalação/implantação/utilização.

Protheus

Vide tópico Pré-requisitos instalação/implantação/utilização.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá 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.

Suporte

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 fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Transações/Entidades/Mensagens únicas

Fluxo das Informações

Os cadastros devem ser realizados no OMS Protheus e integrados para o 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. 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.

...

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.

Cadastros

Mensagem de integração dos registros do cadastro de "Tipo de Veículo"

...

Processos

Foi realizado tratamento na rotina OMSXCPL2 para a carga de dados do SIGAOMS para o Cockpit Logístico, permitindo a sincronização dos cadastros de Filiais, Clientes, Produtos, Tipos de Veículos, Fornecedores e Transportadora. 
Além disso, foi disponibilizada uma nova rotina(OMSXCPL6) que permite a seleção e envio de pedidos de vendas criados no OMS para o CPL gerando pedidos de transporte, e uma nova rotina(OMSXCPL7) que monitora e recebe as viagens geradas no CPL para posterior geração de carga e liberação no Protheus.
 

Fluxo do Processo

Clientes
Tipo de Fluxo: Protheus -> Cockpit Logístico
Mensagem: LocalityAcquisitionService
Versão: 1.000
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
Filiais
Tipo de Fluxo: Protheus -> Cockpit Logístico
Mensagem: LocalityAcquisitionService
Versão: 1.000
Ao cadastrar uma filial 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
Versão: 1.000
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, 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
Versão: 1.000
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
Versão: 1.000
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
Versão: 1.000
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
Versão: 1.000
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 CPL Pedidos de transporte e poderão ser visualizados em: PROGRAMAÇÃO -> Analise, deve-se filtrar os dados da cesta geral.
No SIGAOMS, foi disponibilizado um programa(OMSXCPL6) que permite selecionar uma lista com os pedidos de venda para envio ao Cockpit Logístico. Os pedidos deverão estar liberados por crédito e estoque e com o campo "Carga" igual a 1 = Utiliza.
O cancelamento do pedido no CPL pode ser feito por meio de duas rotinas: 
Cancelamento via rotina Preparação dos Documentos de Saída (MATA460A):

...

Cargas
Tipo de Fluxo: Cockpit Logístico -> Protheus
Mensagem: ReleaseTripPublishRequestService
Versão: 1.000
O Cockpit Logistico envia as viagens geradas para o SIGAOMS para a formação das Cargas. O envio é realizado pela chamada do WebService  ReleaseTripPublishRequestService, para isso foi disponibilizado um programa monitor para receber estas viagens(OMSXCPL7). 
A rotina oferece a opção de marcação dos registros e um botão "Gera Carga" para geração das Cargas no OMS.  
Uma vez recebida a viagem do Cockpit e gerada a Carga no SIGAOMS, após a geração do documento fiscal da carga (NF de Saída) é enviada novamente ao Cockpit uma mensagem de retorno com a confirmação da gravação da Carga e documento de saída, assim o Cockpit confirma a viagem gerada, este retorno é realizado pelo WebService publishReleasedTripResponse, mensagem UnblockReleasedTripAcquisition. Esta chamada ocorre por meio da opção "Liberar Viagem".
 

Como fazer (opcional)

Ver item "Procedimento para Utilização" no documento técnico DT_Integracao_OMS_Neolog
  

Checklist de suporte da aplicação

Instalação/Configuração

• Pelo programa Parâm Integração (OMSXCPL1) informe e teste a URL do Web Service do Cockpit Logístico.

...

• Configuração dos parâmetros de integração

Anexos