Manual Operacional - Integração SGE x Protheus - Parte 1



Projeto: FS007779 (873247-874083) - Parte 1



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 tela possui os seguintes campos disponíveis:

  • Natureza Financeira: campo em formato lista, onde o 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, através do processo definido no Req.03.


  • Produto: campo em formato lista, onde o 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: campo em formato lista, onde o 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: campo texto onde o usuário informa a série que será utilizada pelo Serviço, quando gerar o Pedido no Protheus.


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


Os dados informados nesta interface são armazenados por Serviço e Coligada. Será necessário informar estes parâmetros para cada serviço que for utilizado pela Integração Protheus.
Cada Serviço poderá ter somente um registro de anexo vinculado. O serviço "MENSALIDADE BALCÃO" por exemplo, na coligada SESI terá apenas uma natureza financeira, produto, TES, serie e prefixo associado. Mas dentro da mesma coligada poderemos ter outro serviço "MENSALIDADE INDUSTRIA' e nele teremos outros anexos, natureza financeira, produto, TES, serie e prefixo associado.
Os dados do cadastro da TES não serão armazenados em tabelas do TOTVS Educacional. A consulta para mostrar a lista será feita diretamente no barramento IIF.
O acesso a esta interface será controlado pelas permissões concedidas por perfil de usuário disponíveis através do TOTVS Serviços Globais | Segurança | Perfil.






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:
  • Ativo
  • Passivo
  • Despesas
  • Receitas
  • Variações Patrim e Financ – Ativa
  • Variações Patrim e Financ – Passiva
  • 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.




  • Descrição do Processo

1. No TOTVS Educacional usuário acessa menu Currículo e Oferta | Estrutura curricular | Mais | Modalidades do Curso | Anexos | Item Contábil.
2. Visão customizada do Anexo é exibida.
3. Usuário insere/altera/exclui registro.
4. Rotina armazena informações em tabela customizada.
5. Fim do processo.

  • Detalhamento de Cálculos

Não se aplica.

  • Detalhamento de Processos Específicos

No TOTVS Educacional por meio do menu Currículo e Oferta | Estrutura curricular | Mais | Modalidades do Curso, será criado um anexo customizado para que sejam informados os Itens Contábeis vinculados às Modalidades do Curso.
Neste anexo, será disponibilizado um campo do tipo lookup que referenciará a tabela SITEMCONTABILPROTHEUS. Os registros exibidos no lookup serão filtrados pela Coligada do contexto.
As informações serão armazenadas em uma tabela customizada (ZIPMODALIDADEITEMCONTABIL) cujo detalhamento de dados segue abaixo.

ZIPMODALIDADEITEMCONTABIL


Propriedade

Descrição

CODCOLIGADA

Código da Coligada do Contexto

CODMODALIDADECURSO

Código da Modalidade do Curso

IDITEMCONTABIL

Identificador do Item Contábil


PONTOS DE ATENÇÃO:
1. Nesta interface, o usuário poderá incluir, editar e excluir registros. O usuário poderá selecionar somente Itens Contábeis vindos do Protheus, não podendo incluir manualmente novo Item Contábil sem que seja validado na tabela SITEMCONTABILPROTHEUS.
2. As informações serão armazenadas em uma tabela customizada (ZIPMODALIDADEITEMCONTABIL).
3. Para cada Modalidade poderão ser vinculados vários Itens Contábeis de acordo com a necessidade do usuário.
4. O acesso a esta interface será controlado pelas permissões concedidas por perfil de usuário disponíveis através do TOTVS Serviços Globais | Segurança | Perfil.

  • Protótipo

As imagens dos protótipos são meramente ilustrativas, podendo variar ao longo do desenvolvimento de acordo com a ferramenta TOTVS.

Fig.1 – Menu do Anexo

Fig.2 – Visão do Anexo


Fig.3 – Formulário de Edição


  • Fluxo do Processo

  • Descrição do Processo

1. No TOTVS Educacional usuário acessa menu Currículo e Oferta | Estrutura curricular | Matriz curricular | Anexos | Matriz Aplicada | Anexos | Dados Financeiros – Integração Protheus.
2. Interface customizada do anexo é exibida.
3. Usuário insere/altera registro.
4. Rotina armazena informações em tabela customizada.
5. Fim do processo.

  • Detalhamento de Cálculos

Não se aplica.

  • Detalhamento de Processos Específicos

No TOTVS Educacional por meio do menu Currículo e Oferta | Estrutura curricular | Matriz curricular | Anexos | Matriz Aplicada, será criado um anexo customizado para que seja informado o Item Contábil e a Classe de Valor vinculados às Matrizes Aplicadas.
Neste anexo, serão disponibilizados dois campos do tipo lista que farão referência às tabelas SITEMCONTABILPROTHEUS e SCLASSEVALORPROTHEUS. Os registros exibidos nas listas serão filtrados pela Coligada do contexto.
As informações serão armazenadas em uma tabela customizada (ZIPMATRIZDADOSFINANCEIROS) cujo detalhamento de dados segue abaixo.

