Manual Operacional da Customização - TOTVS Educacional x LMS - SENAI

Pré-requisitos

Não se aplica.

Descrição do processo

Tela para que o usuário defina todos parâmetros necessários para efetuar a integração com o sistema LMS

Detalhamento do processo

No menu TOTVS Educacional | Customização | Parâmetros, o usuário administrador consegue efetuar as parametrizações referentes ao processo. 

São eles:

• Dados de Conexão - Web Service

• Status de Matrícula - Matrícula: Situações de matrícula que identificam quais alunos devem ser enviados para o LMS. Para os processos de alteração de matrícula pelo menos uma situação de matrícula deve estar parametrizada. A figura abaixo é ilustrativa e o regional deve parametrizar as situações que serão enviadas para o LMS.

• Status de Matrícula - Inativar Matrícula LMS: Situações de matrícula que são utilizadas para informar quais Alunos são retirados do LMS. Para os processos de alteração de Matrícula pelo menos uma situação de matrícula deve estar parametrizada. A figura abaixo é ilustrativa e o regional deve parametrizar as situações que serão retiradas do LMS.

• Modalidade: Parâmetro utilizado para informar quais modalidades de cursos são enviadas para o LMS. A figura abaixo é ilustrativa e o regional deve parametrizar as modalidades que serão integradas com o LMS.

Pré-requisitos

Para cadastro do Grupo Pai LMS é necessário criar uma tabela dinâmica, como a da imagem abaixo. Os itens da tabela dinâmica devem estar de acordo com o que foi cadastrado no LMS, sendo o código do grupo no LMS o código do item no SGE.

Descrição do processo

Esta tela permite o cadastro do Grupo Pai LMS da matriz aplicada. Esse valor é usado para identificar a qual grupo Pai LMS essa matriz aplicada pertence no sistema LMS. Essa cadastro não é obrigatório caso o regional não utilize o conceito de Grupo Pai LMS.

Detalhamento do processo

Ao acessar a matriz aplicada, em anexo é possível informar qual o Grupo Pai LMS para essa matriz aplicada.

Pré-requisitos

Somente são enviados ao LMS professores vinculados a uma Turma/Disciplina a distância ou semi-presencial.

Descrição do processo

O processo customizado envia as informações de professores com o sistema LMS da Time do Know.

Detalhamento do processo

O processo customizado é acionado quando um usuário vincula um professor a uma turma/disciplina, no menu Currículo e Oferta | Turmas/Disciplinas | Anexos | Professores. Após ser exportado, o professor consegue acessar o sistema LMS com o seu login sendo o seu CPF e a senha “123456”. Essa senha é temporária e deve ser alterada após primeiro acesso do professor.

São enviadas as seguintes informações referente ao professor:

São enviadas as seguintes informações referente ao vínculo do Professor à Turma/Disciplina:

A partir da versão 2.0 (Janeiro/2019), a customização envia as seguintes informações:

Pré-requisitos

Somente são exportados alunos que estão matriculados em turmas/disciplinas à distância ou semi presencial.

Descrição do processo

Este processo envia as informações do Aluno para o Sistema LMS via WebService.  

Detalhamento do processo

No momento em que a matrícula de um aluno é efetuada em uma turma a distância ou semi-presencial, o aluno é enviado para o LMS. Após ser exportado, o aluno consegue acessar o sistema LMS com o seu login sendo o e-mail e a senha sendo seu CPF. Essa senha é temporária e deve ser alterada após primeiro acesso do aluno.

No cadastro do Aluno, caso este esteja matriculado em alguma turma/disciplina a distância ou semi-presencial e alguma informação do cadastro é alterada, o aluno é enviado para atualização no LMS.

São enviada as seguintes informações:           

• Pré-Requisitos / Parametrizações

Somente são exportadas matrículas vinculadas a turmas/disciplinas a distância ou semi- presencial.(STURMADISC.TIPO = ‘D’ ou ‘S’).

Somente são exportados para o LMS matrícula de alunos nos status parametrizados na tabela ZMATSTATUS, no campo Status de Matrícula-Matrícula, conforme Req.01.(ZMATSTATUS.CODSTATUS = SMATRICULA.CODSTATUS).

• Descrição do Processo

Através do processo customizado, a matrícula do aluno em uma disciplina é enviada para o sistema LMS da Time to Know.  O processo customizado é acionado quando um usuário executa o processo “Matricular Aluno nas Disciplinas”, disponível em Matrícula e Avaliação /Matrícula.

Quando o usuário executa o processo de matrícula do aluno e o registro é gravado com sucesso, o TOTVS Educacional consome o WS disponibilizado pela Time to Know, que deve estar parametrizado na tela de parâmetros da customização (Req. 01). Se a matrícula do aluno na disciplina não for finalizada no TOTVS Educacional, este não é integrado com o LMS.

• Detalhamento do Processo

O processo customizado é acionado ao executar o processo de Matrícula do Aluno na Disciplina , através do menu Currículo e Oferta | Alunos | Anexos | Matrícula no Período Letivo | Processos | Matricular Alunos nas Disciplinas. Além do processo descrito acima, também é realizado a integração de matrículas de alunos no LMS por meio dos processos:

• Alterar situação de matrícula

Alunos->Anexos->Matrículas no Período Letivo->Processos-> Alterar Situação de Matrícula

Matrículas-> Processos->Matricular Aluno nas Disciplinas->-Processos-> Alterar situação de matrícula no período  letivo

Matrícula e Avaliação->Matrículas->-Processos-> Alterar Situação de Matrícula

Matrícula e Avaliação->Matrículas->Anexos ->Matrícula em Disciplinas->Processos ->Alterar Situação de Matrícula 

• Matrícula no período letivo

Aluno -> Anexos -> Matrícula no Período Letivo -> Processos->Alterar Situação de Matrícula

• Enturmação

Matrícula e Avaliação -> Enturmação

• Confirmação de matrícula por pagamento

Matrícula e Avaliação -> Matrícula -> Confirmação de Matrícula por Pagamento

• Matrícula Isolada

 Matrícula e Avaliação -> Matrícula Isolada

Aluno->Anexos->Matrícula Isolada 

• Matrícula de Disciplinas em Lote

 Matrícula e Avaliação -> Mais - > Matrícula de Disciplinas em Lote 

• Rematrícula

 Matrícula e Avaliação -> Rematrícula

São enviadas as seguintes informações para vincular o Aluno a turma/disciplina:

• Pré-Requisitos / Parametrizações

Somente são exportados para o LMS alteração de matrícula de alunos nos status parametrizados na tabela ZSTATUSALTMAT, no campo Status de Matrícula-Alteração de Matrícula, conforme Req.01.ZSTATUSALTMAT.CODSTATUS = SMATRICULA.CODSTATUS).

• Pré-Requisitos / Parametrizações

É importante que no LMS haja uma diferenciação entre as Avaliações que devem ou não ser exportadas para o TOTVS EDUCACIONAL. Ou seja, apenas as Etapas que possuem Avaliações de acordo com o Rendimento Escolar do DR terão Avaliações enviadas do LMS para o TOTVS EDUCACIONAL. Para haver esta diferenciação é necessário que as Avaliações que devem ser enviadas possuam o prefixo A#E#, onde ‘#’ é o código da Avaliação e da Etapa respectivamente. Avaliações que não devem ser enviadas para o TOTVS EDUCACIONAL (Nota direto na Etapa) devem possuir o prefixo E#, no qual # é o código da Etapa.

• Descrição do Processo

O Web Service utiliza o protocolo/tecnologia SOAP, onde é necessário autenticação e possibilita a transferência de mensagens em formato XML para uso em  ambientes distribuídos e que atende a diversas plataformas com mensagens personalizadas.

O método disponibilizado no webservice receberá como parâmetro um arquivo XML, onde este conterá as informações de alunos e a notas a serem processados,e efetuará os tratamentos necessários para realizar a operação solicitada (inclusão/alteração) no TOTVS Educacional.

• Detalhamento do Processo

O processo de inclusão de notas etapas possui a seguinte a assinatura:

Ao consumir este método, o arquivo XML será processado, incluindo ou alterando as notas dos alunos na etapa através do processo nativo do TOTVS Educacional, de acordo com as informações passadas no XML. Todas as validações serão do processo nativo de inclusão de notas na etapa.

O processo customizado irá receber o arquivo XML e enviar as informações do arquivo para o serviço nativo de inclusão de notas, 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 informado no arquivo XML.

O campo CODPROVA determinará se a nota será gravada na Etapa ou na Avaliação dependendo da estrutura do código enviado.

Caso o código possua a estrutura E + Código da Etapa, a nota será gravada na Etapa (SNOTAETAPA). Se o código for A + Código da Prova + E + Código da Etapa, a nota será gravada na Avaliação (SNOTAS).

No exemplo abaixo segue a estrutura do arquivo XML que deverá ser enviado no caso de uma Nota de Etapa:

