Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Para o desenvolvimento de relatórios é necessário possuir o Java™ JDK/JRE superior a 1.6. Endereço para download: http://java.sun.com/javase/downloads/index.jsp.

O fluig utiliza o BIRT - Business Intelligence and Reporting Tools - como motor de execução de relatórios, por esse motivo para o desenvolvimento de relatórios deve-se utilizar o padrão e a metodologia do BIRT. O BIRT é uma plataforma open source que facilita a modelagem de relatórios dentro do fluig.

A versão do BIRT utilizada no fluig é a 2.6.2. A partir da plataforma, é possível criar relatórios com:

  • Listagem
  • Agrupamento
  • Cálculos
  • Cartas e Documentos
  • Gráficos

Recomenda-se o uso do BIRT Report Designer para o desenvolvimento de relatórios para o fluig. O  O BIRT pode ser integrado ao Studio ou Eclipse (já instalados para utilização do fluig Studio, conforme Guia de instalação fluig Studio), basta instalar o plugin do BIRT. Para Para isso é necessário realizar acessar a opção Ajuda -> Instalar Novo Software e seguir os procedimentos a seguir: 

  1. Work with: Selecionar Indigo.
  2. Busca: Após listar as opções do BIRT, digitar Birt no campo de busca.
  3. Marcar a caixa de seleção de Business Intelligence, Reporting and Charting.
  4. Em seguida, acionar Avançar.

...

O BIRT Report Designer conta com várias funcionalidades que auxiliam no desenvolvimento de relatórios. Entre elas destacam-se: ajuste de layout, configuração de acesso a dados e formatação do relatório.

...

Para fazer conexão direta com banco de dados SQLServer SQLServer é preciso utilizar o seguinte padrão:

...

  • No projeto fluig previamente criado, clique com o botão direito do mouse na pasta reports, e em seguida em Novo -> Relatório fluig.
  • Em seguida basta informar o Nome do Relatório e clicar em Concluir.

...

Image Added

Figura 1 - Criação de relatório no projeto fluig.

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelPasso1

 

  • Ao criar o novo relatório, selecione a perspectiva Report Design e em seguida a aba Data Explorer, clique com o botão direito do mouse sobre o item Data Source em seguida selecione a opção New Data Source

Figura 5 2 - Novo Data Source.

 

Card
id2
labelPasso 2

 

  • Ao abrir a janela New Data Source, selecione a opção Scripted Data Source e define o nome dsColleague como Data Source Name em seguida clique no botão Concluir.

Figura 6 3 - Tipo de Data Source.


Card
id3
labelPasso 3

 

  • Na aba Data Explorer clique com o botão direito do mouse sobre o item Data Sets em seguida clique na opção New Data Set conforme figura 74. Data Set é uma tabela temporária do BIRT no qual os dados são armazenados do Data Source e renderizados no relatório.

Figura 7 4 - Novo Data Set.


Card
id4
labelPasso 4

 

  • Ao abrir a janela New Data Set define colleagueDataSet como Data Set Name, clique no botão Next em Output Columns clique no botão Add e adicione todas as os registros do DataSetData Set. Em seguida clique no botão Concluir.

 

Column Name

Data Type

Column Alias

Display Name

colleagueId

String

Vazio

Vazio

Login

String

Vazio

Vazio

colleagueName

String

Vazio

Vazio

mail

String

Vazio

Vazio

active

String

Vazio

Vazio

adminuser

String

Vazio

Vazio

 

Figura 8 5 - Colunas do Data Set.

 


Incluindo parâmetros no Relatório

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelPasso1

 

  • Selecione a aba Data Explorer, em seguida clique com o botão direito do mouse no item Report Parameters, selecione a opção New Parameter. 

Figura 9 6 - Parâmetros do Relatório.

 

Card
id2
labelPasso 2

 

  • A figura 10 7 ilustra a janela de inclusão de parâmetros.

Figura 10 7 - Configuração de parâmetros.


Ao abrir a janela New Parameter inclua os seguintes parâmetros:

 

Matrícula

CampoValor
NameMatricula
Prompt textMatrícula do Usuário ou "*" para mostrar todos
Data typeString
Display typeText Box
Is Requiredtrue

 

Mostra Usuários

CampoValor
NameparamEnable
Prompt textMostrar usuários
Data typeString
Display typeList Box
Is Requiredtrue

Selection Values

ValueDisplay Text
*Todos
trueAtivos
falseInativos

 

Ordenar Por

CampoValor
NameparamSort
Prompt textOrdenar por
Data typeString
Display typeList Box

Selection Values

ValueDisplay Text
c.colleaguePK.colleagueIdMatrícula
c.collegueNameNome
c.loginLogin

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelInitialize

 

  • Selecione a aba Script na pagina do relatório e em seguida selecione o evento initialize, inclua o seguinte código conforme figura 118:
Bloco de código
languagejavascript
importPackage(Packages.com.datasul.technology.webdesk.dataset.service);
importPackage(Packages.com.datasul.technology.webdesk.dataset);
importPackage(Packages.com.datasul.technology.webdesk.search.controller);
importPackage(Packages.java.util);
var count = 0;
var dataset = null;

Figura 11 8 - Evento initialize.

 

O código a cima importa as bibliotecas Java™ e a biblioteca disponibilizada pelo fluig para consulta aos dados do produto, além de realizar a inicialização das variáveis utilizadas pelo relatório.

Detalhes sobre o código:

    • importPackage: comando responsável pela importação de bibliotecas Java™.
    • Package.java.util: biblioteca responsável pelas Classes utils do Java™.
    • Packages.com.datasul.technology.webdesk.dataset.service: biblioteca disponibilizada pelo fluig para consulta ao banco de dados do produto.


Card
id2
labelBeforeOpen

 

  • Selecione a aba Data Explorer, expanda o item Data Sets e clique no colleagueDataSet em seguida clique na aba Script então selecione o evento beforeOpen e inclua o seguinte código conforme a figura 129.
Bloco de código
languagejavascript
try{
	var factory = DatasetFactory.getInstance(${WKCompany});
	var constraints = new Array();	
	var sortingFields = new Array();
	var i = 0;		
	 
	//Filtra somente pela matricula do colaborador informado
	if(params["Matricula"].value != null && params["Matricula"].value != "*") {		
		constraints[i] = factory.createConstraint("colleaguePK.colleagueId", params["Matricula"].value, params["Matricula"].value, ConstraintType.MUST);
		i++;
	}
	
	//Filtra ativos caso selecionado
	if(params["paramEnable"].value != null && params["paramEnable"].value != "*"){
		constraints[i] = factory.createConstraint("active", params["paramEnable"].value, params["paramEnable"].value, ConstraintType.MUST);
		i++;
	}
	
	//Ordena conforme seleção
	if(params["paramSort"].value != null && params["paramSort"].value != "*"){
		sortingFields[0] = params["paramSort"].value;
	}	
	
	//Dataset
	dataset = factory.getDataset("colleague", null, constraints, sortingFields);
	
}catch (e) {
}finally {
}

Figura 12 9 - Evento BeforeOpen.


O código acima monta a consulta do relatório através da consulta via dataset e inclui os filtros da solicitação de acordo com os parâmetros definidos pelo usuário.

Detalhes sobre o código:

  • ${WKCompany}: TAG disponibilizada pelo fluig, retorna o código da empresa que o usuário está autenticado;
  • params["Matricula"]: parâmetro de relatório, retorna o código da matricula definido pelo usuário;
  • params["paramEnable "]: parâmetro de relatório, retorna o tipo de usuário;
  • params["paramSort "]: parâmetro de relatório, retorna o modo de ordenação;

Card
id3
labelFetch
  • Para incluir o resultado da consulta no Data Set e  formatar os dados do relatório, selecione o evento fetch na área de Script e inclua o seguinte códigoconforme figura 1310.
Bloco de código
languagejavascript
if (dataset != null) {
	if (count <	dataset.rowsCount){
		//monta o objeto da linha
		row["colleagueId"] = dataset.getValue(count, "colleaguePK.colleagueId");
		row["login"] = dataset.getValue(count, "login");
		row["colleagueName"] = dataset.getValue(count, "colleagueName");
		row["mail"] = dataset.getValue(count, "mail");
		
		if(dataset.getValue(count, "active") == true){
			row["active"] = "Sim";
		}else{
			row["active"] = "Não";
		}
		
		//Atualiza o contador  
		count++;
		return true;
	}
}
return false;

Figura 13 10 - Evento fetch.


 

Obtendo dados via conexão JDBC

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelPasso 1

 

  • Selecione a aba Data Explorer, clique com o botão direito do mouse sobre o item Data Source em seguida selecione a opção New Data Source conforme a figura 1411.

    Figura 14 11 – Novo Data Source


Card
id2
labelPasso 2

 

  • Ao abrir a janela New Data Source, selecione a opção JDBC DataSource e define o nome JDBC-DataSource como Data Source Name em seguida clique no botão Next, conforme a figura 1512.

    Figura 15 12 – Tipo Data Source


Card
id3
labelPasso 3

 

  • Na próxima janela a conexão com o banco de dados deve ser configurada. 

    No campo Driver Class selecione o driver de conexão com o banco de dados, neste caso, a conexão será feita com o banco MySQL®. Se o driver necessário não estiver listado, basta adiciona-lo clicando em Managed Drivers...

    Informe também os valores para Database URL, User Name Password de acordo com o banco de dados escolhido, conforme a figura 1613.

    Figura 16 13 – Configurando conexão com banco de dados.


Card
id4
labelPasso 4

 

  • Na aba Data Explorer clique com o botão direito do mouse sobre o item Data Sets em seguida clique na opção New Data Set.

    Figura 17 14 – Criando Novo Data Set.


Card
id5
labelPasso 5

 

  • Selecione o DataSource criado (JDBC-DataSource), no campo Data Set Type selecione SQL Select Query, informe um nome para o Data Set e clique em nextem Next, conforme a figura 1815.

Figura 18 15 – Configurando Data Set.


Card
id6
labelPasso 6

 

  •  Na próxima tela informe a SQL que busca os dados no banco de dados, neste exemplo, serão buscados os volumes da empresa autenticada no fluig.

Figura 19 16 – Criação da Query SQL


  • A Query abaixo busca no banco de dados todos os volumes da empresa do usuário autenticado no fluig, este código é obtido através da TAG ${WKCompany}.

Bloco de código
languagejava
SELECT vol_fisic.CD_VOL_FISIC,
         vol_fisic.COD_EMPRESA,
         vol_fisic.NOM_DIR_FISIC,
         vol_fisic.ID_TIP_VOL_FISIC
FROM vol_fisic
WHERE vol_fisic.COD_EMPRESA = ${WKCompany}
Informações
titleNota

Poderá ocorrer um erro quando concluir a criação do Data Set pois a TAG  ${WKCompany} não existe no contexto do BIRT. A figura a seguir apresenta o erro devido à utilização da TAG, este é um erro de sintaxe no SQL e indica que ${WKCompany} não é um comando SQL. Porém quando o relatório for executado no fluig, ela retornará o código da empresa normalmente, com isso a TAG será substituída pelo código da empresa do usuário autenticado no fluig, corrigindo o erro de sintaxe.

Figura 20 17 – Erro do Birt pelo uso da TAG ${WKCompany}


Nota
titleAtenção

A criação de relatório no Birt BIRT utilizando conexão JDBC exige atenção com relação à segurança da publicação do relatório no fluig, uma vez que o arquivo .rptdesign (XML do relatório Birt) deixa exposto os parâmetros de conexão com o banco de dados, porém o campo senha fica ofuscado com base64. Por este motivo e pela facilidade de busca das informações do fluig, sempre recomendamos a criação de relatórios com fontes de dados via Dataset do fluig ou query JPA.

Se a criação de relatórios utilizando JDBC for necessária, recomendamos que ao publicar um relatório no fluig as configurações de permissão sejam definidas apenas para leitura. Usuários que possuem permissão de manutenção podem fazer o download dos anexos e com isso terão acesso aos dados de conexão com o banco de dados.

...

É necessária a inclusão dos componentes de renderização do relatório. Clique na aba Layout para visualizar a página do relatório que está em branco e em seguida selecione a aba Palette conforme a figura 2118.

Figura 21 18 – Relatório em branco.

Na aba Pallets é possível incluir vários componentes de visualização e renderização de dados entre eles destacam-se:

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelComponente Image

 

  • É possível incluir imagens da internet, incluir imagens de arquivo ou ainda embutir a imagem no XML do relatório. Neste exemplo será usada uma imagem em anexo para posteriormente mostrar como publicar relatórios com anexo.

    Arraste um componente Image no relatório, ao abrir a janela Edit Image Item, selecione a opção Image file in shared resources, selecione o arquivo da imagem na opção Enter resource file e em seguida clique no botão Insert.

    Figura 22 19 – Componente Image.


