Integração TOTVS Educacional x BackOffice Protheus

(1)

Integração TOTVS Educacional x BackOffice Protheus

(2)

TOTVS Educacional x BackOffice Protheus

Título do documento

Sumário

Sumário ... 1

1. Contexto de negócio (Introdução) ... 3

2. Sistemas Envolvidos ... 3 3. Integração ... 4 4. Escopo ... 6 5. Pré-requisitos instalação/implantação/utilização ... 6 5.1. Protheus ... 10 5.2. RM ... 10 6. Instalação/Atualização ... 10 6.1. Protheus ... 10 6.2. RM ... 14 7. Controle de Versão ... 15 8. Suporte ... 15 9. Transações/Entidades/Mensagens únicas ... 15 9.1. Tabelas De-Para ... 15 9.1 16 9.1.1 Mensagem AccountAntAccount (Plano de Contas) ... 16

9.1.2 Mensagem CostCenter (Centro de Custo) ... 16

9.1.3 Mensagem AccountingEntry (Lançamento Contábil) ... 16

9.1.4 Mensagem AccountingCalendar (Período Contábil)... 16

9.1.5 Mensagem AccountAntDefaultHistory (Histórico Contábil)... 16

10. Fluxo das Informações ... 16

10.1. Cadastros ... 17 10.1.1. Cadastros Especiais ... 17 10.1.1.1. Empresa e Filial... 17 10.1.2. Cadastros comuns ... 18 10.1.2.1. <Plano de Contas>... 18 10.1.2.2. <Centro de custo> ... 20 10.1.2.3. <Histórico Padrão>... 21 10.1.2.4. <Período Contábil> ... 21 10.1.2.5. <Lançamentos Contábeis> ... 22

11. Fluxo das Informações ... 25

12. Como fazer (opcional) ... 25

13. Situações comuns (opcional) ... 25

14. Checklist de suporte da aplicação ... 26

(3)

TOTVS Educacional x BackOffice Protheus

1. Contexto de negócio (Introdução)

TOTVS Educacional

O TOTVS Educacional, permite a instituição de ensino iniciar seus trabalhos depois da captação de alunos, sendo montado uma estrutura curricular, para serem ofertadas aos alunos e professores. Cadastram-se cursos, disciplinas, matrizes curriculares para depois ofertá-las aos alunos nos períodos letivos, turmas etc.

Depois da estrutura curricular montada e ofertada, a instituição de ensino poderá realizar a matrícula de seus alunos e dar permissão aos seus professores para registrarem as notas e faltas dos alunos.

Iniciado o período letivo de uma instituição de ensino, algumas rotinas são realizadas com frequência, tais como: Transferência de alunos, atividades extra-curriculares, avaliação institucional, emissão de certificados/diplomas, solicitação de recursos/instalações, alocação de salas e etc. Para essas rotinas relacionadas a estrutura acadêmica, damos o nome de movimentação acadêmica.

Outro ponto de movimentação na instituição de ensino, são os processos que acontecem na tesouraria e/ou financeiro. Nessa etapa, são cadastrados os planos de pagamentos, parcelas, bolsas, geração de lançamentos, boletos de pagamentos e etc. Faz parte do fluxo processual do TOTVS Educacional as integrações com outros sistemas/módulos como Gestão de Relacionamento com Clientes, Folha de pagamento, Gestão Bibliotecária, Gestão Financeira entre outros.

BackOffice Protheus (Contabilidade Gerencial)

Entre os diversos instrumentos utilizados pela administração, é importante destacar o papel da Contabilidade como meio especialmente concebido para captar, registrar, acumular, resumir, medir e interpretar os fenômenos que afetam a situação patrimonial, financeira e econômica de qualquer empresa, seja qual for seu ramo de atividade ou sua forma jurídica.

A Contabilidade, assim como qualquer outra atividade, tem um elenco de regras e princípios que orienta e disciplina a atividade contábil.

Baseado nestes princípios, o ambiente Contabilidade Gerencial (SIGACTB) proporciona automação completa no controle dos lançamentos contábeis, tendo total integração com os demais ambientes que compõem o sistema Protheus.

TOTVS Educacional x BackOffice Protheus

Este documento tem por objetivo reunir as informações relevantes sobre a Integração do Totvs Educacional RM com BackOffice Protheus (Contabilidade Gerencial).

Esta integração está de acordo com as boas práticas recomendadas pelo Comitê de Integração TOTVS e utiliza a arquitetura Mensagem Única e comunicação via WebService.

2. Sistemas Envolvidos

 TOTVS Educacional – Módulo Educacional que gerencia escolas e faculdades (ensino básico e superior), por meio de ferramentas que permitem maior agilidade nos processos que envolvem os alunos, responsáveis, professores e os funcionários.

(4)

TOTVS Educacional x BackOffice Protheus

Título do documento

3. Integração

O objetivo principal é Integrar a contabilização por competência do TOTVS Educacional com o BackOffice Protheus (Contabilidade Gerencial):

 Envio de Centro de Custo do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Plano de Contas do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Período Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Moeda Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Classe de Valor do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Item Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de Lançamentos Contábeis do RM Labore para o BackOffice Protheus, módulo Contabilidade Gerencial. Definição de Mensagem Única – TotvsMessage

Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes forma adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela “etiqueta”, pudessem agora compor o seu ambiente de TI, utilizando produtos de origens diferentes (Ex.: TOTVS Educacional + BackOffice PROTHEUS).

Esta mesma iniciativa já era uma prática comum nos clientes, porém todo custo envolvido na integração entre estes aplicativos era visto pelo cliente como parte da escolha de utilizar-se de produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS passam a demandar que estes produtos sejam naturalmente integrados. Isto significa que se antes o cliente arcava com o custo e o risco envolvido em uma integração, ele agora entende que a TOTVS deve prover soluções já integradas, independente da origem dos produtos oferecidos.

Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definido uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS devam trabalhar com uma mensagem XML única, evitando desta forma, o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro:

Neste cernário, qualquer produto TOTVS trabalhará com o mesmo XML para uma mesma entidade, ou seja, supondo que tenhamos um XML correspondente à mensagem de clientes, ela poderá ser enviada para qualquer um dos produtos que suporte o recebimento desta entidade.

(5)

TOTVS Educacional x BackOffice Protheus

Uma vez que os vários produtos TOTVS terão um “idioma” comum (o XML único), as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro. Com isso, será possível conectar diretamente dosi produtos, como no diagrama abaixo:

Além de questões referentes ao formato das mensagens, a mensagem única também torna uniforme o tratamento destas mensagens XML pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento.

Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS. Este fluxo poderá ocorrer nos seguintes sentidos:

 RM (Educacional, Processo Seletivo, Biblioteca, Financeiro)  PROTHEUS: Os dados serão trafegados pelo fluxo normal até a fila de integração TBC, onde o mesmo irá consumir o WebService do EAI do PROTHEUS para envio da(s) mensagem(s). Após a resposta do PROTHEUS o RM atualizará o registro, com o status de processamento e demais dados, no monitor da fila de Mensagem Única.

 PROTHEUS  RM (Educacional, Processo Seletivo, Biblioteca, Financeiro): O PROTHEUS irá consumir o WebService da linha RM para recebimento de mensagens únicas. O mesmo também será responsável por encaminhar as mensagens para o EAI RM, que processará a mesma e encaminhará o retorno de acordo com o tipo de comunicação definida (síncrona ou assíncrona).

Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas:

 Síncrona: O sistema de origem gera uma mensagem de integração na sua fila e envia ao WebService de destino. O processo na origem aguarda o processamento da mensagem no destino e ao receber o retorno, atualiza o status do processamento na fila de integração.

 Assíncrona: O sistema de origem gera uma mensagem de integração em sua fila, envia ao WebService de destino e aguarda somente a confirmação de recebimento da mensagem. O processo na origem não fica parado aguardando o processamento da mensagem de destino.

Ao término do processamento da mensagem por parte do sistema de destino, o mesmo envia outra mensagem de retorno ao sistema de origem com status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente através do monitor da fila de integração.

Nota

Cada linha de produto poderá programar a fila de integração de uma maneira, mas sempre irá respeitar o protocolo definido para mensagem padrão e armazenado o log de processamento de todas mensagens recebidas e/ou enviadas.

(6)

TOTVS Educacional x BackOffice Protheus

Título do documento

4. Escopo

Essa integração visa a utilização do BackOffice Protheus para fazer a contabilização e o RM Classis para os lançamentos contábeis da gestão educacional. Para tal fim, os seguintes itens fazem parte do escopo:

 Envio de inclusão, alteração e exclusão de Centro de Custo do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Plano de Contas do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Período Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Classe de Valor do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Item Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Moeda Contábil do BackOffice Protheus, módulo Contabilidade Gerencial, para o RM Classis.

 Envio de inclusão, alteração e exclusão de Lançamento Contábil do RM Classis para o BackOffice Protheus, módulo Contabilidade Gerencial.

Os seguintes itens NÃO fazem parte do escopo dessa integração:

 Envio de Moeda Contábil do RM Classis para o BackOffice Protheus.

 Envio de Centro de Custo do RM Classis para o BackOffice Protheus.

 Envio de Plano de Contas do RM Classis para o BackOffice Protheus.

 Envio de Período Contábil do RM Classis para o BackOffice Protheus.

 Envio de Classe de Valor do RM Classis para o BackOffice Protheus.

 Envio de Item Contábil do RM Classis para o BackOffice Protheus.

 Envio de Lançamento Contábil do Protheus para o RM Classis.

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

(7)

TOTVS Educacional x BackOffice Protheus

