Manual Operacional - Integração SGE x Protheus


Todas as funcionalidades descritas neste manual têm como base do que está descrito nos documentos:


Descrição do processo


Parâmetros necessários para a Integração de dados entre o TOTVS Educacional (SGE) e o Protheus.


Detalhamento do processo


A tela de parâmetros esta disponível em TOTVS Educacional | Customização | Parâmetros da Integração - TOTVS Educacional (SGE) x Protheus e exibe uma visão com a lista de parâmetros disponíveis para configuração. São eles:



  • Servidor Barramento: endereço de acesso ao banco de dados correspondente ao barramento IIF disponibilizado pelo cliente.

  • Usuário: usuário para conexão com o banco de dados do barramento IIF.

  • Senha: senha do usuário informado para conexão com banco de dados do barramento IIF. O campo é salvo criptografado.

  • Empresa Protheus: código da Empresa do Protheus correspondente à Coligada da parametrização no TOTVS Educacional. Este campo é utilizado para efetuar o De-Para entre Coligada e Empresa.

  • Habilita Integração: campo que define se a integração estará habilitada (valor igual a um) ou desabilitada (valor igual a zero). Este parâmetro é verificado antes de cada gatilho que efetua importação ou exportação de dados referentes à integração (plug-ins, processos customizados). Caso esteja desmarcado, os gatilhos não são executados.

  • Condição de Pagamento: código da condição de pagamento que é utilizada ao enviar o Pedido para o Protheus. O cadastro de condição de pagamento do Protheus não é sincronizado com o TOTVS Educacional (SGE) sendo sempre enviado no pedido o valor parametrizado neste campo (Atualmente o cliente utiliza a condição de pagamento = 9).

  • Código do Tipo de Baixa – Cancelamento: código do tipo de baixa por cancelamento que será enviado ao Protheus, nas situações de cancelamento de lançamentos.

  • Código do Tipo de Baixa – Cartão de Crédito: código do tipo de baixa por cartão de crédito que será enviado ao Protheus, nas situações de baixa de lançamento com a forma de pagamento igual a cartão de crédito.


Os campos acima são de preenchimento livre. Não existe lista para buscar os cadastros e selecionar os códigos. Os códigos devem ser informados diretamente nos campos.



É necessário fazer o cadastro dos parâmetros em todas as Coligadas que utilizarão a integração. As informações são armazenadas em tabela customizada (ZPARAMETROTEMPLATE), por coligada.


O acesso à parametrização é pelas permissões concedidas por perfil de usuário disponíveis através do TOTVS Serviços Globais | Segurança | Perfil.


Importante: O preenchimento dos parâmetros é de responsabilidade do cliente. Para o correto funcionamento da customização, todos os dados devem estar parametrizados corretamente.



Descrição do processo


Criação de um anexo customizado no cadastro de serviços, disponível em TOTVS Educacional | Financeiro/Contábil | Serviços, em que o usuário faz a parametrização de informações necessárias para criação do pedido de venda no Protheus.


Detalhamento do processo


O usuário deve selecionar o Serviço para o qual deseja informar os parâmetros, clicar em Anexos – Integração Protheus. A partir do Serviço selecionado, são disponibilizados os seguintes campos para preenchimento: 


  • Natureza Financeira: usuário pode selecionar o código da natureza financeira que será utilizada para Serviço. A lista de Naturezas é obtida através da tabela nativa de Natureza Orçamentária Financeira do TOTVS Educacional (TTBORCAMENTO), que será preenchida com os dados do cadastro de Natureza do Protheus.


  • Produto: usuário poderá selecionar o código do produto que será utilizado para o Serviço. A lista de Produtos será obtida através da tabela nativa do TOTVS Educacional (TPRODUTO), que será preenchida com os dados do cadastro de Produtos do Protheus, através do Processo Automático de Importação de Cadastros Básicos (Protheus => SGE).


  • TES: usuário pode selecionar um código de TES que será utilizado para o Serviço. Para seleção da TES, a customização consulta a View IIFR_SF4010_VW do barramento IIF que retorna uma lista de registros para o usuário selecionar um item.


  • Série: usuário informa a série que será utilizada pelo Serviço, quando gerar o Pedido no Protheus.


  • Prefixo: usuário informa a o prefixo do documento que será utilizada pelo Serviço, quando gerar o Pedido no Protheus.


