Páginas filhas
  • Manual Operacional da Customização - Integrações com AVA, WIFI, Moodle (SESI-SENAI)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Manual Operacional da Customização - Integrações com AVA, WIFI, Moodle (SESI-SENAI)


Projeto: FS007782 (873247-874083) – Integrações com AVA, WIFI, Moodle (SESI-SENAI)

Nome do cliente: FIERGS

Objetivo


O manual a seguir tem por objetivo orientar o usuário sobre as implementações realizadas para sua empresa. Todas as funcionalidades descritas neste manual têm como base do se baseiam no que está descrito no documento “Especificação Anexo I – Detalhamento Funcional – FS007782 e FS008016 (983465).


Expandir
titleParâmetros da Customização

Pré-requisitos


Não se aplica.


Descrição do processo


Este requisito detalha os 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 estará disponível em TOTVS Educacional | Customização | Parâmetros da Integração - TOTVS Educacional (SGE) x AVA/Moodle/Usuários Wi-Fi.



A tela exibirá uma lista de parâmetros disponíveis para configuração, onde o usuário administrador do sistema informará se a integração estará habilitada ou não e os dados referentes ao acesso ao barramento FIERGS.



Importante:

A parametrização de informações de conexão ao barramento IIF FIERGS ficaram centralizadas no menu TOTVS Educacional | Customização | Parâmetros | Integração SGE x Protheus. A customização irá utilizar os mesmos parâmetros de conexão ao barramento IIF configurados no menu de parametrização de integração SGE x Protheus. 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 será salvo criptografado.



Os parâmetros específicos da integração SGE x AVA, Moodle e Usuários Wi-Fi serão realizados no menu TOTVS Educacional | Customização | Parâmetros | Integração SGE x AVA/Moodle/Usuários Wi-Fi.

 

  • Habilita Integração AVA/MOODLE: campo que definirá se a integração estará habilitada (valor igual a um) ou desabilitada (valor igual a zero). Este parâmetro será verificado antes de cada gatilho que efetua importação ou exportação de dados referentes à integração (plug-ins, processos customizados) de turma/disciplina, cadastro, matrícula e importação de notas de alunos e cadastros de professores. Caso esteja desmarcado, os gatilhos não serão executados.


  • Habilita Integração Usuários Wi-Fi: campo que definirá se a integração estará habilitada (valor igual a um) ou desabilitada (valor igual a zero). Este parâmetro será verificado antes de cada gatilho que efetua exportação de dados referentes à integração (plug-ins, processos customizados) de usuários da rede Wi-Fi. Caso esteja desmarcado, os gatilhos não serão executados.


  • Reenvio de dados: campo que definirá se o reenvio de dados estará habilitado (valor igual a um) ou desabilitado (valor igual a zero). Este parâmetro será verificado antes da execução do processo de Reenvio de dados - Req. 11.


  • Quantidade máxima de tentativas de reenvio: número máximo de tentativas de reenvio de dados permitido. Ao atingir esse limite, o reenvio não será mais processado automaticamente.


  • Endereço de e-mail para envio de alerta: endereço de e-mail para onde será enviado um alerta de limite excedido de tentativas de integração de registros.



Para que a integração funcione corretamente para os sistemas destino desejados, os parâmetros “Habilita Integração AVA/Moodle” e “Habilita Integração Usuários Wi-Fi” deverão estar marcados.

  

Será necessário fazer o cadastro dos parâmetros em todas as Coligadas que utilizarão a integração. As informações serão armazenadas em tabela customizada (ZPARAMETROTEMPLATE), por Coligada, onde cada parâmetro corresponde a um registro na tabela.


Para editar os parâmetros, o usuário deverá selecionar a linha da visão correspondente ao parâmetro desejado e clicar em editar (ou duplo clique). Será exibido formulário com o campo selecionado para edição (conforme abaixo).



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



Exportação de Turma Presencial


Para que turmas/disciplinas possam ser enviadas é necessário que o parâmetro “Exportar turmas presenciais” esteja marcado



O envio permanecerá sendo realizado conforme o projeto original, onde existe um job agendado que de tempos em tempos (definido no agendamento do job) envia os dados para o barramento ou por operação manual em: TOTVS Educacional | Customização | Integração SGE x AVA/Moodle/Usuários Wi-Fi | Integração SGE x AVA/Moodle.


A cada execução do job ou do envio manual serão enviados dados do aluno e sua matrícula em turmas/disciplinas.


A exportação de turmas presenciais será controlada por esse parâmetro. Caso a Coligada SESI não queira enviar as Turmas Presenciais ao barramento, este parâmetro deverá estar desmarcado na Coligada SESI.



Log de integração


2 parâmetros são definidos para definir como será o comportamento do log de integração para AVA/Moodle/Usuários Wi-Fi.


