Escopo

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.

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

Instalação/Configuração

Configuração WebService AppServer Protheus

Para que seja possível receber as viagens do Cockpit Logístico, é necessário configurar um WebService no servidor de aplicação 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\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.

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

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:

Parametrização do Processo de Debug

É possível parametrizar para salvar todas as mensagens trocadas entre o OMS e o Cockpit Logístico, permitindo assim analisar os detalhes das mensagens trocadas. Esta parametrização deverá ser feita no arquivo de configuração do servidor Protheus (appserver.ini). As configurações abaixo devem ser incluídas no arquivo na seção [NEOLOG]:

;Configuração integração com o Cockipt Logístico
[NEOLOG]
DefaultCompany=<empresa>
Debug=1
DebugPath=<caminho relativo> ;logs\neolog

Onde:

• DefaultCompany: Empresa padrão para integração entre o OMS e o Cockpit Logístico. Caso não informado não será considerado, sempre sendo enviado nas mensagens nas 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á enviado apenas a concatenação do código com campo filial do respectivo cadastro/processo.
• Debug: Indicador de que o processo de gravação dos arquivos xml das mensagens está ativado. 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".

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

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.

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.

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.

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.

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.

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 Cockpit Logístico pedidos de transporte e poderão ser visualizados em: Programaçã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. 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 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. 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.

Viagens

Tipo de Fluxo: Cockpit Logístico > Protheus

Mensagem: ReleaseTripPublishRequestService

Versão: 1.000

O Cockpit Logístico envia as viagens geradas para o OMS 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 OMS, 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". 

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.

Detalhamento das Mensagens

Mensagem de integração dos registros do cadastro de Filiais

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

Mensagem de integração dos registros do cadastro de Fornecedor como Localidade

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

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

Mensagem de integração dos registros do cadastro de Fornecedor como Transportadora

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

² 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á enviado 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 ficar em branco, em função de algumas parametrizações e configuração da tabela ser compartilhada.

Configuraçõ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:

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

Funcionalidades Não Contempladas