Projeto: TOTVS Educacional x LMS
Nome do Cliente: CNI Confederação Nacional da Indústria
Data: 20/04/2018





Sumário
Objetivo Desse Documento
Síntese
Instalando a Customização
Parametrização CNI
Cadastro do Grupo Pai LMS
Cadastro do Domínio LMS
Processo Customizado de Exportação de Curso (Matriz Aplicada)
Processo Customizado de Exportação de Turma e Turma/Disciplina
Processo Customizado Exportação de Professores
Processo Customizado de Exportação de Aluno
Processo Customizado de Exportação de Matrícula do Aluno Disciplina
Processo Customizado de Exportação de Situação de Matrícula do Aluno
Processo Customizado de Importação de Notas de Avaliações (EJA)
Processo Customizado de Importação de Frequência
Processo Customizado Importação de Avaliações em Turmas/Disciplinas
Processo Customizado de Exportação da Mudança de Turma
Monitor de Log
Histórico de Atualização do Documento

Objetivo Desse Documento

Prezados Senhores,
O documento 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 nos documentos:

• Especificacao Anexo I - Detalhamento Funcional - FS007361
  • Análise de Impacto - FS007361
  • Análise de Impacto II - FS007361
  • Análise de Impacto III - FS007361
  • Análise de Impacto IV - FS007361
  • Análise de Impacto V - FS007361
• Especificacao Anexo I - Detalhamento Funcional - FS007608
• Especificacao Anexo I - Detalhamento Funcional - FS007623
• Especificacao Anexo I - Detalhamento Funcional - FS007625

Síntese

O objetivo desta customização é prover recursos a CNI para interação entre os sitemas TOTVS Educacional e LMS Time to Know.

Instalando a Customização

Ambiente necessário
Sistema Operacional: Windows XP / Vista / 7
Banco de Dados: SQL Server ou Oracle
Versão do ERP RM: 11.83 / 12.1.17
Esse documento não visa exemplificar a instalação da customização. Para maiores informações sobre como é o processo de instalação você deve acessar o seguinte link: {*}http://tdn.totvs.com/x/oAdFFw*. Se após a execução dos itens listado no documento do TDN você não conseguir instalar a customização você deve entrar em contato com a equipe da Fábrica de Software.
Para configuração do IIS da aplicação wsTotvs você deve acessar o seguinte link: {*}http://tdn.totvs.com/x/WTPHG*.

Parametrização CNI

Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos.

Descrição do Processo

Esta tela permitirá o cadastro dos parâmetros necessários para efetuar a integração com o sistema LMS

Detalhamento do Processo

No TOTVS Educacional, por meio do menu "Parâmetros", o usuário administrador efetuará as parametrizações referentes ao processo.

Deverão ser parametrizados as seguintes informações:

Dados Gerais

• Situação de Matrícula - Matrícula:

Situações de matrícula que serão utilizadas para informar quais Alunos serão enviados para o LMS. Para os processos de alteração de Matrícula pelo menos uma situação de matrícula deverá estar parametrizada.
A figura abaixo é ilustrativa e as situações de matrícula devem ser consultadas no manual de Processos disponibilizado pela equipe do projeto.

Status de Matrícula

• Situação de Matrícula - Inativar Matrícula LMS: Situações de matrícula que serão utilizadas para informar quais Alunos serão retirados do LMS. Para os processos de alteração de Matrícula pelo menos uma situação de matrícula deverá estar parametrizada.

A figura abaixo é ilustrativa e as situações de matrícula devem ser consultadas no manual de Processos disponibilizado pela equipe do projeto.

Status de Inativar Matrícula no LMS

Cadastro do Grupo Pai LMS

Pré-Requisitos / Parametrizações

Para cadastro do Grupo Pai LMS será necessário criar uma tabela dinâmica, como a da imagem a baixo:

Para os itens da tabela dinâmica você deverá informar 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 permitirá o cadastro do Grupo Pai LMS da matriz aplicada. Esse valor será 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 você terá a opção de informar qual o Grupo Pai LMS para essa matriz aplicada.

Cadastro do Domínio LMS

Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos.

Descrição do Processo

Esta tela permitirá o cadastro do Domínio LMS da modalidade do curso. Esse valor será 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 você terá a opção de informar qual o Domínio LMS para essa modalidade.

Processo Customizado de Exportação de Curso (Matriz Aplicada)

Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos

Descrição do Processo

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

Detalhamento do Processo

O envio será feito no momento do cadastro da Turma/Disciplina, caso esta seja a Distancia ou Semi-Presencial, será enviada o Curso.
Para envio do curso será necessário informa o domínio LMS a qual esse curso pertence. Para isso, será necessário informa, no anexo "Dominio LMS" do cadastro de modadalide do curso, qual é domínio LMS da modalidade, dessa forma o curso pertence ao domínio informado na sua modalidade.
E no momento da alteração das informações do curso, caso este tenha vinculo com alguma Turma/disciplina a distancia ou Semi Prensencial, as informações serão enviadas para atualização.
Serão enviada as seguintes informações:

Processo Customizado de Exportação de Turma e Turma/Disciplina

Pré-Requisitos / Parametrizações

Somente serão exportadas turmas/disciplinas a distância ou semi-presencial.
Deverá ser criado um campo complementar de turma/disciplina, com o código ETAPALMS, validado por tabela dinâmica. Neste campo complementar o usuário deverá informar qual é a etapa de notas do LMS, ou seja, a etapa de provas on-line. A tabela dinâmica deverá ter os itens cadastrados de acordo com o número das possíveis etapas de notas existentes no TOTVS Educacional. Este campo será considerado para identificar a etapa na importação de Notas.

Descrição do Processo

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

Detalhamento do Processo

Será feito o envio das informações da Turma e Turma Disciplina, e será feito o vinculo, da Disciplina -> Turma e da Turma ao Curso, no momento do envio.

Serão enviada as seguintes informações da Turma:

Turma/Disciplina:

Vinculo da Turma ao Curso:

Vinculo da Disciplina a Turma:

Processo Customizado Exportação de Professores

Pré-Requisitos / Parametrizações

Somente serão enviados ao LMS professores vinculados a uma Turma/Disciplina a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').

Descrição do Processo

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

Detalhamento do Processo

O processo customizado será acionado quando um usuário vincular um professor a uma turma/disciplina, em Turmas/Disciplinas/Anexos/Professores.
Após ser exportado o professor irá acessar o sistema LMS com o seu login sendo o seu CPF é a senha "123456". Essa e temporária e deve ser alterada após primeiro acesso do professor.



Serão enviada as seguintes informações referente ao professor:

Serão enviada as seguintes informações referente ao vinculo do Professor a Turma/Disciplina:

Processo Customizado de Exportação de Aluno

Pré-Requisitos / Parametrizações

Somente serão exportados alunos que esta matriculados em turmas/disciplinas a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').

Descrição do Processo

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

Detalhamento do Processo

No momento que for efetuado a matricula de um aluno em uma turma que for a distancia ou semi-presencial, será enviado o aluno para o LMS.
Após ser exportado o aluno irá acessar o sistema LMS com o seu login sendo o e-mail é a senha sendo seu CPF. Essa e 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 distancia ou semi-presencial e seja alterado alguma informação do cadastro, este será enviado para atualização no LMS.

Serão enviada as seguintes informações:

Processo Customizado de Exportação de Matrícula do Aluno Disciplina

Pré-Requisitos / Parametrizações

Somente serão exportadas matrículas vinculados a turmas/disciplinas a distância ou semi-presencial.(STURMADISC.TIPO = 'D' ou 'S').
Somente serã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 será enviado matrícula do aluno em uma disciplina com o sistema LMS da Time to Know.O processo customizado será acionado quando um usuário executar o processo "Matricular Aluno nasDisciplinas", disponível em Matrícula e Avaliação /Matrícula.
Quando o usuário executar o processo de matrícula do aluno e o registro for gravado com sucesso o TOTVS Educacional irá consumir o WS disponibilizado pela Time to Know, que 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 será integrado com o LMS.

Detalhamento do Processo

O processo customizado será acionado ao executar o processo de Matrícula do Aluno na Disciplina através do caminho Alunos->Anexos->Matrícula no Período Letivo->Processos-> Matricular Alunos nas Disciplinas.
Além do processo descrito acima os seguintes processos será realizado a integração de matrículas de alunos no LMS:

• 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

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

Processo Customizado de Exportação de Situação de Matrícula do Aluno

Pré-Requisitos / Parametrizações

Somente serã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 (ZSTATUSALTMAT.CODSTATUS = SMATRICULA.CODSTATUS).

Processo Customizado Importação de Notas em Etapa (ECO)

Pré-Requisitos / Parametrizações

Configurar web-service.

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.
A nota será sempre importada para a etapa final (SETAPAS.ETAPAFINAL='S') das etapas de notas da turma/disciplina enviada no arquivo e SNOTAETAPA.TIPOETAPA='N'.
Estrutura do arquivo XML:
<INCLUIRNOTAETAPA>
<SNOTAETAPA>
<CODCOLIGADA></CODCOLIGADA>
<IDTURMADISC></IDTURMADISC>
<NOTAFALTA></NOTAFALTA>
<RA></RA>
</SNOTAETAPA>
</INCLUIRNOTAETAPA>
Exemplo de XML preenchido:
<INCLUIRNOTAETAPA>
<SNOTAETAPA>
<CODCOLIGADA>1</CODCOLIGADA>
<IDTURMADISC>D1724</IDTURMADISC>
<NOTAFALTA>10</NOTAFALTA>
<RA>M-PROF-1</RA>
</SNOTAETAPA>
</INCLUIRNOTAETAPA>
Tipos de dados:

Processo Customizado de Importação de Notas de Avaliações (EJA)

Pré-Requisitos / Parametrizações

Configurar web-service, conforme item 1.8

Descrição do Processo

O método customizado, no WebService TOTVS, vai receber um arquivo XML com as informações de notas de avaliações e executará a inclusão das notas de avaliações 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 a notas de avaliações 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 do serviço:
public string IncluirNotaAvaliacao (xml ArquivoXML)
O método terá a seguinte estrutura:

Ao consumir este método, o arquivo XML será processado, incluindo ou alterando as notas dos alunos das avaliações, 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 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 notas de avaliações, que realizará a inclusão ou alteração da nota do aluno. Caso não exista lançamento de nota para o aluno na avaliação será considerado uma inclusão, ou se já existir nota lançada esta será substituída pelo valor informado no arquivo XML.
Na tabela abaixo estão os dados que devem ser enviados no arquivo XML:

O campo TIPOETAPA da tabela SNOTAS será preenchido sempre com 'N'.
O campo CODETAPA da tabela SNOTAS será preenchido de acordo com o código da etapa de notas do LMS, que será identificado atavés do campo complementar de turmas/disciplinas ETAPALMS. Será verificado através do código da turma/disciplina enviada no arquivo qual o código da etapa informada no campo complementar ETAPALMS.
Estrutura do arquivo XML:
<INCLUIRNOTAAVALIACAO>
<SNOTAS>
<CODCOLIGADA></CODCOLIGADA>
<IDTURMADISC></IDTURMADISC>
<NOTA></NOTA>
<CODPROVA></CODPROVA>
<RA></RA>
</SNOTAS>
</INCLUIRNOTAAVALIACAO>
Exemplo de XML Preenchido:
<INCLUIRNOTAAVALIACAO>
<SNOTAS>
<CODCOLIGADA>1</CODCOLIGADA>
<IDTURMADISC>D1724</IDTURMADISC>
<NOTA>5</NOTA>
<CODPROVA>2</CODPROVA>
<RA>M-PROF-1</RA>
</SNOTAS>
</INCLUIRNOTAAVALIACAO>

Processo Customizado de Importação de Frequência

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>

Processo Customizado Importação de Avaliações em Turmas/Disciplinas

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'.
A avaliação será inserida na etapa (SPROVAS.CODETAPA) de acordo com o código da etapa de notas do LMS, que será identificado atavés do campo complementar de turmas/disciplinas ETAPALMS. Será verificado através do código da turma/disciplina enviada no arquivo qual o código da etapa informada no campo complementar ETAPALMS.
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>

Processo Customizado de Exportação da Mudança de Turma

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.

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:

Monitor de Log

Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos.

Descrição do Processo

No menu customização do TOTVS Educacional esta disponível o processo "Monitor de Log – TOTVS Educacional com LMS", neste processo o usuário poderá consultar o LOG das operação de importação e exportação executadas pela integração e executar o reenvio dos registros do tipo exportação.

Detalhamento do Processo

Este cadastro será possível efetuar apenas a consulta das informações, não sendo possível editar os dados.
Os seguintes campos serão exibidos na visão "Monitor de Log – TOTVS Educacional com LMS":

Esta visão será apenas de "leitura", não possibilitando ao usuário fazer qualquer tipo de manutenção nos registros, ou seja, inclusão, edição e exclusão.
Nesta visão o usuário poderá efetuar o reenvio dos registros com status "E". Para isto deverá selecionar os registros com erro e acessar Processos -> Reenvio de Registros.
Ao executar o processo a rotina customizada irá consumir o WS de acordo com o processo do registro. A identificação do registro a ser enviado será de acordo com o campo Chave, e o tipo de processo será identificado através com o campo Processo.
Quando um registro for reenviado, o campo REPROCESSADO da tabela ZLOGLMS será alterado para "True" e será gerado outro registro detalhando o reenvio. Somente poderão ser reenviados registros com o campo REPROCESSADO igual a "False".

Histórico de Atualização do Documento

Histórico de Versões