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:
Expandir | ||
---|---|---|
| ||
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 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çã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.
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.
|
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.
Caminho para cadastro do Domínio: Currículo e Oferta | Cursos | Edite o curso desejado | Edite a Modalidade | Anexos | Domínio LMS
|
Expandir | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
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. São enviadas as seguintes informações:
|
Expandir | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
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. Campo complementar ETAPALMS informado. O campo complementar e tabela dinâmica são criados através do script disponibilizado no pacote de instalação,porém, será necessário algumas conferências para que o campo complementar seja exibido na base de dados e esteja pronto para preenchimento: 1- Acessar o TOTVS Educacional SGE → clique em configurações → Campos complementares → Turma/Disciplina e conferir se o campo complementar ETAPALMS está ativo na base de dados. Caso esteja vermelho (desativado), será necessário abrir o registro e clicar em Ativar.
2 - Verificar se possuiu a tabela dinâmica 'ETAPANOTA' cadastrada e seus itens, para acessar: Clique no campo Tabela Dinâmica existente na tela do campo complementar. A tabela dinâmica deverá estar vinculada ao campo e os itens da tabela dinâmica deverão ser cadastrados com os mesmos códigos e nomes das etapas existentes no SGE (que irão receber as notas importadas do LMS).
3 - Conferir se o campo complementar está habilitado para a filial. Acesse TOTVS Educacional SGE → clique em configurações→ Níveis de ensino → edite o nível de ensino correspondente → acesse a aba de campos complementares disponíveis → turma/disciplina → habilite o campo complementar e salve a edição.
Campo complementar Não Enviar ao LMS. 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. Ao exportar Turma/Disciplinas que sejam da Nova EJA ou EJA Profissionalizante, é adicionado o nome da Habilitação/Serie no nome da Turma/Disciplina. 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.
Se o parâmetro “Não enviar ao LMS” no campo complementar da Turma/Disciplina esteja marcado, não será realizado 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á o cancelamento/exclusão das informações já enviadas ao LMS.
São enviadas as seguintes informações da Turma:
|
Esse processo não possui pré-requisitos.
Esta tela permitirá o cadastro dos parâmetros necessários para efetuar a integração com o sistema LMS
No TOTVS Educacional, por meio do menu "Parâmetros", o usuário administrador efetuará as parametrizações referentes ao processo.
Image Removed
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
Dados Gerais
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.
Image Removed
Status de Matrícula
Image Removed
Status de Inativar Matrícula no LMS
Para cadastro do Grupo Pai LMS será necessário criar uma tabela dinâmica, como a da imagem a baixo:
Image Removed
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.
Ao acessar a matriz aplicada, em anexo você terá a opção de informar qual o Grupo Pai LMS para essa matriz aplicada.
Image Removed
Esse processo não possui pré-requisitos.
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
Ao acessar a modalidade do curso, em anexo você terá a opção de informar qual o Domínio LMS para essa modalidade.
Esse processo não possui pré-requisitos
Este processo envia as informações do Curso para o Sistema LMS via WebService.
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.
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'
Somente serão exportadas turmas/disciplinas a distância ou semi-presencial.
Deverá ser criado um campo complementar de turma/disciplina, com o código ETAPALMS, validado por tabela dinâmica ETAPANOTA. Neste campo complementar o usuário deverá informar qual é a etapa de notas do LMS, ou seja, a etapa de provas on-line. A tabela dinâmica ETAPANOTA deverá ter os itens cadastrados de acordo com o número das possíveis etapas de notas existentes no TOTVS Educacional. Este campo será considerado para identificar a etapa na importação de Notas. O campo complementar e tabela dinâmica são criados através do script disponibilizado no pacote de instalação, assim o usuário deve informar os valores da tabela dinâmica ETAPANOTA e ativar o campo complementar para o nível de ensino.
Este processo envia as informações da Turma e Turma/Disciplina para o Sistema LMS via WebService. Ao exportar Turma/Disciplinas que sejam da Nova EJA ou EJA Profissionalizante será adicionado o nome da Habilitação/Serie no nome da Turma/Disciplina.
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.
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
|
|
|
|
Name
|
|
|
|
|
|
|
|
|
'C' +SHABILITACAOFILIAL.IDHABILITACAOFILIAL
ID do Curso
String
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
Somente serão enviados ao LMS professores vinculados a uma Turma/Disciplina a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').
O processo customizado envia as informações de professores com o sistema LMS da Time do Know.
|
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.
São enviadas |
as seguintes informações referente ao professor:
|
|
São enviadas as seguintes informações referente ao |
vínculo do Professor |
à Turma/Disciplina:
|
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 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'
Somente serão exportados alunos que esta matriculados em turmas/disciplinas a distância ou semi-presencial (STURMADISC.TIPO ='S' ou 'D').
|
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. |
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:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Varchar(11)
Permitir tempo Extra
-
Não será enviado ao LMS
|
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-Alteração de Matrícula |
. |
Expandir | ||
---|---|---|
| ||
Pré- |
requisitos Configurar web-service, conforme Roteiro para Configuração do WebService. 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:
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.
|
é sempre importada para a etapa final (SETAPAS.ETAPAFINAL='S') das etapas de notas da turma/disciplina enviada no arquivo e SNOTAETAPA.TIPOETAPA = 'N'. Estrutura do arquivo XML: <INCLUIRNOTAETAPA> <SNOTAETAPA> <CODCOLIGADA></CODCOLIGADA> <IDTURMADISC></IDTURMADISC> <NOTAFALTA></NOTAFALTA> <RA></RA> </SNOTAETAPA> </INCLUIRNOTAETAPA> Exemplo de XML preenchido: <INCLUIRNOTAETAPA> <SNOTAETAPA> <CODCOLIGADA>1</CODCOLIGADA> <IDTURMADISC>D1724</IDTURMADISC> <NOTAFALTA>10</NOTAFALTA> <RA>M-PROF-1</RA> </SNOTAETAPA> </INCLUIRNOTAETAPA> Tipos de dados:
|
Expandir |
---|
|
|
| |
Pré- |
requisitos Configurar web-service, conforme |
Roteiro para Configuração do WebService. 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 |
que deve conter as informações de |
notas de avaliações a serem processados e, |
neste caso, efetuará os tratamentos necessários para realizar a operação solicitada (inclusão/alteração) no TOTVS Educacional. |
Detalhamento do |
processo O método |
tem a seguinte estrutura:
Ao consumir este método, o arquivo XML |
é processado, incluindo ou alterando as notas dos alunos das avaliações, 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 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 notas de avaliações, que |
realiza a inclusão ou alteração da nota do aluno. Caso não exista lançamento de nota para o aluno na avaliação, será considerado uma inclusão, ou se já existir nota lançada esta será substituída pelo valor informado no arquivo XML. |
No exemplo abaixo segue a estrutura dos dados que devem ser enviados no arquivo XML:
O campo TIPOETAPA da tabela SNOTAS |
é preenchido sempre com 'N'. O campo CODETAPA da tabela SNOTAS |
é preenchido de acordo com o código da etapa de notas do LMS, que |
é identificado |
através do campo complementar de turmas/disciplinas ETAPALMS. |
É verificado através do código da turma/disciplina enviada no arquivo, qual o código da etapa informada no campo complementar ETAPALMS. Estrutura do arquivo XML: <INCLUIRNOTAAVALIACAO> <SNOTAS> |
<CODCOLIGADA></CODCOLIGADA> <IDTURMADISC></IDTURMADISC> <NOTA></NOTA> <CODPROVA></ |
CODPROVA> <RA></RA> </SNOTAS> </INCLUIRNOTAAVALIACAO> Exemplo de XML Preenchido: <INCLUIRNOTAAVALIACAO> <SNOTAS> |
<CODCOLIGADA>1</CODCOLIGADA> <IDTURMADISC>D1724</IDTURMADISC> <NOTA>5</NOTA> <CODPROVA>2</CODPROVA> <RA>M-PROF-1</RA> </SNOTAS> </INCLUIRNOTAAVALIACAO> |
Expandir |
---|
|
| |
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:
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:
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 |
---|
|
| |
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 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”.
|
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 |
Gustavo Fonseca Nunes | 2.0 | 27/07/2018 | Ajustes solicitados |
Pedro Marcus Paixão Silva | 3.0 | 17/09/2018 | Atualização do documento |
Ana Luiza Martins Moreira | 4.0 | 10/06/2019 | Atualização - Melhorias na documentação |
Vinicius Alaor da Silva | 5.0 | 11/08/2020 | Atualização - Melhorias na Integração |
Paulo Henrique Rey | 6.0 |
| Atualização - Campos chaves de integração |