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


Projeto: FS007361  – TOTVS Educacional x LMS - SENAI

Nome do Cliente: Confederação Nacional da Indústria 

Objetivo


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:

Esse manual tem a função de detalhar, de forma operacional, como ocorrerá a integração entre os sistemas TOTVS Educacional e LMS Time to Know.


Pré-Requisitos / Parametrizações

Não se aplica.

  • Descrição do Processo


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


  • Detalhamento do Processo


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



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


Campo

Descrição

Endereço do Web Service

Endereço do WebService LMS

Usuário

Usuario com acesso ao Web Service LMS

Senha

Senha do usuário do LMS


  • Dados Gerais


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


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


  • Modalidade: Parâmetro que será utilizado para informar quais modalidades de cursos serão enviados para o LMS. A figura abaixo é ilustrativa e o regional deve parametrizar as modalidades que serão integradas com o LMS.



  • Pré-Requisitos / Parametrizações

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


Para os itens da tabela dinâmica você deverá informar de acordo com o que foi cadastrado no LMS sendo o código do grupo no LMS o código do item no SGE.


  • Descrição do Processo

Esta tela permitirá o cadastro do Grupo Pai LMS da matriz aplicada. Esse valor será usado para identificar a qual grupo Pai LMS essa matriz aplicada pertence no sistema LMS. Essa cadastro não é obrigatório caso o regional não utilize o conceito de Grupo Pai LMS.

  • Detalhamento do Processo

Ao acessar a matriz aplicada, em anexo você terá a opção de informar qual o Grupo Pai LMS para essa matriz aplicada.


  • Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos.

  • Descrição do Processo

Esta tela permitirá o cadastro do Domínio LMS da modalidade do curso. Esse valor será usado para identificar a qual domínio a modalidade será cadastrada no sistema LMS.

  • Detalhamento do Processo

                Ao acessar a modalidade do curso, em anexo você terá a opção de informar qual o Domínio LMS para essa modalidade.



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

  • Pré-Requisitos / Parametrizações

Esse processo não possui pré-requisitos

  • Descrição do Processo

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

  • Detalhamento do Processo

O envio será feito no momento do cadastro da Turma/Disciplina, caso esta seja a Distancia ou Semi-Presencial, será enviada o Curso.

Para envio do curso será necessário informa o domínio LMS a qual esse curso pertence. Para isso, será necessário informa, no anexo “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 + ‘-‘

SCURSO.NOME

Nome do Curso

Varchar(60)

classification

SMODALIDADECURSO.DESCRICAO

Modalidade do Curso


Varchar(60)

Type

Fixo ‘Course’

Fixo ‘Course’

Fixo ‘Course’



  • Pré-Requisitos / Parametrizações

Somente serão exportadas turmas/disciplinas a 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

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

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’


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


  • Vinculo da Disciplina a 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




  • Pré-Requisitos / Parametrizações

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

  • Descrição do Processo

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

  • Detalhamento do Processo

O processo customizado será acionado quando um usuário vincular um professor a uma turma/disciplina, em Turmas/Disciplinas/Anexos/Professores.

Após ser exportado o professor irá acessar o sistema LMS com o seu login sendo o seu CPF é a senha “123456”. Essa e temporária e deve ser alterada após primeiro acesso do professor.



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

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)


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

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’

  • Pré-Requisitos / Parametrizações

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

  • Descrição do Processo

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

  • Detalhamento do Processo

No momento que for efetuado a matricula de um aluno em uma turma que for a distancia ou semi-presencial, será enviado o aluno para o LMS.

Após ser exportado o aluno irá acessar o sistema LMS com o seu login sendo o e-mail é a senha sendo seu CPF. Essa e temporária e deve ser alterada após primeiro acesso do aluno.



No cadastro do Aluno, caso este esteja matriculado em alguma turma/disciplina a distancia ou semi-presencial e seja alterado alguma informação do cadastro, este será enviado para atualização no LMS.



Para que o aluno seja exportado para o LMS o mesmo deve ter um e-mail informado no seu cadastro.

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.

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

Serã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 será enviado ao LMS


CPF

PPESSOA.CPF


Varchar(11)

Situação de trabalho atual

-

Não será enviado ao LMS


Permitir tempo Extra

-

Não será enviado ao LMS








Histórico de Atualização do Documento

Autor

Versão

Data

Descrição das Alterações



13/08/2018

Pedro Antonio Silva Barroso

1.0

Documento inicial.



22/11/2018

Jéssica Gonçalves Silva

2.0

Atualização alteração de escopo.