Para instalar qualquer módulo da linha RM, o primeiro passo é realizar a instalação da Biblioteca RM, pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC. (Veja mais detalhes em: COMO FAZER – TBC – Instalar BibliotecaRM.pdf).

Os WebServices do TBC necessários para esta integração, se encontram no diretório de instalação da Biblioteca RM. Se for utilizar o Webservice do EAI pelo RM.Host, sem utilizar o IIS, pode-se utilizar o endereço http://<NOME DA MÁQUINA COM RM.HOST>:8051/EAIService/, onde “<NOME DA MÁQUINA COM RM.HOST>” será o nome da máquina que está instalado o “RM.Host.Service.exe ou RM.Host.exe” (Aplicativo responsável por realizar a comunicação entre os diversos aplicativos da linha RM). A porta padrão é 8051, mas poderá ser alterada para outra conforme a necessidade do cliente. Para isso, basta mudar/adicionar uma tag no arquivo “RM.Host.Service.exe.config”, conforme mostra imagem abaixo (<add key=”HTTPPort” value=”8051” />):

Senão, deve seguir a instalação e configuração do Webservice, pelo documento do TBS, para instalação pelo IIS.

Exemplo:

http://localhost:8051/EAIService/

Nota

Para verificar se o WebServices está no “ar” (pronto para receber requisições), basta digitar o endereço no seu navegador preferido (lembrando de alterar o nome da máquina e porta, se for o caso), conforme mostra figura abaixo:

(8)

TOTVS Educacional x BackOffice Protheus

Título do documento

Se for utilizar o RM.Host.Service.exe será necessário a execução do comando, abaixo, para liberação da porta configurada na tag “HttpPort”, via prompt de comando:

 Adicionar

netsh http add urlacl url=http://+:8051/ user=NetworkService

 Apagar

netsh http delete urlacl url=http://+:8051/

 Exibir

netsh http show urlacl

A sintaxe do link do webservice do EAI que será utilizado pelo Protheus vai depender se está sendo utilizado o IIS ou RM.Host como base.

Se utilizar o TBC como base e configurar o webservice no EAI, será utilizado, como exemplo, o link:  http://localhost/EAIService/wsEAIService.asmx?wsdl

Se utilizar o RM.Host como base para utilizar o webservice do EAI, será utilizado, como exemplo, o link:  http:// localhost:8051/EAIService/IConWSEAIService

Caso o serviço do Host (RM.Host.Service.exe ou RM.Host.exe) não esteja rodando e/ou a porta não esteja correta, a mensagem abaixo poderá ser exibida:

(9)

TOTVS Educacional x BackOffice Protheus

Para que a integração possa funcionar corretamente, deve-se verificar se existe a tag de qual base padrão do RM para integração no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config):

<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>”, onde a variável <ALIAS_DO_BANCO_RM> será o nome do alias cadastrado para acesso ao banco de dados da linha RM.

Exemplo:

Importante: Para o correto funcionamento da integração, somente um servidor (Host), deve estar configurado para ler a fila de mensagens únicas. Esse requisito deve ser atendido para que as mensagens do tipo assíncronas possam ser processadas em sequência.

A linha RM possui software específico para a integração com demais linhas de produtos TOTVS. Este produto é parte integrante do conjunto de ferramentas denominada TBC – TOTVS Business Connect, acessada a partir do módulo “Integração”.

(10)

TOTVS Educacional x BackOffice Protheus

Título do documento

Os parâmetros necessários para estabelecer a comunicação com o Protheus devem ser realizadas no módulo de integração.

Observação: Para mais informações sobre este módulo e demais produtos RM, acesse o endereço: http://wikihelp.totvs.com.br/wikihelp/default.aspx

5.1. Protheus

 Versão minima do Protheus: 11.80.

 Possuir um licenciamento (License Server) adequado do sistema Protheus.

 Necessário o uso da ferramenta EAI.

 Necessária configuração de um WebService.

 Módulos necessários: Contabilidade Gerencial (SigaCTB).

 Programa CTBA060 cuja data mínima seja 24/10/2014.

 Programa CTBA180 cuja data mínima seja 24/10/2014.

 Programa CTBI020 cuja data mínima seja 24/10/2014.

5.2. RM

Utilizar a versão 11.83.55 ou superior.

6. Instalação/Atualização

Atualização de sistema não necessariamente quer dizer atualização de versão de mensagem. Cada integração tem suas versões de mensagens já definidas. Uma alteração na versão da mensagem pode impactar em toda a integração, pois é desenvolvida uma lógica para cada versão.

Quando houver uma atualização, do TOTVS Educacional, para correções relacionadas à integração, será necessário a exclusão da integração, referente, e a sua reinstalação pelo Configurador. É importante verificar antes das exclusão as informações dos parâmetros de integração e as configurações do webservice de destino, pois seus valores, também, serão apagados.

6.1. Protheus

 Acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente ao qual o Protheus será integrado.

(11)

TOTVS Educacional x BackOffice Protheus

 Acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_EAIWS com o nome do cliente WebService do EAI para envio a outro EAI. (WSEAISERVICE).

 Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_ EAIUSER com o nome de usuário.

 Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_ EAIPASS com a senha de usuário.

 Acessar SigaCFG > 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

Sim CTBA010 ACCOUNTINGCALENDAR Sim Não Assíncrono Todas EAI CTG Sim CTBA020 ACCOUNTANTACCOUNT Sim Não Assíncrono Todas EAI CT1 Sim CTBA030 COSTCENTER Sim Não Assíncrono Todas EAI CTT Sim CTBA040 DEPARTAMENT Sim Não Assíncrono Todas EAI CTD Sim CTBA060 CLASSVALUE Sim Não Assíncrono Todas EAI CTH Sim CTBA102 ACCOUNTINGENTRY Não Sim Assíncrono Todas EAI CT2

Sim CTBA140 CURRENCY Sim Não Assíncrono Todas EAI CTO

 Caso alguma mensagem esteja configurada com o método Assíncrono, acessar SigaCFG > Ambiente > Schedule > Schedule e configurar um agente e um agendamento, conforme segue abaixo:

 Cadastrar agente.

Clicar no símbolo destacado no canto superior direito da tela, para o cadastro automático dos agentes:

 Cadastrar agendamento.

(12)

TOTVS Educacional x BackOffice Protheus

Título do documento

Preencher o campo “Rotina” com a rotina FWEAI e informar as empresas para as quais o agendamento será válido:

Definir a data e horário para a execução do agendamento e definir a recorrência (clicando no símbolo destacado na parte superior), conforme as necessidades existentes:

(13)

TOTVS Educacional x BackOffice Protheus

Confirmar a inclusão do agendamento:

(14)

TOTVS Educacional x BackOffice Protheus

Título do documento

 Iniciar os agentes:

6.2. RM

Para a configuração e instalação da integração do TOTVS Educacional x SIGACTB Protheus, siga os passos abaixo. 1º Passo:

Carregar o “Assistente de Configuração” do TBC (Módulo Integração -> Ferramentas -> Configurar);

Neste passo, deve-se informar o usuário e senha do banco de dados com permissão para executar os scripts de configuração da integração.

2º Passo:

([v]) Marcar a integração do “TOTVS Educacional x SIGACTB Protheus” através do processo; 3º Passo:

Executar o processo para realizar a instalação da integração; 4º Passo:

Depois de executar a instalação, deve-se configurar o endereço do WebService do EAI do TOTVS Protheus para a integração

“TOTVS Educacional x SIGACTB Protheus”, disponível em “Módulo TBC (Integração) -> Mensagem Única -> Integrações”; 5º Passo:

Ativar integração “TOTVS Educacional x SIGACTB Protheus”, disponível em “Módulo TBC (Integração) -> Mensagem Única -> Integrações”;

Informar os campos, abaixo, para configuração da integração:

URL WEB SERVICE: Informe o endereço do WebService Protheus para envio de mensagens. Utilize o formato http://[servidor]:[porta]/EAIService.apw . Para verificar se o WS Protheus está disponível digite o endereço do mesmo no seu navegador (no formato http://[servidor]:[porta]), na página apresentada procure pelo texto EAISERVICE)

USUÁRIO AUTENTICAÇÃO: Informe o nome do usuário para autenticação pelo WebService. SENHA AUTENTICAÇÃO: Informe a senha para autenticação pelo WebService.

(15)

TOTVS Educacional x BackOffice Protheus

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

8. Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos TOTVS 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.

9. Transações/Entidades/Mensagens únicas

9.1. Tabelas De-Para

Todas as movimentações de mensagens, com algumas exceções, tanto para envio quanto para recebimento, resultarão em um registro na tabela De-Para para relacionamento entre os códigos dos sistema que estão trocando informações.

Considerando as mensagens envolvidas nessas integração, seguem os registros De-Para que serão registrados ao enviar ou receber uma mesagem, como exemplo:

Método ID Descrição Origem Destino XSD (versões podem variar)

Cadastros 01 Centro de Custo Protheus RM CostCenter_2_000.xsd

02 Classe de Valor Protheus RM ClassValue_1_000.xsd 03 Item Contábil Protheus RM Departament_1_000.xsd 04 Plano de Contas Protheus RM AccountantAccount_2_000.xsd 05 Moeda Contábil Protheus RM Currency_2_001.xsd

06 Período Contábil Protheus RM AccountingCalendar_1_000.xsd 07 Lançamento Contábil RM Protheus AccountingEntry_2_000.xsd

(16)

TOTVS Educacional x BackOffice Protheus

Título do documento

9.1.1

Mensagem AccountAntAccount (Plano de Contas)

Tabela RM Chave Primária RM Valor Chave

Primária RM Sistema Integrado Valor Chave Integração

CConta CODCOLIGADA|CODCONTA 2|01 PROTHEUS 01|01AM |01

CConta CODCOLIGADA|CODCONTA 2|0101 PROTHEUS 01|01AM |0101

9.1.2 Mensagem CostCenter (Centro de Custo)

Tabela RM Chave Primária RM Valor Chave

Primária RM Sistema Integrado Valor Chave Integração

GCCusto CODCOLIGADA|CODCCUSTO 1|100000000 PROTHEUS 01|01AM

|100000000

GCCusto CODCOLIGADA|CODCCUSTO 1|100000002 PROTHEUS 01|01AM

|100000002 9.1.3 Mensagem AccountingEntry (Lançamento Contábil)

Tabela RM Chave Primária RM Valor

Chave Primária

RM

Sistema

Integrado Valor Chave Integração

CLancamento CODCOLIGADA|IDLANCAMENTO 2|116 PROTHEUS 01|01AM|20141031|001500|001|000002 CLancamento CODCOLIGADA|IDLANCAMENTO 2|117 PROTHEUS 01|01AM|20141130|001500|001|000001

9.1.4 Mensagem AccountingCalendar (Período Contábil) Não haverá registro na tabela De-Para para essa mensagem.

9.1.5 Mensagem AccountAntDefaultHistory (Histórico Contábil) Essa mensagem não está utilizada para essa integração.

10. Fluxo das Informações

Mensagens Únicas relacionadas a esta integração:

(17)

TOTVS Educacional x BackOffice Protheus

Cadastros 01 Plano de

contas PROTHEUS RM AccountantAccount 2.000

02 Período

Contábil PROTHEUS RM AccountingCalendar 1.000

03 Histórico

contábil PROTHEUS RM AccountAntDefaultHistory 1.000 04 Centro de

Custo PROTHEUS RM CostCenter 2.000

05 Lançament os contábeis RM PROTHEUS AccountingEntr y 2.000 06 Item

Contábil PROTHEUS RM Departament 1.000

07 Classe de

Valor PROTHEUS RM ClassValue 1.000

08 Moeda

Contábil PROTHEUS RM Currency 2.001

***Importante: A mensagem de histórico, apesar de mapeada para a integração, ainda, não está sendo utilizada.

10.1. Cadastros

10.1.1. Cadastros Especiais

Será necessário primeiro fazer o cadastro manualmente no Protheus e no RM e depois configurar o “de/para” de integração correspondente (RM e Protheus possuem interfaces específicas para este fim).

RM: RM.exe | Segmento Integrações | Aba Integração | Mensagem Única | De-Para

10.1.1.1. Empresa e Filial

O primeiro cadastro que deve ser realizado para operação dos sistemas é o de Empresa (Coligada) e suas Filiais. No RM estas entidades são cadastros comuns, mas no Protheus a Empresa e as Filias são definidas em arquivos de configuração de ambientes sendo parte da implantação do Protheus padrão.

(18)

TOTVS Educacional x BackOffice Protheus

Título do documento

A maioria das mensagens de integração fará referências ao cadastro de Empresa/Coligada. Ex:

De-para RM (Filial)

Tabela RM GFILIAL

Chave Primária RM CODCOLIGADA|CODFILIAL

Valor Chave Primária RM 1|2

Sistema Integrado PROTHEUS

Valor Chave Integração 10|113

Obs: Nas integrações com o Protheus, será necessário cadastrar manualmente na tabela de De/Para um mapeamento da coligada para ela mesma (conforme exemplo abaixo). Esse cadastro é necessário para o correto funcionamento dos códigos de extensions criados nas integrações.

De-para RM (Empresa)

Tabela RM GCOLIGADA

Chave Primária RM CODCOLIGADA

Valor Chave Primária RM 1

Sistema Integrado PROTHEUS

Valor Chave Integração 1

Nota

Nesse projeto não está sendo contemplado o sincronismo automático de empresas e filiais.

Obs: Em integração específicas com o Protheus, no cadastro de “de/para” o campo “Tabela RM” deve ser preenchido com a tabela “GFilial” para buscar a coligada, conforme exemplo acima.

10.1.2. Cadastros comuns

10.1.2.1. <Plano de Contas>

Identificador da Mensagem: AccountAntAccount Versão: 2.000

Módulo Gestão Contábil: RM Módulo Protheus: Protheus

(19)

TOTVS Educacional x BackOffice Protheus

Mensagem Padrão RM PROTHEUS

Tabela Campo Tabela Campo

CompanyId CCONTA CODCOLIGADA _- _{Variável do Sistema}

CompanyInternalId CCONTA CODCOLIGADA _- _{Variável do Sistema}

Code CCONTA CODCONTA CT1 CT1_CONTA

InternalId CCONTA CODCOLIGADA|CODCONTA _CT1 _{CT1_FILIAL|CT1_CONTA}

ShortCode CCONTA REDUZIDO CT1 CT1_RES

Description CCONTA DESCRIÇÃO _CT1 _{CT1_DESC01}

PostingNature CCONTA NATUREZA CT1 CT1_NORMAL

AnalyticalOrSynthetic CCONTA ANALITICA _CT1 _{CT1_CLASSE}

ActiveOrInactive CCONTA INATIVA CT1 CT1_BLOQ

Informações importantes sobre o Plano de Contas:

Caminho para acesso ao cadastro do Plano de contas, no sistema:

Acesse: BackOffice | Contabilidade Gerencial | Cadastros | Contábil Nota

Está disponível no RM um campo chamado “NATSPED” conforme print abaixo. Esse campo informa para o SPED a natureza da conta (se é uma conta de ativo, passivo, patrimônio líquido, contas de resultado, contas de compensação). Esse campo não será transferido na mensagem pois o mesmo deve estar somente no backoffice. Porém, esse campo é obrigatório para inclusão da conta contábil no RM. Sendo assim, iremos gravar o valor de valor “01 – Não informado” somente para permitir a geração.

A máscara parametrizada da conta contábil no TOTVS Contabilidade Gerencial será validada no processo de inclusão da conta contábil. Portanto, o parâmetro de máscara contábil deve ser cadastrado de acordo com o formato do código da conta a ser enviado pelo Protheus. Caso o Protheus não envie máscara no seu código de conta (ex: 1011214), então o parâmetro “Não utiliza máscara nas contas” deve ser marcado. Caso contrário, ocorrerá um erro no processo de inclusão da conta.

Caminho para acesso ao parâmetro para não utilizar máscar:

Acesse: BackOffice | Contabilidade Gerencial | Ambiente | Parâmetros |

01.01 – Plano de Contas | 01.01.01 – Plano de Contas contábil | Plano de Contas Contábil | Não utilizar máscara nas contas

No cenário onde o Protheus possuir um compartilhamento por Empresa e por Filial para o Plano de Contas, o TOTVS Contabilidade Gerencial deve ser parametrizado para utilizar contas globais por padrão:

Caminho para acesso ao parâmetro para utilizar conta global:

(20)

TOTVS Educacional x BackOffice Protheus

Título do documento

01.01 – Plano de Contas | 01.01.01 – Plano de Contas contábil | Plano Contas | Acessa conta globais

01.01 – Plano de Contas | 01.01.01 – Plano de Contas contábil | Plano Contas | Cadastrar como global por padrão

Importate: A configuração para utilização da conta Global será realizada somente se o Protheus tiver um compartilhamento por Empresa.

10.1.2.2. <Centro de custo>

Identificador da Mensagem: CostCenter Versão: 2.000

Módulo Gestão Financeira: RM Módulo Protheus: Protheus

Tipo de Envio:

CompanyId GCCUSTO CODCOLIGADA - Variável do Sistema

CompanyInternalId - Variável do Sistema

BranchId CTT CTT_FILIAL

InternalId GCCUSTO CODCOLIGADA|CODCCUSTO CTT CTT_FILIAL|CTT_CUSTO

Code GCCUSTO CODCCUSTO CTT CTT_CUSTO

Name GCCUSTO NOME CTT CTT_DESC01

RegisterSituation GCCUSTO ATIVO CTT CTT_BLOQ

ShortCode GCCUSTO CODREDUZIDO CTT CTT_RES

Sped GCCUSTO ENVIASPED - -

Class GCCUSTO CTT CTT_CLASSE

Informações importantes sobre a mensagem de Centro de Custo:

O código do centro de custo no TOTVS Gestão Financeira poderá ser criado de forma sequencial ou através de máscara. Essa definição poderá ser feita através do parâmetro EDUCTBCCUSTOAUTOINC criado nos parâmetros de integração.

Se o parâmetro estiver com valor True (marcado) o código enviado será ignorado e um código de auto incremento será gerado. Se o parâmetro estiver com valor False (desmarcado) será utilizado o código enviado pelo sistema de origem de acordo com a máscara utilizada.

(21)

TOTVS Educacional x BackOffice Protheus

Acesse: Módulo Integração | Integração | Mensagem Única | Integrações | Anexo Parãmetros de Integração A máscara de centro de custo deverá ser removida para que o sistema financeiro TOTVS Gestão Financeira aceite os código enviado pelo PROTHEUS, na integração.

No sistema, o parâmetro pode ser acessado através do caminho:

Caminho para acesso ao cadastro do Centro de Custo, no sistema:

Acesse: BackOffice | Gestão Financeira | Cadastros | Centro de Custo

10.1.2.3. <Histórico Padrão>

Identificador da Mensagem: AccountAntDefaultHistory Versão: 1.000

Módulo Educacional: RM Módulo Protheus: Protheus

Tipo de Envio:

CompanyId CHISTP CODCOLIGADA

DefaultHistoryCode CHISTP CODHISTP

InternalId CHISTP CODCOLIGADA|CODHISTP

Description CHISTP DESCRICAO

