Sistemas Envolvidos 

• TOTVS Processo Seletivo – Módulo Educacional que gerencia os processos seletivos das escolas e faculdades, possibilitando o ingresso de alunos nas instituições por meio de vestibulares. 

• TOTVS Gestão Bibliotecária – Módulo Educacional que gerencia as bibliotecas das escolas e faculdades (com diferentes unidades bibliotecárias). 

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

• TOTVS Gestão Financeira – Módulo Financeiro que gerencia as operações financeiras das escolas e faculdades, por meio de ferramentas que permitem maior agilidade nos processo que envolvem contas a pagar/receber, fluxo de caixa entre outros. 

• TOTVS Gestão Patrimonial – Módulo Patrimonial que gerencia os ativos fixos (bens e títulos) e o seus cálculos de depreciação entre outras operações. 

• BackOffice Protheus (Financeiro).
  
  

Integração

Melhoria na integração dos sistemas TOTVS Educacional, TOTVS Processo Seletivo, TOTVS Gestão Bibliotecária e o BackOffice do Protheus (Financeiro), por meio da mensagem única.

Atualmente é realizada por tabelas intermediárias, sendo que os módulos da linha RM realiza as consultas em determinadas tabelas do módulo do Protheus, sendo necessário uma nova conexão para que a linha RM consuma as informações na base do Protheus.

Definição de Mensagem Única – TotvsMessage 

Com o objetivo de padronizar as integrações com os produtos, foi definida a utilização da diretriz para os projetos de integração que todos os produtos devem trabalhar com a mensagem XML única, evitando desta forma, o processo de transformação de mensagens.

Neste cenário, temos o seguinte quadro:

Qualquer um dos produtos são executados com o mesmo XML para uma mesma entidade, ou seja, caso um arquivo XML corresponde a mensagem de clientes, pode ser enviado para qualquer um dos produtos que suporte o recebimento desta entidade, como no diagrama abaixo:

A mensagem única torna uniforme a execução destes arquivos XML pelos aplicativos, principalmente para a capacidade de rastreamento.

Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS.

Este fluxo pode ocorrer nos seguintes sentidos: 

• • TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro) -> PROTHEUS: Os dados são trafegados pelo fluxo normal até a fila de integração TBC, em que este irá consumir o WebService do EAI do Protheus para envio da(s) mensagem(s). Após a resposta do Protheus, o TOTVS Conector atualiza o registro com o status de processamento e demais dados, no monitor da fila de Mensagem Única. 

• • PROTHEUS -> TOTVS (Educacional, Processo Seletivo, Biblioteca, Financeiro): O Protheus consume o WebService TOTVS Conector para recebimento de mensagens únicas. Sendo também responsável por encaminhar as mensagens para o TOTVS Conector, que processa e encaminha o retorno de acordo com o tipo de comunicação definida (síncrona ou assíncrona).

Para mais informações sobre o fluxo dos dados internos ao TBC, vide documentação: TOTVS Business Connect

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 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 na 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, este 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 por meio do monitor da fila de integração.

Escopo

As entidades e os pontos de integração que fazem parte desta integração são:

 Os itens abaixo estão fora de escopo desta integração:

• Agrupamento de lançamentos (boleto).
• Conta corrente do aluno.
• Concessão/cancelamento de bolsa retroativa.
• Negociação online.
• Pagamento com cartão de crédito e débito.
• Registro online de boletos nos Portais Acadêmicos.
• O preenchimento automático do nosso número é feito apenas para lançamentos financeiros gerados pelo Educacional. Lançamentos gerados pelo Nucleus não vão com este campo preenchido.
• Os valores de bolsas enviados para os lançamentos financeiros de forma agrupada, somando em um único valor opcional, serão enviados para o Protheus também de forma agrupada. Dessa forma, não é possível tratar a contabilização desses valores separadamente na inclusão e na baixa dos títulos.
• Se a tabela de cliente for exclusiva por filial ou se existir mais de uma loja sendo utilizada no Protheus, o código do cliente deve ser parametrizado para ser gerado sequencialmente.
• O Educacional trabalha com classe de valor e item contábil parametrizados na matriz aplicada. Qualquer outro tipo de parametrização deverá ser customizada.
• Preenchimento dos valores de bolsa na inclusão de títulos. Estes valores são preenchidos no Protheus apenas no momento da baixa.

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

Atenção: Para instalar qualquer módulo da linha RM, é necessário instalar da Biblioteca RM o pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC.

(Mais detalhes acesso o documento Orientações para instalar BibliotecaRM)

Para que a integração possa funcionar, 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>