Uma vez que o volume (e tamanho) de dados gravados pela integração AVA/Moodle/Wi-Fi é grande torna-se necessário fazer um controle do que será gravado no log de integração. Esse parâmetros são  informados por coligada:

  • Habilita Gravação somente de log com erro”:
  1. Caso o parâmetro esteja marcado só serão registrados no log registros de erro, ignorando logs de integrações bem sucedidas;
  2. Caso o parâmetro esteja desmarcado todos os registros de integração serão gravados no log, tanto os bem sucedidos como os mal sucedidos.





  • Habilita Gravação de Pacote de Integração (PL/SQL)”:
  1. Caso o parâmetro esteja marcado a customização gravará no log o pacote de integração;
  2. Caso o parâmetro esteja desmarcado a customização não gravará no log o pacote de integração.



Para a integração Protheus também será aplicado o parâmetro “Habilita Gravação do Pacote de Integração”, disponível no menu: TOTVS Educacional | Customização | Parametros | Integração SGE x Protheus e deve ser informado por coligada: 

  • “Habilita Gravação de Pacote de Integração (PL/SQL)”:
  1. Caso o parâmetro esteja marcado a customização gravará no log o pacote de integração;
  2. Caso o parâmetro esteja desmarcado a customização não gravará no log o pacote de integração.


Nota
titleImportante

Devido ao grande volume de dados de log é recomendável realizar uma limpeza periódica nos logs da integração SGE x AVA/Moodle/Wi-Fi.



Expandir
titleProcesso de integração (JobServer)

Pré-requisitos


Não se aplica.


Descrição do processo


Este requisito detalha a exportação das informações do TOTVS Educacional para o barramento IIF. Os menus de integração do TOTVS Educacional com o barramento IIF foram divididos em dois visando uma melhor organização do processo.


Detalhamento do processo


Os processos poderão ser executado manualmente ou agendados de acordo com os intervalos parametrizados pelo usuário através das telas disponíveis nos menus TOTVS Educacional | Customização | Integração SGE x AVA/Moodle.



E, TOTVS Educacional | Customização | Integração SGE x Usuários Wi-Fi



Ao serem executados, estes processos irão fazer as respectivas consultas das informações ao banco de dados do TOTVS Educacional para realizar as seguintes exportações de informações para o barramento IIF FIERGS.


  • Exportação: Turma/disciplina, curso e matriz aplicada, dados do aluno e suas matrículas, cadastros auxiliares de matrícula do aluno, dados de professores e suas turmas/disciplina, exportação de dados de usuários para acesso a rede Wi-Fi.


A cada execução do processo serão armazenados em tabela nativa (ZLOGJOB) do TOTVS RM os detalhes de execução. Se for uma execução imediata em que o usuário acompanha e aguarda, será exibido o log de execução indicando o sucesso ou falha do processo de integração. A customização irá gravar em tabela customizada (ZLOGINTEGRACAO) um log da integração do TOTVS Educacional com o barramento FIERGS as informações referentes à integração de cada entidade (Id do processo, funcionalidade, status, dados, mensagem de erro caso ocorra). Os detalhes sobre o funcionamento deste log estão descritos no ‘Req. 10 – Monitor de Log de Exportação’.


A customização irá gravar em tabela customizada (ZULTIMAEXECPROC) a data e hora da última execução (execução com sucesso ou falhas) das integrações de cada entidade identificada pela coluna (ZULTIMAEXECPROC.IDFUNCPROC) conforme descrição da tabela a seguir:



A cada execução do processo de integração, será realizada uma consulta à data da última integração realizada para que seja processados apenas o registros mais recentes, ou seja, os registros que foram incluídos/alterados após a útlima execução da integração, otimizando o tempo de execução e processamento do processo.


A tela de agendamento de processos do TOTVS RM possui as seguintes funções e aplicabilidades:

  • Escalabilidade: A configuração de escalabilidade permite agendar a execução de mais de 1 processos em paralelo (para ser executado ao mesmo tempo). Isso permite acelerar o processamento de vários itens distintos. Para este escopo esta opção não se aplica.


  • Hora da execução (1ª execução): Opção utilizada para configurar a primeira execução do processo.


  • Repetir a execução: Nesta opção deverão ser configuradas os intervalos de repetição de execução do processo. Os valores solicitados em horas ou minutos (ex.: 01:00 hora ou 00:20 minutos).


PONTO DE ATENÇÃO:

A recorrência e o agendamento de processos estarão disponíveis para uso somente se o JobServer estiver configurado para execução em 3 Camadas, nos arquivos RM.Host.Service.exe.config e RM.exe.config. A tag “JobServer3Camadas” deverá estar configurada com o valor true - <add key="JobServer3Camadas" value="true" />.


Expandir
titleExportação de Curso e Matriz Aplicada

Pré-requisitos


É necessário que o Curso e Matriz Aplicada estejam associados à uma Turma/Disciplina do tipo a distância ou semipresencial para serem exportados.


Descrição do processo


O objetivo deste requisito é simplificar a arquitetura de exportação dos registros que, associados, compõem o registro de turma/disciplina descrito no Req. 04 - Exportação de Turma/Disciplina. Neste requisito serão detalhadas as tabelas que serão exportadas do TOTVS Educacional para o barramento FIERGS.


Detalhamento do processo


Os registros serão exportados através do serviço automático descrito no ‘Req. 02 – Processo de integração SGE x AVA/Moodle’ (Processo de Integração). A recuperação das informações de matriz aplicada se baseará nos seguintes dados:


Nome da Tabela

Conteúdo da tabela

SPLETIVO

Dados dos Períodos Letivos nos quais as Matrizes Aplicadas, Turmas e Turmas/Disciplinas estarão vinculados.


SHABILITACAO

Dados dos Períodos ou Séries do Curso.


SHABILITACAOFILIAL

Cadastro de determinada Matriz Curricular por Filial e Turno.


SGRADE

Dados mais específicos do Curso. Informações de Carga Horária, Data Início e Fim, Controle de Vagas (Turma ou Disciplina da Turma), Total de Créditos (apenas SENAI), Mínimo e Máximo de Créditos (apenas SENAI)

SPERIODO

Dados básicos Período (Módulo) do Curso. O conceito varia entre SESI e SENAI. No caso do SESI o período é único por Matriz Curricular. No SENAI é possível ter mais de um período. É através deste cadastro que são vinculadas as disciplinas do Período.


SDISCGRADE

Lista das Disciplinas de determinado Período da Matriz Curricular.

SCURSO

Dados básicos do curso como Nome, Código INEP, Modalidade etc.

SCURSOCOMPL

Informações complementares do Curso



Os registros de matriz aplicada associados a uma turma/disciplina a distância ou semipresencial incluídos após a última execução do serviço, serão enviados ao barramento.


Para atualizar registros que já tenham sido gravados com sucesso no barramento, o processo verificará:

  • Caso o usuário realize alguma modificação no cadastro de matriz aplicada associados a uma turma/disciplina a distância ou semipresencial que afete as tabelas SPLETIVO, SHABILITACAO, SHABILITACAOFILIAL, SGRADE, SPERIODO, SDISCGRADE, SCURSO e SCURSOCOMPL, na próxima vez que o processo de integração (Req. 02 Job Server de Integração) for executado, este irá recuperar as informações atualizadas e enviar ao barramento o registro com as informações atualizadas.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.

Expandir
titleExportação de Turma/Disciplina

Pré-requisitos

  1. Criação de campo complementar TIPOLMS e tabela dinâmica com lista de valores. A criação destes artefatos está contemplada no script “TOTVS_Custom_Consolidate_All_SQL_Developer.sql”.
  2. Para exportar a Turma Disciplina, é necessário que a Etapa da Turma/Disciplina seja cadastrada.
  3. Para que turmas/disciplinas presenciais possam ser enviadas (em adição às turmas/disciplinas à distância e semipresenciais) é necessário que o parâmetro “Exportar turmas presenciais” esteja marcado nos parâmetros da integração SGE x AVA/Moodle/Usuários Wi-Fi, disponível no menu: TOTVS Educacional | Customização | Parâmetros | Integração SGE x AVA/Moodle/Usuários Wi-Fi e deve ser informado por Coligada.


Descrição do processo


As turmas/disciplinas são as disciplinas de uma matriz aplicada, que são vinculadas as turmas e então, ofertadas para que os alunos possam cursá-las. As informações de turmas/disciplinas de uma matriz aplicada necessitam que o curso, o período letivo, a turma e a matriz curricular tenham sido criados.


Detalhamento do processo


O objetivo deste requisito é possibilitar o envio dos dados de turma/disciplina existentes no cadastro ‘Currículo e Oferta | Oferta | Turmas/disciplinas’ do TOTVS Educacional para o barramento FIERGS.


Os registros serão exportados através do serviço automático descrito no ‘Req. 02 – Processo de integração SGE x AVA/Moodle’. A recuperação das informações de turma/disciplina se baseará nos seguintes dados:


Nome da Tabela

Conteúdo da tabela

STURMADISC

Para cada Turma são criadas Turmas/Disciplinas de todas as Disciplinas da Série/Período. Neste cadastro coloca-se informações de Duração da Aula, Período de Matrícula, Número de Aulas, Datas Inicial e Final, Tipo de Aula (Presencial, Semipresencial ou Distância) etc.

STURMA

Cadastro de determinada Turma da Matriz Aplicada num Período Letivo. Neste cadastro coloca-se informações de Número Máximo de Alunos, Datas, Localização etc.


STURMACOMPL

Campos complementares que podem ser criados de acordo com a necessidade do cliente para atender à sua regra de negócio.


STURNO

Dados dos Turnos nos quais as Matrizes Aplicadas, Turmas e Turmas/Disciplinas estarão vinculados.


SDISCIPLINA

Dados das Unidades Curriculares que serão vinculadas às Séries/Períodos da Matriz Curricular e que farão parte das Turmas/Disciplinas.


SETAPAS

Dados das Etapas que compõem as Turmas/Disciplinas. O Modelo de Etapas utilizado na Turma/Disciplina é herdado da Parametrização por Curso. Na Parametrização por Curso o usuário define para uma Matriz Aplicada de determinado Período Letivo quais serão as Etapas de Nota e Falta e as configurações básicas de cada Etapa (SMODETAPAHABILITACAO). No momento que as Turmas/Disciplinas são criadas elas recebem as Etapas que estão configuradas na Parametrização por Curso para sua Matriz Aplicada / Período Letivo e grava as informações na tabela SETAPAS.



Os registros de turma/disciplina do tipo a distância ou semipresencial incluídos após a última execução do serviço, serão enviados ao barramento.


Para atualizar registros que já tenham sido gravados com sucesso no barramento, o processo verificará:

  • Caso o usuário realize alguma modificação no cadastro de Turma/Disciplina do tipo a distância ou semipresencial que afete as tabelas STURMADISC, STURMA, STURMACOMPL, STURNO, SDISCIPLINA e SETAPAS, na próxima vez que o processo de integração (Req. 02 Job Server de Integração) for executado, este irá recuperar as informações atualizadas e enviar ao barramento o registro com as informações atualizadas.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.


Turmas Presenciais

A exportação de turmas presenciais será controlada por esse parâmetro. Caso a Coligada SESI não queira enviar as Turmas Presenciais ao barramento, este parâmetro deverá estar desmarcado na Coligada SESI.


Expandir
titleExportação de Aluno e Matrícula do aluno

Pré-requisitos

  1. É necessário que a Matricula do aluno esteja associada à uma Turma/Disciplina do tipo a distância ou semipresencial para que as informações do aluno e sua matrícula sejam exportados.
  2. Criação do campo complementar de aluno "Exportar Cadastro para o Protheus".


Descrição do processo


O objetivo deste requisito é descrever como é realizada a exportação de informações pessoais e de matrícula do aluno em uma disciplina do TOTVS Educacional para o barramento FIERGS.


Detalhamento do processo


Os registros serão exportados através do serviço automático descrito no ‘Req. 02 – Processo de integração SGE x AVA/Moodle’. A recuperação das informações de aluno e sua matrícula em turma/disciplina a distância ou semipresencial se baseará nos seguintes dados:


Nome da Tabela

Conteúdo da tabela

PPESSOA

É uma tabela que centraliza informações de todos os cadastros de Pessoas de qualquer sistema TOTVS RM. São registrados dados primários, de endereço, documentos, responsáveis acadêmico e financeiro, filiação, necessidades especiais etc.

SPESSOA

O código dos registros de responsáveis financeiro e acadêmico e dos pais são vinculados ao aluno através da tabela SPESSOA.

SALUNO

Dados cadastrais do Aluno.


SALUNOCOMPL

Campos complementares que podem ser criados de acordo com a necessidade do cliente para atender à sua regra de negócio.


STURMADISC

Para cada Turma são criadas Turmas/Disciplinas de todas as Disciplinas da Série/Período. Neste cadastro coloca-se informações de Duração da Aula, Período de Matrícula, Número de Aulas, Datas Inicial e Final, Tipo de Aula (Presencial, Semipresencial ou Distância) etc.


SMATRICULA

Ao executar o processo Matricular Aluno o usuário deve definir o Período Letivo, Matriz Aplicada (Curso, Série. Matriz Curricular e Turno), Turma, Tipo de Matrícula (Matrícula ou Rematrícula) e Situação de Matrícula.Com estas informações é possível definir em quais Turmas/Disciplinas o Aluno irá entrar com base nas Disciplinas do Período (Módulo) da Matriz Curricular vinculada à Matriz Aplicada. A conclusão deste processo gera os registro nestas tabelas.

SMATRICPL

SHABILITACAOALUNO

SHABILITACAOFILIAL


O campo complementar "Exportar cadastro para o Protheus" (SALUNOCOMPL.EXPPROTHEUS) é para envio ao barramento de uma informação que o possibilite verificar a necessidade de cadastrar um Aluno que não seja Responsável Financeiro como cliente no Protheus.


Ao incluir ou editar o aluno, quando este campo estiver marcado, ele será automaticamente exportado para o Barramento, juntamente com o valor do campo.



Os registros de aluno e sua matrícula em turma/disciplina a distância ou semipresencial incluídos após a última execução do serviço, serão enviados ao barramento.


Por se tratar de um campo complementar, é necessário habilitá-lo através das configurações do contexto (Coligada/Nível de Ensino), podendo então habilitá-lo de forma independente para SESI ou SENAI, conforme a necessidade do usuário.

