Child pages
  • DI_POC_TOTVS_Incorporação_BackOffice_Protheus
Skip to end of metadata
Go to start of metadata

Importante

Para garantir a qualidade, a Integração da Apuração de resultados (POC) com o BackOffice Protheus será validada em cliente piloto para que, posteriormente seja disponibilizada a todos os clientes.

Caso seja necessária a utilização deste recurso, entre em contato com o Suporte RM para que seja avaliada a possibilidade de participar do programa de pilotos.

 

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:

 

Apuração de Resultado Contábil

Cod. Modelo

Modelo de Cálculo

Contabilização

1

Cálculo por Empreendimento

Por Empreendimento

2

Cálculo por Subunidade/ Contrato

Por Empreendimento

3

Por Subunidade

 

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= CIi /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   = CIi / valor do CUB Acumulado (até o mês de apuração)

POCCUB = CICUB / COCUB


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.
    • 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:

Mensagem Única

Rotina

Mensagem

Envia

Recebe

Método

Operação

Canal

Alias

Versão

Sim

CTBA020

ACCOUNTANTACCOUNT

Sim

Não

Síncrono

Todas

EAI

CT1

2.001

Sim

CTBA030

COSTCENTER

Sim

Não

Síncrono

Todas

EAI

CTT

2.000

Sim

CTBA040A

ACCOUNTINGITEM

Sim

Não

Síncrono

Todas

EAI

CTD

1.000

Sim

CTBA060

CLASSVALUE

Sim

Não

Síncrono

Todas

EAI

CTH

1.000

Sim

CTBA102

ACCOUNTINGENTRY

Não

Sim

Síncrono

Todas

EAI

CT2

2.001
SimCTBA800ALISTOFMANAGERIALACCOUNTINGENTITYNãoSimSíncronoTodasEAICV01.000
SimCTBXSINTACCOUNTINGBALANCENãoSimSíncronoTodasEAICQ01.000
SimFINA055FINANCING                                         NãoSimSíncronoTodasEAISE11.002
SimCTBA140CURRENCYSimNãoAssincronoTodasEAICTO2.001

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. 

Método

ID

Descrição

Origem

Destino

XSD (versões podem variar)

Pré-Requisitos (ID)

Cadastros

01

Centro de Custo

Protheus

RM

CostCenter_2_000.xsd

 

02

Classe de Valor

Protheus

RM

ClassValue_1_000.xsd

 

03

Conta Contábil

Protheus

RM

AccountantAccount_2_001.xsd

 

04

Conta Gerencial

RM

Protheus

ListOfManagerialAccountingEntity_1_000.xsd

 

05

Item Contábil

Protheus

RM

AccountantItem_1_000.xsd

 

Processos

06

Consulta Saldo ContábilRMProtheusAccountingBalance_1_000.xsd01, 03, 04
07Lançamento ContábilRMProtheusAccountingEntry_2_001.xsd01, 02, 03, 04, 05
08Lançamento FinanceiroRMProtheusFinancing_1_002.xsd 

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.

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

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.

 

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

Erro

Mensagem

Origem / Motivo

Solução

General Error

General Error http://172.116.103.189:92/EAISERVICE.apw?WSDL

 

Verificar o serviço do EAI Protheus e/ou endereço configurado no RM

HELP: SEMMOEDA  

Nao existe moeda cadastrada!

 Verificar o cadastro do De/Para de moeda no Protheus.
 SE1T10 - Error : 1 - ORA-00001: unique constraint violated SE1T10 - Error : 1 - ORA-00001: unique constraint violated Verificar se a numeração do HardLock referente a tabela SE1 (Campo E1_NUM ) está funcionando corretamente. Utilize a função APCFG110.

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;