Pré-requisitos

No TOTVS Serviços Globais, por meio do menu Customização | Controle de customizações ativas, verificar se a customização Lib CNI e Integração LMS está ativada.

ATENÇÃO: Para correto funcionamento da Integração LMS, é necessário configurar também a Integração Google, deixando o campo Ativada marcado ou desmarcado de acordo com a utilização dessa customização.

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 | Sistema Indústria | Parâmetros, o usuário administrador consegue efetuar as parametrizações referentes ao processo de integração.

São eles:

• Dados de Conexão - Web Service

Endereço do WebService: endereço do Web Service - disponibilizado pelo LMS

Endereço do WebService de Consulta: endereço do WebService de Consulta - Para atender os Regionais que não atuam com a customização do CTM e na necessidade  de consultar os alunos que já foram exportados ao LMS.

Usuário: usuário com acesso ao Web Service - disponibilizado pelo LMS

Senha: senha do usuário - disponibilizado pelo LMS

• 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

Não se aplica.

Descrição do processo

Esta tela permite o cadastro do Domínio LMS da modalidade do curso. Esse valor é usado para identificar a qual domínio a modalidade será cadastrada no sistema LMS.

Detalhamento do processo

Ao acessar a modalidade do curso, em anexo é possível informar qual o Domínio LMS para essa modalidade.

Pré-requisitos

Não se aplica.

Descrição do processo

Este processo envia as informações do Curso para o Sistema LMS via Web Service.

Detalhamento do processo

O envio é feito no momento do cadastro da Turma/Disciplina. Caso esta seja a Distância ou Semi-Presencial, é enviado o Curso. Para envio do curso é necessário informar o domínio LMS a qual esse curso pertence. Para isso, é necessário informar no anexo “Domínio LMS” do cadastro de modalidade do curso, qual é domínio LMS da modalidade, dessa forma o curso pertence ao domínio informado na sua modalidade.

No momento da alteração das informações do curso, caso este tenha vínculo com alguma Turma/disciplina do tipo À Distância ou Semi-Presencial, as informações são enviadas para atualização.

Ao realizar alguma inclusão e/ou alteração nos campos Descrição, Data de Início e/ou Data Término de uma Matriz Curricular que esteja no domínio LMS, essas informações são enviadas para atualização.

São enviadas as seguintes informações:

Pré-requisitos

Somente são exportadas turmas/disciplinas à distância ou semi-presencial e que estiverem com a opção do campo complementar turma/disciplina Não Enviar ao LMS desmarcado.

O campo complementar na turma/disciplina é criado através do script disponibilizado no pacote de instalação, porém, será necessário liberar a visualização do campo por nível de ensino.

1- Acessar o TOTVS Educacional SGE → clique em configurações → Nível de Ensino → Campos Complementares Disponíveis e conferir se o campo complementar Não Enviar ao LMS está ativo na base de dados. Caso esteja desabilitado, será necessário habilitá-lo.

Descrição do processo

Este processo envia as informações da Turma e Turma/Disciplina para o Sistema LMS via Web Service.

Detalhamento do processo

É feito o envio das informações da Turma e Turma Disciplina, e é feito o vínculo, da Disciplina -> Turma e da Turma ao Curso, no momento do envio.

Quando o parâmetro “Não enviar ao LMS” no campo complementar da Turma/Disciplina está marcado, não é realizado o envio da Turma/disciplinas e consequentemente também não envia os alunos e matrículas associados àquela turma/disciplina.

ATENÇÃO! Caso a turma/disciplina já tenha sido enviado para o LMS e o parâmetro “Não enviar ao LMS” seja desmarcado, a customização não realiza o cancelamento/exclusão das informações já enviadas ao LMS.

São enviadas as seguintes informações da Turma:

• Turma/Disciplina:

• Vínculo da Turma ao Curso:

• Vínculo da Disciplina à Turma:

Pré-requisitos

Somente são enviados ao LMS professores vinculados a uma Turma/Disciplina a distância ou semi-presencial e que tenha no campo complementar E-mail Google do seu cadastro preenchido para que seja exportado para o LMS.

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.

Para a integração, será validado se o E-mail do Google no campo complementar do Professor está preenchido.

• Endereço de E-mail Google preenchido: A customização realizará a integração do professor.
• Endereço de E-mail Google não preenchido com integração do Google ativa: A customização não realizará a integração do professor ao LMS.
• Endereço de E-mail Google não preenchido sem integração do Google: A customização deverá enviar o professor para o LMS, uma vez que o endereço de e-mail do campo complementar não será preenchido em nenhum momento.

Com essas validações, quando for utilizado as duas integrações: “Extração de dados Google” e “Integração SGE com LMS”, o processo garantirá que professores sejam integrados ao LMS somente após a criação do endereço de e-mail realizado pela customização de Extração de dados Google.

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 sua data de nascimento, sem nenhum caractere especial (ex.: 10111995). Essa senha é temporária e deve ser alterada após primeiro acesso do aluno. 

Para a integração, será validado se o E-mail do Google no campo complementar do aluno está preenchido.

• Endereço de E-mail Google preenchido: A customização realizará a integração do aluno.
• Endereço de E-mail Google não preenchido com integração do Google ativa: Caso elegível a integrar com o Google não realizará a integração do aluno ao LMS antes de ter integrado ao Google.
• Endereço de E-mail Google não preenchido sem integração do Google: A customização deverá enviar o aluno para o LMS, uma vez que o endereço de e-mail do campo complementar não será preenchido em nenhum momento.

• Identificação se o Aluno possui usuário no LMS: A customização verificará se o aluno já possui o registro de usuário no LMS e seguirá as seguintes ações:
  • Alunos que já possuem usuário no LMS: Não será gerado um novo usuário para o aluno e o campo complementar E-mail usuário LMS, será preenchido com o valor informado na consulta.
  • Alunos NÃO possuem usuário no LMS: Será gerado um novo usuário para o aluno e o campo complementar E-mail usuário LMS, será preenchido com o valor informado na consulta.
  • Alunos que já possuem usuário no LMS e houver atualização do e-mail: Para os alunos que já possuem usuário no LMS e que houver atualização no campo e-mail (PPESSOA.EMAIL), a customização atualizará no LMS o campo E-mail. O campo complementar E-mail usuário LMS não será atualizado, uma vez preenchido, quer dizer que o aluno já possui um usuário no LMS e não será criado um novo usuário para ele.

Com essas validações, quando for utilizado as duas integrações: “Extração de dados Google” e “Integração SGE com LMS”, o processo garantirá que alunos sejam integrados ao LMS somente após a criação do endereço de e-mail realizado pela customização de Extração de dados Google.

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

Somente são exportadas matrículas vinculadas a turmas/disciplinas a distância ou semi-presencial.

Somente são exportados para o LMS matrícula de alunos nos status parametrizados no campo Código Status da Matrícula (em parâmetros da customização → Status de Matrícula - Matrícula).

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

Somente são exportados para o LMS alteração de matrícula de alunos nos status parametrizados no campo Status de Matrícula - Matrícula.

Pré-requisitos

É 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#, em que ‘#’ é 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, em que é 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 web service recebe como parâmetro um arquivo XML, onde este conterá as informações de alunos e a notas a serem processados,e efetua 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 é 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 são do processo nativo de inclusão de notas na etapa.

O processo customizado recebe o arquivo XML e envia as informações do arquivo para o serviço nativo de inclusão de notas, que realiza 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 determina 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 é gravada na Etapa (SNOTAETAPA). Se o código for A + Código da Prova + E + Código da Etapa, a nota é 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

Configurar web-service, conforme Roteiro para Configuração do WebService.

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 web service 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

Configurar web-service, conforme Roteiro para Configuração do WebService.

Descrição do processo

O método customizado, no Web Service TOTVS, recebe um arquivo XML com as  informações de avaliações e executa 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 web service recebe como parâmetro um arquivo XML, onde este conterá as informações de avaliações a serem incluídas, e neste caso, efetua os tratamentos necessários para realizar a operação solicitada (inclusão) no TOTVS Educacional.

O método tem a seguinte estrutura:

Detalhamento do processo

Ao consumir este método, o arquivo XML é 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 são do processo nativo de inclusão de avaliações.

O processo customizado recebe o arquivo XML e envia as informações do arquivo para o serviço nativo de inclusão de avaliações, que realiza 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 é 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

Somente são exportados para o LMS a alteração de turma com status destino parametrizados no campo Status de Matrícula-Matrícula.

Descrição do processo

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

Detalhamento do processo

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

O aluno é excluído da turma origem através do método DetachUserToGroup e é 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, é 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, é executado somente a inclusão na turma (AttachUserToGroup). 

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

Informações enviadas:

Pré-requisitos

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

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

Para que o LMS possa acessar o Web Service disponibilizado pelo SGE será necessaário passar as seguintes informações:

1 - CodColigada: Código da coligada a ser utilizada na integração;
2 - CodUsuário: código do usuário para realização da autenticação SOAP;
3 - Senha: password do usuário para autenticação SOAP;
4 - URL: endereço do Web Service disponibilizado no SGE. Essa url tem a seguinte estrutura:
PROTOCOLO://SERVER/APLICACAO_IIS/CstImportarNotas.asmx

PROTOCOLO: http ou https, conforme configurado no ISS;
SERVER: nome do domínio definido na associação do site;

APLICACAO_IIS: nome de aplicativo no IIS, no caso do LMS sugerido como WSTotvs.

Para mais informações sobre a configuração do WebService e/ou modelo do arquivo Web.Config clique aqui