Estas informações são imprescindíveis para os serviços utilizados na integração com Protheus e os dados serão armazenados em tabela customizada por Serviço e Coligada.

Os dados das TES serão consultados diretamente no barramento IIF (visão do banco de dados: IIFR_SF4010_VW) e, portanto, não ficarão gravados em nenhuma tabela do TOTVS Educacional.

Além dos campos do anexo customizado, é necessário configurar no Serviço a Natureza orçamentária, que será utilizada no processo de Exportação de Pedido de Venda.






Pré-requisitos

Não se aplica.


Descrição do processo


Importação de cadastros básicos do barramento IIF para o TOTVS Educacional.


Detalhamento do processo


Este processo pode ser executado manualmente ou agendado de acordo com os intervalos parametrizados pelo usuário através da tela disponível em TOTVS Educacional | Customização | Importação de Cadastros Básicos. Ao ser executado, o processo consulta as views disponíveis no barramento IIF:

Cadastros

Mnemônico Tabela Protheus

View Barramento

Tabela do RM que será alimentada

Centro de Custo

CTT

IIFR_CTT010_VW

GCCUSTO

Item Contábil

CTD

IIFR_CTD010_VW

SITEMCONTABILPROTHEUS

Classe de Valor

CTH

IIFR_CTH010_VW

SCLASSEVALORPROTHEUS

Natureza Financeira

SED

IIFR_SED010_VW

TTBORCAMENTO

Moeda

CTO

IIFR_CTO010_VW

GMOEDA

Banco

SA6

IIFR_SA6010_VW

GBANCO, GAGENCIA, FCONTA, FCXA

Produto

SB1

IIFR_SB1010_VW

TPRODUTO

Plano de Contas

CT1

IIFR_CT1010_VW

CCONTA


Os resultados das consultas criarão seus respectivos registros no TOTVS Educacional na Coligada adequada. Todos os registros das Views consultadas deverão retornar o código da Empresa no Protheus. Através dele, será buscada a Coligada do TOTVS Educacional, na tabela de parâmetros ZPARAMETROSTEMPLATE. O registro será gerado no TOTVS Educacional para a Coligada associada à Empresa do Protheus. São exceções os cadastros de Natureza Financeira, Moeda e Produto que serão globais.

Detalhes dos dados importados podem ser consultados no documento de Especificação Funcional.


  • Somente os cadastros mencionados acima serão sincronizados de forma automática através do processo de importação.

  • As informações de Empresa/Coligada e Filial não serão sincronizadas entre os dois sistemas, sendo necessário realizar o cadastro manual nos dois sistemas. As Views consultadas nestes requisitos deverão trazer o código da Empresa (duas primeiras posições do campo Filial-Protheus), possibilitando a associação entre a Empresa (Protheus) e a Coligada (TOTVS Educacional).

  • A regra para ocultar/mostrar registros integrados ou não nas Views e a criação do pacote para atualização de registros processados são tratados pelo barramento e é de responsabilidade do Cliente.

  • A pedido do cliente, a chave R_E_C_N_O_ do Protheus não será armazenada no TOTVS Educacional. Segundo o cliente, como este é um número sequencial, ele poderá não refletir o código correto em determinadas situações.

  • Não será necessário preencher o Código da Filial no cadastro das entidades importadas acima no TOTVS Educacional. Portanto, não utilizaremos o Código da Filial do Protheus nesta importação.

  • A máscara do centro de custo do RM deverá ser do tamanho 20 (número máximo no Protheus) e sem pontos, para não ser obrigatória a validação de níveis cadastrados. Ela deverá ser definida em TOTVS Gestão Contábil | Ambiente | Parâmetros | TOTVS Gestão Contábil | Lançamentos | Centro de Custos.

  • Para que a natureza seja Global, é necessário preencher o parâmetro Será global (Parâmetro em TOTVS Gestão de Estoque, Compras e Faturamento | Ambiente | Parâmetros | Tabelas | Natureza Orçamentária/Financeira).

    A máscara da natureza precisa ser configurada para atender os requisitos do código do Protheus, e eventualmente, alguns códigos do Protheus precisarão ser ajustados, já que não são aceitos alguns caracteres no campo código. O quadro abaixo define as possibilidades no RM:



Observação: Atualmente, a máscara utilizada no Protheus para FIERGS é ######## (8 números)

  • A máscara do Produto deverá ser configurada para não controlar níveis (Opções para a Máscara: Não controla níveis de máscara) e sem pontos, para não ser obrigatória a validação de níveis cadastrados. Ela deverá ser definida em TOTVS Gestão de Estoque, Compras e Faturamento | Ambiente | Parâmetros | Gestão de Estoque, Compras e Faturamento | Parâmetros Gerais | Tabelas | Produtos | Definições de Produto 1/3. No mesmo caminho, na aba Produto Global, marcar parâmetro Usa Produto Global.

  • O Plano de Contas Contábil deverá estar configurado para não utilizar máscara, nos parâmetros do TOTVS Gestão Contábil, etapa, marcar o campo Não utilizar Máscara. Este parâmetro precisa ser ajustado em todas as coligadas. Além disso, é necessário cadastrar no RM as contas sintéticas, quando não estiverem disponíveis para importação no Protheus. São elas:

    1. Ativo

    2. Passivo

    3. Despesas

    4. Receitas

    5. Variações Patrim e Financ – Ativa

    6. Variações Patrim e Financ – Passiva

    7. Resultado exercício


Análise de Impacto


Ao efetuar a importação do cadastro de Natureza Financeira do Protheus para o RM, o campo ED_CALCINS disponível na visão de Naturezas IIFR_SED010_VW será copiado para o RM. Quando preenchido com 'S', o campo 'Campo Livre' do cadastro da Natureza (TTBORCAMENTO.CAMPOLIVRE) será preenchido com o valor 'RETEMINSS'. Quando o campo estiver preenchido com 'N' ou vazio, o campo 'Campo Livre' ficará vazio.



Essa informação é utilizada para que o SGE identifique quando o imposto INSS precisará ser calculado no Contrato Corporativo. Quando a Natureza com essa configuração estiver associada ao Serviço (Anexo de Dados Financeiros – Item do Contrato Corporativo), o imposto será calculado. A Natureza do Contrato não será utilizada para este cálculo.
O percentual de alíquota do imposto não será importado, já que no TOTVS RM não existe um campo na Natureza para armazenar a informação. A alíquota será parametrizada no TOTVS RM, no Tipo de Movimento gerado a partir do faturamento/medição do contrato.


Pré-requisitos

Não se aplica.


Descrição do processo


Disponibilização do anexo customizado “Item Contábil” em TOTVS Educacional | Currículo e Oferta | Estrutura curricular | Mais | Modalidades do Curso.


Detalhamento do processo




O lookup visível nesta tela apresentará os registros da tabela SITEMCONTABILPROTHEUS filtrados pela Coligada do contexto. A informação aqui definida será gravada na tabela customizada ZIPMODALIDADEITEMCONTABIL com base nos itens contábeis provenientes do Protheus. Não será possível incluir manualmente um novo item contábil sem que seja validado na tabela SITEMCONTABILPROTHEUS.



Para cada modalidade podem ser vinculados vários itens contábeis.


Na Coligada 2, o menu de Modalidade não está disponível no mesmo caminho. Para acessá-lo, é necessário visualizar o cadastro do Curso, clicar no nome da Modalidade e em seguida, selecionar o anexo. Caso seja necessário acessar lista de Modalidades, basta clicar no botão logo a frente do nome da Modalidade, selecionar o item desejado e clicar em Editar




Pré-Requisitos

Não se aplica.


Descrição do processo


Disponibilização do anexo customizado “Dados financeiros – Integração Protheus” em TOTVS Educacional | Currículo e Oferta | Estrutura curricular | Matriz curricular | Anexos | Matriz Aplicada.



Detalhamento do processo


