Documentação Relatórios

De Gennera Apps
Ir para: navegação, pesquisa

O módulo de relatórios permite a criação, modificação e emissão de diversos tipos de documentos como: contratos, declarações, históricos escolares, boletins, requerimentos, listas entre outros tipos de documentos.

Existe ainda um conjunto de documentos pré-definidos e padronizados que podem ser adaptados para a realidade de cada instituição de ensino pela equipe da Gennera ou da própria instituição.

O sistema está dividido em:

Relatórios

Um relatório é composto basicamente por uma descrição, uma fonte de dados e um conteúdo. A descrição é útil para localizá-lo tanto no módulo de relatórios quanto em outros módulos. É importante lembrar que outros módulos como matrícula, financeiro, sala de aula e eventos permitem vincular relatórios aos seus processos de negócio, sendo assim, a descrição é fundamental para associá-los corretamente nestas situações.

Em termos de tecnologia, os relatórios são feitos utilizando a linguagem HTML, juntamente com o framework AngularJS, responsável por renderizar os dados existentes na fonte de dados. Além disso, é possível também utilizar as linguagens CSS, para customizar qualquer aspecto visual e também JavaScript para processar os dados que serão renderizados.

Fontes de Dados

A fonte de dados indica basicamente qual é o conjunto de dados que deve ser obtido e disponibilizado para renderização. A fonte de dados de matrícula é recomendada quando o relatório for emitido por matrícula. Por exemplo, um contrato é emitido por matrícula assim como um boletim. Uma ata de sala, onde consta a lista de alunos matriculados em uma determinada turma ou disciplina não é emitida por matrícula sendo mais recomendado utilizar uma outra fonte de dados como turma ou disciplina.

Todas as fontes de dados estão associadas com relacionamentos e filtros e eles variam de acordo com a fonte de dados.

Relacionamentos

Os relacionamentos existem de forma explícita, em primeiro lugar, por uma questão de performance. Só na fonte de dados de matrícula existem mais de 30 relacionamentos, por exemplo, ao renderizar um conjunto de dados da fonte de matrícula é possível retornar também os dados do aluno. A partir dos dados do aluno é possível chegar nos dados das pessoas relacionadas a ele como o pai, a mãe e outras pessoas associadas ao aluno. Da mesma forma, a partir da matrícula é possível chegar nos contratos associados e deles chegar nas faturas de cada contrato.

A questão é, quanto mais relacionamentos, mais dados são necessário e mais tempo irá demorar para realizar a consulta no banco de dados. Assim, caso seja necessário renderizar um boletim, a partir da fonte de dados de matrícula, é interessante utilizar os relacionamentos de disciplinas, notas, médias e frequência mas não utilizar contratos, faturas e pagamentos.

Isso faz com que o módulo de relatórios possa ter uma excelente performance, desde que os relatórios sejam construídos de forma adequada.

Filtros

Além dos relacionamentos, existem os filtros, que são utilizados no momento da emissão. Eles são importantes por dois motivos, o primeiro está em encontrar os dados corretos. Por exemplo, se for necessário emitir um histórico escolar para um aluno específico, de nada adianta emitir para vários e depois precisar localizá-lo em meio a inúmeras páginas. Além disso, geralmente a emissão deste tipo de documento envolve a obtenção e manipulação de um grande volume de dados, assim, quanto mais específico forem os filtros mais rápido será o processo de emissão do documento.

Assim, a combinação dos relacionamentos corretos no modelo do relatório com um conjunto de filtros específico é a garantia de criar e emitir relatórios com o máximo de agilidade e performance.

Para entender melhor as fontes de dados com seus relacionamentos e seus filtros, vamos abordar cada uma delas:

Matrícula

A fonte de dados de matrícula é uma das mais importantes e está diretamente relacionada com uma ou mais matrículas. A partir dela é possível navegar para a maior parte dos dados do sistema, já que boa parte deles está associada a ela. Esta fonte de dados é recomendada para a emissão de contratos, declarações, fichas, atestados e boletins.

Relacionamentos

Relacionamento Descrição
Matrícula / Aluno Dados do aluno
Matrícula / Aluno / Relacionamento Dados dos relacionamentos do aluno como pai, mãe, avô, avó, entre outros
Matrícula / Documento Lista de documentos com a situação
Matrícula / Curso Dados do curso
Matrícula / Módulo Dados do módulo
Matrícula / Turma Dados da turma
Matrícula / Calendário Acadêmico Dados do calendário acadêmico
Matrícula / Currículo Dados do currículo
Matrícula / Período Lista de períodos
Matrícula / Definição de Média Lista das definições de média, por exemplo: média semestral, média de recuperação e média final
Matrícula / Disciplina Lista de disciplinas
Matrícula / Disciplina / Turma Dados da turma associada a disciplina
Matrícula / Disciplina / Módulo Dados do módulo associado a disciplina
Matrícula / Disciplina / Nota Lista de notas na disciplina, indexada pelo período
Matrícula / Disciplina / Frequência Lista de frequência na disciplina, indexada pelo período
Matrícula / Disciplina / Média Lista de médias na disciplina, indexada pela definição de média
Matrícula / Disciplina / Parecer Descritivo Lista de pareceres descritivos na disciplina, indexada pelo período
Matrícula / Disciplina / Período / Média Lista de médias na disciplina, indexada pelo período
Matrícula / Disciplina / Aulas Lista de aulas na disciplina, indexada pelo período
Matrícula / Disciplina / Aulas / Frequencia Dados da frequência associados a aula
Matrícula / Contrato Lista de contratos associados a matrícula
Matrícula / Contrato / Fatura lista de faturas associadas a um contrato
Matrícula / Contrato / Fatura / Compra Lista de compras associadas a uma fatura
Matrícula / Contrato / Fatura / Desconto Lista de descontos associados a uma fatura
Matrícula / Contrato / Fatura / Pagamento Lista de pagamentos associados a uma fatura
Matrícula / Responsável Dados dos responsáveis acadêmico e financeiro

Objeto

O objeto contendo os dados é retornado no formato JSON, clique aqui para visualizar.

Filtros

Toda fonte de dados está associada a um conjunto de filtros. No caso da matrícula, os filtros são os seguintes:

  • Calendário Acadêmico
  • Curso
  • Módulo
  • Turma
  • Matrícula
  • Status

Além destes, existem também filtros avançados, utilizados para filtrar as faturas:

  • Mês de Início
  • Ano de Início
  • Mês de Fim
  • Ano de Fim
  • Itens
  • Descontos

O período compreendido entre os mês e ano de início e o mês e ano de fim será utilizado para filtrar as faturas pela competência financeira. Os itens e descontos podem ser utilizados para filtrar apenas as faturas que tiverem relação com os itens ou descontos.

Disciplina

A fonte de dados de disciplina incorpora a fonte de dados de matrícula, permitindo obter um conjunto de matrículas dentro de um conjunto de disciplinas. É indicada para emitir documentos como: Lista de alunos em uma determinada disciplina, mapa de notas da disciplina ou qualquer documento com dados disciplina como a lista de professores, de aulas ou de conteúdo.

Relacionamentos

Relacionamento Descrição
Disciplina Dados da disciplina
Disciplina / Curso Dados do curso associado a disciplina
Disciplina / Módulo Dados do módulo associado a disciplina
Disciplina / Turma Dados da turma associada a disciplina
Disciplina / Avaliação Lista de avaliações associadas a disciplina
Disciplina / Aula Lista de aulas associadas a disciplina
Disciplina / Professor Lista de professores associados a disciplina
Disciplina / Período Lista de períodos associados a disciplina
Disciplina / Conteúdo Lista de conteúdos associados a disciplina

Objeto

O objeto contendo os dados é retornado no formato JSON, clique aqui para visualizar.

Filtros

Os filtros são praticamente os mesmos da fonte de dados de matrícula.

Turma

A fonte de dados de turma incorpora a fonte de dados de matrícula e disciplina, permitindo obter um conjunto de matrículas dentro de um conjunto de disciplinas dentro um conjunto de turmas.

É indicada para emitir documentos como: Lista de alunos em uma determinada turma, mapa de notas da turma ou qualquer documento com dados da turma como a lista de professores, de aulas ou de conteúdo.

Relacionamentos

Relacionamento Descrição
Turma / Curso Dados do curso associado a turma
Turma / Módulo Dados do módulo associado a turma
Turma / Período Lista de períodos associados a turma
Turma / Definição de Média Lista de definições de média associados a turma

Objeto

O objeto contendo os dados é retornado no formato JSON, clique aqui para visualizar.

Filtros

Os filtros são praticamente os mesmos da fonte de dados de matrícula.