CONTEÚDO

  1. Visão Geral
  2. Definições

01. VISÃO GERAL

O TOTVS Educacional disponibiliza uma série de provedores de dados para auxiliar na montagem de relatórios pois estes trazem dados específicos alinhados com as regras educacionais.


02. Definições

Para os provedores carregarem os dados corretamente, existem parâmetros obrigatórios para cada provedor, abaixo está detalhado quais os parâmetros necessários para utilizar cada provedor e quais regras mínimas devem existir.


Análise Curricular - EduAnaliseCurricularProvider

Este provedor executa o mesmo processo utilizado na tela de análise curricular para um ou mais alunos. 

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
IDHABILITACAOFILIALId. habilitação filialinteiro
RADER.A. de:texto
RAATER.A. até:texto

Para utilizar um único R.A. informe o mesmo nos dois parâmetros de R.A de e R.A. até. 

Para mais informações sobre as regras do provedor acesse a documentação:


Documentos pendentes do aluno - EduDocExigidoProvider

Este provedor carrega a lista de documentos exigidos de um ou mais alunos, sendo documentos de ingresso ou do período letivo, quantidade entregue pelo aluno e data da entrega. 

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODFILIALCódigo da filialinteiro
CODTIPOCURSONível de ensinointeiro
DTENTREGAData da entregadata
RADER.A. de:texto
RAATER.A. até:texto

Para utilizar um único R.A. informe o mesmo nos dois parâmetros de R.A de e R.A. até. 

Para mais informações sobre as regras do provedor acesse as documentações:


Ficha de resultado final - EduFichaResultadoFinalProvider

Este provedor carrega a ficha de resultado final dos alunos das turmas/disciplinas de uma determinada turma. 

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODFILIALId. habilitação filialinteiro
IDPERLETId. período letivointeiro
CODTURMACódigo da turmatexto

As turmas/disciplinas devem possuir uma etapa do tipo "nota" e que seja a etapa final.

Para mais informações sobre as regras do provedor acesse a documentação:


Histórico Ensino Fundamental - EduHistoricoFundamentalProvider

Histórico Ensino Médio - EduHistoricoMedioProvider

Este provedor carrega o histórico que foi cadastrado ou gerado para o aluno.

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODCURSOHISTCódigo do Curso do Históricointeiro
RARegistro acadêmicotexto

Para mais informações sobre as regras do provedor acesse a documentação:

A partir da versão 12.1.25 o provedor de dados de histórico do ensino médio (EduHistoricoMedioProvider) foi alterado de 25 para até 60 posições de disciplinas entre base comum e base diversificada, assim será possível ter até 60 disciplinas no relatório conforme definição disponível nas partes do histórico, porém o relatório do book "EDUREL0002 - Histórico Escolar - Ensino Médio" disponível para o TOTVS Educacional continuará com 25 posições fixas no relatório. 

As disciplinas estão sendo ordenadas por:

  • Ordem da Série do histórico
  • Código da Parte do histórico
  • Posição da Disciplina do histórico

Nota etapa do aluno - EduNotaEtapaAlunoProvider

Este provedor carrega as notas e faltas das etapas do aluno.

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
IDHABILITACAOFILIALId. habilitação filialinteiro
IDPERLETId. período letivointeiro
RARegistro acadêmicotexto

Para mais informações sobre as regras do provedor acesse a documentação:


Quadro de horário do aluno - EduQuadroHorarioAlunoProvider

Este provedor carrega o quadro de horários das disciplinas que o aluno está matriculado no período letivo.

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODFILIALCódigo da filialinteiro
IDPERLETId. período letivointeiro
IDHABILITACAOFILIALId. habilitação filialinteiro
RARegistro acadêmicotexto
CODTIPOCURSOCódigo do nível de ensinointeiro

O sistema não irá carregar os horários de turmas/disciplinas que estiverem desativadas.

Os campos "data inicial (DATAINICIAL) e final (DATAFINAL) que o provedor retorna são buscados do horário da turma/disciplina, porém se estiver vazio o sistema busca da turma/disciplina, se este também estiver vazio o sistema busca da turma e caso este também esteja vazio o sistema irá buscar o do período letivo.

Os campos código da sala (CODSALA), código do bloco (CODBLOCO) e código do prédio (CODPREDIO) que o provedor retorna são buscados do horário da turma/disciplina, se um deles estiver vazio o sistema irá buscar da turma/disciplina e se também estiver vazio o sistema irá buscar da turma.


Quadro de horário do professor - EduQuadroHorarioProfessorProvider

Este provedor carrega o quadro de horários das disciplinas que o professor está definido.

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODFILIALCódigo da filialinteiro
CODPERLETCódigo do período letivotexto
CODPROFCódigo do professortexto
CODTIPOCURSOCódigo do nível de ensinointeiro
DATAATUALData atualinteiroNão é obrigatório

O sistema não irá carregar os horários de turmas/disciplinas que estiverem desativadas.

Os campos "data inicial (DATAINICIAL) e final (DATAFINAL) que o provedor retorna são buscados do horário da turma/disciplina, porém se estiver vazio o sistema busca da turma/disciplina, se este também estiver vazio o sistema busca da turma e caso este também esteja vazio o sistema irá buscar o do período letivo.

Os campos código da sala (CODSALA), código do bloco (CODBLOCO) e código do prédio (CODPREDIO) que o provedor retorna são buscados horário da turma/disciplina, se um deles estiver vazio o sistema irá buscar da turma/disciplina e se também estiver vazio o sistema irá buscar da turma.


Resumo do Histórico Ensino Fundamental - EduResumoHistoricoProvider

Este provedor carrega um resumo do histórico do ensino básico.

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODCURSOHISTCódigo do curso no históricotexto
RARegistro acadêmicotexto

Para mais informações sobre as regras do provedor acesse a documentação:


Declaração Mensal de Serviços Educacionais - EduDeclaracaoMensalServicoProvider

Este provedor carrega os dados do contrato do aluno para um curso

Parâmetros obrigatórios:

CampoDescriçãoTipoObservação
CODCOLIGADACódigo da coligadainteiro
CODFILIALCódigo da filialinteiro
CODTIPOCURSOCódigo do nível de ensinointeiro
DATACOMPETENCIADMSCompetência da DMStextoA competência da DMS deve ser informada no formatado MM/yyyy. Exemplos: 11/2023, 01/2024

Para mais informações sobre as regras do provedor acesse a documentação: