Projeto: TOTVS Educacional x LMS
Nome do Cliente: CNI Confederação Nacional da Indústria

O manual a seguir tem por objetivo orientar o usuário da integração entre os sistemas TOTVS Educacional e LMS Time to Know. Todas as funcionalidades descritas neste manual têm como base do que está descrito nos documentos:

• Especificação 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
• Especificação Anexo I - Detalhamento Funcional - FS007608
• Especificação Anexo I - Detalhamento Funcional - FS007623
• Especificação Anexo I - Detalhamento Funcional - FS007625

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 sua data de nascimento sem nenhum caracteres especias (10101195). 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 (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 nas Disciplinas", 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.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:

Histórico de Atualização do Documento: