INTEGRAÇÃO POC TOTVS Incorporação X BackOffice Protheus 

Contexto de negócio (Introdução)

 O objetivo da integração do POC TOTVS Incorporação x BackOffice Protheus é de parametrizar a Apuração de Resultado Contábil por POC entre os módulos da linha RM (TIN) x Protheus  (Financeiro e Contábil) para que seja realizada a exigência da Construção e Incorporação Imobiliária - Norma Brasileira de Contabilidade ITG 02 – Contrato de Construção do Setor Imobiliário, aprovada pela Resolução CFC n° 1266/09, é necessário configurar o Adapter E.A.I para utilização da Mensagem Única.

Para mais informações consulte:  http://www.gerenciamento.ufba.br/Disciplinas/Financeiro/Contabilidade%20de%20Contratos%20de%20Constru%C3%A7%C3%A3o.pdf

Aplicação da Regra aos produtos TIN (linha RM) e gestão Contábil (linha Protheus)

O TOTVS Incorporação possui um recurso que permite parametrizar a Apuração de Resultado Contábil por POC entre módulos da linha RM (TIN, Financeiro e Contábil).

Este recurso é chamado de Apuração de Resultado Contábil por POC que houve alteração para atender a integração com o Protheus.

A seguir, a definição dos modelos de Apuração entendidos e aplicados no TIN:

A apuração de resultado contábil, ou simplesmente POC, deve ser aplicada a todas as operações (fatos contábeis) que impactam em reconhecimento de resultado (receita ou custo) atribuído ao empreendimento em construção, sendo necessário parametrizar por coligada e por empreendimento todas as formulas de apuração  para cada uma das operações necessárias. Esta parametrização é unica por empreendimento e deve ser realizada antes do inicio da apuração.

Para que a apuração de resultado contábil por POC seja realizada é necessário realizar o seguintes cadastros no TIN:

• Cadastros / Empreendimento / Anexo / Avanço da Obra (POC) ou Cadastros / Apuração de Resultado Contábil por POC / Andamento da Obra (POC)
• Cadastros / Apuração de Resultado Contábil por POC/ Regras de Apuração
  • Composição da Base de Calculo
  • Fórmula de Apuração

Avanço da Obra ou POC

O POC (Percentage of Completion) é a identificação do avanço da Obra, seja por meio contábil, ou por medição, sendo que todas as operações dependem desta Identificação para o reconhecimento. O POC pode ser calculado das seguintes maneiras:

• Indicado manualmente: o usuário recebe da engenharia o valor do avanço da obra e indica manualmente no TIN. Este método também pode ser utilizado caso o usuário responsável opte por aproveitar resultados de planilhas utilizadas anteriormente a utilização do TIN;
• Fórmula: a fórmula permite criar um modelo de cálculo do POC baseado em variáveis diversas. O cálculo mais comum é o Custo Incorrido dividido pelo Custo Orçado. Geralmente os dois valores são obtidos pelo saldo de um conjunto de contas contábeis.

Exemplos de Fórmula

CI-> Custo Incorrido = ∑Saldo de Contas Contábeis de Custo Incorrido; 

CO-> Custo Orçado = Valor Atualizado do Custo Orçado que pode ser indicado no cadastro de Sped Pis Cofins ou como Movimento específico de Conta contábil de Custo Orçado do Empreendimento. O Empreendimento pode ter uma conta específica ou se a conta for geral deve ter a identificação por Conta Gerencial ou centro de custo no TIN e no Protheus por Item contábil, classe de receita ou outra entidade contábil customizável. 

i = mês da apuração

POC= CI_i /CO

Cálculo do POC por Indexação CUB 

Custo Orçado em CUB     = CO  / valor do CUB Acumulado (até o mês de apuração)

Custo Incorrido em CUB   = CI_i / valor do CUB Acumulado (até o mês de apuração)

POC_CUB = CI_CUB / CO_CUB

Sistemas Envolvidos

• TOTVS Incorporação (TIN) - Solução que realiza todo o controle de prazos, documentos e previsões da empresa, com gerenciamento de contratos de vendas e planos de financiamento, sendo possível acompanhar desde a fase dos prospects até a fidelização de clientes, com agilidade na emissão dos contratos, garantindo a efetivação das vendas. É o responsável pela definição das regras de apuração e medição do andamento das obras, sendo necessário ou não, de informações oriundas do BackOffice.

• BackOffice Protheus  - Contabilidade Gerencial (SIGACTB) e Financeiro (SIGAFIN).

  
  

Integração

Para atender a demanda de clientes que possuem a solução TOTVS Incorporação integrado ao BackOffice Protheus, foi desenvolvida esta integração que possibilita a execução da Apuração de resultados pelo POC neste ambiente integrado.

Premissas de Integração

TOTVS Incorporação

• Configurar a integração TOTVS Incorporação x BackOffice Protheus por meio do TBC (Integração / Ferramentas / Configuração) na versão 12.1.8 ou superior.
• Caso a integração tenha sido implantada em versão anterior é necessário que o configurador seja executado novamente para implantação dos novos processo de integração.
• Ativar a Integração TOTVS Incorporação x BackOffice Protheus acessando Integração / Mensagem única / Integrações no menu do TBC (Integração);
• Importação das Fórmulas Visuais com gatilhos de integração, enviando os registros ao EAI.
• O cadastro mantido pelo BackOffice RM como Conta Gerencial deve ser desabilitado no Protheus sua entidade correspondente, evitando concorrência de dados.

Protheus

• Configuração dos adapters utilizados na integração TOTVS Incorporação x BackOffice Protheus, assim como toda a configuração do EAI Protheus.
• Utilizar a versão 12.1.8 do Protheus com a LIB 0712  ou superior.
• Incluir uma nova entidade contábil que será responsável pela entidade Conta Gerencial" do RM utilizando o wizard de configuração CTBWIZENT, mais informações no link: Entidades Contábeis Adicionais_TEQCVV.
• O cadastro de entidade gerencial relacionado com o cadastro de Contas gerenciais do RM deve possuir a seguinte configuração de dicionário de dados:
  
  • Empresa:  Exclusivo
  • Unidade:   Deve ser equivalente à entidade relacionada no De-Para de integração (Empresa ou filial)
  • Filial:        Compartilhado
• Todos os cadastros mantidos pelo BackOffice Protheus devem ser desabilitados no RM, evitando concorrência de dados.
  
  

Escopo

O escopo desta implementação se restringe aos processos oriundos do processamento da Apuração de resultados (POC) e os cadastros utilizados por estes.

A integração do TIN com o BackOffice Protheus permite que o processamento da Apuração (POC) seja executado de forma transparente ao usuário final, sem aumento considerável da complexidade de parametrização ou execução dele. Os cadastros envolvidos na integração são integrados pelo sistema mandatário de forma automática, sem necessidade de processamento posterior, ou acompanhamento de filas de integração com inclusão, alteração ou exclusão, que devem ser restritas no sistema de destino.

Em caráter ilustrativo, o cadastro de Contas Contábeis é de domínio do BackOffice Protheus, tendo as modificações enviadas de forma transparentemente ao TOTVS Incorporação e a manutenção do cadastro restrito neste.

É restrito ao escopo deste projeto a integração de processos relacionados ao processamento do POC. Desta maneira, somente os lançamentos contábeis gerados e / ou estornados a partir dos processos do POC são integrados ao BackOffice Protheus. Os demais processos que geram contabilização / estorno no TIN devem ser desabilitados, pois não foram contemplados nos testes.

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

Apesar da integração TOTVS Incorporação x BackOffice Protheus estar disponível para o mercado desde as versões 11.82.26.108 (ou superior) para a linha RM e 11.7 (ou superior) para a linha Protheus, a implementação realizada para tratamento da Apuração de resultados (POC) de forma integrada entre as duas linhas (RM e Protheus) está disponível apenas a partir da versão 12.1.8 para a linha RM e Protheus, com a LIB Protheus na versão 0712 ou superior.

Tem como pré-requisito a instalação e implantação dos módulos envolvidos (TIN, Protheus e seus anexos como o TBC), assim como correta configuração do módulo de POC. (Configurações)

Instalação Protheus

• No Configurador acesse Ambiente / Cadastros / Parâmetros e configure os parâmetros:
  •  MV_EAIURL2 com o endereço do serviço de EAI do ambiente ao qual o Protheus é integrado.
    • Exemplo: http://12.50.90.211:81/MensagemUnicaWS.
  • MV_CTBCGER com a entidade adicional correspondente a entidade de conta gerencial.

• No Configurador acesse  Ambiente / Cadastros / Parâmetros e configure os parâmetros:
•  MV_EAIWS com o nome do cliente WebService do EAI para envio a outro EAI. (WSEAISERVICE).

• MV_ EAIUSER: caso o servidor necessite de autenticação, com o nome de usuário.

• MV_ EAIPASS: caso o servidor necessite de autenticação, com a senha de usuário.

• No Configurador acesse Ambiente / Schedule / Adapter E.A.I. e realizar o cadastro das rotinas de integração, conforme segue:

Instalação TIN

Esta integração é nativa ao ERP RM, mas é necessário instalá-la a parte para que fique disponível. Isto significa que as rotinas para esta integração já pertencem ao núcleo do sistema, mas a integração não está disponível para ser configurada e ativada, sendo necessário realizar o(s) passo(s) abaixo:

No RM.exe acesse o segmento Integração na aba Ferramentas na opção Configuração.

É apresentada a tela para entrada de usuário e senha para a base de dados RM. Clique no botão Testar conexão e, clique em Avançar para habilitar.

No próximo passo selecione a integração TOTVS Incorporação x BackOffice Protheus, clique em Avançar e em Executar.

É necessário também, executar a importação das formulas visuais com seus gatilhos:

• Mensagem Padrão - Lançamentos Financeiros
• Mensagem Única - Sincronização de Conta Gerencial
• Mensagem Única - Lista de Conta Gerencial

Os demais detalhes de configuração e os tratamentos necessários podem ser consultados nos boletins técnicos existentes. 

Atualização

Protheus

Após as configurações descritas na seção instalação e atendida as premissas, o ambiente Protheus estará pronto para a utilização dessa integração.

Mais detalhes técnicos estão na especificação no link: ER_PCREQ-5854_Integração RM TIN X Protheus POC.

RM

Para atualizar ambientes que já utilizam a integração TIN x BackOffice Protheus, é necessário executar novamente o configurador da integração (da mesma maneira como descrito no tópico acima Instalação TIN).

A diferença da instalação para a atualização, é que será necessário excluir a formula visual Mensagem Padrão - Lançamentos Financeiros, que utiliza a versão 1.001 da mensagem financing e importa a nova versão desta formula visual, que irá utilizar a versão 1.002.

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 TOTVS Incorporação 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.

Transações/Entidades/Mensagens únicas

A tabela abaixo apresenta quais as Mensagens Únicas TOTVS utilizadas para a integração do TOTVS Incorporação com BackOffice Protheus que causam algum impacto e interferem na Apuração de resultados (POC), com os respectivos processos de integração apresentados na próxima seção do documento. 

Vale ressaltar que existem outras Mensagens únicas TOTVS que fazem parte da integração TOTVS Incorporação x BackOffice Protheus, porém não fazem parte do escopo desta documentação que é voltada para a Apuração de resultados (POC)

Fluxo do Cálculo do POC

O cálculo e contabilização do POC pelo TOTVS Incorporação pode ser dividido em três macro-processos, além da integração dos cadastros base utilizados para vínculos contábeis e demais parametrizações. Abaixo seguem listados os processos de integração com o BackOffice Protheus.

Passo 1 - Cálculo do Avanço da Obra

O cálculo do Avanço da Obra pode ser executado a partir de inserção manual ou por meio de cálculo de fórmula, sendo que somente o segundo pode executar integração com o BackOffice Protheus.
Abaixo segue diagrama que apresenta o cálculo por fórmula, utilizando funções de consulta saldo contábil ao Protheus.

Image Added

Passo 2 - Apuração de Resultado Contábil pelo POC

A Apuração de Resultado Contábil pelo POC  é efetuada em duas etapas, que são: o cálculo das Composições da Base de Cálculo e o cálculo das Fórmulas de Apuração. 

Estas duas etapas podem efetuar integração com o BackOffice Protheus, caso existam consultas de saldo contábil por uma das funções de fórmula (vide lista na seção 'Funções de Formula') ou por Valor de Origem do tipo 'Contábil'.

Image Added

Passo 3 - Contabilização das Apurações Realizadas | Estornar/Excluir Contabilização

Os processos de contabilização disponíveis no POC (inclusão ou estorno) são responsáveis por efetuar a leitura dos valores apurados no Passo 2 e executar a respectiva integração com o BackOffice Protheus por meio da mensagem AccountingEntry.

Image Added

Cadastros

Todos os cadastros contemplam inclusão, alteração e exclusão, e devem ser feitos exclusivamente no sistema descrito como mandatário e com as mesmas operações bloqueadas no outro sistema. Por padrão, a integração de todos os cadastros será realizada de forma síncrona, sendo opcional a alteração do método de envio pela implantação ou cliente.

Os gatilhos de integração, adapters, restrições e demais informações constam na especificação do requisito disponível no item Link do Requisito.

Centro de Custo

Requisito: ER_Integração_Centro_de_Custo - CostCenter

Identificador da Mensagem: CostCenter

Versão: 2.000

Mandatário: BackOffice Protheus

Tipo de Envio: Síncrono

Classe de Valor

Requisito: ER_Integração_Classe_de_Valor - ClassValue

Identificador da Mensagem: ClassValue

Versão: 1.000

Mandatário: BackOffice Protheus

Tipo de Envio: Síncrono

Conta Contábil

Requisito: ER_Integração_Conta_Contábil - AccountantAccount

Identificador da Mensagem: AccountantAccount

Versão: 2.000

Mandatário: BackOffice Protheus

Tipo de Envio: Síncrono

Conta Gerencial

Requisito: ER_Integração_Conta_Gerencial - ListOfManagerialAccountingEntity

Identificador da Mensagem: ListOfManagerialAccountingEntity

Versão: 1.000

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Item Contábil

Requisito: ER_Integração_Item_Contabil - AccountingItem

Identificador da Mensagem: AccountantItem

Versão: 1.000

Mandatário: BackOffice Protheus

Tipo de Envio: Sincrono

Processos

Segue listado abaixo os processos do módulo de apuração de POC do TOTVS Incorporação que podem vir a executar integração com o BackOffice Protheus.

Os gatilhos de integração, adapters, restrições e demais informações constam na especificação do requisito disponível no item "Link do Requisito".

Calcular Avanço da Obra (POC)

O Cálculo de Avanço da Obra somente executa integração caso o mesmo seja efetuado através de fórmula que utilize uma das funções de Consulta de Saldo Contábil (vide seção 'Funções de Formula').

Requisito: ER_Consulta de Saldos Contábeis - AccountingBalance

Fluxo da Mensagem: RM → Protheus

Mensagem: AccountingBallance

Tipo de Envio: Sincrono 

Apuração de Resultado Contábil pelo POC

O cálculo das Composições da Base de Cálculo e o cálculo das Fórmulas de Apuração podem efetuar integração com o BackOffice Protheus uma vez que utilizem consultas de saldo contábil por uma das funções de fórmula (vide seção 'Funções de Formula') ou Valor de Origem do tipo 'Contábil'.

Requisito: ER_Consulta de Saldos Contábeis - AccountingBalance

Fluxo da Mensagem: RM → Protheus

Mensagem: AccountingBallance

Tipo de Envio: Síncrono 

Contabilização das Apurações Realizadas

O processo de Contabilização das Apurações será executado conforme especificação do requisito abaixo.

Requisito: ER_Lançamentos Contábeis - AccountingEntry

Fluxo da Mensagem: RM → Protheus

Mensagem: AccountingEntry

Tipo de Envio: Síncrono 

Estornar/Excluir Contabilização

Quando o ambiente possuir integração ativa com BackOffice Protheus, sempre será executado estorno e nunca exclusão, ou seja, será gerada mensagem de integração de inclusão de lançamento contábil com "sinais opostos" (contas opostas), conforme descrito na especificação do requisito abaixo.

Requisito: ER_Lançamentos Contábeis - AccountingEntry

Fluxo da Mensagem: RM → Protheus

Mensagem: AccountingEntry

Tipo de Envio: Síncrono 

Geração de lançamentos financeiros

A geração de lançamentos financeiros é um processo que já era integrado nas versões anteriores, porem, para atender demandas da apuração de resultado (POC), foi alterado para tratar alguns campos necessários, conforme descrito na especificação do requisito abaixo.