ZIPMATRIZDADOSFINANCEIROS


Propriedade

Descrição

CODCOLIGADA

Código da Coligada do Contexto

IDHABILITACAOFILIAL

Identificador da Matriz Aplicada

IDITEMCONTABIL

Identificador do Item Contábil

IDCLASSEVALOR

Identificador da Classe de Valor




No momento que o usuário salvar o anexo de Dados Financeiros se o Item Contábil estiver preenchido serão realizadas as seguintes validações:

  1. O Curso da Matriz Aplicada associada ao anexo que está sendo salvo possui Modalidade?
  2. O Item Contábil informado está vinculado à Modalidade do Curso (Req. 04)?


Se o Curso da Matriz Aplicada não possuir Modalidade de Curso associada, ou se a Modalidade do Curso da Matriz Aplicada não estiver associada ao Item Contábil informado (Req.04), será exibida mensagem de erro, impossibilitando salvar o anexo.
Portanto, só será possível salvar o anexo se o Item Contábil e a Modalidade estiverem vinculados no TOTVS Educacional.
PONTOS DE ATENÇÃO:
1. Nesta interface, o usuário poderá incluir e editar registros. O usuário poderá selecionar somente Itens Contábeis e Classes de Valor vindos do Protheus, não podendo incluir manualmente sem que sejam validados nas tabelas SITEMCONTABILPROTHEUS e SCLASSEVALORPROTHEUS respectivamente.
2. As informações serão armazenadas em uma tabela customizada (ZIPMATRIZDADOSFINANCEIROS).
3. Para cada Matriz Aplicada poderá ser vinculado apenas um Item Contábil e uma Classe de Valor.
4. O acesso a esta interface será controlado pelas permissões concedidas por perfil de usuário disponíveis através do TOTVS Serviços Globais | Segurança | Perfil.




  • Protótipo

As imagens dos protótipos são meramente ilustrativas, podendo variar ao longo do desenvolvimento de acordo com a ferramenta TOTVS.

Fig.1 – Menu Anexo



 

  • Descrição do Processo

1. No TOTVS Educacional usuário acessa Currículo e Oferta | Estrutura Curricular | Matrizes curriculares | Anexos | Matriz Aplicada.
2. Visão nativa é exibida.
3. Usuário inclui/altera registro e clica em salvar.
4. Item Contábil e Modalidade vinculados?
4.1. Sim. Executa passo 5.
4.2. Não. Mensagem de erro customizada é exibida e usuário é impedido de salvar as informações da Matriz Aplicada.
5. Item Contábil e Centro de Custo vinculados?
5.1. Sim. Informações da Matriz Aplicada são salvas.
5.2. Não. Mensagem de erro customizada é exibida e usuário é impedido de salvar as informações da Matriz Aplicada
6. Fim do processo.

  • Detalhamento de Cálculos

Não se aplica.

  • Detalhamento de Processos Específicos

Será criado um plugin customizado que interceptará o 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.
No momento que o usuário salvar uma Matriz Aplicada e se houver Item Contábil vinculado à ela, serão realizadas as seguintes validações.

  1. O Curso da Matriz Aplicada que está sendo salva possui Modalidade?
  2. O Item Contábil da Matriz Aplicada (Req. 05) está vinculado à Modalidade do Curso (Req. 04)?
  3. A Matriz Aplicada que está sendo salva possui Centro de Custo?
  4. O Item Contábil e o Centro de Custo da Matriz Aplicada estão associados entre si no Protheus?

Se alguma das condições acima não for satisfeita, uma mensagem customizada será exibida ao usuário e ele será impossibilitado de salvar a Matriz Aplicada. Portanto, o usuário só conseguirá salvar as informações se o Item Contábil e a Modalidade estiverem vinculados no SGE e se o Item Contábil e o Centro de Custo estiverem vinculados no Protheus.
Para essa validação, o Protheus disponibilizará uma View (IIFR_CTA010_VW) que informará o vínculo entre Item Contábil e Centro de Custo. A consulta deverá ser feita por Coligada. Para isso, 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.


  • Descrição do Processo

1. No TOTVS Educacional usuário acessa Currículo e Oferta | Oferta | Turmas | Anexos | Dados Financeiros – Integração Protheus.
2. Interface customizada é exibida.
3. Usuário insere/altera/exclui registro.
4. Rotina armazena informações em tabela customizada.
5. Fim do fluxo.

  • Detalhamento de Cálculos

Não se aplica.

  • Detalhamento de Processos Específicos