Os campos obrigatórios para inclusão do Cliente/Fornecedor no barramento são validados na inclusão do Aluno, quando o campo estiver marcado. O envio será realizado somente se todos os campos a seguir estiverem preenchidos: Rua, Número, Bairro, CEP, Município, Estado e País. Caso contrário, é exibida mensagem ao usuário:



Para atualizar registros que já tenham sido gravados com sucesso no barramento, o processo verificará:

  • Caso o usuário realize alguma modificação no cadastro de matrícula em turma/disciplina a distância ou semipresencial que afete as tabelas PPESSOA, SPESSOA, SALUNO, SALUNOCOMPL, STURMADISC, SMATRICULA, SMATRICPL, SHABILITACAOALUNO e SHABILITACAOFILIAL, na próxima vez que o processo de integração (Req. 02 Job Server de Integração) for executado, este irá recuperar as informações atualizadas e enviar ao barramento o registro com as informações atualizadas.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.




Expandir
titleExportação de cadastros auxiliares de Matrícula do Aluno

Pré-requisitos


Não se aplica.


Descrição do processo


O objetivo desta funcionalidade é enviar para o barramento os registros de cadastros relevantes para compor a informação de matrícula do aluno na turma/disciplina que forem modificados  (inclusão/alteração) pelo usuário através do TOTVS Educacional (SGE).


Detalhamento do processo


Os registros serão exportados através do serviço automático descrito no ‘Req. 02 – Processo de integração SGE x AVA/Moodle’. A recuperação das informações de turma/disciplina se baseará nos seguintes dados:


Nome da Tabela

Conteúdo da tabela

SSTATUS

Dados de situação da matricula do aluno: matriculado, pré-matriculado, cancelado, desistente, etc.

STIPOMATRICULA

Tipos matricula do aluno: novato, dependência, veterano, etc.

STIPOINGRESSO

Tipos de ingresso do aluno na instituição de ensino: processo seletivo, normal, transferência, etc.

SCAMPUS

Informações sobre os prédios da instituição de ensino.


Os registros de informações adicionais de matrícula do aluno incluídos após a última execução do serviço, serão enviados ao barramento.


Para atualizar registros que já tenham sido gravados com sucesso no barramento, o processo verificará:

  • Caso o usuário realize alguma modificação nos cadastros de situação de matricula, tipo de matricula, tipo ingresso e campus da instituição de ensino que afete as tabelas SSTATUS, STIPOMATRICULA, STIPOINGRESSO e SCAMPUS, na próxima vez que o processo de integração (Req. 02 Job Server de Integração) for executado, este irá recuperar as informações atualizadas e enviar ao barramento o registro com as informações atualizadas.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.




Expandir
titleImportação de Notas de Alunos

Pré-requisitos


1. As notas precisam estar disponíveis para importação através da View disponibilizada no Barramento.


Descrição do processo


Após conclusão da turma disciplina no ambiente virtual, será disponibilizado no barramento de integração da FIERGS, informações de notas da turma/disciplina para apuração de resultado final do aluno no TOTVS Educacional.


Detalhamento do processo


O objetivo deste requisito é descrever como as informações de notas de alunos na turma/disciplina serão importadas do barramento FIERGS para o TOTVS Educacional.


O menu utilizado para execução deste processo é o TOTVS Educacional | Customização | Importação de Notas de Alunos.




Ao ler as notas na tabela de integração através da execução da view “DDA_IIF.IIFR_NOTASALUNOS_OUT_VW” a customização executará o serviço nativo de inclusão de notas do TOTVS Educacional (SGE), que realizará a inclusão ou alteração da nota do aluno. Caso não exista lançamento de nota para o aluno na etapa, será considerado uma inclusão, ou se já existir nota lançada esta será substituída pelo valor apurado. Todas as validações serão do processo nativo de inclusão de notas na etapa.


As notas serão importadas para a etapa "1 - Etapa conceito das avaliações - EAD" da turma/disciplina. O código desta etapa não será fixado no SGE, ele deverá ser disponibilizado no barramento IIF e a customização utilizará o código da etapa correspondente no SGE.


No TOTVS Educacional (SGE), a disciplina da turma/disciplina deverá estar parametrizada para usar nota por conceito (SDISCIPLINA.TIPONOTA =’C’). A customização deverá utilizar o serviço nativo do TOTVS Educacional para gravar o IDGRUPO no campo SNOTAETAPA.IDGRUPO através do campo SETAPAS.IDGRUPO. O valor do conceito deverá estar disponível no registro do barramento de acordo com o valor de conceitos existentes no TOTVS Educacional (SGE) para ser gravado no campo SNOTAETAPA.CODCONCEITO. Não será realizado nenhum tipo de ‘de-para’ para conceitos diferentes entre o barramento FIERGS e o TOTVS Educacional.


Para todo registro importado pelo TOTVS Educacional será gerado um log em tabela customizada. Em caso de sucesso serão gravados os detalhes da operação de integração. Caso os dados não possam ser gravados no TOTVS Educacional, será gerado log com as informações da operação e a mensagem de erro.