DefaultHistoryCode CHISTP CODCOLIGADA

Nota

Apesar da mensagem de histórico padrão pertencer a integração, ainda, não será utilizada.

10.1.2.4. <Período Contábil>

(22)

TOTVS Educacional x BackOffice Protheus

Título do documento

Versão: 1.000

Módulo Educacional: RM Módulo Protheus: Protheus

Tipo de Envio:

CompanyId CPARAM CODCOLIGADA - Variável do Sistema

CompanyInternalId CPARAM CODCOLIGADA - Variável do Sistema

CalendarCode CPARAM CODCOLIGADA |24|25 CTG CTG_CALEND

InternalId CPARAM CODCOLIGADA|24|25 CTG CTG_FILIAL|CTG_CALEND|CTG_EXERC

InitialDate CPARAM CODCOLIGADA|24 CTG CTG_DTINI

FinalDate CPARAM CODCOLIGADA|25 CTG CTG_DTFIM

Nota

ID = 24 (corresponde a linha da parametrização da dataInicio do período contábil) ID = 25 (corresponde a linha da parametrização da dataFIm do período contábil)

No processo de integração, o RM atualizará as datas de período contábil sempre de acordo com a menor data inicial e a maior data final enviada pelo Protheus. No Protheus, essas informações são armazenadas em um cadastro, e no RM essas informações são armazenadas nos parâmetros, sendo assim, teremos espaço para armazenar somente uma dataIncial e uma dataFinal.

Caminhos para a parametrização do período contábil:

10.1.2.5. <Lançamentos Contábeis>

Identificador da Mensagem: AccountingEntry Versão: 2.000

Módulo Gestão de Estoque, Compras e Faturamento: RM Módulo Protheus: Protheus

(23)

TOTVS Educacional x BackOffice Protheus

CompanyId CLANCAMENTO CODCOLIGADA - Variável _Sistema do

BranchId CLANCAMENTO CODFILIAL - Variável _Sistema do

CompanyInternalId CLANCAMENTO CODCOLIGADA - Variável _Sistema do

PeriodStartDate CLANCAMENTO DATAINICIAL - -

PeriodoEndDate CLANCAMENTO DATAFINAL - -

BatchNumber CLANCAMENTO CODLOTE CT2 CT2_LOTE

Document CLANCAMENTO CODLOTE CT2 CT2_DOC

InternalId CLANCAMENTO CODCOLIGADA|CODLOTE

CT2 CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC Entries/Entry/item CT2 CT2_LINHA Entries/Entry/ItemType CT2 CT2_DC

Entries/Entry/EntryNumber CPARTIDA CODCOLIGADA| IDPARTIDA - -

Entries/Entry/MovementDate CPARTIDA DATA CT2 CT2_DATA

Entries/Entry/DebitAccountCode CPARTIDA DEBITO CT2 CT2_DEBITO

Entries/Entry/DebitAccountInternalId CPARTIDA CODCOLDEBITO|DEBITO CT1 CT1_FILIAL |

CT1_CONTA

Entries/Entry/CreditAccountCode CPARTIDA CREDITO CT2 CT2_CREDIT

Entries/Entry/CreditAccountInternalId CPARTIDA CODCOLCREDITO|CREDITO CT1 CT1_FILIAL _{CT1_CONTA} |

Entries /EntryValue CPARTIDA VALOR CT2 Ct2_VALOR

Entries/Entry/HistoryCode CT2 CT2_HP

Entries/Entry/ComplementaryHistory CPARTIDA COMPLEMENTO CT2 Ct2_HIST

Entries/Entry/CostCenterCode CPARTIDA CODCCUSTO CT2 CT2_CCD

Entries/Entry/CostCenterDebitInternalI

d CPARTIDA CODCOLIGADA|CODCCUSTO

CTT CTT_FILIAL | CTT_CUSTO

CompanyId CPARTIDA CODCCUSTO - Variável do

Sistema

BranchId CPARTIDA CODCOLIGADA|CODCCUSTO - Variável do

Sistema

CompanyInternalId CLANCAMENTO CODCOLIGADA - Variável do

Sistema

PeriodStartDate CLANCAMENTO CODFILIAL - -

PeriodoEndDate CLANCAMENTO CODCOLIGADA - -

BatchNumber CLANCAMENTO DATAINICIAL CT2 CT2_LOTE

Document CLANCAMENTO DATAFINAL CT2 CT2_DOC

InternalId CLANCAMENTO CODLOTE

CT2 CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC

Entries/Entry/item CLANCAMENTO CODLOTE CT2 CT2_LINHA

Entries/Entry/ItemType CLANCAMENTO CODCOLIGADA|CODLOTE CT2 CT2_DC

Entries/Entry/EntryNumber - -

Entries/Entry/MovementDate CT2 CT2_DATA

Entries/Entry/DebitAccountCode CPARTIDA CODCOLIGADA| IDPARTIDA CT2 CT2_DEBITO