Nesta tela haverá dois campos que farão referência às tabelas SITEMCONTABILPROTHEUS (Item Contábil) e SCLASSEVALORPROTHEUS (Classe de Valor) filtrados pela Coligada do contexto. A informação aqui definida será gravada na tabela customizada ZIPMATRIZDADOSFINANCEIROS.



Ao salvar o registro a customização validará os seguintes pontos caso o Item Contábil esteja preenchido:

  • O Curso da Matriz Aplicada associada ao anexo que está sendo salvo possui Modalidade?
  • O Item Contábil informado está vinculado à Modalidade do Curso?


Caso alguma das afirmativas acima não seja verdadeira, será emitida uma mensagem de consistência e não será possível salvar o anexo.

Para cada Matriz Aplicada poderá ser vinculado apenas um Item Contábil e uma Classe de Valor.


Pré-Requisitos

Não se aplica.


Descrição do processo


Disponibilização do plugin no evento do Botão Salvar/OK do cadastro de Matriz Aplicada acessado através do menu TOTVS Educacional | Currículo e Oferta | Estrutura curricular | Matriz curricular | Anexos | Matriz Aplicada.


Detalhamento do processo


No momento que uma Matriz Aplicada for salva, se houver Item Contábil vinculado, a Customização fará as seguintes validações:

  • O Curso da Matriz Aplicada que está sendo salva possui Modalidade?
  • O Item Contábil da Matriz Aplicada está vinculado à Modalidade do Curso?
  • A Matriz Aplicada que está sendo salva possui Centro de Custo?
  • O Item Contábil e o Centro de Custo da Matriz Aplicada estão associados entre si no Protheus?


Caso alguma das afirmativas acima não seja verdadeira, será emitida uma mensagem de consistência e não será possível salvar a Matriz Aplicada


O vínculo entre Item Contábil e Centro de Custo será validado no Protheus a partir da view IIFR_CTA010_VW. A consulta é por Coligada e para tal será considerada a Empresa Protheus parametrizada. O valor do campo EMPRESAPROTHEUS deverá ser recuperado da tabela ZPARAMETROTEMPLATE e passado como filtro para a View.


Pré-requisitos

Não se aplica.


Descrição do processo


Disponibilização do anexo customizado “Dados financeiros – Integração Protheus” em TOTVS Educacional | Currículo e Oferta | Oferta | Turmas.


Detalhamento do processo


Nesta tela haverá dois campos que farão referência às tabelas SITEMCONTABILPROTHEUS (Item Contábil) e SCLASSEVALORPROTHEUS (Classe de Valor) filtrados pela Coligada do contexto. A informação aqui definida será gravada na tabela customizada ZIPTURMADADOSFINANCEIROS.




Ao salvar o registro a customização validará os seguintes pontos caso o Item Contábil esteja preenchido:

  • O Curso da Turma associada ao anexo que está sendo salvo possui Modalidade?
  • O Item Contábil informado está vinculado à Modalidade do Curso ?


Caso alguma das afirmativas acima não seja verdadeira, será emitida uma mensagem de consistência e não será possível salvar o anexo.

Para cada Turma poderá ser vinculado apenas um Item Contábil e uma Classe de Valor.

Dependendo da situação, o Item Contábil pode ser informado na Turma ou na Matriz Aplicada. Nos casos onde for informado em ambos, o Item Contábil da Turma deve prevalecer para a integração.


Pré-requisitos

Não se aplica.


Descrição do processo


Disponibilização do plugin no evento do Botão Salvar/OK do cadastro de Turma acessado através do menu TOTVS Educacional | Currículo e Oferta | Oferta | Turma.


Detalhamento do processo


No momento que uma Turma for salva, se houver Item Contábil vinculado, a Customização fará as seguintes validações:

  • O Curso da Turma que está sendo salva possui Modalidade?
  • O Item Contábil da Turma está vinculado à Modalidade do Curso ?
  • A Turma que está sendo salva possui Centro de Custo?
  • O Item Contábil e o Centro de Custo da Turma estão associados entre si no Protheus?


Caso alguma das afirmativas acima não seja verdadeira, será emitida uma mensagem de consistência e não será possível salvar a Turma

