Projeto: TOTVS Educacional x LMS
Nome do Cliente: CNI Confederação Nacional da Indústria
Data: 20/04/2018
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
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
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:
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||
---|---|---|
|
|
Âncora | ||||
---|---|---|---|---|
|
Esse processo não possui pré-requisitos.
Âncora | ||||
---|---|---|---|---|
|
Esta tela permitirá o cadastro dos parâmetros necessários para efetuar a integração com o sistema LMS
Âncora | ||||
---|---|---|---|---|
|
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:
Descrição
Endereço do web service: endereço do Web Service
Endereço do WebService- disponibilizado pelo LMS
Usuário
Usuário: usuário com acesso ao Web Service - disponibilizado pelo LMS
Senha
Senha: senha do usuário
do- disponibilizado pelo LMS
Dados Gerais
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
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
Âncora | ||||
---|---|---|---|---|
|
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.
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.
Ao acessar a matriz aplicada, em anexo você terá a opção de informar qual o Grupo Pai LMS para essa matriz aplicada.
Âncora | ||||
---|---|---|---|---|
|
Esse processo não possui pré-requisitos.
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
Ao acessar a modalidade do curso, em anexo você terá a opção de informar qual o Domínio LMS para essa modalidade.
Nota | ||
---|---|---|
| ||
O código do domínio para cada regional é disponibilizado pela equipe do LMS. |
Âncora | ||||
---|---|---|---|---|
|
Esse processo não possui pré-requisitos
Este processo envia as informações do Curso para o Sistema LMS via WebService.
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 "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.
E no momento da alteração das informações do curso, caso este tenha vinculo com alguma Turma/disciplina a distancia ou Semi-Presencial, as informações serão enviadas para atualização.
Serão enviada as seguintes informações:
Campo LMS (Details) | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
codcoligada | SHABILITACAOFILIAL.CODCOLIGADA | Código da Coligada | Smallint |
External_id | 'C' + SHABILITACAOFILIAL.IDHABILITACAOFILIAL | ID da Habilitação – Será concatenado a letra C para identificar que é um curso | Varchar |
name | SHABILITACAOFILIAL.CODCURSO + '-' | Nome do Curso | Varchar(60) |
classification | SMODALIDADECURSO.DESCRICAO | Modalidade do Curso | Varchar(60) |
Type | Fixo 'Course' | Fixo 'Course' | Fixo 'Course' |
Âncora | ||||
---|---|---|---|---|
|
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 ETAPANOTA. 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 ETAPANOTA 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. O campo complementar e tabela dinâmica são criados através do script disponibilizado no pacote de instalação, assim o usuário deve informar os valores da tabela dinâmica ETAPANOTA e ativar o campo complementar para o nível de ensino.
Este processo envia as informações da Turma e Turma/Disciplina para o Sistema LMS via WebService. Ao exportar Turma/Disciplinas que sejam da Nova EJA ou EJA Profissionalizante será adicionado o nome da Habilitação/Serie no nome da Turma/Disciplina.
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:
Campo LMS (Details) – UpdateGroup - Turma | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
Name | STURMA.CODTURMA + '-' STURMA.NOME | Nome da Turma | Varchar(60) |
external_id | 'T' + STURMA.IDFT | ID da turma- Será concatenado a letra 'T' para indicar que é uma turma | String |
open_date | STURMA.DTINICIAL | Data inicial | Datetime |
close_date | STURMA.DTFINAL | Data final | Datetime |
Type | Fixo 'Course' | Fixo 'Course' | Fixo 'Course' |
Turma/Disciplina:
Campo LMS (Details) – UpdateGroup – Turma/Disciplina | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
Name | STURMADISC.CODDISC + '-' | Nome do Curso | String |
external_id | 'D' + STURMADISC.IDTURMADISC | ID da turma/disciplina – Será concatenado a letra 'D' para indicar que é uma Disciplina | String |
codtemplate | SDISCGRADECOMPL.CODTEMPLATE | Código do Template do LMS | Varchar(20) |
open_date | STURMADISC.DTINICIAL | Data inicial | Datetime |
close_date | STURMADISC.DTFINAL | Data final | Datetime |
Type | Fixo 'Course' | Fixo 'Course' | Fixo 'Course' |
Vinculo da Turma ao Curso:
Campo LMS (Details) – | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
string ext_group_id | 'T' + STURMA.IDFT | Id da Turma | String |
string ext_parent_id | 'C' +SHABILITACAOFILIAL.IDHABILITACAOFILIAL | ID do Curso | String |
Vinculo da Disciplina a Turma:
Campo LMS (Details) – | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
string ext_group_id | 'D' +STURMADISC.IDTURMADISC | ID da Turma/Disciplina | String |
string ext_parent_id | 'T' +STURMA.IDFT | ID da Turma | String |
Âncora | ||||
---|---|---|---|---|
|
Somente serão enviados ao LMS professores vinculados a uma Turma/Disciplina a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').
O processo customizado envia as informações de professores com o sistema LMS da Time do Know.
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:
Campo LMS (Details) - UpdateUser | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
codcoligada | SPROFESSOR.CODCOLIGADA | Coligada | Smallint |
firstname | PPESSOA.NOME | Nome do Professor | Varchar(140) |
lastname | PPESSOA.NOME | Sobrenome do Professor | Varchar(140) |
PPESSOA.EMAIL | E-mail do Professor | Varchar(60) | |
External_id | SPROFESSOR.CODPROF | ID do Professor | Varchar(10) |
gender | PPESSOA.SEXO | Gênero do Professor | Varchar(1) |
username | PPESSOA.CPF | CPF do Professor | Varchar(11) |
address | PPESSOA.RUA | Endereço do Professor | Varchar(140) |
city | PPESSOA.CIDADE | Cidade do Professor | Varchar(32) |
state | PPPESSOA.ESTADO | Estado do Professor | Varchar(2) |
country | PPESSOA.PAIS | País do Professor | Varchar(60) |
birthday | PPESSOA.DTNASCIMENTO | Data de Nascimento | Datetime(8) |
bphone | PPESSOA.TELEFONE1 | Telefone Fixo | Varchar(15) |
mphone | PPESSOA.TELEFONE2 | Telefone Celular | Varchar(15) |
id | PPESSOA.CARTIDENTIDADE | RG do Professor | Varchar(15) |
Serão enviada as seguintes informações referente ao vinculo do Professor a Turma/Disciplina:
Campo LMS (Details) - AttachManager | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
ext_user_id | SPROFESSOR.CODPROF | Código do Professor | Varchar(10) |
ext_group_id | 'D' + STURMADISC.IDTURMADISC | ID da turma | String |
manager_type | SPROFESSORTURMA.TIPOPROF | SPROFESSORTURMA.TIPOPROF=NULL | Varchar(1) |
codcoligada | SPROFESSOR.CODCOLIGADA | Código da Coligada | Smallint |
set_primary | Fixo '0' | Fixo '0' | Fixo '0' |
Âncora | ||||
---|---|---|---|---|
|
Somente serão exportados alunos que esta matriculados em turmas/disciplinas a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').
Nota | ||
---|---|---|
| ||
Para que o aluno seja exportado para o LMS o mesmo deve ter um e-mail informado no seu cadastro. |
Este processo vai enviar as informações do Aluno para o Sistema LMS via WebService.
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:
Campo LMS (Details) | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
codcoligada | SMATRICULA.CODCOLIGADA | Código da Coligada | Smallint |
firstname | PPESSOA.NOME | Nome do Aluno. | Varchar(120) |
lastname | PPESSOA.NOME | PPESSOA.NOME | Varchar(120) |
PPESSOA.EMAIL | E-mail do Aluno | Varchar(60) | |
External_id | SMATRICULA.RA | ID do Aluno | Varchar(20) |
gender | PPESSOA.SEXO | Gênero do Aluno -'M' ou 'F' | Varchar(1) |
username | PPESSOA.EMAIL | PPESSOA.EMAIL | Varchar(60) |
address | Serão concatenados os campos:PPESSOA.RUA, | Endereço do Aluno | Varchar(288) |
city | PPESSOA.CIDADE | Cidade do Aluno | Varchar(32) |
state | PPPESSOA.ESTADO | Estado do Aluno | Varchar(2) |
country | PPESSOA.PAIS | País do Aluno | Varchar(60) |
birthday | PPESSOA.DTNASCIMENTO | Data de Nascimento | Datetime(8) |
bphone | PPESSOA.TELEFONE1 | Telefone Fixo | Varchar(15) |
mphone | PPESSOA.TELEFONE2 | Telefone Celular | Varchar(15) |
Password | PPESSOA.CPF | Somente os números | Varchar(11) |
id | PPESSOA.CARTIDENTIDADE | RG do Aluno | Varchar(15) |
Unidade Operacional | - | Não será enviado ao LMS | |
CPF | PPESSOA.CPF | Varchar(11) | |
Permitir tempo Extra | - | Não será enviado ao LMS |
Âncora | ||||
---|---|---|---|---|
|
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).
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.
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:
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
Aluno > Anexos -> Matrícula no Período Letivo -> Processos>Alterar Situação de Matrícula
Matrícula e Avaliação -> Enturmação
Matrícula e Avaliação -> Matrícula -> Confirmação de Matrícula por Pagamento
Matrícula e Avaliação -> Matrícula Isolada
Aluno->Anexos->Matrícula Isolada
Matrícula e Avaliação -> Mais - > Matrícula de Disciplinas em Lote
Matrícula e Avaliação -> Rematrícula
Importante: |
Serão enviada as seguintes informações para vincular o Aluno a turma/disciplina:
Campo LMS (Details) | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
ext_user_id | SMATRICULA.RA | RA do Aluno | Varchar(20) |
ext_group_id | 'D'+ SMATRICULA.IDTURMADISC | ID da turma disciplina | Int(4) |
Âncora | ||||
---|---|---|---|---|
|
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).
Configurar web-service.
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.
O processo de inclusão de notas etapas possui a seguinte a assinatura:
Nome | IncluirNotaEtapa |
Parâmetros | Arquivo XML com os campos |
Retorno | XML |
Tabela | SNOTAETAPA |
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:
NOTAS NA ETAPA | TIPO | DESCRIÇÃO |
CODCOLIGADA | SMALLINT(2) | Código da coligada |
IDTURMADISC | Int(4) | ID da turma disciplina |
NOTAFALTA | Numeric | Nota do Aluno |
RA | Varchar(20) | RA do Aluno |
Âncora | ||||
---|---|---|---|---|
|
Configurar web-service, conforme item 1.8
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.
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:
Nome | IncluirNotaAvaliacao |
Parâmetros | Arquivo XML com os campos |
Retorno | XML |
Tabela | SNOTAS |
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:
NOTAS DA AVALIAÇÃO | TIPO | DESCRIÇÃO |
CODCOLIGADA | SMALLINT(2) | Código da coligada |
IDTURMADISC | Int(4) | ID da turma disciplina |
NOTA | Numeric | Nota do Aluno |
CODPROVA | SMALLINT(2) | Código da Avaliação |
RA | Varchar(20) | RA do Aluno |
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>
Âncora | ||||
---|---|---|---|---|
|
Configurar web-service, conforme requisito item 1.8
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.
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:
Nome | IncluirFrequenciaEtapa |
Parâmetros | Arquivo XML com os campos |
Retorno | XML |
Tabela | SNOTAETAPA |
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:
NOTAS NA ETAPA | TIPO | DESCRIÇÃO |
CODCOLIGADA | SMALLINT(2) | Código da coligada |
IDTURMADISC | String | ID da turma disciplina |
NOTAFALTA | Numeric | Número de Faltas(%) |
RA | Varchar(20) | ID do Aluno |
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>
Âncora | ||||
---|---|---|---|---|
|
Configurar web-service, conforme item 1.8.
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.
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:
Nome | IncluirAvaliacao |
Parâmetros | Arquivo XML com os campos |
Retorno | XML |
Tabela | SPROVAS |
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:
AVALIAÇÕES | TIPO | DESCRIÇÃO |
CODCOLIGADA | SMALLINT(2) | Código da coligada |
IDTURMADISC | Int(4) | ID da turma disciplina |
CODPROVA | SMALLINT(2) | Código da Avaliação |
DESCRICAO | VARCHAR(100) | Descrição da Avaliação |
VALOR | NUMERIC | Valor da Avaliação |
DTPREVISTA | DATETIME | Data prevista |
MEDIA | NUMERIC | Valor da Média |
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>
Âncora | ||||
---|---|---|---|---|
|
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.
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.
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
Âncora | ||||
---|---|---|---|---|
|
Campo LMS (Details) | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
ext_user_id | SMATRICULA.RA | RA do Aluno | Varchar(20) |
ext_group_id | 'D' +SMATRICULA.IDTURMADISC | ID da turma disciplina | String |
Campo LMS | Campo de Origem TOTVS | Descrição do campo de origem do TOTVS | Formato TOTVS |
ext_user_id | SMATRICULA.RA | RA do ALuno | Varchar(20) |
ext_group_id | 'D' + SMATRICULA.IDTURMADISC | ID da turma disciplina | Int(4) |
Âncora | ||||
---|---|---|---|---|
|
Esse processo não possui pré-requisitos.
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.
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":
Campos | Descrição |
ID | ID do Processo |
CODCOLIGADA | Código da Coligada |
PROCESSO | Nome do Processo |
STATUS | Status do registro – Erro ou Sucesso |
CHAVE | Chave do Registro |
DATA | Data do registro |
DESCRIÇÃO DO ERRO | Descrição do Erro |
ARQUIVO XML | Arquivo XML recebido ou Enviado |
REPROCESSADO | Indica se o registro já foi reenviado – Será exibido Sim ou Não |
TIPO | Exportação ou Importação |
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".
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Âncora | ||||
---|---|---|---|---|
|
Autor | Versão | Data | Descrição das Alterações |
Pedro Antonio Silva Barroso | 1.0 | 03/05/2018 | Reformulação do documento, colocando no padrão FSW |
Gustavo Fonseca Nunes | 2.0 | 27/07/2018 | Ajustes solicitados |
Pedro Marcus Paixão Silva | 3.0 | 17/09/2018 | Atualização do documento |