Entries/Entry/DebitAccountInternalId CPARTIDA DATA CT1 CT1_FILIAL _{CT1_CONTA} |

(24)

TOTVS Educacional x BackOffice Protheus

Título do documento

Entries/Entry/CreditAccountInternalId CPARTIDA CODCOLDEBITO|DEBITO CT1 CT1_FILIAL _{CT1_CONTA} |

Entries /EntryValue CPARTIDA CREDITO CT2 Ct2_VALOR

Entries/Entry/HistoryCode CPARTIDA CODCOLCREDITO|CREDITO CT2 CT2_HP

Entries/Entry/ComplementaryHistory CPARTIDA VALOR CT2 Ct2_HIST

Entries/Entry/CostCenterCode CT2 CT2_CCD

Entries/Entry/CostCenterDebitInternalI

d CPARTIDA COMPLEMENTO

CTT CTT_FILIAL | CTT_CUSTO

CompanyId CPARTIDA CODCCUSTO - Variável do

Sistema

BranchId CPARTIDA CODCOLIGADA|CODCCUSTO - Variável do

Sistema

CompanyInternalId CPARTIDA CODCCUSTO - Variável do

Sistema

PeriodStartDate CPARTIDA CODCOLIGADA|CODCCUSTO - -

PeriodoEndDate CLANCAMENTO CODCOLIGADA - -

BatchNumber CLANCAMENTO CODFILIAL CT2 CT2_LOTE

Document CLANCAMENTO CODCOLIGADA CT2 CT2_DOC

InternalId CLANCAMENTO DATAINICIAL

CT2 CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC

Entries/Entry/item CLANCAMENTO DATAFINAL CT2 CT2_LINHA

Entries/Entry/ItemType CLANCAMENTO CODLOTE CT2 CT2_DC

Entries/Entry/EntryNumber CLANCAMENTO CODLOTE - -

Entries/Entry/MovementDate CLANCAMENTO CODCOLIGADA|CODLOTE CT2 CT2_DATA

Entries/Entry/DebitAccountCode CT2 CT2_DEBITO

Entries/Entry/DebitAccountInternalId CT1 CT1_FILIAL _{CT1_CONTA} |

Entries/Entry/CreditAccountCode CODCOLIGADA| IDPARTIDA CT2 CT2_CREDIT

Informações importantes sobre a geração de lançamentos contábeis:

A informação do “Código do Lote” [BatchNumber] será utilizada como identificador do lote contábil enviado para o Protheus. Durante a geração de contabilização por competência do Educacional (Aba Financeiro / Contabilidade > Processo de Contabilidade), será enviado uma mensagem com todos os lançamentos contábeis processados para o Protheus.

Caso seja executado o processo de estorno (Aba Financeiro / Contabilidade > Processo de Contabilidade), deverá ser enviado uma mensagem com os lançamentos contábeis do tipo “delete”.

Caminhos para acesso a geração da contabilização: Acesse:

(25)

TOTVS Educacional x BackOffice Protheus

Processos | Gerar contabilização

11. Fluxo das Informações

Não se aplica.

12. Como fazer (opcional)

Não se aplica.

13. Situações comuns (opcional)

Algumas situações de erro e/ou validações podem ocorrer durante o processamento de mensagens da integração. Nas duas situações, as mensagens que foram processadas podem ser verificadas no módulo “Integração”, menu “Integração -> Mensagem Única -> Fila de mensagens únicas”.

Ao abrir o cadastro de “Fila de mensagem”, podemos perceber a fila de mensagem processada e no anexo “Informação de execução de mensagem”, temos as informações do processamento da mensagem.

Caso ocorra algum erro ou validação durante uma integração que utilize uma mensagem síncrona, o texto do erro ou validação aparecerá também no momento da operação.

As integrações que utilizam mensagens assíncronas poderão processar ou agendar o processamento através da tela de “Fila de mensagens”, no menu “Processos -> Execução manual de mensagens únicas”.

Casos de erros onde a mensagem informada refere-se ao WebService do EAI, conforme mostra a figura abaixo:

Poderá ser resolvido verificando 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.

(26)

TOTVS Educacional x BackOffice Protheus

Título do documento

14. Checklist de suporte da aplicação

Itens para conferência no TOTVS Educacional 1º Instalação da Biblioteca RM versão 11.83.55.

2º Instalação do pacote TOTVS Business Connect.

3º Integração “TOTVS Educacional x SIGACTB Protheus" carregada no TBC. 4º Configuração do endereço do webservice do EAI do Protheus.

5º Integração “TOTVS Educacional x SIGACTB Protheus" ativa. Itens para conferência no Protheus 1º Configuração do endereço do webservice do TBC.

2º 3º 4º

Parametrizações da integração.

Equalização dos tamanhos dos campos chave das tabelas do Backoffice e TOTVS Educacional. Amarração das moedas contábeis com os calendários contábeis cadastrados na integração.