Páginas filhas
  • DI_SIGATMS_x_Datasul_Contas_a_Receber

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

INTEGRAÇÃO PROTHEUS SIGATMS X DATASUL

BACKOFFICE

Contexto de negócio (Introdução)

- CONTAS A RECEBER

Introdução

Cada vez mais as empresas necessitam gerenciar e otimizar sua logística e conforme legislação, necessitam do papel de uma Transportadora. Por isto, há uma busca por softwares de Gestão de Transportes que controlem os processos e operações de uma Transportadora. O módulo SIGATMS da linha Microsiga Protheus possui integração é a solução TOTVS para este cenário de mercado. Em relação aos clientes desta linha, o módulo já possui integração nativa com os módulos de BackOffice de mesma linha como, faturamento Faturamento (SIGAFAT), fiscal Fiscal (SIGAFIS), financeiro Financeiro (SIGAFIN) e contábil Contábil (SIGACTB). Existem Já em relação aos clientes da linha Datasul que demandam a necessidade de utilização de um módulo de Gestão de Transportes como o SIGATMS, porém mantendo os módulos de BackOffice da linha Datasul.

Para que seja possível atender esta demanda e possibilitar uma nova oferta de mercado TOTVS, através desta integração será possível a utilização do módulo SIGATMS da linha Microsiga Protheus integrado aos módulos de BackOffice da linha Datasul (faturamento, fiscal, financeiro e contábil).

, o módulo SIGATMS não possuía integração. 

Sistemas Envolvidos

Linha Microsiga Protheus

  • SIGATMS (Transportation Management System): sistema  Sistema de gerenciamento de transportes que tem como objetivo principal controlar todos os processos fiscais e gerenciais envolvidos na operação de transportes, bem como, controlar os veículos, motoristas, fretes e viagens da empresa e de terceiros, entre . Entre as atividades mais importantes, destacam-se controle das despesas dos veículos, viagens, fretes, emissão de CTRC (Conhecimento de Transporte Rodoviário de Cargas), nota fiscal de serviço, manifesto e entre outros. O SIGATMS controla todos os processos de um transportador, abrangendo as áreas: operacionalOperacional, comercialComercial, segurosSeguros, faturamentoFaturamento, logística Logística e SAC. Solução totalmente integrada com a área administrativa (financeiroFinanceiro, fiscal Fiscal e contábilContábil).

Linha Datasul (BackOffice)

Faturamento:

  • Fiscal:
  • Financeiro:
    • ACR (Contas a Receber ): APB (Contas a Pagar(ACR): 
  • Contábil:

 

    • O Módulo de Contas a Receber visa auxiliar o gerenciamento administrativo, controlando movimentações de títulos e outros. Maiores detalhes, consultar: ACR - Contas a Receber

Integração

O módulo SIGATMS da linha Microsiga Protheus, possui integração nativa com os módulos de BackOffice de mesma linha como, Faturamento (SIGAFAT), Fiscal (SIGAFIS), Financeiro (SIGAFIN) e Contábil (SIGACTB).

Existem clientes da linha Datasul que demandam a necessidade de utilização de um módulo de Gestão de Transportes como o SIGATMS, porém mantendo os módulos de BackOffice da linha Datasul.

Para que seja possível atender esta demanda e possibilitar uma nova oferta de mercado TOTVS, por meio desta integração será possível a utilização do módulo SIGATMS da linha Microsiga Protheus, integrado aos módulos de BackOffice da linha Datasul (Faturamento, Fiscal, Financeiro e Contábil).

Este documento especificamente apresenta os detalhes da integração do SIGATMS com o módulo Datasul: Contas a Receber.

  • Premissas
    • Integrar o módulo SIGATMS da linha Protheus com o módulo Financeiro do BackOffice Datasul: Contas a Receber;

Escopo

Image Added


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

Datasul

 

Versão mínima12.1.18
Módulo implantado

ACR - Contas a Receber

Ferramentas necessáriasConfiguração do WebService EAI2


Protheus

Versão mínima12.1.18
Módulo implantadoSIGATMS - Gestão de Transportes
Funcionalidades implantadasConhecimento de Transporte Eletrônico (Ct-e)
Ferramentas necessárias¹ Servidor WebServices Protheus iniciado

Schedule Protheus configurado
Aviso

¹ Ajuste o timeout do servidor HTTP na qual o WebService Protheus estará para acima de 15 minutos (900 segundos).

  1. Acessar o ambiente Protheus / Programa inicial: APWEBWIZARD;
  2. Servidor Internet (HTTP/FTP) / HTTP;
  3. Altere o parâmetro: TimeOut de Sessions WEBEX para 900;

Instalação/Atualização

Datasul

Configurações Iniciais

  1. Realizar as configurações descritas para o Datasul no documento: DI_SIGATMS_x_Datasul_Cadastros_restore

Configurações EAI 

  1. Toda a configuração do EAI Datasul será feita através do TOTVS Monitor, que é acessado através do caminho: http://<HOST-DATASUL>:<PORTA>/totvs-monitor

  2. Configurar no EAI do Datasul as mensagens de Transação do Contas a Receber que serão trocas com o Protheus:
    1. A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Transações Disponíveis;

    2. As mensagens deverão ser configuradas conforme tabela abaixo:

      TransaçãoVersãoModo Habilitado
      TransportInvoice2.000Recebimento
      TransportInvoiceStatus2.000Envio
  3. Configurar as Rotas de Envio para as Transações que serão enviadas ao Protheus.

    1. A configuração é feita através do caminho: TOTVS Monitor / EAI2 / Aplicação Interna / Rotas de Envio;

    2. Importante: para que seja possível realizar este procedimento, é necessário que previamente as transações estejam atualizadas do lado do Protheus, conforme descrito neste manual;
    3. Deverá ser selecionado no combo-box "Aplicação Externa" a aplicação que representa o Protheus;

    4. Para a transação "TransportInvoiceStatus", deve ser selecionada e marcada a opção "Habilitado". 

 Configurações Gerais 

  1. No Menu do Datasul, através do programa "Recebimento Padrão", deverá ser incluído um novo registro conforme abaixo:
    1. Para cada Fatura gerada no TMS Protheus, será gerado um Título no Contas a Receber, portanto, deve ser informado no Recebimento Padrão, as informações que serão utilizadas para geração deste título, espécie, série, portador, carteira, etc...
    2. A princípio, o Código do Cliente não precisa ser informado. Ele somente será informado, caso seja necessário gerar o Título com parametrizações diferentes para um determinado cliente.
  2. No Menu do Datasul, através do programa "Seleção Recebimento Padrão", deverá ser  realizada parametrização conforme abaixo:
    1. Através deste programa, é realizada a parametrização para determinar qual Recebimento Padrão será utilizado para geração do Título no Contas a Receber, a partir da integração de Faturas do TMS Protheus;
    2. Caso, o Título deve ser gerado sempre da mesma forma, pode ser criado um único registro de Seleção mais genérico, deixando os campos "Código Transação" e "Clientes" em branco e informado um único Recebimento Padrão;
    3. Mas, também é possível criar parâmetros mais específicos, por exemplo, informando um Cliente, desta forma, na geração do Título, caso a Fatura seja para o cliente que está parametrizado, será utilizado o Recebimento Padrão informado para aquela Seleção. Caso seja outro cliente, será utilizado o Recebimento Padrão da parametrização mais genérica;
    4. O campo "Código Transação" equivale ao Tipo de Documento do Conhecimento de Transporte parametrizado no TMS Protheus. Portanto, é possível criar uma Seleção de Recebimento Padrão diferenciada por Tipo de Conhecimento que faz parte da Fatura.
  3. É possível parametrizar o Datasul para que, a cada Conhecimento (ou CT-e) registrado no TMS Protheus, seja criado um Título no Contas a Receber para representá-lo, para fazer isto deve-se:
    1. Para as Naturezas de Operação que foram marcadas como "Natureza Transporte TMS" (conforme descrito no documento: DI_SIGATMS_x_Datasul_Faturamento_Fiscal) deve ser marcada a opção "Emite Duplicata";
    2. Desta forma, para cada CT-e registrada no TMS Protheus, será realizada uma integração com o Faturamento do Datasul, para geração de uma Nota Fiscal, que posteriormente será integrada com o Contas a Receber para geração de um Título;
    3. Caso o Datasul seja parametrizado desta forma, o Título gerado no Contas a Receber a partir da integração da Fatura do TMS Protheus, será criado a partir de uma Substituição, onde, os títulos de Origem serão os que foram criados a partir da Nota Fiscal criada no Faturamento a partir da CT-e.
  4. Para mais detalhes sobre as configurações, acessar a FAQ: http://tdn.totvs.com/x/TiscEQ

Protheus

Parâmetros de Integração

  1. Acessar o ambiente Protheus / Programa inicial: SIGACFG.
  2. Ambiente / Cadastros / Parâmetros.
  3. Busque e altere os parâmetros:

    ParâmetroDescriçãoValor
    MV_TMSERPERP que está integrado ao SIGATMS. 0 - Protheus, 1 - Datasul.1
    MV_TMSMFATModo de Faturamento do TMS. 1- Faturamento a partir do SE1; 2- Faturamento a partir do DT6          2

Configurações EAI

  1. Cadastre um agendamento no Schedule para a rotina FWEAI, de forma que fique sempre ativo (Este serviço é necessário para processamento das mensagens).

  2. Configure a rota para o ambiente Datasul que será integrado, por meio da alteração dos parâmetros ou do cadastro de rotas:

(Lib inferior a label 20170208)

ParâmetroDescriçãoValor
MV_EAIWSNome do Client WS do EAI para envio a outro EAI.WSEAIDATASUL
MV_EAIURL2Nome do canal configurado no EAI para envio a outro EAI. http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente Datasul
MV_EAIMETHMétodo de envio do EAI para envio a outro EAIreceiveMessage
MV_EAIXSDDiretórios dos XSD usados na validação<DIRETÓRIO XSD>
MV_EAIUSERUsuário para autenticação<USUÁRIO>
MV_EAIPASSSenha para autenticação<SENHA>


(Lib igual ou superior label 20170208)
Por intermédio do cadastro de rotas:

  1. Acessar o ambiente Protheus / Programa inicial: SIGACFG.
  2. Ambiente / Schedule / Cadastro Rotas Eai.

    ProdutoAplicaçãoURLClient WSMétodoUsuárioSenha
    DATASUL<Aplicação Datasul>http://<HOST>:<PORTA>/eai2-ws/EAIService * Ambiente DatasulWSEAIDATASULreceiveMessage<USUÁRIO><SENHA>

       


  1. Realize o cadastro de De/Para de Empresas Mensagem Única:
    1. Acessar o ambiente Protheus / Programa inicial: SIGACFG.
    2. Ambiente / Schedule / Emp.filial Mensagem Única.

      ReferênciaCompanyBranchEmp.ProtheusFil.Protheus
      DATASUL<EMPRESA DATASUL><EMPRESA PROTHEUS><FILIAL PRINCIPAL>
      Informações
      Cadastre o De/Para, para todas as empresas que possuírem integração.
  2. Devem ser realizados os seguintes cadastros de adapters EAI:
    1. Acessar o ambiente Protheus / Programa inicial: SIGACFG.
    2. Ambiente / Schedule / Adapter E.a.i.
    3. Cadastre os seguintes registros:

      Mensagem única?RotinaMensagemDescriçãoEnvia?Recebe?MétodoOperaçãoCanal EnvioXSDVersão Envio
      1 - SimTMSA851TRANSPORTINVOICEFATURA DE TRANSPORTE A RECEBER1 - Sim2 - Não1 - Síncrono1 - Todas2 - EAI2.000
      1 - SimTMSI852TRANSPORTINVOICESTATUSSTATUS DA FATURA DE TRANSPORTE2 - Não1 - Sim2 - Assíncrono1 - Todas2 - EAI2.000
      Aviso
      titleObservação (Lib igual ou superior label 20170208)
      Vincule a rota criada do produto Datasul e indique o campo Envia como Sim, para todos os adapters que enviam mensagem (Envia? 1 - Sim).

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 SIGATMS Protheus e BackOffice Datasul, 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

Método

ID

Descrição

Origem

Destino

XSD (versões podem variar)

Processos

01Fatura de Transporte a ReceberProtheusDatasulTransportInvoice_2_000.xsd
02Status da Fatura de TransporteDatasulProtheusTransportInvoiceStatus_2_000.xsd

Fluxo das Informações


Processos

  1. Fatura por Documento e Fatura Automática
    Tipo de Fluxo: Protheus > Datasul
    Mensagem: TransportInvoice_2_000
    Versão: 2.000
    Modo: Síncrono

    O processo de geração de Fatura por Documento e Fatura Automática no SIGATMS, quando ativada a integração com o ERP Datasul, não realizará a criação da tabela financeira do Contas a Receber do módulo Protheus SIGAFIN e sim uma nota tabela intermediária do módulo SIGATMS (DRT - Fatura de Transporte a Receber). O processo de geração de fatura permanece o mesmo já existente no produto para ambas as rotinas de Fatura por Documento e Fatura Automática, porém, na efetivação será criado um registro na nova tabela e será disparada a integração com o módulo de Contas a Receber Datasul, onde será criado o título para cobrança. Em relação ao processo de cancelamento da fatura, será acionado também pelas rotinas de faturamento do SIGATMS Protheus e integrado ao BackOffice para cancelamento do título gerado.

  2. Status da Fatura
    Tipo de Fluxo: Datasul > Protheus
    Mensagem: TransportInvoiceStatus_2_000
    Versão: 2.000
    Modo: Assíncrono


Nota
titleNotas:

Integração no modo Assíncrono: Ao ser disparada, a mensagem será enviada ao EAI Protheus para que seja processada pela agenda do programa FWEAI no Schedule. Ao processar a mensagem, será enviada ao EAI Datasul que por sua vez irá processar a mensagem conforme agenda do programa Registrar Fila do EAI2 no RPW (BTB948AA)

Aviso
titleAviso:
É estritamente necessário que o Schedule Protheus e RPW Datasul, estejam corretamente configurados para o processamento no modo assíncrono.

Integração no modo Síncrono: Ao ser disparada, a mensagem será enviada pelo EAI Protheus diretamente ao EAI Datasul, que irá processar e retornar a resposta. O processo que disparou a mensagem fica aguardando até o retorno da resposta do ambiente destino para dar continuidade em sua execução.

Limitações / Restrições Gerais

  1. Fatura por Documento e Fatura Automática
    1. Para efetuar corretamente a geração da fatura, é necessário que o CTe e NFST estejam devidamente integrados ao Datasul Faturamento Fiscal. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Faturamento_Fiscal.
    2. Alguns cadastros devem estar relacionados em ambos os sistemas: Protheus SIGATMS e BackOffice Datasul. Detalhes no documento de integração: DI_SIGATMS_x_Datasul_Cadastros_restore.

Como fazer

  1. Fatura por Documento e Fatura Automática
    Os procedimentos para utilização do processo de fatura no módulo SIGATMS integrando com o BackOffice Datasul, estão descritos no documento técnico Integração SIGATMS x ERP Datasul Finanças ACR. 

Situações comuns

Erros de integração:

CódigoErroRota de integraçãoSituação
707Valor do Título Inválido ! | O valor do título deve ser maior que 0 (zero).PROTHEUS>DATASULAo disparar a integração entre a Fatura do SIGATMS com o Contas a Receber Datasul, a geração do título foi realizada, porém, a fatura não foi criada (alguns motivos possíveis: Ocorreu Timeout durante a execução (é necessário aumentar o tempo de Timeout nas configurações do servidor HTTP Protheus), a sessão Protheus fechou ou foi finalizada incorretamente durante o processo). Realize manualmente o estorno do título no financeiro.
360Tradução da Empresa &1 não encontrada na Matriz &2 !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, a correspondente da empresa &1 no Datasul-EMS.
361Tradução do Estabelecimento &1 não encontrado na Matriz &2 !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Cadastre na Matriz de Tradução de Unidade Organizacional Externa &2, o correspondente do estabelecimento &1 no Datasul-EMS.
446Cliente Financeiro &1 inexistente !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Verifique se existe tal ocorrência no cadastro de &2.
691Matriz da Unidade Organizacional não cadastrada !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: A Matriz da Unidade Organizacional informada não está cadastrada.
8148Não existe tradução para a moeda !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Não existe tradução para a moeda &1 na matriz &2.
22358Cliente não encontrado !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Cliente da Empresa: &1, com CPF/CNPJ: &2 e Inscrição Estadual: &3, não está cadastrado.
22359Seleção do Recebimento Padrão Inexistente ou Inválida !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Consulte o cadastro de Seleção de Recebimento Padrão. Empresa: &8, Transação: &3, Cod Trans: &7, Estab: &4, &5: &6.
22360Rateio Padrão Recebimento não encontrado !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Não foi encontrado Rateio Padrão para o Recebimento Padrão: &3.
22361Condição de Pagamento Inexistente !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Não encontrada nenhuma Condição de Pagamento cadastrada para o &1: &2.
22364Nenhum Conhecimento Informado !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Para gerar Título(s) no ACR é necessário selecionar pelo menos um Conhecimento.
22365Título do Contas a Receber não encontrado !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Título ACR de Origem Faturamento não encontrado. Estab: &1, Série: &2, Conhecimento: &3.
22386Nenhum Título encontrado.PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Não foram encontrados Títulos relacionados ao Estab:  &1, Fatura: &2.
22387Título não encontrado.PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Título relacionado a Fatura, não encontrado. Estab: &1, Esp: &2, Série: &3, Título: &4, Parcela: &5.
22391Tipo de Conhecimento inválido !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos agrupados para Faturamento não possuem a mesma parametrização de atualização do financeiro, conforme Natureza de Operação. &1
22393Parâmetro POL não encontrado.PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Parâmetro Plataforma Operador Logístico do Estabelecimento: &1, não encontrado.
22394Condição de Pagamento Inválida !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: O campo 'Permite Fatura Parcelada' do Parâmetro Plataforma Operador Log¡stico do Estabelecimento: &1, está marcado como 'Não' e a Condição de Pagamento do Cliente: &2, está parametrizado para gerar mais de uma Parcela.
22395Recebimento Padrão inválido.PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Os Conhecimentos informados possuem Recebimento Padrão diferentes. Verifique o cadastro de Seleção Recebimento Padrão. &1
22427Erro ao buscar informações da Nota Fiscal !PROTHEUS>DATASULSituação de negócio retornada do Datasul Contas a Receber: Nota Fiscal não encontrada para o Conhecimento do Estabelecimento: &1, Série: &2, Fatura: &3.

Integração

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.

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:

 

 

 Image Removed

 

Image Removed

 

Método

ID

Descrição

Origem

Destino

XSD (versões podem variar)

Cadastros

01

Cliente/Fornecedor

RM

Protheus

CustomerVendor_1_000.xsd

02

Moeda

RM

Protheus

Currency_1_000.xsd

03

Unidade de Medida

RM

Protheus

UnitOfMeasure_1_000.xsd

04

Produto

RM

Protheus

Item_?_000.xsd

05

Centro de Custo

RM

Protheus

CostCenter_1_000.xsd

06

Ativos

RM

Protheus

NOVA, Ativo fixo

07

Funcionários

RM

Protheus

Employee_1_000.xsd

08

Projeto

RM

Protheus

Project_1_000.xsd

09

Obra

RM

Protheus

SubProject_1_000.xsd

10

Tarefa

RM

Protheus

TaskProject_1_000.xsd

11

Meio de Pagamento

RM

Protheus

?????.xsd

12

Condições de pagamento

RM

Protheus

PaymentCondition_1_000.xsd

13

Coligada*
* implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

RM

Protheus

Company_1_000.xsd

14

Filial*
* implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

RM

Protheus

Branch_2_000.xsd

Processos

15

Solicitações (compras/armazém)

Protheus

RM

Request_1_000.xsd

16

Cancelar movimento (solicitação, OS, etc)

Protheus

RM

CancelRequest_1_000.xsd

17

Cancelar movimento (solicitação, OS, etc)

RM

Protheus

CancelRequest_1_000.xsd

18

Baixa de estoque

Protheus

RM

Request_1_000.xsd

19

Baixa de estoque

RM

Protheus

Request_1_000.xsd

20

Consulta Saldo

Protheus

RM

 

21

Apropriação de custos

 

 

Request _1_000.xsd

22

Geração de OS

 

 

 

23

Consulta de OS

 

 

 

24

Ampliação patrimonial

 

 

 

 

 

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>

 

Mensagem Padrão

PROTHEUS

RM

Tabela

Campo

Tabela

Campo

Code

CTO990

CTO_SIMB

GMOEDA

SIMBOLO *

Description

CTO990

CTO_DESC

GMOEDA

DESCRICAO

Symbol

CTO990

CTO_SIMB

GMOEDA

SIMBOLO

 

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)

 

Erro

Mensagem

Solução

Código do erro

Mensagem exibida

Ação a ser tomada para resolução do erro.

 

Tratamento de erros de integração (Produto B)

Erro

Mensagem

Solução

Código do erro

Mensagem exibida

Ação a ser tomada para resolução do erro.

 

 

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