Expandir
titleExportação de Professores

Pré-requisitos


É necessário que o registro do professor esteja associado à uma Turma/Disciplina a distancia ou semipresencial para ser exportado.


Descrição do processo


Através desta funcionalidade, será possível enviar ao barramento FIERGS dados de professores inseridos/atualizadas/excluídos.


Detalhamento do processo


Os registros serão exportados através do serviço automático descrito no ‘Req. 02 – Processo de integração SGE x AVA/Moodle’. A recuperação das informações de turma/disciplina se baseará nos seguintes dados:


Nome da Tabela

Conteúdo da tabela

SPROFESSORTURMA

Dados cadastrais do Professor. Este cadastro é uma composição de duas tabelas: SPROFESSOR e PPESSOA, mas apresentadas todas numa mesma tela. São registrados dados primários, de endereço, documentos, responsáveis, necessidades especiais etc. Na tabela SPROFESSORTURMA é realizado o vínculo do Professor com as Turmas que o mesmo leciona.

SPROFESSOR

PPESSOA



Inclusão/Atualização de registros


Os registros de informações de professores incluídos após a última execução do serviço, serão enviados ao barramento.


Para atualizar registros que já tenham sido gravados com sucesso no barramento, o processo verificará:

  • Caso o usuário realize alguma modificação no cadastro de professor da Turma/Disciplina à distância ou semipresencial que afete as tabelas SPESSOA, SPROFESSOR e SPROFESSORTURMA, na próxima vez que o processo de integração (Req. 02 Job Server de Integração) for executado, este irá recuperar as informações atualizadas e enviar ao barramento o registro com as informações atualizadas.


Exclusão de registros

 

Para os casos de exclusão de registros de professores da turma/disciplina, haverá um gatilho denominado plug-in no TOTVS Educacional para que, quando o usuário excluir o professor da turma/disciplina por meio do cadastro Turma/Disciplina | Anexo | Professores, a data fim de vigência do professor na turma disciplina será atualizada para a data atual, fechando a vigência do registro. Posteriormente o registro será enviado ao barramento IIF de forma síncrona, por meio de um plugin customizado.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.


Expandir
titleExportação de Usuários

Pré-requisitos


Não se aplica.


Descrição do processo


O objetivo deste requisito é descrever como ocorre a exportação dos dados de uma pessoa que possua no TOTVS Educacional os papéis de aluno, professor, diretor, secretário ou coordenador de unidades de ensino e que tenha usuário cadastrado no TOTVS Educacional para o barramento FIERGS.


Detalhamento do processo


Este processo será acionado através do serviço automático, descrito no “Req. 02 – Processo de integração SGE x Usuários WI-Fi”, e os registros de usuários, que foram incluídos/alterados após a última execução do serviço, serão enviados para o barramento.


Serão enviados os seguintes dados dos usuários e suas informações serão agrupadas na tabela ZPAPELUSUARIO de acordo com as regras definidas a seguir para que o processo de integração leia as informações desta tabela e envie-as ao barramento FIERGS. Informações mais detalhadas sobre as regras podem ser consultadas no documento “FS007782 - Especificação Anexo I - Detalhamento Funcional”


O usuário no TOTVS Educacional é a pessoa que possui um login e senha para acessar o TOTVS RM e portal web.

A apuração dos papéis e usuários do TOTVS Educacional descritos neste requisito serão realizadas da seguinte forma:


Usuário com papel de Aluno:

  • Será verificado se o aluno possui matricula em período letivo (SMATRICPL) e possui usuário ativo no TOTVS Educacional (GUSUARIO.ATIVO = 1). Caso possua, a customização gravará essa informação no campo ZPAPELUSUARIO.USUARIOSGEATIVO = ‘S’ e o papel de aluno em ZPAPELUSUARIO.PAPEL.


  • Para os casos de inativação do usuário ou casos em que o aluno deixe de possuir este papel após a última execução do processo de integração, a customização gravará na tabela ZPAPELUSUARIO sinalizando a alteração do registro no campo ZPAPELUSUARIO.OPERACAO = A, gravará em ZPAPELUSUARIO.USUARIOSGEATIVO ‘S’ para usuário ativo e ‘N’ para usuário inativo e atualizará o campo ZPAPELUSUARIO.PAPEL para ‘INDEFINIDO’ caso a pessoa deixe de exercer o papel de professor. Em seguida, o processo de integração enviará essa informação ao barramento FIERGS.


