Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleParâ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. 


Image Modified


São eles:


  • Dados de Conexão - Web Service


Image RemovedImage Added


Campo

Descrição

Endereço do Web Service

Endereço do 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.


Image Modified


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


Image Modified


  • 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
titleCadastro 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
titleCadastro 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
titleImportante!

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



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

 NameName

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

 openopen_date

STURMA.DTINICIAL

Data inicial

Datetime

 closeclose_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

 NameName

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

‘D’ +STURMADISC.IDTURMADISC


ID da Turma/Disciplina

String

string ext_parent_id

‘T’ +STURMA.IDFT


ID da Turma

String




...

Expandir
titleProcesso 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
titleImportante!

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


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.



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.




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

 firstnamefirstname

PPESSOA.NOME

Nome do Aluno.

PPESSOA.NOME menos a última sequência de caracteres após o último espaço.

Varchar(120)

 lastnamelastname

PPESSOA.NOME

PPESSOA.NOME

Última sequência de catacteres caracteres após o último espaço.

Varchar(120)

 emailemail

PPESSOA.EMAIL

E-mail do Aluno

Varchar(60)

 ExternalExternal_id

SMATRICULA.RA

ID do Aluno

Varchar(20)

 gendergender

PPESSOA.SEXO

Gênero do Aluno  -‘M’ ou ‘F’

Varchar(1)

username

PPESSOA.EMAIL

PPESSOA.EMAIL

Varchar(60)

 addressaddress

Serão concatenados os campos:
PPESSOA.RUA,

PPESSOA.NUMERO,

PPESSOA.COMPLEMENTO,

PPESSOA.BAIRRO

Endereço do Aluno

Varchar(288)

 citycity

PPESSOA.CIDADE

Cidade do Aluno

Varchar(32)

 statestate

PPPESSOA.ESTADO

Estado do Aluno

Varchar(2)

 countrycountry

PPESSOA.PAIS

País do Aluno

Varchar(60)

 birthdaybirthday

PPESSOA.DTNASCIMENTO

Data de Nascimento

Datetime(8)

 bphonebphone

PPESSOA.TELEFONE1

Telefone Fixo

Varchar(15)

 mphonemphone

PPESSOA.TELEFONE2

Telefone Celular

Varchar(15)

Password

PPESSOA.CPF

Somente os números

Varchar(11)

 idid

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


Expandir
titleProcesso 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 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 (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 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
titleImportante!

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
titleProcesso Customizado de Importação de Frequência

Pré-requisitos


Configurar web-service, conforme requisito item 1.8 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:


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


Expandir
titleProcesso Customizado Importação de Avaliações em Turmas/Disciplinas

Pré-requisitos


Configurar web-service, conforme item 1.8.conforme Roteiro para Configuração do WebService.


Descrição do processo


O método customizado, no WebService Web Service TOTVS, receberá recebe um arquivo XML com as  informações de avaliações e executará 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 possibilita a transferência de mensagens em formato XML para uso em  em ambientes distribuídos e que atende a diversas plataformas com mensagens personalizadas


Detalhamento do processo


O método disponibilizado no web service receberá recebe como parâmetro um arquivo XML, onde este conterá as   informações de avaliações a serem incluídas, e neste caso, efetuará efetua os tratamentos necessários para realizar a operação solicitada (inclusão) no TOTVS Educacional.


O método terá 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 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 são do processo nativo de inclusão de avaliações.


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 avaliações, que realizará 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 será é preenchido sempre com ‘N’.


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>

           

Expandir
titleProcesso 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 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 ALunoAluno

Varchar(20)

 ext_group_id

‘D’ + SMATRICULA.IDTURMADISC

ID da turma disciplina

Int(4)

Expandir
titleProcesso 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 WebServiceWeb 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
titleMonitor 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 – Será exibido 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”.







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 Abras4.004/01/2019Atualização - Melhorias na Integração
Ana Luiza Martins Moreira5.010/06/2019Atualização - Melhorias na documentação