em que a variável <ALIAS_DO_BANCO_RM> será o nome do alias cadastrado para acesso ao banco de dados.

Exemplo:

Para verificar se o webservice está funcionando, abra o endereço abaixo no navegador:

                               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:

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

Uma segunda opção, como alternativa de configuração para utilização do EAI é o conjunto de ferramentas denominada TBC – TOTVS Business Connect, que possui esse mesmo webservice em seu instalador e necessita de uma configuração no IIS do Windows.

Para mais informações da instalação do TBC, consulte os documentos de apoio abaixo:

• • Para instalação do TBC através do host acesse o documento Como Expor os Web Services do RM através do Host
  • Para Instalação do TBC através do IIS acesse o documento Instalação do TBC no IIS
    
    

Conversor da integração para adequação a mensageria única 

Caso seja utilizada a integração entre Educacional e Protheus via conexão de banco de dados, é executado o conversor para adequação das tabelas a estrutura utilizada pela integração por mensageria única, no RM Atualizador.

Premissas para a execução do conversor: 

Deve ser executado o assistente Aproveitar valores em contas correntes em: TOTVS Educacional / Financeiro/Contábil / Assistentes, para que sejam zeradas as contas correntes dos alunos.

Pós execução do conversor:

É alterada a parametrização do TOTVS Educacional em TOTVS Educacional / Integração / Financeiro / Cobrança Retroativa,  para não utilizar o recurso de conta corrente.

Deve ser executado o sincronizador para criação do De/Para dos registros existentes da integração via banco de dados, que está em: Módulo Integração / Ferramentas / Conversão / Converter Integração

Após a criação dos De/Para, deve ser executada no Protheus a carga inicial das mensagens ClassValue (Classe de Valor) e AccountingItem (Item Contábil) para que seja atualizado os dados no TOTVS Educacional.

As Naturezas Financeiras associadas aos serviços educacionais no anexo de dados financeiros da integração com o Protheus devem ser atualizadas, pois após a conversão será utilizado o cadastro de Natureza Orçamentária Financeira no módulo de Gestão Financeira.

Habilitar parametrização dos produtos para integração

Após a instalação dos produtos RM e a conversão, caso tenha sido necessária, deve ser realizada a habilitação da integração com o Protheus nos produtos:

• • TOTVS Educacional:

1)       Ative a integração com Protheus em Módulo Educacional / Configurações / Parâmetros / 15.05 Integração / 15.05.07 Protheus / Utiliza integração com Protheus;

2)       Marque o Novo (mensageria única) no campo Modelo de integração.

• • TOTVS Gestão Bibliotecaria:

1)       Ative a integração com Protheus em Módulo Gestão Bibliotecária / Parâmetros/Configurações / Parâmetros do sistema / 14.09 Integração / 14.09.05 Protheus / Utiliza integração com Protheus;

2)       Marque o Novo (mensageria única) no campo Modelo de integração.

• • TOTVS Processo Seletivo:

1)       Ative a integração com Protheus em Módulo Processo Seletivo / Parâmetros / Parâmetros do sistema / Aba Integração / Utiliza integração com Protheus;

2)       Marque o Novo (mensageria única) no campo Modelo de integração.

Protheus

• Versão minima do Protheus: 11.80.
• Possuir um licenciamento (License Server) adequado do sistema Protheus.
• Necessária a utilização da ferramenta EAI.
• Necessária configuração de um WebService.
• Módulos necessários: Financeiro(SIGAFIN).
• Programa FINA040 com data mínima de 24/11/2014.
• Programa FINA060 com data mínima de 18/11/2014.
• Programa FINA070 com data mínima de 27/10/2014.
• Programa FINA130 com data mínima de 24/10/2014.
• Programa FINA280 com data mínima de 24/11/2014.
• Programa FINA460 com data mínima de 24/10/2014.
• Programa FINI010I com data mínima de 24/10/2014.
• Programa FINI040 com data mínima de 24/10/2014.
• Programa FINI070 com data mínima de 24/11/2014.
• Programa FINI070A com data mínima de 24/10/2014.
• Programa FINI150A com data mínima de 24/10/2014.
• Programa FINI280 com data mínima de 18/11/2014.
• Programa FINI460 com data mínima de 24/10/2014.
• Programa FINXATU com data mínima de 24/10/2014.
• Programa MATA020 com data mínima de 01/10/2014.
• Programa MATA030 com data mínima de 29/09/2014.
• Programa MATI010 com data mínima de 28/10/2014.
• Programa MATI020 com data mínima de 18/11/2014.
• Programa MATI030 com data mínima de 18/11/2014.
• Programa MATI070 com data mínima de 27/10/2014.
• Programa INTXATU01 com data mínima de 24/11/2014.
• Programa INTIATU01 com data mínima de 12/11/2014.
  
  

