Histórico da Página
Projeto: Integração TOTVS Educacional x LMS - SENAI
Nome do Cliente: Confederação Nacional da Indústria
...
...
| 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 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.
- 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 | ||
|---|---|---|
| ||
As Melhorias na Integração, estão destacadas neste documento com o ícone: Novo! |
| Expandir | ||
|---|---|---|
| ||
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.
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:
Endereço do WebService: 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 pelo LMS Senha: senha do usuário - disponibilizado pelo LMS
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çõ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.
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 | ||
|---|---|---|
| ||
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 | ||
|---|---|---|
| ||
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.
|
...
...
...
...
...
...
...
...
| title | Processo Customizado de Exportação de Turma e Turma/Disciplina |
|---|
|
| Expandir | ||
|---|---|---|
|
...
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:
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.
Quando o parâmetro “Não enviar ao LMS” no campo complementar da Turma/Disciplina está marcado, não é realizado o envio da Turma/disciplinas e consequentemente também não 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 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/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
...
...
...
...
...
...
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
...
| 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.
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.
São enviadas as seguintes informações referente ao professor:
...
...
codcoligada
...
SPROFESSOR.CODCOLIGADA
...
Coligada
...
Smallint
...
firstname
...
PPESSOA.NOME
...
Nome do Professor
...
Varchar(140)
...
lastname
...
PPESSOA.NOME
...
Sobrenome do Professor
...
Varchar(140)
...
...
PPESSOA.EMAIL
...
E-mail do Professor
...
Varchar(60)
...
External_id
...
SPROFESSOR.CODPROF
...
ID do Professor
...
Varchar(10)
...
gender
...
PPESSOA.SEXO
...
Gênero do Professor
...
Varchar(1)
...
username
...
PPESSOA.CPF
...
CPF do Professor
...
Varchar(11)
...
address
...
PPESSOA.RUA
...
Endereço do Professor
...
Varchar(140)
...
city
...
PPESSOA.CIDADE
...
Cidade do Professor
...
Varchar(32)
...
state
...
PPPESSOA.ESTADO
...
Estado do Professor
...
Varchar(2)
...
country
...
PPESSOA.PAIS
...
País do Professor
...
Varchar(60)
...
birthday
...
PPESSOA.DTNASCIMENTO
...
Data de Nascimento
...
Datetime(8)
...
bphone
...
PPESSOA.TELEFONE1
...
Telefone Fixo
...
Varchar(15)
...
mphone
...
PPESSOA.TELEFONE2
...
Telefone Celular
...
Varchar(15)
|
| Expandir | ||
|---|---|---|
| ||
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.
|
...
id
...
PPESSOA.CARTIDENTIDADE
...
RG do Professor
...
...
...
...
...
...
...
...
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
...
...
...
...
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
...
| 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 | ||
|---|---|---|
| ||
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:
...
...
...
...
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)
...
...
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
...
| title | Processo Customizado de Exportação de Matrícula do Aluno Disciplina |
|---|
Pré-Requisitos / Parametrizações
Somente são exportadas matrículas vinculadas a turmas/disciplinas a distância ou semi- presencial.(STURMADISC.TIPO = ‘D’ ou ‘S’).
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, conforme Req.01.(ZMATSTATUS.CODSTATUS = SMATRICULA.CODSTATUS).
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
|
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Pré-requisitos Somente são exportados alunos que estão matriculados em turmas/disciplinas à distância ou semi presencial.
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.
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:
|
| Expandir | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
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:
Alunos → Anexos → Matrículas no Período Letivo → Processos → Alterar Situação de Matrícula Matrículas → Processos → Matricular Aluno nas Disciplinas → Processos → Alterar situação de matrícula no período letivo Matrícula e Avaliação → Matrículas → Processos → Alterar Situação de Matrícula Matrícula e Avaliação → Matrículas → Anexos → Matrícula em Disciplinas → Processos → Alterar Situação de Matrícula
Aluno → Anexos → Matrícula no Período Letivo → Processos → Alterar Situação de Matrícula
Matrícula e Avaliação → Enturmação
Matrícula e Avaliação → Matrícula → Confirmação de Matrícula por Pagamento
Matrícula e Avaliação → Matrícula Isolada Aluno → Anexos → Matrícula Isolada
Matrícula e Avaliação → Mais → Matrícula de Disciplinas em Lote
Matrícula e Avaliação → Rematrícula
São enviadas as seguintes informações para vincular o Aluno a turma/disciplina:
|
| Expandir | ||
|---|---|---|
| ||
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 | ||
|---|---|---|
| ||
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 |
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 | ||
|---|---|---|
| ||
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 | ||
|---|---|---|
| ||
Somente são exportados para o LMS alteração de matrícula de alunos nos status parametrizados na tabela ZSTATUSALTMAT, no campo Status de Matrícula-Alteração de Matrícula, conforme Req.01.ZSTATUSALTMAT.CODSTATUS = SMATRICULA.CODSTATUS). |
...
| title | Processo Customizado Importação de Notas |
|---|
Pré-Requisitos / Parametrizações
É 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 ‘#’ é 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, onde é necessário autenticação e possibilita a transferência de mensagens em formato XML para uso em ambientes distribuídos e que atende a diversas plataformas com mensagens personalizadas.
O método disponibilizado no webservice receberá como parâmetro um arquivo XML, onde este conterá as informações de alunos e a notas a serem processados,e efetuará os tratamentos necessários para realizar a operação solicitada (inclusão/alteração) no TOTVS Educacional.
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 será processado, incluindo ou alterando as notas dos alunos na etapa através do processo nativo do TOTVS Educacional, de acordo com as informações passadas no XML. Todas as validações serão do processo nativo de inclusão de notas na etapa.
O processo customizado irá receber o arquivo XML e enviar as informações do arquivo para o serviço nativo de inclusão de notas, que realizará a inclusão ou alteração da nota do aluno.Caso não exista lançamento de nota para o aluno na etapa, será considerado uma inclusão, ou se já existir nota lançada esta será substituída pelo valor informado no arquivo XML.
O campo CODPROVA determinará 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:
<INCLUIRNOTAAVALIACAO>
<SNOTAS>
<CODCOLIGADA>3</CODCOLIGADA>
<IDTURMADISC>D29205</IDTURMADISC>
<NOTA>78</NOTA>
<CODPROVA>E1</CODPROVA>
<RA>99144488</RA>
</SNOTAS>
</INCLUIRNOTAAVALIACAO>
No exemplo abaixo segue a estrutura do arquivo XML que deverá ser enviado no caso de uma Nota de Avaliação:
<INCLUIRNOTAAVALIACAO>
<SNOTAS>
<CODCOLIGADA>3</CODCOLIGADA>
<IDTURMADISC>D29205</IDTURMADISC>
<NOTA>78</NOTA>
<CODPROVA>A1E1</CODPROVA>
<RA>99144488</RA>
</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
...
| title | Processo Customizado de Importação de Frequência |
|---|
Pré-Requisitos / Parametrizações
Configurar web-service, conforme requisito item 1.8.
Descrição do Processo
...
...
Detalhamento do Processo
...
...
...
...
...
...
...
...
...
| title | Processo Customizado Importação de Avaliações em Turmas/Disciplinas |
|---|
Pré-Requisitos / Parametrizações
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 webservice receberá como parâmetro um arquivo XML, onde este conterá as informações de avaliações a serem incluídas,e neste caso, efetuará os tratamentos necessários para realizar a operação solicitada (inclusão) no TOTVS Educacional.
O método terá a seguinte estrutura:
...
Nome
...
IncluirAvaliacao
...
Parâmetros
...
Arquivo XML com os campos
...
Retorno
...
XML
...
Tabela
...
SPROVAS
Ao consumir este método, o arquivo XML será processado, incluindo a avaliação em uma turma/disciplina, através do processo nativo do TOTVS Educacional, de acordo com as informações passadas no XML. Todas as validações serão do processo nativo de inclusão de avaliações.
O processo customizado irá receber o arquivo XML e enviar as informações do arquivo para o serviço nativo de inclusão de avaliações, que realizará a inclusão da avaliação na turma/disciplina.
Na tabela abaixo estão os dados que devem ser enviados no arquivo XML:
...
AVALIAÇÕES
...
TIPO
...
DESCRIÇÃO
...
CODCOLIGADA
...
SMALLINT(2)
...
Código da coligada
...
IDTURMADISC
...
Int(4)
...
ID da turma disciplina
...
CODPROVA
...
SMALLINT(2)
Código da Avaliação
...
DESCRICAO
...
VARCHAR(100)
Descrição da Avaliação
...
VALOR
...
NUMERIC
Valor da Avaliação
...
DTPREVISTA
...
DATETIME
...
Data prevista
...
MEDIA
...
NUMERIC
...
Valor da Média
O campo TIPOETAPA da tabela SPROVAS será preenchido sempre com ‘N’.
...
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>
<INCLUIRAVALIACAO>
<SPROVAS>
...
...
<DESCRICAO></DESCRICAO>
<CODPROVA></CODPROVA>
<VALOR></VALOR>
<DTPREVISTA></DTPREVISTA>
<MEDIA></MEDIA>
</SPROVAS>
...
<INCLUIRAVALIACAO>
<SPROVAS>
...
...
<DESCRICAO>TESTE 123</DESCRICAO>
<CODPROVA>3</CODPROVA>
<VALOR>3</VALOR>
<DTPREVISTA>21/09/2015</DTPREVISTA>
<MEDIA>12</MEDIA>
</SPROVAS>
</INCLUIRAVALIACAO>
...
| title | Processo Customizado de Exportação da Mudança de Turma |
|---|
Pré-Requisitos / Parametrizações
Somente serão exportados para o LMS a alteração de turma com status destino parametrizados na tabela ZMATSTATUS, no campo Status de Matrícula-Matrícula, conforme Req.01.
Descrição do Processo
O processo customizado vai integrar o processo de alteração de turma dos alunos do TOTVS Educacional com o sistema LMS da Time do Know.
O processo customizado será acionado quando um usuário executar o processo nativo “Mudar Turma”, disponível em Matrícula/Processos/Mudar Turma.
Detalhamento do Processo
O aluno será excluído da turma origem através do método DetachUserToGroup será incluído na nova turma através do processo AttachUserToGroup.
Caso turma/disciplina origem seja do tipo a distância ou semi-presencial, e a turma destino não, será executado somente a exclusão do aluno da turma (DetachUserToGroup).
Caso a turma/disciplina origem não seja do tipo a distância ou semi-presencial, e a turma destino sim, será executado somente a inclusão na turma (AttachUserToGroup).
Se tanto origem quanto destino forem do tipo a distância ou semi-presencial serão executados a exclusão da turma de origem e a inclusão a turma de destino.
Informações que serão 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)
...
| title | Processo de Vincular e Desvincular Alunos com LMS |
|---|
Pré-Requisitos / Parametrizações
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 WebService.
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.
<NOTAFALTA>10</NOTAFALTA> <RA>M-PROF-1</RA> </SNOTAETAPA> </INCLUIRFREQUENCIAETAPA> |
| Expandir | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
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:
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:
O campo TIPOETAPA da tabela SPROVAS é 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 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
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:
|
| Expandir | ||
|---|---|---|
| ||
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 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
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”.
|
| Expandir | ||
|---|---|---|
| ||
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;
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 |
| Atualização - Alteração na customização - E-mail do aluno / Envio de CPF |
| Paulo Henrique Rey | 10.0 |
| Atualização - Campos chaves de integração |
| Vanessa de Sousa Carvalho | 11.0 |
| Atualização - Envio de e-mail na exportação de alunos. |
...
| 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 – 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”.
...
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
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas