Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: DI-2733

A ferramenta de relatório do Cronapp possui diversos recursos para permitir a criação de relatórios bem elaborados de forma rápida, podendo ser alimentado por Fonte de dados ou arquivos. 

Os relatórios criados no Cronapp podem ser visualizados através do componente Visualizador de relatório, chamada de eventos ou pelo bloco de programação Abrir relatório.


Image Added

Figura 1 - Pré-visualização de um relatório

Criar relatório

O Cronapp possui o diretório Relatórios (Localização: Relatórios/ 

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: src/main/java/reports/

) para armazenar e manter esse conteúdo (Figura 3). Caso seja o primeiro relatório do projeto, clique no ícone de atalho (destaque 1 da figura 3) para criar o diretório e ser direcionado até ele.

É possível criar relatórios novos ou gerar relatórios a partir de uma Fonte de Dados ou classe do Diagrama. A seguir, forneceremos uma descrição mais detalhada de cada uma dessas opções.

A partir da Fonte de dados ou Classe

Para gerar relatórios com os atributos de uma classe no Diagrama de Dados (destaque 1 na figura 2) ou com os campos de uma Fonte de Dados (2), basta acessar o item Ação do menu de contexto.

A figura abaixo utiliza a classe "User" presente no Diagrama de dados. Para começar, clique com o botão direito sobre ela e selecione no menu Ação > Novo relatório. Isso abrirá a janela de Configuração.

A janela de Configuração contém cinco colunas. Na coluna Campo (3), encontram-se listados os atributos da classe ou Fonte de dados. Na segunda coluna, Rótulo (4), estão os labels definidos ao configurar a classe no Diagrama de dados, esse campo permite edição. Os destaques 5 e 6 representam, respectivamente, os botões de ordenação para mover um atributo para cima ou para baixo. Caso seja necessário, é possível excluir um atributo clicando no ícone da lixeira (7). No campo Nome (8) é possível definir o nome do relatório.


Image Added

Figura 2 - Criando relatório através de uma classe ou fonte de dados


Informações

Caso uma Fonte de dados possua algum tipo de filtro e um relatório seja criado a partir dela, os filtros serão incluídos automaticamente no relatório.

Novo Relatório

Utilize o diretório Relatório para criar um relatório, clique no botão (+) (destaque 1 da figura 3) exibido ao lado do diretório ou através do menu de contexto, selecionando Novo Relatório. Após isso, será exibida a janela "Novo" (2), onde é possível escolher um relatório "Em branco" ou um dos vários templates de relatórios disponíveis. Essa janela apresenta um campo de busca (3) e uma lista de templates. Selecione um dos modelos, clique em Avançar para informar o nome do arquivo (4) e clique em Finalizar.


Image Added

Figura 3 - Criando relatório

Alterar a Fonte de dados do template

Com exceção do modelo "Em Branco", todos os outros são criados com uma Fonte de dados de exemplo. Para inserir a sua Fonte de dados é necessário importar uma nova fonte de dados e substituir os campos. 

Para substituir a Fonte de dados pela a que acabamos de importar, clique duas vezes no componente Faixa de Dados (destaque 1 da figura 3.1) para exibir a janela Dados, nela serão apresentadas todas as Fontes de dados contidas no relatório, selecione a Fonte desejada e clique em Ok.

O destaque 3 da figura 3.1 apresenta os atributos da Fonte de dados anterior, para alterá-los, clique duas vezes sobre o atributo e selecione um atributo da nova Fonte de dados.

Os templates possuem variáveis de sistema (destaque 4), para alterá-las, clique duas vezes sobre o campo para abrir a janela de configuração de texto, clique na subaba HTML e altere o valor.


Image Added

Figura 3.1 - Adicionando uma nova fonte de dados e alterando os atributos


Confira o resultado final da nossa configuração na figura abaixo.


Image Added

Figura 3.2 - Pré-visualizar

Visão geral do novo relatório

O editor de relatório apresenta diversas ferramentas para construir um relatório poderoso e de maneira simples através de seus componentes. Para iniciar a configuração do relatório, basta arrastar e soltar os componentes na área de edição (3), eles serão automaticamente encaixados na tela. Clique sobre um desses componentes para editá-los a partir do menu lateral (2). 


Image Added

Figura 4 - Visão geral do relatório


  1. Menu superior.
  2. Menu lateral.
  3. Área de edição do relatório.
  4. Menu inferior.

Âncora
menuSuperior
menuSuperior

Menu superior

O menu superior é composto por três botões e seis abas, os dois botões iniciais têm a finalidade de desfazer e refazer uma ação, as abas são divididas em: Arquivo, Início, Inserir, Página, Layout e Pré-visualizar (destaque 1 da figura 4.1). Além disso, o botão apresentado pelo destaque 2 faz com que a aba selecionada no menu se expanda ou retraia, apresentando ou escondendo suas ferramentas correspondentes. Nos subtópicos a seguir detalharemos cada aba.


Image Added

Figura 4.1 - Menu superior

Aba Arquivo

Clicando na aba Arquivo será possível escolher um relatório vazio ou novo template para seu relatório, ao fazer isso, o relatório atual será substituído.


Image Added

Figura 4.1.1 - Aba Arquivo


  1. Relatório em Branco: cria um relatório sem nenhuma Fonte de dados ou componentes, o usuário deve inseri-los manualmente.
  2. Relatório Padrão: o assistente de relatório padrão é usado para criar relatórios como uma lista. Neste tipo de relatório só é permitido utilizar uma Fonte de dados.
  3. Relatório de Mestre-Detalhe: utiliza o relacionamento entre Fontes de dados para gerar um relatório.


Clicando duas vezes em qualquer um dos templates, a janela Novo Relatório será exibida, ela possui uma sequência de passos para configurar a(s) Fonte(s) de dados e o Layout do relatório.


Image Added

Figura 4.1.2 - Janela Novo Relatório


  1. Fonte de Dados: esta etapa é obrigatória e permite selecionar a Fonte de dados. Essa janela possui dois campos:
    • Nova Fonte de Dados: adiciona uma nova Fonte de dados.
    • Excluir: deleta a Fonte de dados selecionada.
  2. Selecione as Colunas: define os atributos que serão utilizados no relatório. Esta etapa é obrigatória.
  3. Ordem de Colunas: utilize as setas para cima e para baixo para redefinir a posição dos atributos nas colunas no relatório. O primeiro atributo corresponde à coluna mais a esquerda enquanto o último ficará na coluna mais à direita.
  4. Ordem: esta etapa exibe os atributos da Fonte de dados e opções de ordenação da lista, crescente ou decrescente.
  5. Filtros: nesta etapa é possível adicionar um ou mais filtros para o relatório. Contém campos de configuração geral dos filtros e campos para configurar cada filtro:
    • Adicionar Filtro: inclui uma caixa de filtro com os campos de configuração de um filtro.
    • Filtro habilitado: ao desativar, todos os filtros configurados serão ignorados.
    • Modo de Filtro: gera condicional "E" ou "OU" entre os filtros, só estará ativo quando existirem 2 ou mais Caixas de filtros. 
    • Caixa do Filtro: as caixas de filtros podem ser ordenadas, basta clicar e arrastar para a nova posição. Clique no "x" dentro da caixa de filtro para excluir o filtro selecionado.
      O conteúdo da caixa de filtro pode variar a partir do primeiro campo "Se o campo for".
      • Se o campo for: define o tipo de filtro.
        • Expressão: gera filtro a partir de uma expressão.
        • Valor: gera filtro a partir de um atributo.
          • Tipo de dados: campo onde definimos qual o tipo de dado utilizado no filtro: numérico, data e hora, boolean, expressão.
          • Coluna: apresenta os atributos da Fonte de dados.
          • Comparação: opções de comparação e negação para: igual, contém, começa e nulo. 
          • Valor: conteúdo a ser comparado.
  6. Grupos: permite agrupar os dados a partir por um dos atributos.
  7. Totais: nesta etapa, é possível selecionar uma função preestabelecida para qualquer coluna da fonte de dados, exemplo: somatório, maior valor, valor mínimo.
  8. Temas: define o estilo do relatório.
  9. Layout: são definidas opções como orientação da página (vertical e horizontal) e unidade (cm, mm, ...).

Aba Início

A aba início apresenta as ferramentas

Introdução

A criação de relatórios mudou com a nova versão da IDE. Contudo, caso você tenha projetos que foram criados na antiga versão e eles possuam relatórios, é possível utilizá-los nessa versão. Além disso, nessa página será mostrado o layout do novo relatório, como a distribuição do seus componentes e elementos.

Criação de relatório

Existe um ícone que, ao clicá-lo, cria uma pasta específica de gerar relatórios (Figura 1), que serve para organizá-los. Para gerar os relatórios, basta clicar em cima da pasta reports com o botão direito e gerar um novo relatório (Figura 2).

Image Removed

Figura 1 - Pasta padrão para guardar relatórios

Image Removed

Figura 2 - Caminho para gerar relatórios

No entanto, é possível criar relatório em qualquer pasta da IDE, basta clicar com o botão direito do mouse em cima da pasta desejada.

Relatórios da versão 1.0 do Cronapp

A versão antiga da IDE trabalhava com relatórios utilizando Jasper e Ad-hoc. Essa opção estará habilitada somente se você tenha inicializado projetos na versão antiga da IDE e tenha criado relatórios. 

Para isso, basta clicar em Projetos e ir em Relatórios, como mostra a Figura 3.

Image Removed

Figura 3 - Relatórios da antiga versão

Overview

Menu superior

Image Removed

Figura 4 - Menu superior

Início

A aba de início apresenta as funções de clipboard, fonte, alinhamento, bordas, formato do texto e estilos.


Image Added

Figura 4.1.3 - Aba início

Aba Inserir

A aba de inserir apresenta elementos que são inseridos no relatório, como adicionar uma as funcionalidades de novo item, categoriais e componente, no quais é possível adicionar página, faixa, faixa cruzada, componentes, código de barras, formas e infográficos. Ele também exibe os itens mais usados dos elementos que contém nessa aba. Além disso, tem-se possui uma caixa de ferramentas, onde você consegue adicionar ou remover os itens que são exibidos na aba .

Informações
titleObservação

Esses elementos são do tipo arrasta-solta. Ou seja, para serem inseridos no relatório eles precisam ser arrastados até a página que compõe esse relatório.

Os elementos da aba inserir podem também ser encontrados ao lado do menu lateral.

(destaque da Figura 4.1.4).


Image AddedImage Removed

Figura 4.1 - Elementos da aba Inserir ao lado do Menu lateral.4 - Aba inserir

Aba Página

A aba de página apresenta todas as configurações que podem ser feitas, como margens e orientação, e exibi as opções da página, como a grade e cabeçalho.

Layout

configurações de margens, orientação, colunas como também habilitar as opções de exibir grade e cabeçalho, etc. (Figura 4.1.5).


Image Added

Figura 4.1.5 - Aba página


Aba Layout

A aba A aba de layout apresenta todas as opções de organização dos elementos que se encontram na página do relatório e o design dos mesmos. Essa opção só fica disponível quando o elemento ou conjunto de elementos é selecionado.

Pré

estão selecionados.


Image Added

Figura 4.1.6 - Aba layout

Aba Pré-visualizar

A aba de pré-visualização visualizar mostra como será o resultado do relatório.

Nota

A pré-visualização se trata de uma apresentação parcial, modificações na Fonte de dados podem demorar para renderizar, nesses casos, salve o relatório, rode o projeto e visualize o relatório executando dentro da aplicação.

Os Campos calculados da Fonte de dados não são exibidos na funcionalidade Pré-visualizar, somente em modo de execução.


Image Added

Figura 4.1.7 - Aba pré-visualizar

Âncora
menuLateral
menuLateral

Menu lateral

O menu lateral apresenta as propriedades do elemento selecionado na área de design do relatório, podendo ser da própria página ou de um componente, também apresenta as Fontes de dados e a árvore hierárquica do relatório. Ele possui um ícone de atalhos da aba inserir do menu superior e alguns ícones de configuração do menu lateral

(Figura 4.2).


Image AddedImage Removed

Figura 5 - Menu lateral

Propriedades

4.2 - Menu lateral


  1. Ícone de atalhos: apresenta os principais elementos da aba inserir do menu superior.
  2. Ícones de configuração do menu lateral.
    • Propriedades: selecionado por padrão, exibe as propriedades do elemento selecionado.
    • Eventos: exibe os eventos que podem ser associados ao elemento selecionado, podendo ser de navegação como de impressão.
    • Colocações: habilita a localização da grade.
    • Fixa ou desprende o menu lateral do relatório.

Propriedades

A aba A aba de propriedades varia conforme o elemento selecionado na página (Figura 4.2.1 e 4.2.2), mas ele exibe todas as configurações que podem ser feitas no elemento.

Além disso, essa aba apresenta opções de visualização – através dos ícones. O padrão é o de propriedade, mas tem também o de eventos (ícone de raio) e a aba de eventos apresenta as configurações relacionadas ao que fazer antes ou após um evento ocorrer, podendo ser de navegação como de impressão.

Dicionário

A aba de dicionário é onde faz toda a configuração de fonte de dados, variáveis do sistema, funções e recursos.

Árvore de relatório

.


Image Added

Figura 4.2.1 - Propriedades referente ao componente cabeçalho


Image Added

Figura 4.2.2 - Propriedades do componente gráfico

Dicionário 

Na aba Dicionário é possível adicionar e remover Fontes de dados, Variáveis do sistema, variáveis criadas pelo usuário, funções e Recursos do relatório.

Informações

Para utilizar esse recurso é preciso que haja uma Fonte de dados associada ao relatório, clique no menu Novo Item > Nova Fonte de Dados e selecionar a fonte de dados desejada.


Image Added

Figura 4.2.3 - Dicionário


  1. Controles: menus e botões para manipulação dos recursos.
    • Ações: exibe ações para os recursos do dicionário.
      • Novo dicionário: limpa o dicionário atual e suas configurações.
      • Abrir dicionário: abre as configurações do dicionário a partir de um arquivo de configurações do dicionário.
      • Salvar dicionário como: permite exportar as configurações do dicionário atual para um arquivo de configurações.
      • Sincronizar: recarrega o dicionário.
    • Novo item: exibe ações para os recursos do dicionário.
      • Nova fonte de dados: adiciona uma Fonte de dados do Cronapp ou um dos arquivos: JSON, CSV e Excel.
      • Nova transformação de dados; cria um atributo a partir de um existente.
      • Nova coluna: (essa opção só será exibida quando um campo da fonte de dados estiver selecionado na área de recursos, destaque 2) - insere uma nova coluna (atributo) na fonte de dados.
      • Nova coluna calculada: (essa opção só será exibida quando um campo da fonte de dados estiver selecionado na área de recursos, destaque 2) - insere uma nova coluna calculada na fonte de dados.
      • Novo relacionamento: cria uma relação entre duas fontes de dados que possuam um atributo de relação.
      • Nova categoria: cria uma categoria de variáveis.
      • Nova variável: cria uma variável.
      • Novo recurso: cria um recurso (arquivo) no diretório "Recursos".
    • Editar: abre a janela de edição dos recursos criados pelo usuário. Exemplo: Fonte de dados, campos da fonte de dados, variáveis, recursos etc. 
    • Excluir: deleta o recurso selecionado e criado pelo usuário. Exemplo: Fonte de dados, campos da fonte de dados, variáveis, recursos etc. 
    • Mover para cima: habilitado somente quando um atributo da fonte de dados estiver selecionado e quando esse elemento não for o primeiro, ele move o atributo da fonte de dados para cima.
    • Mover para baixo: habilitado somente quando um atributo da fonte de dados estiver selecionado e quando esse elemento não for o último, ele move o atributo da fonte de dados para baixo.
  2. Recursos
    • Fonte de dados: lista as fontes de dados (e seus campos) vinculados ao relatório.
    • Variáveis: lista as variáveis criadas pelo usuário.
    • Variáveis do Sistema: lista um conjunto de variáveis pré-definidas, normalmente são variáveis que fornecem informações sobre o status atual de um relatório e são do tipo somente leitura.
    • Funções: lista um conjunto de funções pré-definidas que podem ser utilizadas no relatório.
    • Recursos: espaço destinado para armazenar recursos que podem ser utilizados no relatório, são eles:
      • Arquivos de dados - CSV, Excel, JSON, XML, DBF;

      • Arquivos de imagem - SVG, JPEG, JPG, PNG, BMP, GIF e outros arquivos de imagem.

Âncora
novaFonteDados
novaFonteDados

Nova fonte de dados

Ao clicar na opção Nova fonte de dados, será exibida a janela Selecionar o tipo de conexão, através dela poderemos incluir no relatório diferentes tipos de Fontes de dados: os arquivos CSV, Excel ou JSON e a Fonte de dados do Cronapp.

Existem três formas de adicionar uma nova Fonte de dados: a primeira é logo após a criação do arquivo relatório, onde será exibida a opção Criar nova Fonte de dados; a segunda é através do menu Novo item, por fim, ao clicar com o botão direito na área de destaque 2 da figura 4.2.3 e selecionando a opção Nova fonte de dados.


Image Added

Figura 4.2.3.1 - Nova Fonte de Dados


  1. Menu de Filtros: exibe os filtros que irão alterar o modo de exibição das fontes de dados na janela Selecionar o tipo de conexão.
    • Procurar: utilizado para buscar uma fonte de dados específica. 
    • Categoria: selecione Tudo para exibir todas as categorias ou selecione uma categoria específica.
  2. Favoritos: campo destinado a exibir as Fontes de dados favoritas do usuário. Para favoritar uma fonte de dados, clique no ícone de estrela que aparece quando colocamos o mouse em cima da opção. Por padrão, a Fonte de Dados do Cronapp já vem favoritada.
  3. Arquivo: exibe as Fontes de dados obtidas a partir de arquivos: CSV, Excel e JSON.
  4. Ocultar fontes de dados não suportadas: oculta as Fontes de dados que não são suportadas atualmente pelo Cronapp.


Ao selecionar a Fonte de dados Cronapp, a janela padrão de seleção de fonte de dados é exibida. Porém, ao selecionar uma das opções de arquivos, a janela exibida será a Nova conexão. Essa janela possui campos comuns a todos os arquivos e campos específicos. 


Image Added

Figura 4.2.3.2 - Configurando a nova fonte de dados escolhida


Para este exemplo utilizamos o tipo de fonte de dados CSV, ele possui alguns campos em comum com os tipos de fonte de dados Excel e JSON.

Campos em comum:

  1. Nome: especifica o nome da Fonte de dados. 
  2. Apelido: define um alias para a Fonte de dados.
  3. Caminho para Dados: clique no botão "..." para selecionar um arquivo em seu computador.
  4. Campos específicos: os campos abaixo vão variar em relação ao arquivo selecionado.
    • CSV
      • Codificando: neste campo é possível informar a codificação do arquivo, para mais informações clique aqui.
      • Separador: define qual tipo de separador será utilizado no CSV, podendo ser: aba, ponto e vírgula, vírgula, espaço ou outro.
    • Excel
      • A primeira linha é cabeçalho: campo booleano que usa a primeira linha no arquivo do Excel como um cabeçalho para os dados. Se estiver habilitado, a primeira linha será o cabeçalho dos dados.
    • JSON
      • Direção da relação: define como os dados do arquivo serão importados.
        • Pai-Para-Filho: quando essa opção é selecionada, a fonte de dados é estruturada de forma que os objetos pais são listados primeiro, seguidos pelos objetos filhos que pertencem a cada objeto pai. Essa direção de relação é usada para exibir informações que têm uma hierarquia, como uma lista de categorias e subcategorias.
        • Filho-Para-Pai: quando essa opção é selecionada, a fonte de dados é estruturada de forma que os objetos filhos são listados primeiro, seguidos pelos objetos pais a que pertencem. Essa direção de relação é usada para exibir informações que têm um relacionamento de dependência, como uma lista de tarefas e seus projetos associados.
  5. Recursos: esse campo exibe a galeria de recursos selecionados, é possível selecionar mais de um arquivo do mesmo tipo.


Após selecionar o arquivo e clicar em Ok o arquivo será incluído na propriedade Fonte de Dados (destaque 1 da figura 4.2.3.3) e a janela de seleção de dados será exibida, dessa forma, o usuário pode decidir se quer trabalhar com todos os campos da fonte ou somente alguns.


Image Added

Figura 4.2.3.3 - Janela de seleção de dados

Âncora
variaveisSistema
variaveisSistema

Variáveis de sistema

As variáveis de sistema podem ser criadas nos relatórios ou encontradas em templates (destaque 4 da figura 3.1). Nos templates, elas são configuradas como somente leitura, ou seja, não podem ser editadas, por isso, precisamos criar nossa própria variável de sistema, 

Clique com o botão direito do mouse em cima do campo Variáveis de Sistema, isso fará com que um menu de contexto seja exibido, selecione a opção Nova Variável, uma janela para configuração da variável será exibida, confira na imagem abaixo.


Image Added

Figura 4.2.3.4 - Adicionando uma nova variável de sistema


  1. Nome: especifica o nome da variável usada no relatório.
  2. Apelido: nome da variável que é exibida ao usuário.
  3. Descrição: descrição da variável.
  4. Tipo: neste campo você pode alterar o tipo de dados que serão colocados em uma variável e o tipo da variável. Ele é representado por dois campos com listas suspensas. A primeira lista é uma lista de todos os tipos de dados disponíveis divididos em categorias: string, float, double, decimal, datetime, timespan, sbyte, byte, byte[], short, ushort, int, uint, long, ulong, bool, char, guid, object ou image. A segunda lista apresenta o modo como a variável será exibida, podendo ser: valor, nullable valor, faixa ou lista.
  5. Iniciar por: o campo iniciar por apresenta uma lista suspensa com duas opções: valor e expressão.
  6. Valor: este campo apresenta o texto final que o usuário quer que seja exibido no relatório.
  7. Somente Leitura: define o modo somente leitura. Neste caso, o valor armazenado em uma variável é retornado e o usuário não pode alterá-lo. 
  8. Solicitado ao usuário: estabelece um modo em que o valor retornado pode ser alterado pelo usuário.
  9. Permitir utilizando como parâmetro de SQL: possibilita utilizar uma variável como parâmetro na consulta ao selecionar dados.

Árvore de relatório

A aba Árvore A árvore de relatório exibe todos os elementos e itens em que ele é constituído, da mesma forma de uma árvore de projeto, com menus e subsubmenus - menus. No entanto, no caso da árvore, é mostrado na forma de suas páginas e os elementos que contém em cada página

Menu inferior

Image Removed

Figura 6 - Menu inferior

(Figura 4.2.4).


Image Added

Figura 4.2.4 - Árvore de relatório

Âncora
menuInferior
menuInferior

Menu inferior

Apresenta as unidades de medida para definir os componentes da página, o valor de zoom do relatório, o elemento selecionado na área de design do relatório, a funcionalidade de varrer o relatório por possíveis erros, etc.


Image Added

Figura 4.3 - Menu inferior


  1. Define

  2. A primeira coluna define
  3. a unidade de medida dos componentes da página, podendo ser centímetros, centésimos de polegada, polegadas e milímetros.

  4. Conforme selecionado, ele será mostrado no título da aba.
  5. Ao clicar na segunda coluna , será feita uma varredura em todo o relatório, e, ao final, será aparecerá uma janela informando os possíveis erros, avisos, informações de mensagens e relatório de prestação de mensagens.

  6. A terceira coluna mostra Mostra o título do elemento selecionado no relatório, podendo ser a página ou um componente de texto e etc.

  7. A quarta coluna mostra a posição do mouse no relatório, mas ao selecionar um componente no relatório ele informará a posição x e y desse componente assim como a largura e a altura.coluna informa as coordenadas x e y do mouse ou do componente selecionado dentro do relatório, assim como largura e altura.

  8. Zoom definido pelo tamanho do relatórioA quinta coluna traz dois ícones de zoom:
    • Largura da Página:
    ao clicar nesse ícone, a área do relatório será preenchida conforme a largura da página
    • altera o zoom do relatório para ver a página inteira na janela.
    • Altura da Página:
    ao clicar nesse ícone, a área do relatório será preenchida conforme a altura da página.
  9. A sexta coluna define o zoom da área do relatório.

 

    • altera o zoom de modo que a largura do relatório corresponda à largura da janela.
    • Informa o percentual utilizado no zoom.
  1. Define o valor do zoom do relatório.
  2. Informa o zoom atual e ao clicar sobre a opção, ele apresenta outros valores de zoom.

Nesta página

Índice


Conteúdo complementar

Exibir filhos

Painel
titleNessa Página
toc