INTEGRAÇÃO LOGIX X GFE

Contexto de negócio (Introdução)

Gestão de Frete Embarcador (SIGAGFE) é um aplicativo desenvolvido sobre a plataforma TOTVS.

Utiliza o framework de funcionalidades do Microsiga Protheus e tem como objetivos funcionais: 

• Auxiliar no controle dos processos operacionais de recepção e despacho de cargas; 
• Registrar, provisionar e conferir as despesas decorrentes da contratação de serviços de transporte realizados por terceiros;
• Suportar a troca de informações entre o contratante e os prestadores de Serviço de Transporte; 
• Manter os dados relacionados a documentos, custos e despesas com transporte, sincronizados e integrados aos demais módulos do software ERP.

Os Cadastros e Processos que são sincronizados e integrados entre os sistemas, na direção do Logix para o SIGAGFE são:

Os Processos realizados dentro do SIGAGFE e que tem informações enviadas aos módulos do Logix são:

Sistemas Envolvidos

•  Protheus / Gestão de Frete Embarcador 
• Logix:
  • Cadastros Gerais; 
  • Faturamento; 
  • Recebimento de Materiais; 
  • Financeiro; 

Integração

Desenvolvida integração que tem por objetivo permitir aos clientes Logix (BackOffice) o uso do sistema especialista para Gestão de Frete Embarcador.

A arquitetura utlizada para a integração é a mensageria única/EAI2 na maioria das integrações e REST especificamente na integração do cálculo da simulação do frete pelo GFE na rotina de Pedidos e Faturamento Logix.

Escopo

Envio de dados do Logix para o GFE

Para a sincronização de cadastros e movimentos originados no ERP são associados os Adapters da Mensagem Única nas interfaces do cadastro no ERP.

As principais ações (inclusão, alteração, eliminação) permitindo assim replicação para a base de dados do TOTVS SIGAGFE e ficando os cadastros iguais em ambos os lados.

Também é possível uma carga inicial de dados através de rotina que permite o envio de toda a massa de dados, ou através de filtros (FIN00000).

Recebimento de dados do GFE no Logix

Para a integração dos documentos registrados no TOTVS GFE para o ERP é utilizada uma rotina de execução contínua do próprio EAI2, essa rotina monitora a entrada de XMLs das mensagens únicas mapeadas para recebimento no ERP Logix.

O controle dos dados que estão aptos para integração é efetuado pelo Monitor de integração (EAI10000). 

Cada Adapter utiliza as rotinas de negócio do Logix para processar os dados; ao final de cada processamento interage novamente com o TOTVS SIGAGFE para atribuir o retorno: Sucesso ou Erro.

Pré-requisitos instalação/implantação/utilização

Logix

• Liberação oficial: release 12.1.19 e posteriores.

• EAI2/Mensageria única instalado e configurado.

Protheus

Insira aqui as informações pertinentes ao Protheus.

Instalação/Atualização

Logix

Configuração das transações do EAI Logix:

 Executar o programa EAI10000 (Monitor EAI)

•  Acesse o menu Configuração > Aplicativo Hospedeiro. Clicar no botão ‘Buscar novos adapters’ para recarregar os adapter existentes no RPO de acordo com as novas configurações.

• Acesse o menu Configuração > Aplicativos Externos. Clicar em ‘Incluir’ e depois no botão ‘Configurar’. Selecionar a ‘Classe canal’ correspondente ao produto com o qual queira se comunicar. 
• No quadro ‘Propriedades’ preencher as informações solicitadas e clicar em ‘Confirmar’. Após isso serão exibidas na tela principal as transações que o aplicativo externo possui e com o qual pode-se trocar informações.

• Acesse novamente o menu Configuração > Aplicativo Hospedeiro. Clicar no botão ‘Modificar’, em seguida dê dois cliques na coluna ‘Rotas’ de cada mensagem envolvida nesta integração para indicar para qual aplicativo externo/contexto a mesma será enviada.

• As mensagens abaixo deveram estar habilitadas para o funcionamento da integração:

Parâmetros Gerais (LOG00087)

• Aplicar os conversores de parâmetros: sup01869.cnv, sup01876.cnv, sup01864.cnv, sup01879.cnv, sup01877.cnv, sup01878.cnv e vdp02564.cnv.
  
  
• Executar o programa LOG00086 (Administração de Parâmetros) e liberar permissão para os seguintes caminhos:
  • PROCESSO ENTRADAS / FRETES / INTEGRAÇÕES 
  • PROCESSO SAÍDAS / FRETE / FRETE - GFE

• Os parâmetros abaixo fazem parte desta integração e devem ser devidamente atualizados antes da utilização:

  Parâmetro	Objetivo
  CT-e sobre NF de vendas será tratado pelo GFE? (gfe_cte_venda)	Indica se CT-e sobre NF de vendas será tratado pelo GFE(Gestão de Frete Embarcador) e depois integrado ao Logix. OBS: Sim/Não (Alterar para S para habilitar a integração).
  Grupo de despesa padrão para inclusão do conhecimento de frete VIA GFE (grupo_desp_frete_gfe)	Parâmetro é opcional, se não informado considera: 1- O grupo de despesa que veio na mensagem Invoice via integração; 2- Ou se o primeiro não tiver sido informado considera o grupo de despesa padrão para frete de venda. LOG00087: 'Grupo de despesa a ser utilizado nos fretes de venda incluídos pelo SUP0580, SUP9220 e SUP0552.(grp_desp_frete_venda). OBS: Somente permite informar um grupo de despesa cadastrado no Logix.
  Condição de pagamento sem pagamento para recebimento de CTE (cond_pgto_cte_sem_pgto)	Indica a condição de pagamento a ser sugerida para preenchimento automático da condição de pagamento, pois o conhecimento de frete não terá pagamento. OBS: Somente permite informar uma condição de pagamento cadastrada no Logix.
  Conhecimento venda integrado GFE pode sofrer modificações no Logix? (ies_conhec_gfe_altera)	Indica se quando trabalhar com integração do Logix com o GFE permitirá incluir, alterar ou excluir um frete de vendas no Logix. 1 - Alerta (No sup0580 ao tentar incluir um conhecimento de nota de venda irá alertar que trabalha com integração com GFE e inclusão deveria ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, alerta o usuário que o frete foi integrado via GFE e a alteração ou exclusão deveria ser realizada no GFE). 2- Trava (No sup0580 ao tentar incluir um conhecimento de nota de venda irá bloquear a inclusão, avisando que existe a integração com GFE e inclusão deve ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, bloqueia a transação e avisa ao usuário que o frete foi integrado via GFE e a alteração ou exclusão deverá ser realizada no GFE). 3- Permite Incluir Modificar ou Excluir Conhecimento( No sup0580 mesmo que esteja com a integração GFE ligada irá permitir incluir, modificar ou excluir qualquer conhecimento de frete, sem exibir aviso em tela).
  Assume automaticamente erros do frete recebido via integração GFE? (assu_auto_erro_integ_fret_gfe)	Indica se assume automaticamente os erros na consistência do frete, recebido via integração GFE. OBS: Sim/Não (Alterar para S para habilitar a integração).
  Diretório XML Frete/Venda quando empresa trabalha com integração GFE (diretorio_gfe_cte_v)	Caso empresa trabalhar com integração do Logix com GFE (Gestão do Frete Embarcador) e os fretes de venda são tratados pelo GFE, então no JOB de Recebimento de XML de Nota/Frete no TOTVS Colaboração irão mover os XML's que forem de frete relacionado a nota fiscal de venda para este diretório. Posteriormente o Gfe irá buscar estes XMLs deste diretório e importar no módulo para cálculos e tratamentos do frete.
  Utilizar integração com o GFE - Gestão de Frete Embarcador? (utiliza_integracao_gfe)	Indica se utiliza integração com o produto Gestão de Frete Embarcador (GFE) para simulação, cálculo e controle do frete no processo saídas.
  Servidor e porta para requisições dos serviços REST do módulo de GFE.  (servidor_de_servicos_rest_gfe)	Informar o IP do servidor e porta para realização das requisições dos serviços REST disponíveis para integração entre o produto Logix e o módulo do GFE (Gestão de Frete Embarcador).

 Relacionamento De/Para de Empresa/Filial:

Para que uma mensagem de integração possa ser recebida, é necessário informar o código da empresa e/ou filial do sistema de origem.

Quando uma mensagem é recebida pelo Logix, a partir da “Empresa Externa” e “Filial Externa” existentes na TOTVSMessage o sistema identificará qual é a “Empresa Logix” para atualização dos dados. Estas informações são registradas no LOG00083 (Cadastro de Empresas).

Nota: Para que estes campos possam ser informados é necessário ativar o parametro “Permite informar empresa/filial externa no cadastro de empresas?”, no LOG00087.

Totvs Colaboração

Como a recepção do frete de venda é realizada diretamente no GFE o mesmo é desviado da recepção via Totvs Colaboração no Suprimentos/Logix. 

Para isso é feito um desvio, e são movidos os XMLs do frete de venda para o diretório parametrizado no LOG00087: "Diretório XML Frete/Venda quando empresa trabalha com integração GFE".
Posteriormente o GFE irá buscar estes XMLs deste diretório e importar no Protheus SIGAGFE para cálculos e tratamentos do frete e após então o Conhecimento é enviado e integrado ao Logix.

Tratamentos no ERP

• • Conforme parametrização nos Parâmetros Gerais Logix "Conhecimento venda integrado GFE pode sofrer modificações no Logix?" permitirá incluir, alterar ou excluir um frete de vendas no Logix.
    Se parâmetro igual a "1" no sup0580 ao tentar incluir um conhecimento de nota de venda irá alertar que trabalha com integração com GFE e inclusão deveria ser realizada no GFE.
    Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, alerta o usuário que o frete foi integrador via GFE e a alteração ou exclusão deveria ser realizada no GFE).
    Se parâmetro igual a "2" no sup0580 ao tentar incluir um conhecimento de nota de venda irá bloquear a inclusão, avisando que existe a integração com GFE e inclusão deve ser realizada no GFE. Ainda no sup0580, ao tentar modificar ou excluir um conhecimento de notas ficais de venda, bloqueia a transação, e avisa ao usuário que o frete foi integrado via GFE e a alteração ou exclusão deverá ser realizada no GFE).
    E se parâmetro igual a "3" permitirá Incluir Modificar ou Excluir Conhecimento normalmente no sup0580 mesmo que esteja com a integração GFE ligada.

Protheus

Insira aqui as informações pertinentes ao Protheus.

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 Logix e Protheus SIGAGFE 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

Cadastros

A seguir temos as rotinas responsáveis pelos cadastros das informações da integração:

Ao executar o programa FIN00000 (Programas conversores), usuário poderá fazer a carga inicial dos cadastros:

• Fornecedor/Transportador
• Cliente
• Embalagens
• Cidades

Fornecedor/Transportador - CustomerVendor

Identificador da Mensagem: CustomerVendor

Versão: 2

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Cliente/Fornecedor no programa VDP10000, irá gerar mensagem única, enviada para o Protheus.

Limitações/Restrições

• Para esta integração, não indica-se trabalhar com Transportador cadastrado no VDP10000 como tipo "2"-Apenas transportadora. Alterar o tipo do mesmo para "5"-Fornecedor/Transportador.
• Para trabalhar com a integração é necessário estar trabalhando com TSS 2.000. Somente esta versão foi possível implementação para realizar o desvio e desconsiderar os Conhecimentos de Venda para que sejam tratados pelo GFE.

Cliente - CustomerVendor

Identificador da Mensagem: CustomerVendor

Versão: 2

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Cliente/Fornecedor no programa VDP10000, irá gerar mensagem única, enviada para o GFE.

Notas:

(*) As tag´s existentes no XSD (schema) da mensagem e que não foram mencionadas na lista acima não possuem tratamento na integração, ou seja, não são consideradas no envio da mensagem;

(**) Nos casos de registros do tipo “Ambos” (onde uma empresa é cliente e fornecedor ao mesmo tempo), o Logix enviará duas mensagens para o GFE, uma com o tipo “Customer” e outra com o tipo “Vendor”.

Cidade - City

Identificador da Mensagem: City

Versão: 1

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de UF e Cidades (VDP10022) , irá gerar mensagem única, enviada para o GFE.

Nota:

(*) Para a integração de cidades é considerado como campo chave entre os sistemas o código oficial, proveniente do IBGE. Desta forma, no Logix torna-se obrigatório o preenchimento desta informação no cadastro de cidades (VDP10022), quando esta mensagem estiver habilitada para envio.

Embalagem - Packaging

Identificador da Mensagem: Packaging

Versão: 1

Tipo de Envio: Síncrona

Gatilho: Ao executar inclusão, modificação e exclusão do cadastro de Embalagens (VDP10026) , irá gerar mensagem única, enviada para o GFE.

Processos 

A seguir temos os processos que transitam entre os produtos na integração:

Conhecimento de frete de venda - Invoice

Identificador da Mensagem: Invoice

Versão: 3

Tipo de Envio: Assíncrona

Ao receber a Invoice no Logix com tag indicando que trata-se de um conhecimento de venda (TypeofDocument = "COV") é acionado Adapter EaiAdapterInvoice3.

Este irá incluir ou excluir (de acordo com o tipo de processamento enviado) através de métodos padrões do ERP o conhecimento de frete de venda no Logix.

Para conferir se a integração ocorreu com sucesso pode-se utilizar a consulta do Status e Passo-a-passo no Monitor de integração do EAI: EAI100000. 

Para validar o documento no ERP utilizar o programa Sup0580.

