Tabela de conteúdos

Layout do arquivo de diários eletrônicos versão 1.8

Um arquivo de diários é um arquivo XML estruturado para armazenar as ações diárias de uma classe escolar. Esse arquivo armazena basicamente dois tipos de informação: os dados da escola, do curso, da série, os critérios de avaliação, entre outros, e os dados coletados durante o percurso dessa turma no período letivo, ou seja, os alunos que fazem parte da turma e suas aulas dadas, frequências, notas e faltas.

Mudanças em relação à versão anterior (1.7)

Convenções

Tags XML

As tags XML devem ser escritas todas em maiúsculas, sem caracteres especiais, acentuação ou pontuação de qualquer tipo.

Nome do arquivo

Qualquer nome de arquivo válido, terminado com a extensão ”.diario”.

Regras de formatação

Textos

Nenhuma formatação especial é requerida. Caracteres especiais e de acentuação/pontuação podem ser usados livremente.

Datas

Datas devem estar no formado YYYY-MM-DD.

Horas

Horas devem estar no formato HH:MM:SS.

Valores numéricos

Valores numéricos devem ser inseridos com seus separadores, quando necessário. A vírgula (,) deve ser usada como separador decimal, enquanto o ponto (.) deve ser usado como separador de milhar.

Valores booleanos

Valores booleanos devem ser informados como TRUE ou FALSE, sempre em maiúsculas.

Composição do arquivo

Cada elemento do arquivo, bem como sua função e a origem das informações que os compõem, estão detalhados nas sessões seguintes.

DIARIOELETRONICO

Este elemento é o elemento raiz do documento. Seus elementos filhos devem ser os diários específicos de cada turma/disciplina.

Elementos filho

Elementos filho Ocorrências Descrição
DIARIO 1:N Dados específicos de cada turma/disciplina.

Atributos

Atributos Descrição Informações adicionais
VERSAO Versão do layout do arquivo de diário eletrônico. Valor do atributo (fixo): 1.8
DATAGERACAO Data em que o arquivo foi gerado. Formato: YYYY-MM-DD
HORAGERACAO Hora em que o arquivo foi gerado. Formato: HH:MM:SS

Exemplo

<?xml version="1.0" encoding="utf-8"?>
<DIARIOELETRONICO VERSAO="1.7" DATAGERACAO="2022-10-04" HORAGERACAO="8:40:00">
  <DIARIO ID="21995">...</DIARIO>
  <DIARIO ID="21996">...</DIARIO>   
 ...
</DIARIOELETRONICO>

DIARIO

Este elemento contém as informações referentes às atividades desempenhadas em uma determinada turma. É o equivalente ao diário impresso do professor, que contém uma lista de alunos e informações como frequência, notas e faltas.

Em geral, cada disciplina lecionada pelo professor deve estar representada por um elemento DIARIO no arquivo. Entretanto, em alguns casos (como na educação infantil, por exemplo), um mesmo diário pode conter várias disciplinas. Essa definição de quantas e quais disciplinas farão parte do diário deve ser realizada durante a geração do arquivo.

Elementos filho

Elementos filho Ocorrências Descrição
PROFESSOR 1 Dados do professor.
ESCOLA 1 Dados da escola.
CALENDARIOESCOLAR 1 Dados do calendário escolar.
CURSO 1 Dados do curso.
SERIE 1 Dados da série.
TURMA 1 Dados da turma.
DISCIPLINAS 1 Lista das disciplinas que compõem o diário.
ALUNOS 1 Lista dos alunos matriculados na turma.
PERIODOSLETIVOS 1 Lista dos períodos letivos do diário.

Atributos

Atributos Descrição Informações adicionais
ID Identificação única do diário no arquivo. Deve ser um número inteiro sequencial, começando por 1.

Exemplo

...
<DIARIO ID="21995">
  <PROFESSOR>...</PROFESSOR> 
  <ESCOLA>...</ESCOLA>
  <CALENDARIOESCOLAR>...</CALENDARIOESCOLAR>
  <CURSO>...</CURSO>
  <SERIE>...</SERIE>
  <TURMA>...</TURMA>
  <DISCIPLINAS>
    <DISCIPLINA>...</DISCIPLINA>
    <DISCIPLINA>...</DISCIPLINA>
    ...  
  </DISCIPLINAS>
  <ALUNOS>
    <ALUNO>...</ALUNO>
    <ALUNO>...</ALUNO>
    ...
  </ALUNOS>
  <PERIODOSLETIVOS>
    <PERIODOLETIVO>...</PERIODOLETIVO>
    <PERIODOLETIVO>...</PERIODOLETIVO>
    ...
  </PERIODOSLETIVOS>
</DIARIO>
...

PROFESSOR

Este elemento contém as informações do professor ao qual o diário pertence.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código do professor no sistema.
NOME 1 Nome completo do professor.

Atributos

Nenhum atributo para esse elemento.

Exemplo

...
<PROFESSOR>
  <ID>154</ID>   
  <NOME>SUEMAR BOTELHO RIANI ARCANJO</NOME>
</PROFESSOR>
...

ESCOLA

Este elemento contém as informações da escola a qual o diário pertence.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código da escola no sistema.
CODIGOINEP 1 Código da escola no INEP.
NOME 1 Nome da escola.

Atributos

Este elemento não tem atributos.

Exemplo

...
<ESCOLA>
  <ID>1</ID>
  <CODIGOINEP>32073364</CODIGOINEP>
  <NOME>EMEF MARINALVA ARAGAO AMORIM</NOME>
</ESCOLA>
...

CALENDARIOESCOLAR

Este elemento contém as informações do calendário escolar vinculado ao curso do diário.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código do calendário escolar no sistema.
ANOLETIVO 1 Ano letivo base do calendário escolar (2020, 2021, …).
PERIODO 1 Período do calendário escolar. Valores permitidos:
- INTEGRAL
- 1SEMESTRE
- 2SEMESTRE

Atributos

Este elemento não tem atributos.

Exemplo

...
<CALENDARIOESCOLAR>
  <ID>8</ID>
  <ANOLETIVO>2021</ANOLETIVO>
  <PERIODO>INTEGRAL</PERIODO>
</CALENDARIOESCOLAR>
...

CURSO

Este elemento contém informações do curso ao qual o diário pertence.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código do curso no sistema.
NOME 1 Nome do curso.
CODIGOENSINO 1 Código do ensino do curso no sistema.

Atributos

Este elemento não tem atributos.

Exemplo

...
<CURSO>
  <ID>1</ID>
  <NOME>ENSINO FUNDAMENTAL</NOME>
  <CODIGOENSINO>2</CODIGOENSINO>
</CURSO>
...

SERIE

Este elemento contém informações da série a qual o diário pertence.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código da série no sistema.
ORDEM 1 Ordem da série no curso.
CODIGOSERIEETAPA 1 Código da série etapa no sistema.
MODULO 1 Módulo da série. Valores possíveis: I e II.
NOME 1 Nome da série.

Atributos

Este elemento não tem atributos.

Exemplo

...
<SERIE>
  <ID>6</ID>
  <ORDEM>6</ORDEM>
  <CODIGOSERIEETAPA>19</CODIGOSERIEETAPA>
  <MODULO>II</MODULO>
  <NOME>6º ANO</NOME>  
</SERIE>
...

TURMA

Este elemento contém informações da turma a qual o diário pertence.

Elementos filho

Elementos filho Ocorrências Descrição
ID 1 Código da turma no sistema.
NOME 1 Nome da turma.
TURNO 1 Turno em que os alunos da turma estudam. Valores permitidos:
- MATUTINO
- VESPERTINO
- NOTURNO
- INTEGRAL
- ALTERNADO.

Atributos

Este elemento não tem atributos.

Exemplo

...
<TURMA>
  <ID>1</ID>
  <NOME>6º A</NOME>
  <TURNO>MATUTINO</TURNO>  
</TURMA>
...

DISCIPLINAS

Este elemento contém a lista de disciplinas que compõem o diário.

Elementos filho

Elementos filho Ocorrências Descrição
DISCIPLINA 1:N Dados da disciplina.
– ID 1 Código da disciplina no sistema.
– TIPO 1 Tipo da disciplina em relação ao diário:
- INDIVIDUAL: o diário tem apenas uma disciplina.
- CONJUNTA: o diário possui várias disciplinas.
- PRINCIPAL: o diário possui várias disciplinas e essa disciplina será usada para importar os dados de frequência e notas dos alunos.
– CODIGOAREA 1 Código da área a qual a disciplina pertence.
– NOME 1 Nome da disciplina.
– VALIDARNOTAS 1 Indica se a disciplina exige que uma nota seja informada (TRUE) ou não permite que uma nota seja informada (FALSE). Valores permitidos: TRUE, FALSE.
– CARGAHORARIA 1 Carga horária da disciplina na série.
– TIPOAVALIACAO 1 Tipo de avaliação adotada na disciplina: SOMATIVA (NOTAS), FORMATIVA (FICHAS).
– TIPOFICHA 1 Tipo de ficha adotada na disciplina: AVALIATIVA (CONCEITOS), DESCRITIVA (TEXTOS).

Atributos

Este elemento não tem atributos.

Exemplo

...
<DISCIPLINAS>
  <DISCIPLINA>
    <ID>46</ID>
    <TIPO>INDIVIDUAL</TIPO>  
    <CODIGOAREA>6</CODIGOAREA>
    <NOME>LÍNGUA PORTUGUESA</NOME>
    <VALIDARNOTAS>TRUE</VALIDARNOTAS>
    <CARGAHORARIA>160</CARGAHORARIA>
    <TIPOAVALIACAO>SOMATIVA (NOTAS)</FORMAAVALIACAO> 
    <TIPOFICHA></TIPOFICHA> 
  </DISCIPLINA> 
 ...
</DISCIPLINAS>
...

ALUNOS

Este elemento contém a lista de alunos matriculados na turma.

Elementos filho

Elementos filho Ocorrências Descrição
ALUNO 1:N Dados do aluno.
– ID 1 Código do aluno no sistema.
– ORDEM 1 Ordem do aluno na lista de alunos.
– NOME 1 Nome completo do aluno.
– DATANASCIMENTO 1 Data de nascimento do aluno.

Atributos

Este elemento não tem atributos.

Exemplo

...
<ALUNOS>
  <ALUNO>
    <ID>1154</ID>
    <ORDEM>1</ORDEM>
    <NOME>ANA CLARA SANTA ROSA SANTOS</NOME>
    <DATANASCIMENTO>2007-10-02</DATANASCIMENTO>
  </ALUNO>
 ...
</ALUNOS>
...

PERIODOS LETIVOS

Este elemento contém a lista de períodos letivos do diário.

Elementos filho

Elementos filho Ocorrências Descrição
PERIODOLETIVO 1:N Dados do período letivo, bem como as informações de frequência e nota.
– ID 1 Código do período letivo no sistema.
– ORDEM 1 Ordem do período letivo na lista de períodos letivos.
– TIPO 1 Tipo do período letivo: NORMAL, RECUPERAÇÃO ou RECUPERAÇÃO ESPECIAL.
– NOME 1 Nome do período letivo.
– PESO 1 Peso do período letivo.
– MEDIA 1 Média do período letivo (utilizada para determinar se uma nota está acima ou abaixo do esperado).
– AULASDADAS 1 Quantidade de aulas dadas no período letivo. (Valor se será importado na turma para as aulas dadas da disciplina e período letivo)
– TOTALIZADORES 1 Lista de resultados (nota final e total de faltas) dos alunos no período letivo.

Atributos

Atributos Descrição Informações adicionais
IMPORTADO Identifica se as informações do período letivo já foram importadas pelo School. Valores permitidos: TRUE ou FALSE.

Exemplo

...
<PERIODOSLETIVOS>
 <PERIODOLETIVO IMPORTADO="FALSE">
  <ID>1</ID>
  <ORDEM>1</ORDEM>
  <TIPO>NORMAL</TIPO>
  <NOME>1° TRIMESTRE</NOME>
  <PESO>30</PESO>
  <MEDIA>18</MEDIA>
  <AULASDADAS>50</AULASDADAS>
  <TOTALIZADORES>...</TOTALIZADORES>    
 </PERIODOLETIVO>
 ...  
</PERIODOSLETIVOS>
...

TOTALIZADORES

Este elemento contém os totalizadores de frequência e nota dos alunos durante o período letivo.

Elementos filho
Elementos filho Ocorrências Descrição
TOTALIZADOR 0:N Contém o resumo das informações de frequência e nota de um aluno específico durante o período letivo. Para cada aluno do diário deve haver um totalizador por disciplina.
– TOTALFALTAS 1 Total de faltas do aluno no período letivo.
– NOTAFINAL 1 Nota final (média ou soma, já considerando as recuperações) do aluno no período letivo.
Atributos
Atributos Descrição Informações adicionais
IDALUNO Código do aluno. Esse deve ser o mesmo Id informado nos dados do aluno na lista de alunos do diário.
IDDISCIPLINA Código da disciplina. Esse deve ser o mesmo Id informado nos dados da disciplina na lista de disciplinas do diário.
Exemplo

...
<TOTALIZADORES>    
  <TOTALIZADOR IDALUNO="1154" IDDISCIPLINA="46">
    <TOTALFALTAS>5</TOTALFALTAS>
    <NOTAFINAL>18,3</NOTAFINAL>
  </TOTALIZADOR>
 ...                          
</TOTALIZADORES>
...