O vínculo entre Item Contábil e Centro de Custo será validado no Protheus a partir da view IIFR_CTA010_VW. A consulta é por Coligada e para tal será considerada a Empresa Protheus parametrizada através do Req. 01. O valor do campo EMPRESAPROTHEUS deverá ser recuperado da tabela ZPARAMETROTEMPLATE e passado como filtro para a View.



Pré-requisitos


Configurar o código do Tipo de Baixa que será exportado para o Protheus no TOTVS Educacional, menu Customização | Parâmetros | Código do Tipo da Baixa – Cancelamento. Esse valor será utilizado no envio do cancelamento (baixa) no Protheus.


Descrição do processo


Exportação de cancelamento de títulos financeiros a ser realizada entre o TOTVS Gestão Financeira e o Protheus. Esse processo é automático e não precisa ser agendado.


Detalhamento do processo


A customização acionará a função FINA070 (pacote IIFR_CLIENTE_PCK) quando um Lançamento for cancelado no sentido TOTVS RM → Protheus. Neste momento a integração enviará o registro para o Barramento IIF de onde serão lidos pelo Protheus.
O processo "Cancelar Contrato" acionado através do menu Educacional | Financeiro/Contábil | Contratos | Processos, quando a opção "Cancelar lançamentos em aberto e não vencidos" do processo estiver marcada, efetuará o cancelamento dos lançamentos financeiros no RM e com isso, a customização será acionada.
O cancelamento do Lançamento será concretizado no TOTVS independente do retorno recebido pelo Protheus. Caso ocorra erro na integração, o usuário poderá efetuar o reenvio do registro através da interface de log.


  • Se for identificado que um Lançamento cancelado no RM já foi baixado no Protheus, ficará a cargo do usuário resolver a situação manualmente.
  • Ao cancelar um Acordo no RM, os lançamentos gerados pelo Acordo são cancelados e os lançamentos originais são reabertos. No entanto, por estarem associados a um Contrato do tipo Acordo, o cancelamento destes títulos não serão enviados para o Protheus. Quando essa operação for necessária (cancelamento do Acordo), será preciso efetuar o cancelamento da negociação no Protheus manualmente, já que não está prevista integração para cancelamento de Acordo/Negociação entre os dois sistemas.

Pré-requisitos

  1. Template de Acordo: Criar o template do acordo chamado "Acordo SGE" no módulo TOTVS Gestão Financeira, menu Contas a Pagar / Receber | Acordo | Template de Acordo. A classificação financeira (aba Defaults) precisa obrigatoriamente ser preenchida. Depois disso, é necessário parametrizar o identificador do template nos parâmetros da customização.
  2. Parametrizar o TOTVS Gestão Financeira e Educacional para gerar apenas lançamentos financeiros do tipo Não Contábeis. Essa parametrização é por Coligada e Filial.
  3. Informar parâmetros de Acordo que se encontram nos parâmetros gerais do TOTVS Educacional, menu Ambiente | Parâmetros |Tesouraria | Avançar, aba Geral ½ : Informar os Serviços (Inadimplência e Processo Seletivo).


Descrição do processo


Integração de Acordos Financeiros a ser realizada entre TOTVS RM e Protheus. A integração será realizada de forma automática (Job Server), respeitando os intervalos de tempo pré-definidos pelo usuário no agendamento. O Processo deverá ser agendado no TOTVS Educacional, menu Customização | Importação de Acordo.


Detalhamento do processo


As renegociações (acordos) referente a débitos dos alunos serão realizadas diretamente no Protheus, através de rotina customizada pela FIERGS para este fim específico. Os títulos gerados pelas negociações serão enviados para o barramento IIF para serem importados no TOTVS Educacional.
Ao ser disparada, a rotina customizada de integração irá ler as informações dos Acordos Financeiros que estarão disponíveis no barramento e acionar rotina nativa para Geração de Acordo disponível em TOTVS Gestão Financeira | Contas a Pagar / Receber | Lançamentos | Processos | Gerar Acordo. Este processo, por sua vez, irá baixar os Lançamentos de origem por acordo e criar os novos, além de gerar um novo Contrato Educacional para o aluno (Contrato do tipo Acordo).
As visões consultadas no barramento para importação de Acordo são:

  • Cabeçalho: DDA_IIF.IIFR_RENEGOCIACAO_OUT_VW