• Consistência
  Após a inclusão do conhecimento é automaticamente processada a consistencia do documento.
  Os valores da integração são carregados no declarado, para manter o histórico e acusar erro de diferença entre declarado e calculado caso algum parâmetro do Logix precise ser revisto.
  Pode ocorrer inconsistência no frete entre declarado e calculado, devido a cadastros que precisam ser arrumados no ERP. Se não forem revistos não há problema, visto que o valor declarado prevalece sobre o calculado. O único inconveniente é que a cada proxima nota que entrar continuará acusando diferença entre declarado e calculado.
  Se o parâmetro do Log00087 "Assume automaticamente erros dos conhecimentos recebidos via integração Gfe?" igual a "S" então após realizar a consistência, já assumir os erros do frete automaticamente. Irá cadastrar automaticamente o usuário que está integrando (usuário integrador) no Sup34698-Usuários responsáveis por assumir erros de frete.
  Conforme padrão do Recebimento, caso esteja parametrizado para contabilização online já irá gerar os lançamentos contábeis automaticamente na integração, assim como a integração com o fiscal. 
  Não integra com o Financeiro visto que a condição de pagamento é sem pagamento. E o Financeiro é tratado diretamente do GFE que envia os dados ao Módulo financeiro do Logix via integração.
  Também integra automaticamente com o GAO-Gestão de Aprovação de Orçamento, caso empresa trabalhe com este conceito.
  
  
  

Limitações / Restrições Gerais

• Percentual de ICMS - Busca alíquota do Logix da tabela de ICMS por grupo de despesa.
• Somente grava a dest_frete_sup4 quando trabalha com 4 níveis de AEN, caso contrário grava apenas a dest_frete_sup.
• Cidade é opcional - se informada busca a aliquota de ICMS dessa cidade no calculo do ICMS no frete, ao invés do padrão que é buscar de acordo com a UF do transportador.
• PaymentConditionCode é opcional - Se informado parâmetro no Log00087 - "Condição de pagamento sem pagamento para recebimento de CTE" irá assumir esta condição de pagamento para o frete.
  
  

Nota fiscal de saída - Invoice

Identificador da Mensagem: Invoice

Versão: 3

Tipo de Envio: Assíncrona

Gatilho: Sempre que realizado o envio de uma nota fiscal de saída para a SEFAZ, após a geração da chave de acesso será feito o envio da nota fiscal via mensagem única (EAI2) para o GFE.

Quando a nota fiscal possuir tipo de frete diferente de 3 (FOB) será adicionado o contexto "gfe" na mensagem. Dessa forma é possível parametrizar no EAI10000 (EAI) apenas o envio de notas fiscais com frete para o GFE, utilizando-se do conceito de "rotas".

Nota:

(*) As tag´s existentes no XSD (schema) da mensagem e que não foram mencionadas na lista acima não possuem tratamento na integração, ou seja, não são consideradas no envio da mensagem.

Limitações / Restrições Gerais

• Para as notas fiscais integradas com o GFE não deverá possuir subsérie informada, pois corre-se o risco de gerar duplicidade de numeração durante a integração.
• É obrigatório utilização do painel da NFE (Parâmetro "Utilizar painel da NF-e e NFS-e?" ativado)

Simulação de frete de venda - FREIGHTSIMULATION

Identificador da Mensagem: FREIGHTSIMULATION

Versão: 1

Tipo de Envio: API REST

Gatilho: Através do botão "Simular frete GFE" localizado na aba "3 - Frete" do programa VDP20000 (Manutenção de Pedidos) ou do botão "simulaR GFE" localizado na tela de transportes dos programas VDP0742 (Faturamento automático) e VDP0746 (Faturamento Manual), é possível realizar a simulação de frete para o pedido/nota fiscal em questão, obtendo informações de transportadoras, valor de frete e imposto, prazo de entrega, rotas, etc diretamente do GFE.

Como fazer (opcional)

Os passos para viabilizar a integração são:

• Setar nos Parâmetros Gerais Logix (Log00087) os parâmetros: "Utilizar integração com o GFE - Gestão de Frete Embarcador? = "S" e "CT-e sobre NF de vendas será tratado pelo GFE?" = "S".
• Configurar os demais parâmetros descritos na sessão Parâmetros Gerais (LOG00087) desse documento;
• No Logix efetuar/atualizar o cadastro das seguintes informações: Clientes, fornecedores, transportadores, embalagens e cidades. A integração será efetuada automaticamente pelos programas de cadastro ou podem ser enviados ao GFE via carga de dados (FIN00000).
• No Vendas/Faturamento Logix efetue o faturamento da nota de saída com tipo de frete diferente de 2 (FOB) e realize o envio para a SEFAZ;
• No GFE confira as informações do faturamento
• No GFE efetue a inclusão do conhecimento de frete
• No Logix efetue a conferência do conhecimento de frete no Sup0580
  
  

Situações comuns (opcional)

• 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

Anexos