Projeto: FS007782 (873247-874083) – Integrações com AVA, WIFI, Moodle (SESI-SENAI)
Nome do cliente: FIERGS
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 | |||||
---|---|---|---|---|---|
| |||||
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:
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.
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:
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:
|
Expandir | ||
---|---|---|
| ||
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.
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:
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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
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:
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á:
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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Pré-requisitos
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:
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á:
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 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Pré-requisitos
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:
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á:
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
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:
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á:
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 | ||
---|---|---|
| ||
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
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:
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á:
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 | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
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:
Usuário com papel de Professor:
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.
|