Usuário com papel de Professor:

  • Será verificado se o professor (SPROFESSOR) possui usuário ativo no TOTVS Educacional (GUSUARIO.ATIVO = 1). Caso possua, a customização gravará essa informação no campo ZPAPELUSUARIO.USUARIOSGEATIVO = ‘S’.


  • Para os casos de inativação do usuário ou casos em que o professor deixe de possuir este papel após a última execução do processo de integração, a customização gravará na tabela ZPAPELUSUARIO sinalizando a alteração do registro no campo ZPAPELUSUARIO.OPERACAO = A, gravará em ZPAPELUSUARIO.USUARIOSGEATIVO o valor ‘S’ para usuário ativo e ‘N’ para usuário inativo e atualizará o campo ZPAPELUSUARIO.PAPEL para ‘INDEFINIDO’ caso a pessoa deixe de exceder o papel de professor. Em seguida, o processo de integração enviará essa informação ao barramento FIERGS.


Usuário com papel de diretor ou secretário (1 e 2) da unidade de ensino: Os diretores e secretários (1 e 2) da unidade de ensino são cadastrados no TOTVS Gestão Fiscal | Filiais | Anexos | Diretores por filial.

A customização verificará todas as inclusões/alterações/exclusões que forem realizados neste anexo, por meio de um gatilho customizado denominado plug-in, e preencherá a tabela ZPAPELUSUARIO com as informações necessárias para enviar ao barramento FIERGS.

Por se tratar de um cadastro anexo do TOTVS Educacional que é manipulado livremente pelo usuário, será necessário que a customização gerencie as alterações nos registros utilizando um plug-in customizado no anexo de diretores das filiais de acordo com as seguintes regras:


Plug-in no anexo de coordenador e secretario (1 e 2):  Ao incluir/editar um registro no Anexo de Diretores por Filial, a customização gravará a alteração na tabela ZPAPELUSUARIO.

Ao excluir um usuário deste anexo, o campo ZPAPELUSUARIO.PAPEL será atualizado com o valor ‘INDEFINIDO’. Será gravado no campo ZPAPELUSUARIO.USUARIOSGEATIVO o valor ‘S’ para usuário ativo e ‘N’ para usuário inativo.

O processo de integração verificará as atualizações ocorridas na tabela ZPAPELUSUARIO após a última execução da integração e enviará as informações atualizadas ao barramento. Uma vez que as informações de papel e status de usuário no TOTVS Educacional estejam disponíveis no barramento, a FIERGS terá autonomia para definir as regras de atualização dos registros nos sistemas destino.


Usuário com papel de membro da comissão coordenadora da matriz aplicada: Para este item existem os seguintes papéis no TOTVS Educacional: coordenador, vice coordenador, assistente de coordenação, conselho de coordenação e coordenação pedagógica.

O cadastro dos membros desta comissão é realizado no menu TOTVS Educacional | Matrizes curriculares | Anexos | Matriz aplicada | Anexos | Comissão coordenadora.

A customização verificará todas as inclusões/alterações/exclusões que forem realizados neste anexo, por meio de um gatilho customizado denominado plug-in, e preencherá a tabela ZPAPELUSUARIO com as informações necessárias para enviar ao barramento FIERGS.


Plug-in comissão coordenadora da matriz aplicada: Ao incluir/editar um registro no anexo de Comissão Coordenadora da Matriz Aplicada,  a customização gravará a alteração na tabela ZPAPELUSUARIO. Ao excluir um usuário deste anexo, o campo ZPAPELUSUARIO.PAPEL será atualizado com o valor ‘INDEFINIDO’. Será gravado no campo ZPAPELUSUARIO.USUARIOSGEATIVO o valor ‘S’ para usuário ativo e ‘N’ para usuário inativo.  O processo de integração verificará as atualizações ocorridas na tabela ZPAPELUSUARIO após a última execução da integração e enviará as informações atualizadas ao barramento. Uma vez que as informações de papel e status de usuário no TOTVS Educacional estejam disponíveis no barramento, a FIERGS terá autonomia para definir as regras de atualização dos registros nos sistemas destino.


Para cada registro integrado com sucesso, será gravado na tabela ZLOGINTEGRACAO, o ID da operação retornado pelo pacote disponibilizado pela FIERGS. Em caso de erros, o registro será gerado no log da integração com status “Erro”. O registro com erro terá seu reenvio acionado de forma automática, conforme funcionalidade descrita no Req. 11 – Processo de Reenvio de dados.


Restrição: a senha do usuário no TOTVS não será enviada. Por questões de segurança do TOTVS Educacional, nem mesmo através de customização, é possível descriptografar uma senha.

               


A tabela ZPAPELUSUARIO será preenchida seguindo as regras acima e seus dados serão utilizados para envio ao Barramento. O campo PAPELUSUARIO armazena a sigla que indica qual tipo de usuário está sendo enviado.


Valor do Campo PAPELUSUARIO

Tipo de Usuário

C

Coordenador - Comissão Coordenadora

V

Vice Coordenador - Comissão Coordenadora

A

Assistente de Coordenador - Comissão Coordenadora

S

Conselho de Coordenação - Comissão Coordenadora

P

Coordenação Pedagógica - Comissão Coordenadora

ALU

Aluno

PROF

Professor

DIR

Diretor

SEC1

Secretário 1

SEC2

Secretário 2

INDEF

Usuário que não possui mais acesso ao SGE

Aviso
titlePONTO DE ATENÇÃO

Neste requisito, os professores serão enviados com o papel Professor, independentemente do Tipo em que foi classificado na Turma/Disciplina. Para identificar a função (tipo) do professor em cada Turma/Disciplina, será necessário consultar a tabela SPROFESSORTURMA, exportada através do Req.08 – Exportação de Professores.

Expandir
titleMonitor de Log de Exportação

Pré-requisitos


Não se aplica.


Descrição do processo


Este requisito detalha a funcionalidade de Monitor de Logs da Integração.


Detalhamento do processo


Está disponível no menu TOTVS Educacional | Customização | Monitor de Logs | Integração SGE x AVA/Moodle/Usuários Wi-Fi um cadastro com as informações da integração.



Neste cadastro o usuário poderá consultar o log das operações de exportação executadas pela integração. Estarão registradas a funcionalidade exportada, sistema destino, status, data de execução entre outras informações no cadastro Monitor de Logs.


No anexo Item do Monitor de Logs, constarão mais informações sobre o registro integrado tais como: chave do registro (composição dos valores que compões a chave da tabela base de informação do registro), status da tentativa de integração, detalhe do erro (se houver), dados enviados (para o barramento IIF), dados recebidos (do barramento IIF) entre outras informações.



Processo para Cancelar reenvio de dados do monitor de Logs:


Este cadastro possui um processo para cancelar as tentativas de reenvio de determinado registro, disponível na tela de Monitor de Logs, menu Processos | Cancelar reenvio de dados. Este processo possibilita ao usuário alterar o status dos registros do Monitor de Logs de ‘Erro’ para ‘Cancelado’. Desta forma, não é possível fazer o reenvio do registro ao barramento, uma vez que somente registros com status ‘Erro’ são processados.


Expandir
titleProcesso de Reenvio de dados (Job Server)

Pré-requisitos


Não se aplica.


Descrição do processo


Este requisito detalha o processo de Reenvio de registros em caso de falha na integração.


Detalhamento do processo


Este processo possibilita ao usuário programar o reenvio de registros processados com erro pelo processo de integração acionado através do Req. 02 – Processo de integração - SGE x AVA/Moodle e Usuários Wi-Fi.


A funcionalidade está disponível na tela de Monitor de Logs, menu Processos | Reenvio de Registros.

                                              

Respeitando a seleção dos registros feita pelo usuário na visão do Monitor de Logs, este processo executará a rotina correspondente à integração do registro, caso o registro esteja com status igual a “Erro” e o número máximo de tentativas realizadas para integrar o registro não tenha sido atingido.


Caso o usuário não selecione nenhum registro na visão do Monitor de Logs, o processo recuperará todos os registros com status “Erro” e processará o uma nova tentativa de envio dos registros com informações atualizadas para o barramento IIF Fiergs.


Se o número da tentativa for menor ou igual ao “Limite Tentativas para Reenvio”, parametrizado através do Req. 01 – Parâmetros da customização, o processo de reenvio de dados será executado na tentativa de integrar o registro novamente. Neste caso, não será gerado novo log para o registro, o log atual será atualizado com os dados do reenvio e com o número de tentativas de integração incidentes sobre o registro.


Caso o número de tentativa seja superior ao limite parametrizado, o processo customizado irá enviar um e-mail para o “Endereço de e-mail responsável’ que deverá ser parametrizado através do Req. 01 – Parâmetros da customização, notificando ao usuário que o registro excedeu ao número de tentativas de integração permitido. O registro terá seu status alterado para “Cancelado” e não será reprocessado.


Os registros com status “Erro” no Monitor de Log de Exportação, serão reenviados ao barramento FIERGS, sendo consumidos os respectivos serviços customizados de acordo com os sistemas TOTVS que originaram os registros e a funcionalidade integrada.


O processo de reenvio de dados seguirá o mesmo modo e regras detalhadas nos requisitos que descrevem as integrações entre os sistemas TOTVS e o barramento FIERGS.


Cada registro do monitor de log de integrações com status “Erro” e que não tenham atingido o limite máximo de tentativas de reenvio, serão agrupados e processados da seguinte forma:

  • Consulta ao banco de dados, de acordo com a funcionalidade, informando a chave primária que estará contida no registro do monitor de log da integração;
  • Acionamento do serviço customizado correspondente ao sistema TOTVS e a funcionalidade a ser integrada passando os dados previamente formatados;
  • Aguarda processamento e retorno do barramento FIERGS;

Atualiza o log de processamento. Em caso de erro atualiza contador de erro do registro.





Histórico de Atualização do Documento

Autor

Versão

Data

Descrição das Alterações

 

Adilson José de Aquino

1.0

Documento inicial.