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.
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.
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.
O objetivo principal é Integrar a contabilização por competência do TOTVS Educacional com o BackOffice Protheus (Contabilidade Gerencial):
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 cená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.
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 dois 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:
Para mais informações sobre o fluxo dos dados internos ao TBC, vide documentação:
TOTVS Business Connect: http://tdn.totvs.com.br/display/public/rm/TBC
Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas:
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.
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. |
Essa integração visa a utilização do BackOffice Protheus para fazer a contabilização e o TOTVS Educacional para os lançamentos contábeis da gestão educacional. Para tal fim, os seguintes itens fazem parte do escopo:
Os seguintes itens NÃO fazem parte do escopo dessa integração:
Atenção: Não é escopo desse documento descrever a instalação do ERP RM e nem sua configuração.
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.
(Mais detalhes no anexo: COMO FAZER – TBC – Instalar BibliotecaRM.pdf).
Para que a integração possa funcionar corretamente, deve-se verificar se a tag “DefaultDB”, que informa o Alias que será utilizado para acesso a base de dados, existe 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.
Exemplo:
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. |
Para verificar se o webservice está no ar, deve-se abrir o endereço, abaixo, em um navegador web:
Endereço: http:// localhost:8051/EAIService/
A porta "8051" é padrão no sistema e caso seja alterada na tag "HttpPort" no arquivo de configuração do Host, precisa ser alterada no link acima.
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:
Se o Host utilizado for 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:
netsh http add urlacl url=http://+:8051/ user=NetworkService
netsh http delete urlacl url=http://+:8051/
netsh http show urlacl Caso contrário, a mesma página de erro, acima, será exibida. |
Com a utilização do webservice pelo Host, o endereço que será utilizado pelo EAI do Protheus precisará conter a informação de PortName:
http:// localhost:8051/EAIService/IConWSEAIService
Esse endereço, aberto no browser (navegador web), irá exibir uma página em branco. Para o teste pelo navegador o link anterior. |
Uma segunda opção, como alternativa, de configuração, para utilização do EAI será o conjunto de ferramentas denominada TBC – TOTVS Business Connect, que possui esse mesmo webservice em seu instalador e necessitará de uma configuração no IIS do Windows.
Utilizar a versão 11.83.55 ou superior.
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.
Exemplo: http://12.50.90.211:81/MensagemUnicaWS.
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.
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 | ACCOUNTINGITEM | 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 |
Sim | INTXATU01 | INTERNALIDLOAD | Não | Sim | Assíncrono | Todas | EAI | - |
Clicar no símbolo destacado no canto superior direito da tela, para o cadastro automático dos agentes:
Clicar no símbolo destacado na parte inferior para adicionar um novo agendamento:
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:
Confirmar a inclusão do agendamento:
Para uso da integração em ambientes onde já existam dados na base do backoffice Protheus e que sejam pertinentes ao escopo da regra da integração, será utilizada a ferramenta de carga inicial disponibilizada no framework do Protheus. A ferramenta efetua o envio dos dados cadastrados na base utilizando a própria mensagem única correspondente ao cadastro em questão.
Somente as mensagens de cadastro poderão ser utilizadas com o sincronizador de carga inicial.
A ferramenta de carga inicial deve ser utilizada somente na implantação da integração. Não é recomendado o uso da mesma durante a operação do sistema. |
Segue a relação das mensagens que devem estar cadastradas para uso na carga de dados:
Rotina | Mensagem | Versão | Alias |
CTBA060 | CLASSVALUE | 1.000 | CTH |
CTBA040A | ACCOUNTINGITEM | 1.000 | CTD |
CTBA030 | COSTCENTER | 2.000 | CTT |
CTBA020 | ACCOUNTANTACCOUNT | 2.000 | CT1 |
CTBA140 | CURRENCY | 2.001 | CTO |
Todos os registros que forem sincronizados na carga inicial possuirão os devidos de/para registrados e as chaves de internalId armazenadas, conforme a configuração do ambiente de integração onde a funcionalidade será executada, ou seja, todas as filiais configuradas no de/para de empresa e filial receberão os dados sincronizados caso existam dados para as filiais em questão.
Não será possível fazer a carga inicial do cadastro de calendário contábil, visto que o mesmo não possuí as características necessárias para ser compatível com essa ferramenta. Contudo, trata-se de um cadastro simples e sem grande volume de registros, portanto o mesmo deverá ser cadastrado manualmente em ambas as ferramentas.
Para utilizar a ferramenta de Carga Inicial no Protheus, acesse: SIgaCFG | Ambiente | Schedule | Sinc. Carga Inicial EAI.
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.
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.
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.
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 | AccountingItem_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 |
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:
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 |
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 |
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 |
Não haverá registro na tabela De-Para para essa mensagem.
Essa mensagem não está utilizada para essa integração.
A integração TOTVS Educacional x Backoffice Protheus utilizando Stored Procedure foi descontinuada a partir da versão 12.1.4 e, portanto, nas migrações da versão 11 para a versão 12, caso o cliente já utilizasse a integração via Stored Procedure, será necessário efetuar a sincronização dos dados existentes nas duas bases de dados (RM e Protheus).
Como o mecanismo da integração via stored procedure faz a amarração dos dados de forma diferente do de/para da mensagem única, é necessário o uso de rotina que faça a sincronização das bases, criando e alimentando o de/para com os InternalIds correspondentes a cada registro e suas respectivas empresas e filiais.
Para isso, foi criada essa mensagem específica, InternalIdLoad, que trafega os dados de cada registro gravado na base RM, junto com a sua contrapartida na base Protheus e o InternalId gravado no de/para do ambiente RM. Uma vez recebidos esses dados, verifica-se se o registro enviado pelo RM existe de fato na base Protheus e, caso exista, o InternalId recebido é gravado no de/para Protheus como ExternalId. Então o InternalId do registro no Protheus é gerado e enviado para o RM poder registrar no seu de/para o ExternalId. Com esse processo, a base histórica gerada através das stored procedures será portada para o padrão utilizado na mensagem única TOTVS.
As seguintes entidades da integração com o contábil estão incluídas no escopo do Sincronizador De/Para:
Para que o sincronizador funcione corretamente, é necessário criar as pastas para gravação dos logs do sincronizador no Protheus. As pastas devem ser criadas a partir do RoothPath do Protheus, da seguinte forma: “<RoothPath>/logs/CargaSolum” |
A mensagem InternalIdLoad está atualmente na versão 1.000, e sua estrutura está definida da seguinte forma:
Tag | Descrição |
EntityName | Nome da entidade que está sendo sincronizada |
IntegrationId | Chave do registro a ser procurado no Protheus |
NewIntegrationId | InternalId gerado no RM |
O padrão de chave a ser trafegado na tag IntegrationId varia de acordo com a entidade a ser sincronizada. Abaixo a relação de formatos de chaves esperadas no recebimento no Protheus, conforme cada entidade:
Entidade | IntegrationId |
COSTCENTER (Centro de Custos) | Código do Centro de Custos |
CURRENCY (Moeda) | Código da Moeda |
CLASSVALUE (Classe de Valor) | Código da Classe de Valor |
ACCOUNTINGITEM (Item Contábil) | Código do Item Contábil |
Mensagens Únicas relacionadas a esta integração:
Método | ID | Descrição | Origem | Destino | Mensagem | Versão |
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çamentos contábeis | RM | PROTHEUS | AccountingEntry | 2.000 | |
| 06 | Item Contábil | PROTHEUS | RM | AccountingItem | 1.000 |
| 07 | Classe de Valor | PROTHEUS | RM | ClassValue | 1.000 |
| 08 | Moeda Contábil | PROTHEUS | RM | Currency | 2.001 |
Requisições | 09 | Sincronizador | RM | PROTHEUS | InternalIdLoad | 1.000 |
A mensagem de histórico, apesar de mapeada para a integração, ainda, não está sendo utilizada. |
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
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.
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 |
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. |
Identificador da Mensagem: AccountAntAccount
Versão: 2.000
Módulo Gestão Contábil: RM
Módulo Protheus: Protheus
Tipo de Envio:
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 |
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 cadastro do Plano de contas, no sistema:
Acesse: BackOffice | Contabilidade Gerencial | Cadastros | Contábil
Caminho para acesso ao parâmetro para não utilizar máscara:
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:
Acesse: BackOffice | Contabilidade Gerencial | Ambiente | Parâmetros |
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
A configuração para utilização da conta Global será realizada somente se o Protheus tiver um compartilhamento por Empresa. |
Identificador da Mensagem: CostCenter
Versão: 2.000
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
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.
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:
Acesse: Módulo BackOffice | Gestão Financeira | Ambiente | Parâmetros | TOTVS Gestão Financeira
02.02 – Contas a receber | 02.02.01 – Manutenção de Lançamentos | 02.02.01.01 – Lançamento | Centro de Custo | Máscara do Centro de Custo
Caminho para acesso ao cadastro do Centro de Custo, no sistema:
Acesse: BackOffice | Gestão Financeira | Cadastros | Centro de Custo
Identificador da Mensagem: AccountAntDefaultHistory
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | CHISTP | CODCOLIGADA |
|
|
DefaultHistoryCode | CHISTP | CODHISTP |
|
|
InternalId | CHISTP | CODCOLIGADA|CODHISTP |
|
|
Description | CHISTP | DESCRICAO |
|
|
DefaultHistoryCode | CHISTP | CODCOLIGADA |
|
|
Apesar da mensagem de histórico padrão pertencer a integração, ainda, não será utilizada. |
Identificador da Mensagem: AccountingCalendar
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
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 |
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:
Acesse: BackOffice | Contabilidade Gerencial | Ambiente | Parâmetros | TOTVS Contabilidade Gerencial
01.04 – Fechamento | 01.04.01 – Fechamento Mensal
Identificador da Mensagem: AccountingEntry
Versão: 2.000
Módulo Gestão de Estoque, Compras e Faturamento: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | CLANCAMENTO | CODCOLIGADA | - | Variável do Sistema |
BranchId | CLANCAMENTO | CODFILIAL | - | Variável do Sistema |
CompanyInternalId | CLANCAMENTO | CODCOLIGADA | - | Variável do Sistema |
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/CostCenterDebitInternalId | 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 |
Entries/Entry/CreditAccountCode | CPARTIDA | DEBITO | CT2 | CT2_CREDIT |
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/CostCenterDebitInternalId | 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 |
Entries/Entry/ AccountingItemDebitCode | SHABILITACAOFILIALINTPROTHEUS | IDCLASSEVALORPROTHEUS | CT2 | CT2_ITEMD |
Entries/Entry/ AccountingItemDebitInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDCLASSEVALORPROTHEUS |
|
|
Entries/Entry/ AccountingItemCreditCode | SHABILITACAOFILIALINTPROTHEUS | IDCLASSEVALORPROTHEUS | CT2 | CT2_ITEMC |
Entries/Entry/ AccountingItemCreditInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDCLASSEVALORPROTHEUS |
|
|
Entries/Entry/ ClassValueDebitCode | SHABILITACAOFILIALINTPROTHEUS | IDITEMCONTABILPROTHEUS | CT2 | CT2_CLVLDB |
Entries/Entry/ ClassValueDebitInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDITEMCONTABILPROTHEUS |
|
|
Entries/Entry/ ClassValueCreditCode | SHABILITACAOFILIALINTPROTHEUS | IDITEMCONTABILPROTHEUS | CT2 | CT2_CLVLCR |
Entries/Entry/ ClassValueCreditInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDITEMCONTABILPROTHEUS |
|
|
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 enviada uma mensagem com os lançamentos de estorno como se estissem incorporados ao lote “0”, nesse caso eles nunca serão excluídos.
Caminhos para acesso a geração da contabilização:
Educacional | Educacional | Financeiro / Contábil | Contabilidade
Educacional | Educacional | Financeiro / Contábil | Contratos
Processos | Gerar contabilização
Importante:
As informações de Item Contábil e Classe de Valor serão obtidas através da Matriz Aplicada do Educacional. Quando houver necessidade de enviá-las na mensagem de lançamentos contábeis será necessário a configuração do Evento Contábil para busca-las.
Será exibida a aba “Integração Protheus”, no cadastro de Evento Contábil, quando a integração estiver ativa. Após a configuração de busca para “Matriz Aplicada”, na aba “Integração Protheus”, ao enviar a mensagem de lançamentos contábeis e as informações de Item Contábil e Classe de Valor vinculadas, elas serão enviadas para a integração.
A mesma configuração poderá ser realizada no Módulo de Gestão de Estoque, Compras e Faturamento para envio dessas informações na contabilização do movimento.
A aba “Integração Protheus” será exibida para todos os eventos do tipo: Contrato Educacional, Parcela Educacional e Movimento.
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.
| 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. |