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



Image Added



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


Image Added


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)”:
    • Caso o parâmetro esteja marcado a customização gravará no log o pacote de integração;

Caso o parâmetro esteja desmarcado a customização não gravará no log o pacote de integração.



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.


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


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.


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.