No TOTVS Educacional por meio do menu Currículo e Oferta | Oferta | Turmas, será criado um anexo customizado para que seja informado o Item Contábil e a Classe de Valor vinculados às Turmas.
Neste anexo, serão disponibilizados dois campos do tipo lista que farão referência às tabelas SITEMCONTABILPROTHEUS e SCLASSEVALORPROTHEUS. Os registros exibidos nas listas serão filtrados pela Coligada do contexto.
As informações serão armazenadas em uma tabela customizada (ZIPTURMADADOSFINANCEIROS) cujo detalhamento de dados segue abaixo.

ZIPTURMADADOSFINANCEIROS


Propriedade

Descrição

CODCOLIGADA

Código da Coligada do Contexto

CODTURMA

Código da Turma

IDITEMCONTABIL

Identificador do Item Contábil

IDCLASSEVALOR

Identificador da Classe de Valor










No momento que o usuário salvar o anexo de Dados Financeiros se o Item Contábil estiver preenchido serão realizadas as seguintes validações:

  1. O Curso da Turma associada ao anexo que está sendo salvo possui Modalidade?
  2. O Item Contábil informado está vinculado à Modalidade do Curso (Req. 04)?


Se o Curso da Turma não possuir Modalidade de Curso associada, ou se a Modalidade do Curso da Turma não estiver associada ao Item Contábil informado (Req.04), será exibida mensagem de erro, impossibilitando salvar o anexo.
Portanto, só será possível salvar o anexo se o Item Contábil e a Modalidade estiverem vinculados no TOTVS Educacional.
PONTOS DE ATENÇÃO:
1. Nesta interface, o usuário poderá incluir e editar registros. O usuário poderá selecionar somente Itens Contábeis e Classes de Valor vindos do Protheus, não podendo incluir manualmente sem que sejam validados nas tabelas SITEMCONTABILPROTHEUS e SCLASSEVALORPROTHEUS respectivamente.
2. As informações serão armazenadas em uma tabela customizada (ZIPTURMADADOSFINANCEIROS).
3. Para cada Turma poderá ser vinculado apenas um Item Contábil e uma Classe de Valor.
4. 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.
5. O acesso a esta interface será controlado pelas permissões concedidas por perfil de usuário disponíveis através do TOTVS Serviços Globais | Segurança | Perfil.

  • Protótipo

As imagens dos protótipos são meramente ilustrativas, podendo variar ao longo do desenvolvimento de acordo com a ferramenta TOTVS.

Fig.1 – Menu do Anexo


Fig.2 – Anexo Dados financeiros – Integração Protheus

  • Descrição do Processo

1. No TOTVS Educacional usuário acessa Currículo e Oferta | Oferta | Turmas.
2. Visão nativa é exibida.
3. Usuário inclui/altera registro e clica em salvar.
4. Item Contábil e Modalidade vinculados?
4.1. Sim. Executa passo 5.
4.2. Não. Mensagem de erro customizada é exibida e usuário é impedido de salvar as informações da Turma.
5. Item Contábil e Centro de Custo vinculados?
5.1. Sim. Informações da Turma são salvas.
5.2. Não. Mensagem de erro customizada é exibida e usuário é impedido de salvar as informações da Turma
6. Fim do processo.

  • Detalhamento de Cálculos

Não se aplica.

  • Detalhamento de Processos Específicos

Será criado um plugin customizado que interceptará o evento do botão Salvar/OK do cadastro de Turma acessado através do menu TOTVS Educacional | Currículo e Oferta | Oferta | Turmas.
No momento que o usuário salvar uma Turma e se houver Item Contábil vinculado à ela, serão realizadas as seguintes validações.

  1. O Curso da Turma que está sendo salva possui Modalidade?
  2. O Item Contábil da Turma (Req. 07) está vinculado à Modalidade do Curso (Req. 04)?
  3. A Turma que está sendo salva possui Centro de Custo?
  4. O Item Contábil e o Centro de Custo da Turma estão associados entre si no Protheus?

Se alguma das condições acima não for satisfeita, uma mensagem customizada será exibida ao usuário e ele será impossibilitado de salvar a Turma. Portanto, o usuário só conseguirá salvar as informações se o Item Contábil e a Modalidade estiverem vinculados no SGE e se o Item Contábil e o Centro de Custo estiverem vinculados no Protheus.
Para essa validação, o Protheus disponibilizará uma View (IIFR_CTA010_VW) que informará o vínculo entre Item Contábil e Centro de Custo. A consulta deverá ser feita por Coligada. Para isso, 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.


Histórico de Atualização das Versões do Documento

Data

Autor

Versão

Descrição das Alterações

24/07/2017

Ana Carolina Eleutério Abras
Alice Viana Machado

1.0

Documento Inicial

27/07/2017

Ana Carolina Eleutério Abras
Alice Viana Machado

2.0

Ajuste no documento após análise do cliente.