Manual Operacional da Customização - TOTVS Educacional x LMS - SENAI

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
Especificação Anexo I - Detalhamento Funcional - FS008014
Especificação Anexo I - Detalhamento Funcional - FS008373
Especificação Anexo I -Detalhamento Funcional - Alteração na customização de integração SGE x LMS - e-mail do aluno -FS008618
Especificação Anexo I - Detalhamento Funcional -Integração LMS - Envio do CPF - FS008669
Especificação - FS008817 - Integração LMS - Envio de E-mail Legado

Aviso

title	Aviso

As Melhorias na Integração, estão destacadas neste documento com o ícone: Novo!

Expandir

title	Parâmetros

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.

Image AddedNã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 | 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

Image RemovedImage Added

Endereço do web serviceWebService: 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 Usuário: usuário com acesso ao Web Service - disponibilizado pelo LMS

Senha: senha do usuário - disponibilizado pelo LMS

Aviso
Os mesmos dados de usuário e senha são aplicáveis a ambas as URLs.

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.
Não será possível acessar o cadastro do Domínio LMS pelo Menu "Executar"

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

Campo LMS (Details)	Campo de Origem TOTVS	Descrição do campo de origem do TOTVS	Preenchimento Obrigatório?	Formato TOTVS
codcoligada	SHABILITACAOFILIAL.CODCOLIGADA	Código da Coligada	-	Smallint
external_id	‘C’ + SCURSO.CODCOLIGADA + SCURSO.CODCURSO + SGRADE.CODGRADE	ID da Habilitação – Concatena a letra 'C' para identificar que é um curso	-	Varchar
name	SGRADE.CODGRADE + SGRADESGRADE.DESCRICAO + external_id	Nome do Curso	Sim	Varchar(60)
classification	SMODALIDADECURSO.DESCRICAO	Modalidade do Curso	Sim	Varchar(60)
Type	Fixo ‘Course’	Fixo ‘Course’	-	Fixo ‘Course’
open_date	SGRADE.DTINICIO	Data Início da Matriz Curricular	Sim	DateTime
close_date	SGRADE.DTFIM	Data Fim da Matriz Curricular	Sim	DateTime

Image Added

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

Caso Quando o parâmetro “Não enviar ao LMS” no campo complementar da Turma/Disciplina esteja está marcado, não será é realizado o envio da Turma/disciplinas e consequentemente também não enviará 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 realizará realiza o cancelamento/exclusão das informações já enviadas ao LMS.

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+ ‘(T\|‘+STURMA.CODFILIAL+ ‘\|‘+STURMA.CODTURMA+ ‘\|‘+STURMA.IDPERLET +‘)‘	Nome da Turma	Varchar(60)
external_id	‘T’ + STURMA.CODCOLIGADA+ STURMA.IDPERLET+ STURMA.CODTURMAIDFT	ID da turma - Concatena 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(D\|‘ + STURMADISC.IDTURMADISC + ‘)'	Nome do Curso	String
external_id	‘D’ + STURMADISC.IDTURMADISC	ID da turma/disciplina – Concatena 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.IDFTCODCOLIGADA+

STURMA.IDPERLET+

STURMA.CODTURMA

Id da Turma

String

string ext_parent_id

‘C’ ‘M’ + SHABILITACAOFILIAL.IDHABILITACAOFILIALSTURMA.CODCOLIGADA+

SPERIODO.CODPERIODO+

SCURSO.CODCURSO+

SGRADE.CODGRADE

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

STURMA.IDPERLET+

STURMA.IDFTCODTURMA

ID da Turma

String

Expandir

title	Processo Customizado Exportação de Professores

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.

Nota
São enviados e vinculados nas turmas no LMS apenas os docentes com o campo tipo de professor preenchido com Tutor ou Titular. Os demais tipos são enviados como "Assistente"e não são vinculados as turmas.

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

São enviadas as seguintes informações referente ao vínculo do Professor à 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 Então Professor SPROFESSORTURMA.TIPOPROF= ASSISTENTE Se não SPROFESSORTURMA.TIPOPROF	Varchar(1)
codcoligada	SPROFESSOR.CODCOLIGADA	Código da Coligada	Smallint
set_primary	Fixo ‘0’	Fixo ‘0’	Fixo ‘0’

A partir da versão 2.0 (Janeiro/2019), a customização envia as seguintes informações:

Campo LMS (Details) - AttachManager

Campo de Origem TOTVS

Descrição do campo de origem do TOTVS

Formato TOTVS

manager_type

SPROFESSORTURMA.TIPOPROF

Se o SPROFESSORTURMA.TIPOPROF = U-Tutor ou T-Titular, envia fixo 'TUTOR'.

Para demais tipos, permanece inalterado.

Varchar(1)

set_primary

SPROFESSORTURMA.TIPOPROF

Se o SPROFESSORTURMA.TIPOPROF = U-Tutor, envia fixo '1'

Se o SPROFESSORTURMA.TIPOPROF = T-Titular, envia fixo '0'

Integer

Expandir

title	Processo Customizado de Exportação de Aluno

Pré-requisitos

Somente são exportados alunos que estão matriculados em turmas/disciplinas à distância ou semi presencial.

Nota

title	Importante!

O aluno deve ter um e-mail informado no campo complementar E-mail Google do seu cadastro para que seja exportado para o LMS.

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 seu CPF. 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: A customização não realizará a integração do aluno ao LMS.
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.

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.

Criação de novo campo complementar: E-mail usuário LMS, onde será registrado o e-mail gerado pelo método de criação de usuário ou pela consulta de usuário existente.