Contém informações como Data do Acordo e Valor Total.

  • Parcelas Geradas: DDA_IIF.IIFR_TIT_RENEGOCIACAO_OUT_VW

Contém informações das Parcelas geradas, como: Data de Vencimento, Nosso Número e Valor.

  • Lançamentos Originais: DDA_IIF.IIFR_TIT_BAIXADO_OUT_VW

Contém o Nosso Número dos lançamentos originais, que precisam ser baixados no RM para geração do Acordo.
Após importação, o RM informará ao Protheus o status da execução de cada registro, através da função "AtualizaMensagem", disponível no barramento. No caso de Sucesso, o Protheus deverá retirar da visão os registros já processados pelo RM.
Os dados da importação estarão disponíveis na interface de log, detalhada no manual da Parte 2 - Req.08.


  • A Negociação no Protheus realiza os processos de baixa dos títulos de origem e criação dos novos títulos em momentos distintos, ao contrário do TOTVS RM, que realiza esses passos em um só momento. Por isso, para que seja possível acionar a rotina nativa de Geração de Acordos do TOTVS RM, o Protheus não deverá enviar a baixa dos títulos do tipo Acordo ao barramento. A integração será realizada em um só momento, quando o Protheus enviar os novos títulos gerados pela Negociação, disponibilizando as informações descritas neste requisito.
  • Ao cancelar um Acordo no RM, os lançamentos gerados pelo Acordo são cancelados e os lançamentos originais são reabertos. Quando essa operação for necessária (cancelamento do Acordo), será preciso efetuar o cancelamento da negociação no Protheus manualmente, já que não está prevista integração para cancelamento de Acordo/Negociação entre os dois sistemas.

Pré-requisitos

  1. Parametrizar o TOTVS Gestão Financeira e Educacional para gerar apenas lançamentos financeiros do tipo Não Contábeis. Essa parametrização é por Coligada e Filial.
  2. Meio de Pagamento: Informar o código do Meio de Pagamento que será utilizado em todos os Acordos no TOTVS Educacional, menu Customização | Parâmetros | Meio de Pagamento.


Descrição do processo


Integração de Baixa de Lançamentos Financeiros a ser realizada entre TOTVS RM e Protheus. A integração será realizada de forma automática (Job Server), respeitando os intervalos de tempo pré-definidos pelo usuário no agendamento. O Processo deverá ser agendado no TOTVS Educacional, menu Customização | Importação de Baixa.


Detalhamento do processo


A Baixa dos Lançamentos Financeiros será realizada diretamente no Protheus e as informações dos títulos baixados deverão ser enviados para o barramento IIF para serem importados no TOTVS RM.
Ao ser disparada, a rotina customizada de integração irá ler as informações dos Lançamentos Financeiros baixados no Protheus que estarão disponíveis na visão DDA_IIF.IIFR_BAIXA_P11_RM_OUT_VW, que contém os dados necessários para realização da baixa no RM. Através do Nosso Número disponível na visão, a customização irá localizar os lançamentos financeiros correspondentes no TOTVS RM e acionar rotina nativa para inclusão da Baixa, que por sua vez, irá baixar os lançamentos no TOTVS RM.
Após importação, o RM informará ao Protheus o status da execução de cada registro, através da função "AtualizaMensagem", disponível no barramento. No caso de Sucesso, o Protheus deverá retirar da visão os registros já processados pelo RM.
Os dados da importação estarão disponíveis na interface de log, detalhada no manual da Parte 2 - Req.08.

  • Não está prevista integração de estorno de baixa.
  • Baixas de títulos nativos do Protheus não deverão ser enviadas ao barramento e por isso, não serão importadas pelo TOTVS RM.
  • Baixas de títulos por Acordo não poderão ser enviadas ao barramento e por isso, não serão importadas pelo TOTVS RM. De acordo com a FIERGS, baixas do tipo Acordo possuem um tipo de mensagem específico no barramento IIF e tratamento diferenciado.