Card
id2
labelComponente Text

 

  • Arraste um componente Text no relatório, ao abrir a janela Edit Text Item selecione a opção HTML e na área de texto inclua a seguinte informação formatada em HTML:

Bloco de código
languagehtml/xml
<br>
<a href="http://www.fluig.com/">http://www.fluig.com/</a>
<br><b>E-mail:</b> <a href="mailto:[email protected]">[email protected]</a>
<br><b>Telefone:</b> 0800 882 9191
<br>
  • Em seguida clique no botão OK conforme figura 2320.

Figura 23 20 - Componente Text.


Card
id3
labelComponente Label

 

  • Arraste um componente Label no relatório, clique duas vezes sobre o componente incluído  e digite Relatório de Usuários, na aba Property Editor - Label -> General defina a formatação da label, conforme figura 2421.

 

Figura 24 21 - Título do relatório.


Card
id4
labelComponente Table

 

  • Arraste um componente Table, ao abrir a janela Insert Table defina 6 colunas e 1 detalhe e clique no botão OK conforme figura 2522.

Figura 25 22 - Configuração da Tabela.


Card
id5
labelLables para Table

 

Na tabela adicionada ao relatório inclua um componente Label para cada coluna da linha Header Row defina os seguintes valores:

  • Matrícula.
  • Nome.
  • Login.
  • E-mail.
  • Ativo.
  • Administrador.

Formate as labels incluídas definindo cor da fonte e cor de fundo conforme figura 2623.

Figura 26 23 - Título das Colunas.


 

Renderizando dados do Data Set

Selecione a aba Data Explorer e expanda o colleagueDataSet criado anteriormente e em seguida arraste cada item do Data Set para a coluna Detail Row da tabela criada anteriormente conforme figura 2724

Figura 27 24 - Data Set.

 

Publicando Relatórios

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelPasso1

 

Para isso clique sobre o pasta do relatório com o botão direito do mouse e acione Exportar.

Figura 28 25 – Exportação de Relatório.


Informações
titleNota

Os anexos são exportados junto ao relatório. Na exportação, o arquivo .rptdesign é automaticamente identificado como arquivo principal, e os demais arquivos são classificados como anexo.

Card
id2
labelPasso 2

 

  • Na tela de Exportação, clique sobre Expotar Exportar para o servidor fluig e em seguida acione Avançar.

     

    Figura 29 26 – Exportação de relatório.


Card
id3
labelPasso 3

 

  • Na tela Exportar Relatório, é necessário informar o nome do Servidor, identificar se está será a publicação de um Novo Relatório, definir o nome do relatório, a Pasta Destino (conforme imagem foi informado o código da pasta destino) e em seguida mencionar o tipo de Versionamento (como estamos fazendo uma nova publicação, selecionamos Manter Atual).

    Figura 29 27 – Exportação de relatório.


Card
id4
labelPasso 4

 

  • Na pasta Relatório da Navegação de Documentos será possível observar que o relatório foi publicado com sucesso.

Figura 29 28 – Publicação de relatório.


...

Uma nova janela deverá abrir, para iniciar a execução do relatório de colaboradores desenvolvido anteriormente é necessária a inclusão de parâmetros, defina os seus valores e em seguida clique no botão OK.

Figura 32 29 – Parâmetros do relatório.

...

O relatório deverá mostrar todos os usuários cadastrados no fluig para a empresa em que o usuário está autenticado.

Figura 33 30 – Relatório de Usuários– Resultado.

...

  • Verificar Indice: Caso o relatório desenvolvido possua índice é possível listá-lo.
  • Executar relatório: Permite que o relatório seja executado novamente.
  • Exportar dados: Exporta os dados gerados do relatório em arquivo, permitindo selecionar as colunas desejadas e o separador de dados.
  • Exportar relatório: Converte os dados do relatório em diferentes formatos de arquivos: Microsoft® Excel®, PostScript®, PDF, Microsoft® Word e Microsoft® Power Point®, permite também a seleção de páginas que serão exportadas.
  • Imprimir relatório: Imprime relatório selecionando as impressoras instaladas no computador do usuário autenticado e permite imprimir em formato PDF ou HTML.
  • Imprimir relatório no servidor: Imprime relatório a partir das impressoras instaladas no servidor do fluig.
  • Navegação de páginas: permite a navegação entre as páginas do relatório.

Image Modified

Figura 34 31 – Funcionalidades do visualizador de relatórios.

...