INTEGRAÇÃO SIGATMS X SIGAGFE

Contexto de negócio (Introdução)

Integrar os módulos Gestão de Transportes (SIGATMS) e Gestão de Frete Embarcador (SIGAGFE), de forma que possibilite a integração de custo de frete com origem no GFE e destino TMS, permitindo a análise de rentabilidade de frete.

A partir das notas fiscais, é possível relacionar o conhecimento de transporte e o documento de frete de subcontratação.

Havendo um documento de frete do GFE relacionado a mais de um conhecimento de transporte no TMS, ocorrerá o rateio dos valores baseado no parâmetro (MV_CRIRAT).

Rotinas alteradas:

Sistemas Envolvidos

• • Gestão de Transportes .(SIGATMS)
  • Gestão de Frete Embarcador .(SIGAGFE)

Integração

A integração SIGATMS x SIGAGFE utiliza comunicação direta entre as rotinas Gestão de Transporte e Gestão de Frete Embarcador.

Image Added

Image Added

Escopo

Disponibilizar os dados sobre despesas realizadas de subcontratação de transporte para o módulo SIGATMS.

Estes dados serão consolidados e apresentados em relatórios e consultas do módulo SIGATMS, para análise da rentabilidade em empresas que prestam serviço de transporte com redespacho ou subcontratação de terceiros.

Para a utilização desta funcionalidade foram criados parâmetros, todos localizados no GFEX000, aba Integração Protheus. São eles:
- 

O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)

Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).

Apresentar a integração como uma melhoria para o cenário ou como uma solução para o problema.

• Premissas
  Gerais, do Vertical, do BackOffice e dos demais artefatos/sistemas envolvidos
  Premissas Gerais
  Premissas A
  Premissas B

• Arquitetura (Tecnologia)

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.

Custos de Transporte: indica a forma de integração do custo de transporte com TMS. Valores aceitos:
1- Sob demanda: a integração somente será efetuada a partir da ação do usuário, podendo ser via GFEA065 (Documento de Frete), GFEA067 (Integrar Doc Frete) ou GFEX100 (Monitor Integração);
2- Automática: a integração será feita de forma automática, após a aprovação (por usuário ou por sistema) do documento de frete;
3- Não integra: desativa a funcionalidade;
- Despesa de Frete para Doc. Frete Normal: código da despesa de frete usada na integração de documentos de frete com tipo Normal;
- Despesa de Frete para Doc. Frete Compl. Valor: código da despesa de frete usada na integração de documentos de frete com tipo Complementar de Valor;
- Despesa de Frete para Doc. Frete Compl. Imposto: código da despesa de frete usada na integração de documentos de frete com tipo Complementar de Imposto;
- Despesa de Frete para Doc. Frete Reentrega: código da despesa de frete usada na integração de documentos de frete com tipo Reentrega;
- Despesa de Frete para Doc. Frete Devolução: código da despesa de frete usada na integração de documentos de frete com tipo Devolução;
- Despesa de Frete para Doc. Frete de Redespacho: código da despesa de frete usada na integração de documentos de frete com tipo Redespacho;
- Despesa de Frete para Doc. Frete de Serviço: código da despesa de frete usada na integração de documentos de frete com tipo Serviço.
* Todos os códigos de despesa deverão estar previamente cadastrados no programa TMSA060.

Para ativar a funcionalidade é necessário:
- No SigaCFG, definir o parâmetro MV_INTTMS com .T.;
- No GFEX000, aba Integração ERP, definir o parâmetro ERP Integrado com 2-Protheus;
- No GFEX000, aba Integração Protheus, definir o parâmetro Custos de Transporte com 1-Sob demanda ou 2-Automático.

Programas alterados:

GFEA065 (Digitação de Documento de Frete):

- Na inclusão do documento de frete, caso não haja integração com TMS, a situação do custo de frete será gravada com 0-Não se aplica.
Do contrário, será gravado com 1-Não enviado e o código da despesa de frete será obrigatório;
- Caso haja integração, sempre que for alterado o tipo do documento de frete, o código da despesa será alterado, baseado nos parâmetros de despesa por tipo de documento de frete;
- Criado o item de menu Atualizar custo frete tms para permitir a integração do custo de frete com TMS apenas Sob Demanda;
- Criado o item de menu Desatualizar custo frete tms para permitir a exclusão da integração do custo de frete com TMS, independente se Sob Demanda ou Automático;
- Caso a integração seja automática, tanto para inclusão quanto para alteração, esta será feita ao salvar um documento de frete que seja aprovado automaticamente, ou então ao aprovar o documento de frete via GFEA066 (Aprovação doc. frete);
- Caso a integração seja manual, esta será possível após a aprovação do documento de frete, via opção de menu Atualizar custo frete tms. Estando o documento integrado com TMS e alterado posteriormente, a situação de integração será alterada para Pendente Atualização, sendo necessário efetuar nova atualização;
- Ao excluir um documento de frete, ocorrerá a desatualização do custo de frete com TMS.

GFEA066 (Auditoria de Documento de Frete):
- Alterado para que, ao aprovar o documento de frete, integrar o custo de frete com TMS, caso o parâmetro indique atualização automática.

GFEA067 (Integrar Documento de Frete):
- Inclusa a opção 3-Custo Frete TMS no parâmetro Tipo de Integração. O processamento permite atualizar, atualizar rejeitados e desatualizar, e também a seleção por documento de frete ou fatura, da mesma forma que os outros tipos de integração já existentes neste programa.

GFEC065 (Consulta de Documento de Frete):
- Na aba Integrações, grupo Protheus, são apresentadas informações de custo de frete;
- Houve alteração para sempre apresentar o grupo Protheus. Até então, esse grupo só era apresentado, caso o parâmetro ERP Integrado fosse igual a 2-Protheus;
- Inclusão dos seguintes campos:

1. Sit Cus Fret: indica a situação da integração do custo de frete com TMS, podendo ser:
0- Não se aplica. Quando não há integração com TMS;
1- Não enviado. Quando a integração não foi efetuada;
2- Atualizado. Quando a integração foi efetuada;
3- Rejeitado. Quando houve inconsistência no processo de integração;
4- Pendente de atualização. Quando já houve uma integração e o documento de frete foi alterado;
2. Cód. despesa: código da despesa de frete. Esta informação é usada na integração do custo de frete com TMS;
3. Dt Int Custo: data da integração do custo de frete com TMS;
4. Usu Cus Fret: usuário que efetuou a integração do custo de frete com TMS;
5. Mot Rej Cust: motivo de rejeição da integração do custo de frete com TMS.
- Criada aba Custo de Frete, que apresenta os registros que foram gerados na integração com TMS.

GFEX000 (Parâmetro do GFE):

GFEX100 (Monitor de Integração):
- Inclusa as colunas Custo Frete e Dt.Cus, que apresentam, respectivamente, a situação de integração do custo de frete com TMS e a data que foi realizada a integração;
- Criado item de menu Enviar custo frete, que permite a integração do custo de frete com TMS;
- Criado item de menu Situação custo frete, que permite alterar a situação de integração do custo de frete com TMS de Não enviado para Atualizado e vice-versa. Essa opção apenas altera a situação do documento de frete, não efetuando atualização ou desatualização do custo de frete no TMS.

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

Liberação oficial: Versão 12

Release liberada: 12.1.17

Deve-se atualizar a release informada e executar os procedimentos para implementação conforme Documento Técnico.

É imprescindível realizar o processamento do programa UPDDISTR para atualização da base.

Instalação/Atualização

Parâmetros para configuração:

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á são de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão produtos SIGATMS e SIGAGFE estão aptas a fazer realizar a primeira análise e, quando se necessário, repassar cada caso 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:

 Image Removed

Image Removed

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.

Fluxo das Informações

Abaixo o fluxo para utilização dessa integração:

Parâmetro MV_INTTMS

Image Added

Parâmetro MV_GFEI21 - Opção Automatica Programa GFEA065

Image Added

Parâmetro MV_GFEI21 - Opção Automatica Programa GFEA066_GFEC065_GFEA115

Image Added

Parâmetro MV_GFEI21 - Opção Não integrar Programa GFEA065_GFEA066_GFEC065_GFEA115

Image Added

Parâmetro MV_GFEI21 - Opção Sob demanda Programa GFEA065

Image Added

Parâmetro MV_GFEI21 - Opção Sob demanda Programa GFEA066_GFEC065_GFEA115

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI21 Automatica Programa GFEA065

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI21 Automatica Programa GFEA066_GFEC065_GFEA115

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI21 Nao integra Programa GFEA065

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI21 Não integra Programa GFEA066_GFEC065_GFEA115

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI20 Sob Demanda Programa GFEA065

Image Added

Parâmetros MV_DFMLA igual 2 ou 3 e MV_GFEI21 Sob Demanda Programa GFEA066_GFEC065_GFEA115

Image Added

Programa GFEA067

Image Added

Programa GFEX100

Image Added

Checklist de suporte da aplicação

Instalação/Configuração

1. Configure o processo do SIGATMS.
2. Configure o SIGAGFE.

Checklist de Verificações:

Identificar o funcionamento da integração:

• Verifique a existência de registros dos Cadastros Básicos.
• Realize a digitação de um documento de frete para realizar a integração do custo de frete com o SIGATMS.