Histórico da Página

...

Expandir

title	Parâmetros

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

Campo	Descrição
Endereço do Web Service	Endereço do WebService Web Service LMS
Usuário	Usuário com acesso ao Web Service LMS
Senha	Senha do usuário do 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.

Expandir

title	Cadastro do Grupo Pai 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.

Expandir

title	Cadastro do Domínio LMS

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.

Nota

title	Importante!

O código do domínio para cada regional é disponibilizado pela equipe do LMS.

Expandir

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

Pré-requisitos

Não se aplica.

Descrição do processo

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

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.

São enviadas 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 + ‘-‘ SCURSO.NOME	Nome do Curso	Varchar(60)
classification	SMODALIDADECURSO.DESCRICAO	Modalidade do Curso	Varchar(60)
Type	Fixo ‘Course’	Fixo ‘Course’	Fixo ‘Course’

Expandir

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

Pré-requisitos

Somente são exportadas turmas/disciplinas à distância ou semi-presencial.

Descrição do processo

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

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.

São enviadas 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 + ‘-‘ SDISCIPLINA.NOME + ‘-‘ SGRADE.CODHABILITACAO	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’

Vínculo da Turma ao Curso:

Campo LMS (Details) –

AttachSubGroup – Turma para Curso

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

Vínculo da Disciplina à Turma:

Campo LMS (Details) –

AttachSubGroup – Disciplina para Turma

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

...

Expandir

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

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 na tabela ZMATSTATUS, no campo 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 (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

→ Anexos → Matrículas no Período Letivo

->Processos-> Alterar

→ Processos → Alterar Situação de Matrícula

Matrículas

-> Processos->Matricular

→ Processos → Matricular Aluno nas Disciplinas

->-Processos-> Alterar

→ Processos → Alterar situação de matrícula no período letivo

Matrícula e Avaliação

->Matrículas->-Processos-> Alterar

→ Matrículas → Processos → Alterar Situação de Matrícula

Matrícula e Avaliação

->Matrículas->Anexos ->Matrícula em Disciplinas->Processos ->Alterar

→ Matrículas → Anexos → Matrícula em Disciplinas → Processos → Alterar Situação de Matrícula

Matrícula no período no período letivo

Aluno -> Anexos -> Matrícula no Período Letivo -> Processos->Alterar

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

Enturmação

Matrícula e

Avaliação ->

Avaliação → Enturmação

Confirmação de 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

Matrícula e Avaliação

-> Matrícula

→ Matrícula Isolada

Aluno

->Anexos->Matrícula

→ Anexos → Matrícula Isolada

Matrícula de Disciplinas em Lote

Matrícula e

Avaliação -> Mais - >

Avaliação → Mais → Matrícula de Disciplinas em Lote

Rematrícula

Matrícula

Matrícula e Avaliação

->

→ Rematrícula

Nota

title	Importante!

A execução de todos processos listados não é de obrigatoriedade do regional. Favor desconsiderar os processo que não são utilizados pelo regional.

São enviadas 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)

...

Expandir

title	Processo Customizado Importação de Notas

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#, onde 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

processo

O Web Service utiliza o protocolo/tecnologia SOAP,

onde

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

webservice receberá

web service recebe como parâmetro um arquivo XML, onde este conterá as informações de alunos e a notas a serem processados,e

efetuará

efetua os tratamentos necessários para realizar a operação solicitada (inclusão/alteração) no TOTVS Educacional.

Detalhamento do

Processo

processo

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

são do processo nativo de inclusão de notas na etapa.

O processo customizado

irá receber

recebe o arquivo XML e

enviar

envia as informações do arquivo para o serviço nativo de inclusão de notas, que

realizará

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

determinará

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

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:

</SNOTAS>

</INCLUIRNOTAAVALIACAO>

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

</SNOTAS>

</INCLUIRNOTAAVALIACAO>

Tipos de dados:

NOTAS NA ETAPA	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

Expandir

title	Processo Customizado de Importação de Frequência

Pré-requisitos

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

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:

</SNOTAETAPA>

</INCLUIRFREQUENCIAETAPA>

Exemplo XML preenchido:

</SNOTAETAPA>

</INCLUIRFREQUENCIAETAPA>

Expandir

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

Pré-requisitos

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

Detalhamento do processo

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

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

</SPROVAS>

</INCLUIRAVALIACAO>

Exemplo XML preenchido:

CODCOLIGADA>1<

<DESCRICAO>TESTE 123</DESCRICAO>

</SPROVAS>

</

INCLUIRAVALIACAO>

Expandir

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

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:

Campo LMS (Details)

DetachUser ToGroup

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

(Details)

AttachUserToGroup

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)

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 13

Nova versão 14

Chave