RM

• Utilize a versão 11.83.55 ou superior.
  
  

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. 

Caso exista alguma atualização do TOTVS Educacional para correções relacionadas à integração, é necessária a exclusão da integração e a reinstalação deve ser realizada pelo Configurador. É importante verificar antes de excluir as informações dos parâmetros de integração e as configurações do webservice de destino, pois os valores são apagados também.

Protheus

Instalação do Protheus V12 e configuração do AppServer e Dbaccess

Acesse os documentos de apoio abaixo para instalação e configuração.

• • Guia de instalação Protheus 12 e Dbaccess 
  • Configuração do AppServer e Dbaccess

Configurações do EAI

Para a configuração do EAI no Protheus, siga os procedimentos abaixo:

• • Acesse o Configurador (SIGACFG) em Ambiente / Cadastros / Parâmetros 
  • Configure o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente em que o Protheus será integrado.

Exemplo: http://12.50.90.211:81/MensagemUnicaWS. 

• • Configure 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, configure o parâmetro MV_ EAIUSER com o nome de usuário. 
  • Caso o servidor necessite de autenticação, configure o parâmetro MV_ EAIPASS com a senha de usuário. 
  • No Configurador (SIGACFG) acesse Ambiente / Schedule / Adapter E.A.I. 
  • Realize o cadastro das rotinas de integração, conforme abaixo: É importante que a configuração dos Alias para o envio das tags de compartilhamento para a integração.

• • Caso alguma mensagem esteja configurada com o método Assíncrono, acesse o Configurador (SIGACFG) em Ambiente / Schedule / Schedule e configure um agente e um agendamento, conforme abaixo:

Agendamentos

FWEAI - Processamento de mensagens assíncronas FINANCINGTRADING 

• • • Cadastrar agente.

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

• • • Cadastrar agendamento.

Clique no símbolo destacado na parte inferior para adicionar um novo agendamento:

Preencha o campo Rotina com a rotina FWEAI e informe as empresas para as quais o agendamento será válido:

Defina a data e horário para a execução do agendamento e a recorrência, para isto, clique no símbolo destacado na parte superior, conforme as necessidades existentes:

Confirme a inclusão do agendamento:

• • • Inicie os serviços de agendamento: 

• • • Inicie os agentes: 

            Carga Inicial

                  Para utilização da rotina de carga inicial dos dados, acesse o documento Carga inicial dos dados de cadastro.

(Mais detalhes sobre configuração acesso o documento Configuração EAI Protheus)

RM

Para a configuração e instalação da integração do TOTVS Educacional x BackOffice Protheus, siga os passos abaixo:

1º Passo: 

Carregue o Assistente de Configuração do TBC (Módulo Integração / Ferramentas / Configurar); 

Informe o usuário e a senha do banco de dados com permissão para executar os scripts de configuração da integração.

2º Passo: 

([X]) Marque a integração do TOTVS Educacional x BackOffice Protheus por meio do processo; 

3º Passo: 

Execute o processo para realizar a instalação da integração;

4º Passo: 

Após a instalação, configure o endereço do WebService do EAI do TOTVS Protheus para a integração TOTVS Educacional x BackOffice Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações;

5º Passo: 

Ative a integração TOTVS Educacional x BackOffice Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações; 

Informe 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 no navegador.

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.

Configurar ( RM e Protheus ) para utilizar a Integração, campos complementares, parâmetros e cadastros obrigatórios. 

Acesso documento de apoio Configurações da Integração - Mensagem única TOTVS Educacional e Protheus  

Controle de Versão

O grupo TOTVS representado por suas marcas irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Transações/Entidades/Mensagens únicas

Integração Financeira – TOTVS Educacional x BackOffice Protheus
TOTVS Gestão Financeira	Mensagens	TOTVS Protheus

 Tabelas De-Para

 Todas as movimentações de mensagens, com algumas exceções, tanto para envio quanto para recebimento, resultam 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:

12.1.Mensagem Currency (Moeda)

12.2.Mensagem CostCenter (Centro de Custo)

12.3.Mensagem CustomerVendor (Cliente/Fornecedor)

12.4.Mensagem FinancialNature (Natureza Financeira)

12.5.Mensagem Bank (Banco/Agência/Conta Corrente/Conta Caixa/Convênio) 

Banco / Agência / Conta Corrente

Conta Caixa

Convênio

12.6.Mensagem AccounReceivableDocument (Lançamentos a receber)

12.7.Mensagem AccountReceivableDocumentDischarge (Baixa de Lançamentos a receber)

12.8.Mensagem ReversalOfAccountReceivableDocumentDischarge (Cancelamento de Baixa de Lançamentos a receber)

Não haverá registro na tabela De-Para para o cancelamento.

Após o cancelamento, o registro referente à baixa é excluído da tabela De-Para.

12.9.Mensagem FinancialTrading (Negociação de Lançamentos a receber)

12.10.Mensagem ReversalOfFinancialTrading (Cancelamento de Negociação de Lançamentos a receber)

Não haverá registro na tabela De-Para para o cancelamento.

Após o cancelamento, o registro referente ao acordo (negociação) é excluído da tabela De-Para.

12.11.Mensagem OurNumberBanking (Nosso Número Bancário )

Não haverá registro na tabela De-Para para essa requisição.

12.12.Mensagem AccountingItem (Item Contábil)

12.13.Mensagem ClassValue (Classe de Valor)

12.14.Mensagem Item (Produto)

12.15.Mensagem StockGroup (Grupo de Produtos)

12.16.Mensagem UnitOfMeasure (Unidade de Medida)

12.17.Mensagem OurNumberBanking (Nosso Número Bancário )

Não haverá registro na tabela De-Para para essa requisição.

12.18.Mensagem Assets (Ativos Fixos)

12.19.Mensagem AccountPayableDocument (Contas a Pagar)

Sincronizador De/Para 

A integração RM 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, é necessário sincronizar os dados existentes nas duas bases de dados (RM e Protheus).

O mecanismo da integração via stored procedure realiza a amarração dos dados de forma diferente do de/para da mensagem única, sendo necessária utilização de uma rotina que sincronize as bases, criando e alimentando o de/para com os InternalIds correspondentes a cada registro e suas empresas e filiais.

Para isso, foi criada a mensagem específica InternalIdLoad, que trafega os dados de cada registro gravado na base RM, junto com a contrapartida na base Protheus e o InternalId gravado no de/para do ambiente RM. Uma vez recebidos esses dados, é verificado 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. Desta maneira o registro do Protheus é gerado e enviado para o RM registrar no de/para.
Neste processo a base histórica gerada por meio das stored procedures são portadas para o padrão utilizada na mensagem única.

As seguintes entidades da integração com o contábil estão incluídas no processo de Sincronizador De/Para: 

• • UNITOFMEASURE - Unidade de Medida
  • CUSTOMERVENDOR – Cliente
  • ACCOUNTRECEIVABLEDOCUMENT - Títulos a Receber
  • BANK - Bancos

A mensagem InternalIdLoad está atualmente na versão 1.000, e sua estrutura está definida da seguinte forma: 

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:

Importante! 

A entidade UNITOFMEASURE (Unidade de Medida) somente é utilizada para sincronizar as unidades cujos tamanhos de seus códigos sejam iguais, ou menores que dois, que é o tamanho padrão no Protheus. Para as outras unidades de medidas, caso seja necessário sincronizar, o processo deve ser feito manualmente, criando o de/para adequado para cada caso.

Fluxo das Informações

Mensagens Únicas relacionadas a esta integração:

Cadastros

Cadastros Especiais

É necessário realizar o cadastro manualmente no Protheus e no RM e posteriormente configurar o de/para para a integração correspondente. Ambos produtos (RM e Protheus), possuem interfaces específicas para esta finalidade

Integrações / Aba Integração / Mensagem Única / De-Para

Empresa e Filial

Nas integrações com o Protheus, é necessário realizar o cadastro manual do De/Para de Coligada/Filial (conforme exemplo abaixo). Esse cadastro é necessário para que haja um relacionamento entre as Coligadas/Filiais do Educacional e do BackOffice Protheus.

Exemplo:

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

Acesse BackOffice / Gestão Financeira / Cadastros / Centro de Custo

            (Mais detalhes do cadastro de Centro de Custo acesse Principais Cadastros da Integração)

Classe de Valor

Identificador da Mensagem: ClassValue

Versão: 1.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Caminhos para a parametrização da Classe de Valor para a integração com o Protheus:

TOTVS Educacional

Acesse: Educacional / Educacional / Currículo e Oferta / Matrizes Curriculares 

Anexo: Matriz Aplicada

Anexo: Dados financeiros - Integração Protheus 

TOTVS Processo Seletivo

Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo 

Anexo: Integração Protheus 

TOTVS Gestão Bibliotecária

Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias 

Anexo: Integração Protheus

Caminho para acesso ao cadastro de Classe de valor, no sistema:

Educacional / Educacional / Integrações / Protheus / Classe de Valor 

Educacional / Gestão Bibliotecária / Integrações / Protheus / Classe de Valor 

Educacional / Processo Seletivo / Integrações / Protheus / Classe de Valor

 (Mais detalhes do cadastro de Classe de Valor acesse Principais Cadastros da Integração)

Item Contábil

Identificador da Mensagem: AccountingItem

Versão: 1.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Caminhos para a parametrização do Item Contábil para a integração com o PROTHEUS:

TOTVS Educacional

Acesse: Educacional / Educacional / Currículo e Oferta / Matrizes Curriculares 

Anexo: Matriz Aplicada

Anexo: Dados financeiros - Integração Protheus

TOTVS Processo Seletivo

Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo 

Anexo: Integração Protheus

TOTVS Gestão Bibliotecária

Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias 

Anexo: Integração Protheus

Caminho para acesso ao cadastro de Item Contábil, no sistema:

Educacional / Educacional / Integrações / Protheus / Item Contábil 

Educacional / Gestão Bibliotecária / Integrações / Protheus / Item Contábil 

Educacional / Processo Seletivo / Integrações / Protheus / Item Contábil

(Mais detalhes do cadastro de Item Contábil acesse Principais Cadastros da Integração)

Unidade de Medida

Identificador da Mensagem: UnitOfMeasure

Versão: 2.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Caminhos para o cadastro de unidade de medida:

Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Mais... / Tabelas Auxiliares / Unidade

Grupo de Produtos

Identificador da Mensagem: StockGroup

Versão: 1.000

Módulo Educacional: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Caminho para acesso a tabela de classificação, no sistema:

BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Tabelas de Classificação                              

As informações de grupo de produtos utilizam sempre a Tabela de Classificação 2 com o nome de Grupo de Produtos. Marque as opções Usar em Produto, Usar em Item de Movimento e Usar em Movimento.                              

Os parâmetros de tabelas de classificação podem ser acessados, no caminho:

BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento                                                             

04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.01 – Classificação

Produto

Identificador da Mensagem: Item

Versão: 2.001

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

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Informações importantes sobre o cadastro de produtos:

O cadastro de produto é utilizado somente para vínculo com o serviço do Educacional e envio posterior, junto com o lançamento a receber para o backoffice Protheus. Por isso são utilizados os campos código e descrição do produto.

As definições Máscara e Opções para a Máscara de produto devem ser alteradas para QQQQQQQQQQQQQ e Não controla níveis de máscara respectivamente, para que o RM aceite os produtos enviados pelo Protheus na integração.

Caminho para acesso ao parâmetro para definições de produto:                                              

Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento

04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.01 – Definições Gerais

Caso possua no Protheus informações de unidade de medida e grupo de produtos, são enviados antes pela integração por meio das mensagens: UnitOfMeasure e StockGroup, 

No cenário em que o Protheus possua compartilhamento por Empresa e por Filial para o produto, o TOTVS Gestão de Estoque, Compras e Faturamento deve ser parametrizado para utilizar um cadastro de produto global. Dessa maneira, todos os produtos são cadastrados na coligada 0 assumindo o comportamento de compartilhados para todas as coligadas.

Caminho para acesso ao parâmetro para permitir o cadastro global:                                              

Acesse BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento                                                              

04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.07 – Produtos / 04.01.04.07.07 –Produto Global / Usa Produto Global

Caminho para a parametrização da natureza para a integração com o Protheus:

Acesse: Educacional / Educacional / Financeiro/Contábil / Serviços 

Anexo: Dados financeiros - Integração Protheus

Caminho para o cadastro de produtos no TOTVS Gestão de Estoque, Compras e Faturamento:

Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Produto

Cliente/Fornecedor

Identificador da Mensagem: CustomerVendor

Versão: 2.002

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Informações importantes sobre o cadastro de clientes: 

O cadastro de cliente/fornecedor é utilizado por ambos os lados. Os cadastrados podem ser realizados no Backoffice Protheus ou no TOTVS Gestão Financeira.

Ao integrar por mensagem única com o Protheus, o cliente/fornecedor não poderá ser cadastro como ambos, PAGREC igual a 3. Não sendo possível a alteração de uma classificação de Cliente para Fornecedor ou vice versa.

O código de Cliente/Fornecedor é gerado de acordo com a parametrização do TOTVS Gestão Financeira. É gerado um código incremental de acordo com a máscara cadastrada. Se o sistema estiver integrado ao Protheus por mensageria única, será permitido a inclusão de uma máscara vazia.

