Integração Protheus x GFE

Contexto de negócio (Introdução)

A integração de dados entre rotinas do ERP Microsiga Protheus e o módulo SIGAGFE utilizando comunicação direta entre as rotinas, sem aplicativos intermediários e sem tráfego de dados no formato XML. O ponto de integração para Simulação de Fretes no Pedido de Venda já utiliza comunicação direta, por isso não necessitará intervenção. Serão mantidas as regras de negócio atuais da integração, alterando-se apenas o modelo de troca de dados.

A integração visa manter os dados cadastrais do ERP, quando necessário, sincronizados ao GFE; manter os dados relacionados a documentos, custos e despesas com transporte, integrados aos demais módulos do software ERP; e possibilitar a simulação do preço do frete durante os processos do ERP (pedidos de venda, pedidos de compra, faturamento etc.) nos quais essa informação possa ser necessária.

Sistemas Envolvidos

• ERP Microsiga Protheus;
• Módulo de Gestão de Frete Embarcado.

Integração

Modelo com EAI e TOTVS ESB

Modelo alterado

Lista dos pontos de integração de dados do ERP para o SIGAGFE

Em cada um dos programas haverá uma função para integração, a ser executada por cada evento listado, com a finalidade de montar a lista de informações a serem enviadas (vide de-para de campos na sequência desta especificação) para o objeto de negócio (model) indicado. Serão utilizadas as operações padrões de manutenção de registros da técnica MVC com o respectivo tratamento do retorno de mensagens de erro. A execução da função será condicionada aos parâmetros MV_INTGFE e MV_INTGFE2.

Em cada um dos programas será implementada a execução (MSEXECAUTO) do objeto de negócio correspondente do ERP, enviando a lista de informações (vide de-para de campos na sequência desta especificação) necessárias à inclusão ou eliminação de registros com o respectivo tratamento do retorno de mensagens de erro. As mensagens de erro ficarão registradas em campo descritivo dos próprios registros do SIGAGFE e para cada integração há um campo de controle indicando o estado: Não-integrado, Pendente, Rejeitado, Atualizado e Pendente de Cancelamento. Com a alteração do modelo de integração os estados “Pendente” e “Pendente Cancelamento” tornam-se obsoletos pois o resultado da integração será conhecido logo após o evento de “Envio para ERP”.

Entidades do ERP utilizadas diretamente pelo SIGAGFE (não precisam de integração)

Regras Gerais

1. Integração em Geral

a. Todas as integrações estão condicionadas ao parâmetro MV_INTGFE; o conteúdo “.T.” indica que a integração está ativa;
b. A integração direta, sem o uso de EAI e TOTVSESB está condicionada ao parâmetro MV_INTGFE2; os conteúdos “1” ou “S” indicam que a integração entre os módulos do ERP base e o SIGAGFE é direta;

2. Registros de Cadastros

a. No SIGAGFE há dois parâmetros que indicam a origem dos cadastros (ERP ou SIGAGFE): MV_CADERP (Municípios, Emitentes, Contas Contábeis e Centros de Custo) e MV_CADOMS (Tipos de Veículo, Veículos e Motoristas); o controle é separado porque algumas empresas não utilizam o SIGAOMS;
b. Os cadastros integrados entre ERP e SIGAGFE permitem inclusão apenas pelo ERP;
c. O SIGAGFE não permite eliminar os registros de cadastros recebidos do ERP; esse comportamento é condicionado ao parâmetro MV_CADERP = “1=ERP” (ou MV_CADOMS = “1=OMS”);
d. O SIGAGFE restringe a alteração dos registros de cadastros recebidos do ERP apenas aos campos próprios do SIGAGFE (que complementam os dados recebidos do ERP e são utilizados apenas pelo SIGAGFE); esse comportamento é condicionado ao parâmetro MV_CADERP = “1=ERP” (ou MV_CADOMS = “1=OMS”);
e. A eliminação de registros de cadastros no ERP altera a situação do registro no SIGAGFE para “Inativo”, sem eliminá-lo. Dessa forma não há impedimento para eliminação no ERP mesmo que o registro possua relacionamentos ativos com outras entidades do SIGAGFE. Ao incluir novamente um registro anteriormente eliminado (com a mesma identificação única), a integração retorna o registro no SIGAGFE para a situação “Ativo”. A situação “Inativo” impede que o registro seja relacionado a novos processos no SIGAGFE (um motorista “Inativo” não pode ser informado em uma nova montagem de Romaneio, por exemplo);
f. Apenas o evento de eliminação altera a situação (Ativo/Inativo) dos registros dos cadastros integrados; esse comportamento é condicionado ao parâmetro MV_CADERP = “1=ERP” (ou MV_CADOMS = “1=OMS”);
g. As operações de inclusão e alteração, dos cadastros integrados, não são completadas se houver erro de validação na integração com GFE; o usuário recebe uma mensagem informando quais são as inconsistências e assim avaliar como proceder corretamente com a operação.

3. Registros de Processos enviados pelo ERP

a. O parâmetro MV_FATGFE permite configurar se a conclusão da emissão de Notas Fiscais depende do êxito da integração com o SIGAGFE; a rotina de integração das Notas Fiscais com Erro de Integração permite realizar a integração posteriormente, amparando a existência desta opção;
b. A eliminação da Nota Fiscal só é concluída com sucesso se não houver erro de validação na integração com o SIGAGFE; podem ser requeridos ao usuário procedimentos no SIGAGFE para que não hajam restrições no SIGAGFE (a fim de impedir que sejam canceladas Notas Fiscais que já foram expedida, por exemplo) e a eliminação ocorra com êxito.

4. Registros de Processos enviados pelo SIGAGFE

a. Os dados gerados pelo GFE no ERP não pemitem eliminação pelo ERP, somente alteração. A eliminação deve ser solicitada pelo SIGAGFE (que executa a integração para eliminar o registro no ERP e retorna o registro da entidade de origem no SIGAGFE para a situação “Não-integrado”);
b. O SIGAGFE não envia alteração de dados, apenas inclusão e eliminação; no caso de necessidade de quaisquer alterações deve-se acionar a ação “Desatualizar ERP” no SIGAGFE sobre o respectivo registro que dessa forma pode ser alterado e posteriormente enviado novamente para o ERP.

5. Regras Particulares e Correspondência entre os Dados

Os campos que compõem a identificação única do registro estão destacados com asterisco. Os campos não indicados na tabela de correspondência devem assumir (na operação de inclusão) o valor inicial indicado no dicionário de dados (ação executada automaticamente pelo model). Nas alterações de registros os dados que não são atribuídos pela integração devem ser preservados. A correspondência entre os campo se baseia no mapeamento já existente da integração via XML, conforme a tabela abaixo:

Escopo

Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.

Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.

[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]

Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.

Citar a responsabilidade de cada produto.

Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.

Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.

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

Relacione quais são os pré-requisitos (técnicos ou de negócio) para a integração. Este tópico não deve incluir informações da implantação normal do módulo, mas apenas informações específicas da integração. É como se este tópico já partisse do princípio que o módulo que será integrado já está normalmente instalado.

Entre os tópicos deste tópico podemos citar:

• Versões mínimas de produtos.
• Módulos ou programas que geram informações necessárias a integração. Muitas vezes a integração partirá de informações que somente são trabalhadas em um determinado programa ou processo, que deverá estar em uso no cliente.
• Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
• Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
• Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

Instalação/Atualização

Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:

• Procedimentos que devem ser observados quando um dos produtos for atualizado.
• Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
• Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
• Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
• Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
• Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
• Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.

Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.

Datasul

Insira aqui as informações pertinentes a Datasul.

Logix

Insira aqui as informações pertinentes ao Logix.

Protheus

Insira aqui as informações pertinentes ao Protheus.

RM

Insira aqui as informações pertinentes ao RM.

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.

Exemplos:

Fluxo das Informações

Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

Cadastros

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

<Transação/Entidade>

Identificador da Mensagem: <mensagem>

Versão: <versão>

Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>

Módulo <marca 2>: <SIGAXXX>

Tipo de Envio: <Assíncrona/Síncrona>

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

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

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

Notas:

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

Limitações/Restrições

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

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)

Descreva os passos que viabilizem a integração.

Exemplo:

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

• No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
• No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
• No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
• No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
• No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
• No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
• No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
• No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
• No Protheus efetuar o faturamento do pedido de venda recebido.
• No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
• No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
• No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).

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