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.

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. 

São utilizados os cadastros básicos já disponibilizados na integração entre o SIGATMS x Cockpit Logístico sendo eles: 

• Produto
• Filial
• Cliente
• Tipo de veículo
• Fornecedores

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

Parametrização appServer.ini

Para que seja possível receber as viagens do Cockpit Logístico, é necessário configurar um WebService no appserver.ini Protheus. É recomendado criar um webservice com as seguintes configurações(modificando o arquivo appserver.ini):

;Serviço webserver HTTP
[HTTP]
ENABLE=1
PATH=<Caminho_Cache_imagens>;C:\TOTVS 11\Prottheus\Protheus_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 11\Prottheus\Protheus_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=TMSXStart ;ponto de inicio obrigatório
ONCONNECT=TMSXConnect ;ponto de inicio obrigatório
TMSPREPAREIN=<empresa>,<filial>;obrigatório

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.

Parametrização Cockpit Logístico

Para configurar o envio de viagens do cockpit ao webservice protheus, entre no Cockpit Logístico e vá em Adminsitração -> Integração. Clique na aba 'Fontes de Dados' e clique em 'Inserir'

Digite o código, Descrição e Código da base. Sugestão: PROTHEUS

No campo 'URL' da seção 'Cancelamento de viagem liberada', digite: http://<ip ou nome>:<porta>/neolog/CancelService.APW 

No campo 'Tempo Máximo de Espera por Resposta' coloque o timeout do serviço. Recomendado 30000.

No campo 'URL' da seção 'Execução da viagem', digite: na. 

No campo 'Tempo Máximo de Espera por Resposta' coloque o timeout do serviço. Recomendado 1000.

No campo 'URL' da seção 'Solicitação de Liberação de Viagem', digite: http://<ip ou nome>:<porta>/neolog/PublishReleasedTrip.APW

No campo 'Tempo Máximo de Espera por Resposta' coloque o timeout do serviço. Recomendado 30000.

No campo 'URL' da seção 'Solicitação de reprogramação de Viagem', digite: http://<ip ou nome>:<porta>/neolog/ReprogramService.APW

No campo 'Tempo Máximo de Espera por Resposta' coloque o timeout do serviço. Recomendado 30000.

Clique em Salvar.

Protheus

Insira aqui as informações pertinentes ao Protheus.

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 RM Conector e 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

Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.

Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.

Fluxo das Informações

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

Mensagem de integração dos registros do cadastro de "Transportadora"

Mensagem de integração dos registros do cadastro de "Pedido de Venda"

Mensagem de integração das viagens geradas no CPL para posterior geração das Cargas no SIGAOMS, utilizando a operação publishReleasedTrip:

Mensagem dos itens (Pedidos) do CPL - deliveryUnit

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

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 serão salvos como Pedidos de transporte e poderão ser visualizados no CPL em: PROGRAMAÇÃO -> Analise, deve-se filtrar os dados da cesta geral.

No SIGAOMS, foi disponibilizado um programa 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):

• • 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. Docs" na confirmação da exclusão do registro, é realizado o envio do cancelamento ao CockPit Logístico.

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. 

Cargas

Tipo de Fluxo: Cockpit Logístico -> Protheus

Mensagem: ReleaseTripPublishRequestService

Versão: 1.000

O Cockpit Logistico terá a função de enviar 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".

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Como fazer (opcional)

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

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

Exemplo 1:

Tratamento de erros de integração (Produto A)

Tratamento de erros de integração (Produto B)

Exemplo 2:

Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

• Identificar o funcionamento da integração;
• Identificar a ocorrências de problemas;
• Coletar evidências do mau funcionamento relatado pelo cliente;
• Realizar possíveis ajustes na integração quanto à configuração ou negócio.

Anexos