Requisito: ER_PCREQ-6397_Lançamentos Financeiros - Financing

Fluxo da Mensagem: RM → Protheus

Mensagem: Financing

Tipo de Envio: Síncrono 

Limitações / Restrições Gerais

Lista de funções de fórmula de Consulta Saldo Contábil integradas ao BackOffice Protheus.

Âncora
Funções de Fórmula Funções de Fórmula

• VALORCONTACONTABILPERIODO
  
  • Função de consulta de saldo contábil a partir dos seguintes parâmetros: Conta Contábil, Tipo de Retorno e Centro de Custo, Histórico Padrão e Período de Consulta (Data início e Data fim).
• VALORCONTACONTABIL
  • Função de consulta de saldo contábil a partir dos seguintes parâmetros: Conta Contábil, Tipo de Retorno, Centro de Custo e Histórico Padrão.
  • É utilizado o período da apuração do POC como período de consulta.
• VALORCONTA
  • Função de consulta de saldo contábil a partir dos seguintes parâmetros: Conta Contábil, Tipo de Retorno e Centro de Custo.
  • É utilizado o período da apuração do POC como período de consulta.
  • Não é enviado Histórico Padrão como filtro.

Gatilhos de Integração do cadastro de Plano de Contas Gerencial.

Visto o objetivo do projeto, restringe-se ao escopo da integração os gatilho listados abaixo, não havendo integração dos demais processos de manutenção do cadastro.

• DataServer de Cadastro (tela de Inclusão/Alteração/Exclusão) - CtbGerenciaData
• Processo "Gerar e Associar Contas Gerenciais", responsável por automatizar a geração de contas gerenciais e associar a Empreendimento, Unidades e Sub-Unidades.
• Fórmula Visual de sincronismo
  
  

Tratamento de Período Contábil.

O sistema de Gestão Contábil da linha RM não é somente utilizado na integração, servindo somente como ponte para o sistema integrado, por este motivo, o configurador parametrizará o período contábil para data inicial 01/01/2000 e data final 01/01/2500.Esta restrição não gerará nenhum impacto ao uso do sistema pois o BackOffice Protheus executará todas as validações necessárias com a parametrização contábil executada no mesmo.

Situações comuns (opcional)

Tratamento de erros de integração (TOTVS Incorporação)

Checklist de suporte da aplicação

• Verificar configuração da integração na linha RM e Protheus;
• Verificar se estão corretos os cadastro de De/Para em ambas as linhas;
• Realizar testes com os serviços para garantir que ambos estão ativos (acessando o endereço pelo browser);
• Verificar se estão sendo incluídos registros nas filas de mensagens (RM e Protheus);
• Verificar erros descritos no processamento das mensagens existentes nas filas;
• Verificar configuração da Apuração de resultados (POC);
• Verificar cadastro de avanço;

INTEGRAÇÃO POC TOTVS Incorporação X BackOffice Protheus

Contexto de negócio (Introdução)

Contextualização sobre do que se trata a área em que iremos dissertar tal integração.

Seu negócio, sua gestão, complexidade, o que está envolvido (em demais áreas), processos, etc. Tais explanações não precisam citar ferramentas (softwares) e sim as expectativas e resultados do uso de um sistema informatizado.

Interessante citar as tendências e necessidades de mercado, o quê, em geral, os software proporcionam (destinam/propósito), principais recursos, etc, e motivos que levaram a criar a integração (em outros termos, o porquê de integrar).

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• TOTVS Incorporação - Descrição do Produto
• BackOffice Protheus  - Descrição do Produto

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

Premissas de Integração

Premissas TOTVS Incorporação

• Configurar a integração “TOTVS Manutenção de ativos x BackOffice RM” através do TBC (Integração | Ferramentas | Configuração);
• Ativar a Integração “TOTVS Manutenção de ativos x BackOffice RM” acessando “Integração | Mensagem única | Integrações” no menu do TBC (Integração);
• Utilização de Fórmula Visual com gatilhos de integração, enviando os registros ao EAI.
• Todos os cadastros mantidos pelo BackOffice RM deverão ser desabilitados no Protheus, evitando concorrência de dados.
• Será utilizado o “novo modelo” do Backoffice RM como referência.

Premissas Protheus

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

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.