É de responsabilidade do Regional a criação desse campo. Maiores informações com a equipe do SENAI DN.

Nome da Coluna: Deverá ser inserido o código: EMAILUSULMS

Descrição: E-mail do usuário LMS

Tipo do campo: Selecionar a Opção “Alfanumérico”;

Subtipo do campo texto: Será preenchido automaticamente a opção “Texto”;

Ordem: Deverá ser informado qual a ordem a campo complementar deverá aparecer na aba de Campo Complementar na Interface do Cadastro de Alunos.

Tamanho: 60

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.

Image Added

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.

Image Added

Sã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. PPESSOA.NOME menos a última sequência de caracteres após o último espaço.	Varchar(120)
lastname	PPESSOA.NOME	PPESSOA.NOME Última sequência de caracteres após o último espaço.	Varchar(120)
email	PPESSOA.EMAIL	E-mail do Aluno *Novo!* Caso as integrações Google e LMS estiverem ativas, será enviada na exportação do aluno ao LMS o campo: SALUNOCOMPL.EMAILLEGADO	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	Campo Complementar: Usuário LMS	Varchar(60)
address	São concatenados os campos: PPESSOA.RUA, PPESSOA.NUMERO, PPESSOA.COMPLEMENTO, PPESSOA.BAIRRO	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.DTNASCIMENTO	Somente os números	Varchar(11)
employee_id	PPESSOA.CARTIDENTIDADE	RG do Aluno	Varchar(15)
id	PPESSOA.CPF	CPF do Aluno

Image Removed

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.

Image Removed

Sã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. PPESSOA.NOME menos a última sequência de caracteres após o último espaço.	Varchar(120)
lastname	PPESSOA.NOME	PPESSOA.NOME Última sequência de caracteres após o último espaço.	Varchar(120)
email	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	São concatenados os campos: PPESSOA.RUA, PPESSOA.NUMERO, PPESSOA.COMPLEMENTO, PPESSOA.BAIRRO	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 enviado ao LMS
CPF	PPESSOA.CPF		Varchar(11)
Situação de trabalho atual	-	Não enviado ao LMS
Permitir tempo Extra	-	Não enviado ao LMS

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

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 de Exportação de Situação de Matrícula do Aluno

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.

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

Nome	IncluirNotaEtapa
Parâmetros	Arquivo XML com os campos
Retorno	XML
Tabela	SNOTAETAPA

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:

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

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

Nome	IncluirAvaliacao
Parâmetros	Arquivo XML com os campos
Retorno	XML
Tabela	SPROVAS

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:

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 é preenchido sempre com ‘N’.

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

</SPROVAS>

</INCLUIRAVALIACAO>

Exemplo XML preenchido:

<DESCRICAO>TESTE 123</DESCRICAO>

</SPROVAS>

</INCLUIRAVALIACAO>

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

Image Removed

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;

Image Removed

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

Image Removed

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)

Expandir

title	Processo de Vincular e Desvincular Alunos com LMS

Expandir

title	Monitor de Log

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 – Exibe Sim ou Não

TIPO

Exportação ou Importação

Expandir

title	Identificação de Web Service para configuração do LMS

Histórico de Atualização do Documento:

_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)

Expandir

title	Processo de Vincular e Desvincular Alunos com LMS

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.

Expandir

title	Monitor de Log

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:

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 – Exibe Sim ou Não
TIPO	Exportação ou Importaçã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”.

Image Added

Expandir

title	Identificação de Web Service para configuração do LMS

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;

Image Added

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

Image Added

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

Histórico de Atualização do Documento:

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 SENAI
Gustavo Fonseca Nunes	2.0	27/07/2018	Ajustes solicitados pelo Luiz Antônio (SENAI PE)
Pedro Marcus Paixão Silva	3.0	17/09/2018	Atualização das funcionalidades
Ana Carolina Eleutério Abras	4.0	04/01/2019	Atualização - Melhorias na Integração
Ana Luiza Martins Moreira	5.0	10/06/2019	Atualização - Melhorias na documentação
Adilson José de Aquino	6.0	05/09/2019	Atualização - Identificação do WS para configuração do LMS
Vinicius Alaor da Silva	7.0	11/08/2020	Atualização - Melhorias na Integração
Jéssica Gonçalves Silva	8.0	11/11/2020	Atualização - Melhorias na documentação
Vanessa de Sousa Carvalho	9.0	24/06/2022	Atualização - Alteração na customização - E-mail do aluno / Envio de CPF
Paulo Henrique Rey	10.0	14/10/2022	Atualização - Campos chaves de integração
Vanessa de Sousa Carvalho	11.0	02/05/2023	Atualização - Envio de e-mail na exportação de alunos.
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 SENAI
Gustavo Fonseca Nunes	2.0	27/07/2018	Ajustes solicitados pelo Luiz Antônio (SENAI PE)
Pedro Marcus Paixão Silva	3.0	17/09/2018	Atualização das funcionalidades
Ana Carolina Eleutério Abras	4.0	04/01/2019	Atualização - Melhorias na Integração
Ana Luiza Martins Moreira	5.0	10/06/2019	Atualização - Melhorias na documentação
Adilson José de Aquino	6.0	05/09/2019	Atualização - Identificação do WS para configuração do LMS
Vinicius Alaor da Silva	7.0	11/08/2020	Atualização - Melhorias na Integração

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 31

Nova versão Atual

Chave

Manual Operacional da Customização - TOTVS Educacional x LMS - SENAI

Histórico de Atualização do Documento:

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 31

Nova versão Atual

Chave

Manual Operacional da Customização - TOTVS Educacional x LMS - SENAI

Histórico de Atualização do Documento: