manuelle d’utilisation de l’outil de reporting de oxiareport

Consulting-Business Solutions-Software Engineering-Managed Services

[email protected] - www.oxia-group.com

Version0.9.0 /15

Page 1/15



Version 0.9.0 P

age 1/15

M014-Mis en Application- 26/10/2007 V1-2-0

Manuelle d’utilisation de l’outil de

reporting de OXIAReport

Version 0.9.0 07/09/2006

Auteur(s) Tarek AKIK

Statut Revue Interne

Classification Confidentiel

Référence



Version0.9.0 /15

Page 2/15



Version 0.9.0 P

age 2/15


GESTION DU DOCUMENT

Gestion de Versions

Version Date Auteur(s) Description/Liste des Changements

0.9.0 14/01/2006 TAK Première Revue Interne

Informations Document

Auteur

Contribution

Autorisations Internes

Prénom Nom Fonction Signature Date



Version0.9.0 /15

Page 3/15



Version 0.9.0 P

age 3/15


TABLE DES MATIERES

TABLE DES MATIERES ______________________________________________________ 3

1. INTRODUCTION ________________________________________________________ 4

2. INSTALLATION ________________________________________________________ 4

2.1 PRE REQUIS __________________________________________________________ 4

2.2 Déploiement de l’application ______________________________________________________ 4

3. CONFIGURATION _______________________________________________________ 6

3.1 Base de données __________________________________________________________________ 6

3.2 Application _______________________________________________________________________ 8

3.2.1 Configuration d’Hibernate ______________________________________________________ 8

dossier de base de l’application ______________________________________________________ 8

4. GUIDE D’UTILISATION____________________________________________________ 9

4.1 Gestion des connexions ____________________________________________________________ 9

4.2 Gestion des rapports ______________________________________________________________ 11

4.2.1 Ajout d’un nouveau rapport ____________________________________________________ 11

4.2.2 Configuration des paramètres d’un rapport ____________________________________ 11

4.2.3 Impression du rapport _____________________________________________________ 14



Version0.9.0 /15

Page 4/15



Version 0.9.0 P

age 4/15


1. Introduction

Le document ci présent a pour objectif de décrire la solution de reporting dynamique. Le

document explique l'installation de l’environnement nécessaire, les concepts de base, la

structure et les éléments qui constituent l’application. Le document contient aussi des

exemples d’impression des rapports indépendamment de ses paramètres.

2. Installation

2.1 Pré requis

JDK version 1.5.0_06-b05 (http://developers.sun.com/resources/downloads.html) Apche tomcat version 5.5.17 (http://tomcat.apache.org/download-55.cgi) Postgresql version (http://www.postgresql.org/download/)

2.2 Déploiement de l’application

Voici quelques écrans qui permettent d’expliquer brièvement le processus de déploiement

de l’application :

Cliquer sur le lien nommé tomcat manager :

http://www.postgresql.org/download/



Version0.9.0 /15

Page 5/15



Version 0.9.0 P

age 5/15


Une boite de dialogue apparaît pour saisir le login et le mot de passe

Une fois authentifiée l’utilisateur « admin » pourra déployer des nouvelles applications.

Pour mettre en place cette application, cliquer sur le bouton parcourir puis donner le

chemin de l’application nommée « RPrinter.war », ensuite cliquer sur le bouton

« Deploy ».

Après avoir déployé cette application son nom apparaît dans la liste des applications

héberger.



Version0.9.0 /15

Page 6/15



Version 0.9.0 P

age 6/15


3. Configuration

3.1 Base de données

La base de données de l’outil de reporting contient essentiellement 3 tables qui sont

« parameter », « report » et « connection » :

Voici la liste des séquences qu’il faut crée :

Séquence d’incrémentation pour la table connection :

CREATE SEQUENCE "public"."seq_conn" INCREMENT 1 MINVALUE 1

MAXVALUE 9223372036854775807 START 4 CACHE 1;



Version0.9.0 /15

Page 7/15



Version 0.9.0 P

age 7/15


Séquence d’incrémentation pour la table report :

CREATE SEQUENCE "public"."seq_report" INCREMENT 1 MINVALUE 1

MAXVALUE 9223372036854775807 START 74

Séquence d’incrémentation pour la table parameter :

CREATE SEQUENCE "public"."seq_param" INCREMENT 1 MINVALUE 1

MAXVALUE 9223372036854775807 START 72 CACHE 1;

Voici les requêtes SQL de création de ces tables :

Table report:

CREATE TABLE "reporting"."report" (

"id" SERIAL,

"rname" TEXT,

"rdescription" TEXT,

"rpath" TEXT,

"connection_id" NUMERIC,

CONSTRAINT "report_pkey" PRIMARY KEY("id"),

CONSTRAINT "report_fk" FOREIGN KEY ("connection_id")

REFERENCES "reporting"."connection"("id")

ON DELETE CASCADE

ON UPDATE CASCADE

NOT DEFERRABLE

) WITH OIDS;

Table connection:

CREATE TABLE "reporting"."connection" (

"id" SERIAL,

"connection_string" TEXT,

"user_name" TEXT,

"user_password" TEXT,

"cname" TEXT,

"cdriver" TEXT,

CONSTRAINT "connection_pkey" PRIMARY KEY("id")

) WITH OIDS;

Table parameter:



Version0.9.0 /15

Page 8/15



Version 0.9.0 P

age 8/15


CREATE TABLE "reporting"."parameter" (

"id" SERIAL,

"pname" TEXT,

"pclass" TEXT,

"pdescription" TEXT,

"pdefault_value" TEXT,

"ui_type" TEXT,

"pquery" TEXT,

"isprompting" BOOLEAN,

"plabel" TEXT,

"report_id" NUMERIC,

CONSTRAINT "parameter_pkey" PRIMARY KEY("id"),

CONSTRAINT "parameter_fk" FOREIGN KEY ("report_id")

REFERENCES "reporting"."report"("id")

ON DELETE CASCADE

ON UPDATE CASCADE

NOT DEFERRABLE

) WITH OIDS;

3.2 Application

Pour fonctionner l’application plusieurs fichiers de configuration doivent être mis a jours.

3.2.1 Configuration d’Hibernate

Ajuster le nom ou l’adresse IP de serveur qui héberge le SGBD postgresql dans le fichier de

configuration d’hibernate nommée hibernate.cfg.xml situé sous le répertoire :

%CATALINA_HOME%\webapps\RPrinter\WEB-INF\classes\ressources

dossier de base de l’application

La propriété base.reports qui se présente dans le fichier

ApplicationResources.properties situé dans le répertoire :

%CATALINA_HOME%\webapps\RPrinter\WEB-INF\classes\ressources

Indiquer à l’application le répertoire qui contient les rapports.



Version0.9.0 /15

Page 9/15



Version 0.9.0 P

age 9/15


4. Guide d’utilisation Pour tester l’application taper l’adresse suivante dans la barre d’adresse d’un navigateur

web comme firefox :

http://nom du serveur : numéro de port/RPrinter

Voici une aperçue sur la page d’accueil de l’application.

4.1 Gestion des connexions

Pour gérer la liste des sources de données disponible cliquer sur le menu Gestion des

Connexions. La page qui s’affiche montre la liste des connexion ainsi des lien pour

mettre a jours, supprimer ou pour ajouter un nouvelle source de données.

http://nom/



Version0.9.0 /15

Page 10/15



Version 0.9.0 P

age 10/15


REMARQUE : Chaque connexion peut contenir plusieurs rapports.

Pour configurer une nouvelle connexion cliquer sur le lien Add New, un formulaire s’affiche

contenant quatre champs texte intitulé nom de la connexion, la classe qui caractérise le

pilote adéquat pour le SGBD considérer, la chaîne de connexion, le nom d’utilisateur qui a

le droit d’accédé aux données de la base et enfin son mot de passe. La figure suivante

montre un exemple :

REMARQUE : le pilote adéquat doit être présent dans le class path de l’application.



Version0.9.0 /15

Page 11/15



Version 0.9.0 P

age 11/15


4.2 Gestion des rapports

Pour gérer la liste des rapports cliquer sur le menu Gestion des Rapports. La page qui

s’affiche montre la liste des rapports disponible ainsi des lien pour mettre a jours,

supprimer ou pour ajouter un nouveau rapport.

4.2.1 Ajout d’un nouveau rapport

Pour ajouter un nouveau rapport cliquer sur le lien Add New, un formulaire s’affiche

contenant quatre champs intitulés nom du rapport, le chemin absolu du rapport, le nom de

la source de données et la description du rapport. La figure suivante montre un exemple :

4.2.2 Configuration des paramètres d’un rapport



Version0.9.0 /15

Page 12/15



Version 0.9.0 P

age 12/15


Après l’ajout du rapport l’administrateur du système peut accéder à l’ensemble des

paramètres qui se présentent dans le rapport comme le montre les deux figures suivantes :

Chaque paramètre contient les propriétés suivantes :

Nom de la propriété Description

Name Le nom du paramètre

Report Path Le nom du rapport qui contient ce paramétre

Default Value La valeur par défaut assigné a ce paramétre

Class Name Tpe du paramètre

Description Description du paramètre

Is Promting Ce paramètre sera affiché ou non au moment de l’exécution

Label Le libellé du paramètre.



Version0.9.0 /15

Page 13/15



Version 0.9.0 P

age 13/15


View Le champ est de type texte ou liste.

Query Si le champ est de type liste alors une requête SQL est

obligatoire pour afficher le contenu de cette liste

Pour modifier quelques propriétés de ce paramètre cliquer sur le nom du paramètre.

Un formulaire s’affiche contient tous les attributs qui constituent le paramètre désiré :



Version0.9.0 /15

Page 14/15



Version 0.9.0 P

age 14/15


4.2.3 Impression du rapport

Cliquer sur le menu Gestion des Rapports, puis cliquer sur le lien Print. Si le rapport

contient des paramètres alors l’application affiche un formulaire contenant la liste des

paramètres à saisir. Une fois la saisi des valeurs des paramètres est achevée cliquer sur le

bouton imprimer pour lancer l’impression :

REMARQUES :

1-la valeur afficher par le formulaire est la valeur par défaut du paramètre.

2-Si l’administrateur souhaite modifier le type d’affichage de ce formulaire (champ

variable de type liste). Alors il doit spécifier la requête SQL qui va construire cette liste à

partir de la source de donnée du rapport. Voici un exemple



Version0.9.0 /15

Page 15/15



Version 0.9.0 P

age 15/15


L’exécution donne :

I- Le premier valeur retourner par cet requête est la valeur qui sera envoyer au serveur par

contre la deuxième valeur sera affiché uniquement sur la page WEB.

manuelle d’utilisation de l’outil de reporting de oxiareport

Documents

managed services

oxiareport version

gestion des connexions

gestion des rapports

matieres table

paramtres dun rapport

impression du rapport

configuration dhibernate