INTEGRAÇÃO OMS PROTHEUS X COCKPIT LOGÍSTICO NEOLOG

Contexto de Negócio (Introdução)

Realizada a integração entre o módulo 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 a utilização de sistemas intermediários (TOTVS EAI, TOTVS ESB, entre outros).

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 qual efetuará a roteirização e o arranjo das cargas com base na demanda de transportes enviados pelo módulo 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;
• 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: 

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

O cadastro de Fornecedor foi ajustado permitindo que quando a integração OMS x CPL estiver habilitada e os campos A2_TRANSP (Cód. Transportadora) ,A2_RNTRC (Reg. Nac. Tr. Rod. Cargas)  e A2_PAGGFE (Pagamento pelo SIGAGFE) não estiverem preenchidos, o mesmo seja enviado como uma "Localidade" para o Cockpit Logístico.

Além dos cadastros, foi realizada 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 módulo 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 obter mais detalhes sobre o OMS TOTVS, acesse o 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 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

O objetivo é integrar o módulo 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 a utilização de sistemas intermediários (TOTVS EAI, TOTVS ESB, entre outros).

Escopo

O escopo desta integração permitirá o envio dos pedidos de venda liberados (crédito / estoque) no módulo 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 módulo 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.

Quando essa funcionalidade for utilizada por meio da Protheus versão 11.80 é imprescindível execução do compatibilizador OMSP11R1. Nas versões superiores não existe esse necessidade.

Para visualizar o documento técnico referente a esta integração, acesse o link: LOGTMS01-69 DT Integração OMS x 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 > Parâm Integração (OMSXCPL1), o Protheus deve ser parametrizado para o 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
OMSPREPAREIN=<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 acesse:

1. Administração > Integração, selecione a pasta 'Fontes de Dados' e clique em 'Inserir'.
2. Digite o Código, Descrição e 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", coloque 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", coloque 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", coloque 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", coloque o timeout do serviço.
    Recomendado 30000.

7. Selecione a opção "Salvar".

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:

[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.

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

O sistema Neolog possuí como característica o tratamento de peso apenas em KG, portanto para que o OMS envie o valor convertido é necessário cadastrar as unidades de medidas utilizadas e associar seu valor em KG. Para realizar esse cadastro é necessário ir em SIGAOMS > Atualizações > Cockpit Logístico > Fator de Conversão. Será necessário realizar esse cadastro para todas as unidades de medidas dos produtos que irão ser utilizadas na integração.

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. 

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.

Transações / Entidades / Mensagens Únicas

Fluxo das Informações

Os cadastros devem ser realizados no módulo SIGAOMS 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"

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

Transações / Entidades / Mensagens Únicas

Método

ID

Descrição

Origem

Destino

XSD (versões podem variar)

Cadastros

01

Transportadora

Protheus

Cockpit Logístico

updateCarriers

Processos

07

Enviar viagens

Cockpit Logístico

SIGAOMS

ReleaseTripPublishRequestService

08

Liberar Viagens

SIGAOMS

Cockpit Logístico

UnblockReleasedTripAcquisition

Fluxo das Informações

Os cadastros devem ser realizados no módulo SIGAOMS 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.

LocalityAcquisitionService ou

CarrierAcquisitionService

updateLocalities ou

updateCarriers

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.

updateProducts

updateLocalities

updateLocalities

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"

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

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

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

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 módulo SIGAOMS, utilizando a operação publishReleasedTrip:

Mensagem dos itens (Pedidos) do CPL - deliveryUnit

Processos

Foi realizado tratamento na rotina Carga de Dados (OMSXCPL2), para a carga de dados do módulo 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 Envio de Pedidos de Venda (OMSXCPL6), que permite a seleção e envio de pedidos de vendas criados no módulo SIGAOMS para o CPL gerando pedidos de transporte, e uma nova rotina Monitor de Cargas (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

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, marcando 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.

Fornecedores

Tipo de Fluxo: Protheus > Cockpit Logístico

Mensagem: LocalityAcquisitionService ou CarrierAcquisitionService

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 (conforme parametrização do cadastro SA2, conforme 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

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 módulo 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 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. Docs" 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.

Cargas

Tipo de Fluxo: Cockpit Logístico > Protheus

Mensagem: ReleaseTripPublishRequestService

Versão: 1.000

O Cockpit Logístico envia as viagens geradas para o módulo 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). 

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

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 módulo 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)

Vide 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.

Checklist de Verificações

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