<INCLUIRNOTAAVALIACAO>

<SNOTAS>

<CODCOLIGADA>3</CODCOLIGADA>

<IDTURMADISC>D29205</IDTURMADISC>

<NOTA>78</NOTA>

<CODPROVA>E1</CODPROVA>

<RA>99144488</RA>

</SNOTAS>

</INCLUIRNOTAAVALIACAO>

No exemplo abaixo segue a estrutura do arquivo XML que deverá ser enviado no caso de uma Nota de Avaliação:

<INCLUIRNOTAAVALIACAO>

<SNOTAS>

<CODCOLIGADA>3</CODCOLIGADA>

<IDTURMADISC>D29205</IDTURMADISC>

<NOTA>78</NOTA>

<CODPROVA>A1E1</CODPROVA>

<RA>99144488</RA>

</SNOTAS>

</INCLUIRNOTAAVALIACAO>

Tipos de dados:

• Pré-Requisitos / Parametrizações

Configurar web-service, conforme requisito item 1.8.

• Descrição do Processo

O método customizado, no WebService TOTVS,  receberá um arquivo XML com informações de faltas na etapa e executará a inclusão de frequência (faltas) para os alunos no TOTVS Educacional.

O Web Service utiliza o protocolo/tecnologia SOAP, onde é necessário autenticação e possibilita a transferência de mensagens em formato XML para uso em  ambientes distribuídos e que atende a diversas plataformas com mensagens personalizadas.

• Detalhamento do Processo

O método disponibilizado no webservice receberá como parâmetro um arquivo XML, onde este conterá as informações de alunos e faltas a serem processados,e neste caso, efetuará os tratamentos necessários para realizar a operação solicitada (inclusão/alteração) no TOTVS Educacional.

Assinatura e estrutura do serviço:

Ao consumir este método, o arquivo XML será processado,incluindo ou alterando as faltas dos alunos na etapa através do processo nativo do TOTVS Educacional, de acordo com as informações passadas no XML. Todas as validações serão do processo nativo de inclusão de faltas na etapa.

Na tabela abaixo estão os dados que devem ser enviados no arquivo XML:

No exemplo abaixo segue a estrutura do arquivo XML que deverá ser enviado:

<INCLUIRFREQUENCIAETAPA>

     <SNOTAETAPA>

   <CODCOLIGADA></CODCOLIGADA>

   <IDTURMADISC></IDTURMADISC>

   <NOTAFALTA></NOTAFALTA>

   <RA></RA>

</SNOTAETAPA>

</INCLUIRFREQUENCIAETAPA>

Exemplo XML preenchido:

<INCLUIRFREQUENCIAETAPA>

   <SNOTAETAPA>

          <CODCOLIGADA>1</CODCOLIGADA>

          <IDTURMADISC>D1724</IDTURMADISC>

          <NOTAFALTA>10</NOTAFALTA>

          <RA>M-PROF-1</RA>

   </SNOTAETAPA>

</INCLUIRFREQUENCIAETAPA>

• Pré-Requisitos / Parametrizações

Configurar web-service, conforme item 1.8.

• Descrição do Processo

O método customizado, no WebService TOTVS, receberá um arquivo XML com  as  informações de avaliações e executará a inclusão das avaliações em turmas/disciplinas no TOTVS Educacional.

O Web Service utiliza o protocolo/tecnologia SOAP, onde é necessário autenticação e  possibilita a transferência de mensagens em formato XML para uso em  ambientes distribuídos e que atende a diversas plataformas com mensagens personalizadas.

• Detalhamento do Processo

O método disponibilizado no webservice receberá como parâmetro um arquivo XML, onde este conterá as   informações de avaliações a serem incluídas,e neste caso, efetuará os tratamentos necessários para realizar a operação solicitada (inclusão) no TOTVS Educacional.

                O método terá a seguinte estrutura:

Ao consumir este método, o arquivo XML será processado, incluindo a avaliação em uma turma/disciplina, através do processo nativo do TOTVS Educacional, de acordo com as informações passadas no XML. Todas as validações serão do processo nativo de inclusão de avaliações.

O processo customizado irá receber o arquivo XML e enviar as informações do arquivo para o serviço nativo de inclusão de avaliações, que realizará a inclusão da avaliação na turma/disciplina.

Na tabela abaixo estão os dados que devem ser enviados no arquivo XML:

O campo TIPOETAPA da tabela SPROVAS será preenchido sempre com ‘N’.     

                No exemplo abaixo segue a estrutura do arquivo XML que deverá ser enviado:

       <INCLUIRAVALIACAO>

     <SPROVAS>

   <CODCOLIGADA></CODCOLIGADA>

   <IDTURMADISC></IDTURMADISC>

   <DESCRICAO></DESCRICAO>

   <CODPROVA></CODPROVA>

   <VALOR></VALOR>

   <DTPREVISTA></DTPREVISTA>

   <MEDIA></MEDIA>

</SPROVAS>

   </INCLUIRAVALIACAO>

Exemplo XML preenchido:

       <INCLUIRAVALIACAO>

       <SPROVAS>

          CODCOLIGADA>1</CODCOLIGADA>

          <IDTURMADISC>D1724</IDTURMADISC>

          <DESCRICAO>TESTE 123</DESCRICAO>

          <CODPROVA>3</CODPROVA>

          <VALOR>3</VALOR>

          <DTPREVISTA>21/09/2015</DTPREVISTA>

          <MEDIA>12</MEDIA>

        </SPROVAS>

</INCLUIRAVALIACAO>             

• Pré-Requisitos / Parametrizações

Somente serão exportados para o LMS a alteração de turma com status destino parametrizados na tabela ZMATSTATUS, no campo Status de Matrícula-Matrícula, conforme Req.01.

• Descrição do Processo

O processo customizado vai integrar o processo de alteração de turma dos alunos do TOTVS Educacional com o sistema LMS da Time do Know.

O processo customizado será acionado quando um usuário executar o processo nativo “Mudar Turma”, disponível em Matrícula/Processos/Mudar Turma.

• Detalhamento do Processo

O aluno será excluído da turma origem através do método DetachUserToGroup será incluído na nova turma  através do processo AttachUserToGroup.

Caso turma/disciplina origem seja do tipo a distância ou semi-presencial, e a turma destino não, será executado somente  a exclusão do aluno da turma (DetachUserToGroup). 

Caso a turma/disciplina origem não seja do tipo a distância ou semi-presencial, e a turma destino sim, será executado somente a inclusão na turma (AttachUserToGroup).               

Se tanto origem quanto destino forem do tipo a distância ou semi-presencial serão executados a exclusão da turma de origem e a inclusão a turma de destino.

Informações que serão enviadas:

• Pré-Requisitos / Parametrizações

Processo disponível a partir da versão 2.0 (Janeiro/2019). Pode ser utilizado para Turmas/Disciplinas já integradas com o LMS.

• Descrição do Processo

Este processo é responsável por atualizar no LMS o vínculo dos Alunos das Turmas/Disciplinas selecionadas via WebService.              

• Detalhamento do Processo

O objetivo desse processo é apresentar uma contingência para integração de alunos entre o SGE e LMS, permitindo que os alunos sejam vinculados ou desvinculados a qualquer momento, de acordo com as regras já existentes. Ele se faz necessário em situações como a de uma turma/disciplina cadastrada como presencial que já possui alunos matriculados e, em algum momento, a turma/disciplina é modificada para semi-presencial ou à distância. O processo está disponível em TOTVS Educacional | Currículo e Oferta | Turmas/Disciplinas | Processos, menu “Vincular/Desvincular Alunos com LMS”.

O usuário deve selecionar as Turmas/Disciplinas desejadas e executar o processo. A customização utiliza as regras já existentes de situação de matrícula para definir se o aluno será vinculado ou desvinculado da Turma no LMS.

Pré-requisitos

Não se aplica.

• Descrição do Processo

Criação do menu TOTVS Educacional | Customização | Monitor de Log – TOTVS Educacional com LMS. Neste processo o usuário consegue consultar o LOG das operações de importação e exportação executadas pela integração e executar o reenvio dos registros do tipo exportação.

• Detalhamento do Processo

Na tela "Monitor de Log – TOTVS Educacional com LMS" é possível efetuar apenas a consulta das informações, não sendo possível editar os dados. Os campos abaixo são exibidos na visão:

O usuário consegue efetuar o reenvio dos registros com status “E”, selecionando os registros com erro e acessando Processos | Reenvio de Registros. Ao executar o processo a rotina customizada consome o WS de acordo com o processo do registro. A identificação do registro a ser enviado é de acordo com o campo Chave e o tipo de processo é identificado através do campo Processo.Quando um registro é reenviado, o campo REPROCESSADO é alterado para “True” e é criado um novo registro detalhando o reenvio. Somente podem ser reenviados registros com o campo REPROCESSADO igual a “False”.