O tamanho máximo do código de cliente/fornecedor não deve ultrapassar 9 caracteres.

Se for definida uma máscara vazia no Financeiro e no Educacional para o cadastro do Cliente/Fornecedor, ao gerar um responsável financeiro no cadastro de Alunos, internamente, será adotada uma máscara numérica com 09 posições.

O parâmetro para utilização de código sequencial numérico deve ser desabilitado caso a integração Educacional x BackOffice Protheus esteja ativa.

O sistema permite a alteração da máscara para vazio, quando integrado, porém não será permitido a alteração de nulo para outro valor.

No ambiente do Backoffice Protheus, os campos A1_LOJA e A2_LOJA (tabelas SA1 e SA2, respectivamente) devem ter os inicializadores padrão preenchidos (X3_RELACAO) com um valor default para a loja, evitando que haja inconsistência dos dados quando for efetuado um cadastro de cliente/fornecedor no ambiente TOTVS Educacional.

Parâmetro para cadastro da máscara de cliente:

Acesse: Módulo 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 / Cliente / Fornecedor / Máscara do código

Para o cenário em que o Protheus tiver um compartilhamento por Empresa, o TOTVS Gestão Financeira deve ser parametrizado para utilizar clientes globais.               

Acesse: 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 / Cliente / Fornecedor / Permite Globais

Acesse: 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 / Cliente / Fornecedor / Default Cli/For Globais

Caminho para acesso ao cadastro de Cliente/Fornecedor no sistema: 

BackOffice / Gestão Financeira / Cadastros / Clientes Fornecedores

Para o envio e o recebimento do código do país do Cliente/Fornecedor é necessário a utilização da tabela de Classificação de País do módulo fiscal. 

A Tabela de Classificação pode ser acessada pelo endereço:

BackOffice / Gestão Fiscal / Cadastros / Globais / Mais... / Endereço / Classificação de País

Pelo anexo de codificação no cadastro de país do módulo fiscal é possível cadastrar um código de acordo com a tabela de classificação inclusa.

O cadastro de codificação de país pode ser acessado pelo endereço:

BackOffice / Gestão Fiscal / Cadastros / Globais / Mais... / Países / Anexos / Codificação de País

Para identificação de qual tabela de classificação será utilizada, foi criado o parâmetro de integração CODCLASSIFICPAIS  para incluir o código da tabela cadastrada.

Caminho para o parâmetro de integração:

                Integração / Mensagem Única / Integrações

Anexos: Parâmetros de integração

Natureza Financeira

Identificador da Mensagem: FinancialNature

Versão: 2.000

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Informações importantes sobre o cadastro de natureza financeira:

O código da natureza financeira deve ser criado de forma sequencial ou utilizando o código enviado. Essa definição poderá ser feita através do parâmetro NATUREZAFISCALAUTOINC 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. 

Acesse: Integração / Integração / Mensagem Única / Integrações / Anexo Parâmetros de integração

Caminhos para a parametrização da natureza para a integração com o Protheus:

TOTVS Educacional

Acesse: Educacional / Educacional / Financeiro/Contábil / Serviços 

Anexo: Dados financeiros - Integração Protheus 

TOTVS Processo Seletivo

Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo 

Anexo: Integração Protheus 

TOTVS Gestão Bibliotecária

Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias 

Anexo: Integração Protheus

Caminho para acesso ao cadastro de naturezas no sistema: 

BackOffice / Gestão Financeira / Cadastros / Natureza Orçamentária Financeira

(Mais detalhes do cadastro de Natureza Financeira acesse Principais Cadastros da Integração)

Bancos

Identificador da Mensagem: Bank

Versão: 2.001

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Informações importantes sobre o cadastro de bancos: 

A mensagem de Banco é utilizada para realizar o cadastro de Bancos, Agências, Contas Correntes, Conta Caixas e Convênios.

Como o cadastro é realizado no Protheus, os cadastros do TOTVS Gestão Financeira são desabilitados para inclusão e exclusão, caso o parâmetro utilize integração com Protheus esteja habilitado e utilizando o modelo novo de integração (Mensagem) tendo a integração Educacional x BackOffice Protheus ativa.

Os campos preenchidos pela integração são desabilitados e apenas informações pertinentes do TOTVS Gestão Financeira podem ser editados. Seguem possíveis campos que podem ser necessários o preenchimento, na geração de lançamentos a receber:

Bancos:

• • Dígito           

Agência:

• • • • Dígito

Conta-Corrente:

• • • • Dígito verificador
      • Dígito agência/conta
      • Tipo conta

Convênio:

• • • • Convênio default para a Conta Caixa
      • Dígito verificador do cedente
      • CNPJ
      • Tipo nosso número
        • Próximo sequencial
        • Limite superior
        • Limite inferior
      • Valor código de barras
      • Nosso número campos adicionais
      • Outros

Caminhos para acesso aos cadastros no sistema:

Bancos:

BackOffice / Gestão Financeira / Movimentações Bancárias / Bancos e Agências 

Educacional / Educacional / Integrações / Protheus / Bancos e Agências

Agências:

BackOffice / Gestão Financeira / Movimentações Bancárias / Bancos e Agências

Anexo: Agência 

Educacional / Educacional / Integrações / Protheus / Bancos e Agências

Anexo: Agência 

Contas:

BackOffice / Gestão Financeira / Movimentações Bancárias / Contas Correntes 

Educacional / Educacional / Integrações / Protheus / Bancos e Agências

Anexo: Agência

Anexo: Conta Corrente 

Contas Caixas:

BackOffice / Gestão Financeira / Movimentações Bancárias / Contas/Caixa

Convênio:

BackOffice / Gestão Financeira / Movimentações Bancárias / Convênio 

Educacional / Educacional / Integrações / Protheus / Convênio

(Mais detalhes do cadastro de Bancos acesse Principais Cadastros da Integração)

Contas a receber

Identificador da Mensagem: AccountReceivableDocument

Versão: 2.007

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Informações importantes sobre os lançamentos a receber: 

A mensagem de Contas a receber é utilizada para enviar ao BackOffice Protheus, os títulos gerados pelos sistemas TOTVS Educacional, TOTVS Gestão Bibliotecária e TOTVS Processo Seletivo e receber alterações e exclusão de títulos do BackOffice Protheus. Ou seja, toda vez que o TOTVS Gestão Financeira receber solicitação de lançamento por esses sistemas, é verificado se este está integrado ao Protheus pelo modelo novo (Mensageria) para envio da mensagem.

Caso o sistema esteja parametrizado para o novo modelo (Mensageria) de integração, não é possível criar títulos através do TOTVS Gestão Financeira, apenas pelos produtos (TOTVS Educacional, TOTVS Gestão Bibliotecária, TOTVS Processo Seletivo e TOTVS Gestão de Estoque, Compra e Faturamento). O parâmetro para regeração de lançamentos cancelados são desabilitados, caso esteja com uma integração ativa.

Existe um limitação do tamanho do número do documento, para a mensagem única de 9 posições. O sistema deve ser configurado para seja adequado a esse tamanho.

O número da parcela do lançamento para integração com o Protheus será sempre 1, independente do código gerado no campo de parcela da FLAN. Essa definição é necessária devido a diferença de conceito no que se refere a parcela do lançamento (Título para o Protheus).

Informações bancárias, como Banco, Agência, Conta, são enviadas na mensagem de lançamentos a receber para o Protheus, apenas quando houver um convênio vinculado a conta caixa configurada para a geração do lançamento.

Lançamentos a receber gerados de faturamento de movimento, pelo TOTVS Gestão de Estoque, Compras e Faturamento, não podem ser cancelados a partir do Protheus. Para a realização do cancelamento desses lançamentos o movimento referente terá que ser cancelado.

Os tipo de documentos utilizados para geração de lançamentos de Faturamentos de Contratos devem ser alterados para gerarem numeração sequencial.

No ambiente Protheus a numeração automática do título (E1_NUM) não pode estar ativada. O sistema valida se existe controle de numeração automática ativado e caso esteja, não permite a utilização da mensagem única, retornando mensagem de XML notificando sobre essa inconsistência.

Acesse: 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 / Inclusão / Tamanho do número / Documento 

Acesse: BackOffice / Gestão Financeira / Cadastros / Tipos Documento / Último número

Seguem os processos relacionados, que geram mensagens de lançamentos a receber para a integração:

• • • Geração de lançamentos (Processo Geral, Visão de contratos e parcelas)

No TOTVS Educacional, caso o processo de geração de lançamento for acionado, após a inclusão/alteração do lançamento, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Alteração da data de vencimento do boleto com alteração do vencimento dos lançamentos a receber

No TOTVS Educacional, ao executar o processo de alteração de data vencimento de boleto, caso seja informado para alterar os vencimentos dos lançamentos, é enviada uma mensagem de lançamento a receber com a informação da nova data de vencimento.

• • • Inscrição de candidato

No TOTVS Processo Seletivo, ao realizar a inscrição do candidato, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Alterar data de vencimento de lançamentos

No TOTVS Processo Seletivo, ao executar o processo de alteração de vencimento de lançamentos, é enviada uma mensagem com a informação da nova data de vencimento.

• • • Exclusão de inscrição

No TOTVS Processo Seletivo, ao excluir uma inscrição, é enviada uma mensagem solicitando a exclusão da mensagem para a integração.

• • • Geração de inscrição anônima

No TOTVS Processo Seletivo, ao realizar a inscrição de candidatos anônima, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Alteração de forma de inscrição

No TOTVS Processo Seletivo, ao alterar a forma de inscrição do candidato, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Devolução com geração de multa

No TOTVS Gestão Bibliotecaria, ao gerar uma devolução com geração de multa, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Cadastro de usuário/renovação

No TOTVS Gestão Bibliotecaria, ao criar um novo usuário e/ou realizar a renovação do mesmo, caso seja gerado um lançamento, deve ser enviado a mensagem com as informações do título para o Protheus.

• • • Faturamento de Contratos e medição de Contratos

No TOTVS Gestão de Estoque, Compras e Faturamento, quando os contratos forem faturados e houver integração com o TOTVS Educacional, para associação de matrículas, os lançamentos são enviados para a integração.

Para que o valores de bolsa incondicional seja enviado para a tag UnconditionalScholarshipValue, no RM o parametro de intgração "ENVIAVLRBOLSAINCONDICIONAL" deve estar marcado como "True". Se o mesmo não estiver aparecendo será necessário gerar a configuração novamente, caso ainda não aparece favor entrar em contato com o suporte, pois pode ser necessário executar alguns scripts.

Contas a pagar

Identificador da Mensagem: AccountPayableDocument

Versão: 2.001

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Ativos Fixos (Patrimônio)

Identificador da Mensagem: Assets

Versão: 1.001

Módulo Gestão Financeira: RM

Módulo Protheus: Protheus

Tipo de Envio: Síncrono

Importante:

Os ativos cadastrados no sistema Protheus são sincronizados com o TOTVS Gestão Patrimonial e disponibilizados para consultas.

As operações de inserção, alteração e exclusão devem ser realizadas no Protheus.

Os patrimônios cadastrados podem ser visualizados em: BackOffice / Gestão Patrimonial / Cadastros / Patrimônio

Com a instalação da integração, o TOTVS Gestão Patrimonial passa a utilizar o parâmetro interno NAOVALIDAMASCARA ativado. Sendo utilizado para que o sistema TOTVS Gestão Patrimonial ignore a máscara cadastrada em seus parâmetros e aceite o código enviado da Integração independente da forma cadastrada. Esse parâmetro é definido por Coligada, por isso, caso haja a ativação de outras coligadas após a instalação, esse parâmetro deve ser inserido na IPARAMETROS manualmente.

Para cadastro do Patrimônio é exigida, pelo sistema, a informação de um Grupo de Patrimônio, porém não é fornecido pelo XML da mensagem de integração. É utilizado um parâmetro de integração para a definição de um grupo padrão, por coligada, para o cadastro desses Patrimônios.

Os parâmetros de integração são incluídos juntamente com a instalação da integração. O parâmetro IDGRUPOPATRIMONIO deve ser configurado com o ID do grupo padrão para a coligada referente. Caso hajam ativações de coligadas após a instalação da integração, deve ser incluído o novo parâmetro para a nova coligada com o id do grupo referente, manualmente.

O processo de baixa e transferência do ativo, realizada no Sistema Protheus, não está contemplada nesta integração, necessitando o ajuste manual no Sistema TOTVS Gestão Patrimonial.

Como não são trabalhados os cenários de desvalorização do ativo, as informações de observação, centro de custo e tipo de ocorrência são consideradas apenas quando a tag TypeAssets contiver o valor 01 (Aquisição).

CONFIGURAÇÃO DE PARÂMETROS

TOTVS Gestão Patrimonial

Os parâmetros abaixo não podem ser utilizados quando houver integração com o BackOffice Protheus, estes devem estar desmarcados:

• • • Preencha nº do patrimônio com zeros a esquerda.
    • Código de patrimônio único.
    • Geração do nº do patrimônio = código do patrimônio.
    • Mensagem de valor mínimo imobilizado no cadastro de patrimônios.

Parâmetros da integração TOTVS Educacional x BackOffice Protheus

Parâmetro "IDGRUPOPATRIMONIO" com o ID do grupo de patrimônio que será utilizado para cadastrar os Patrimônios.

Requisições 

Baixa de lançamento (títulos a receber)

Tipo de Fluxo:

• • • Protheus -> RM
    • RM -> Protheus

Mensagem: AccountReceivableDocumentDischarge

Versão: 2.007