GUIDE UTILISATEUR NQI ORCHESTRA V BIRT V.2.2.2

Transcription

1 GUIDE UTILISATEUR NQI ORCHESTRA V BIRT V.2.2.2

2 Table des Matières 1. INTRODUCTION SUJET OBJECTIFS DÉFINITION DE TERMES, ACRONYMES RÉFÉRENCE CONFIGURATION GÉNÉRAL Architecture et fonctionnalités générales Pré-requis CONFIGURATION DU SERVEUR PostgreSQL : fichier pg_hba.conf PostgreSQL : fichier postgres.conf PostgreSQL : Redémarrage du service CONFIGURATION DU POSTE DE TRAVAIL RÉALISATION DU RAPPORT INTÉGRATION DANS Properties editor Properties Report Parameters (voir tableau en 2.1.1) Rapport sur une entité (Ex : projet) Rapport sur une liste d'entités (Ex : Liste de projets) Intégration dans... Version /07/2009 2

3 1.Introduction 1.1 Sujet Ce document décrit le paramétrage de BIRT à réaliser pour l intégration de rapport de type Projet dans. 1.2 Objectifs Fournir un guide d utilisation et aider à maintenir une base de connaissance sur le paramétrage de BIRT pour. 1.3 Définition de termes, acronymes BIRT = Business Intelligence and Reporting Tools 1.4 Référence L utilisation de BIRT est documentée et disponible sur : Version /07/2009 3

4 2. Configuration 2.1 Général Architecture et fonctionnalités générales Actuellement, les types de rapports suivants sont supportés : Projets Liste de Projets Liste de tâches Groupe de tâches Activités utilisateur Organisation Portefeuilles Evénements Liste d'évènements Pour chaque type de rapport, il est nécessaire de spécifier la liste des paramètres requis et la clé du type de rapports (catégorie dans le fichier reports.xml) utilisée pour filtrer les listes de choix (combos) dans la visualisation des rapports. De plus, l'identifiant de l'utilisateur est passé systématiquement en paramètre de chaque rapport (paramètre login), ce qui permet de gérer les droits d'accès aux données dans les rapports si nécessaire. Type de Rapport Clé Paramètres Requis Projet com.nqi.cpms.projectreports projectid : id du projet Liste de Projets com.nqi.cpms.project.list.report idlist = liste des id de projets Liste de tâches com.nqi.cpms.task.list.report idlist = liste des id de tâches Groupe de Tâches com.nqi.cpms.taskgroupreports taskid : id du groupe de tâches Activités utilisateur com.nqi.cpms.activitiesreports userlogin : login de l utilisateur Organisation com.nqi.cpms.unitreports unitid : id de l'organisation Portefeuilles com.nqi.cpms.dashboard.report.<type de portefeuille> portfolioid : id du portefeuille Evènements com.nqi.cpms.processrequest.report.<code évènement> processrequestid : id de l'évènement Liste d'évènements com.nqi.cpms.processrequest.list.report.<code idlist = liste des id des évènements Version /07/2009 4

5 évènement> Pré-requis V ou supérieure BIRT Configuration du serveur Afin de permettre un accès à la base de données depuis les postes client, il faudra s'assurer que la base de données est accessible depuis les postes client. La procédure suivante détaille les manipulations à faire dans le cas d'une utilisation de labase de données PostgreSQL PostgreSQL : fichier pg_hba.conf Emplacement : <répertoire d'install PostgreSQL>\8.1\data Modification : Copier la ligne Ipv4 sur la ligne au-dessus et remplacer l'adresse IP par la plage d'adresses IP autorisées à se connecter au serveur de base de données. Mettre les blocs communs aux adresses IP de tous les postes, compléter les blocs suivant par 0, et préciser le nombre de bloc à prendre en compte (8 : premier bloc uniquement, 16 : 2 premiers blocs, 24 : 3 premiers blocs, 32 : toute l'adresse IP) # TYPE DATABASE USER CIDR-ADDRESS METHOD host all all /16 md5 # IPv4 local connections: host all all /32 md5 Pour plus d'informations: PostgreSQL : fichier postgres.conf Emplacement : <répertoire d'install PostgreSQL>\8.1\data Modification : Dans la partie CONNECTIONS AND AUTHENTICATION du fichier, décommenter la ligne listen_adresses et remplacer localhost par * : Version /07/2009 5

6 avant : #listen_addresses = 'localhost' après : listen_addresses = '*' PostgreSQL : Redémarrage du service Une fois les modifications effectuées, le service PostgreSQL doit être redémarré. 2.3 Configuration du poste de travail La configuration du poste de travail est nécessaire si les rapports sont développés sur un poste différent du serveur sur lequel est installée l'application. Dézipper l'archive BIRT.zip fournie par NQI dans C:\Program Files (<répertoire d'install>) - un autre emplacement peut être choisi Les rapports devront être stockés à l'emplacement <répertoire d'install>\birt\config\specificconfig\reports\birt car il s'y trouve le fichier de configuration de la connexion avec la base de données. Créer un raccourci sur le bureau vers <répertoire d'install>\birt-rcp-reportdesigner-2_2_2\birt.exe 2.4 Réalisation du rapport Ouvrir BIRT Créer un nouveau rapport : Menu : File New New Report. Donner un nouveau nom au rapport, décocher Use Default, et entrer le chemin de stockage du rapport, comme cidessous. Attention : le nom du rapport ne doit pas comporter d'espace Cliquer sur Finish Version /07/2009 6

7 Création d'un nouveau rapport Ajout de la source de données (Data Source) voir copie d'écran ci-dessous : Sélectionner l'onglet Library Explorer dans la fenêtre en haut à gauche Ouvrir les répertoires Shared Librairies, cpms_datasource.library, Data Sources Sélectionner nqidb, et faire glisser vers Data Sources dans la fenêtre Outline en bas à gauche Sélection de la librairie Vérification de la connexion à la base de données : Double cliquer sur nqidb dans le Data Source du rapport Version /07/2009 7

8 Cliquer sur Test connections... Un message vous informe de l'état de la connexion POUR SORTIR DE LA FENETRE, CLIQUER SUR CANCEL Création du Data Set : Cliquer droit sur Data Sets dans la fenêtre Outline, choisir New Data Set Remplir Data Set Name (voir copie d'écran ci-dessous) Cliquer sur Next Création du Data Set Créer la requête SQL (voir copie d'écran ci-dessous) : Schema : sélectionner -All- Type : sélectionner Table Cliquer sur Apply Filter Dans Available Items, Ouvrir nqidb, public Utiliser les éléments de la base de données affichés pour écrire la requête Cliquer sur Finish Version /07/2009 8

9 Création de la requête SQL 2.5 Intégration dans Properties editor Faire apparaître les propriétés du rapport lui même en cliquant sur la feuille (hors d une cellule ou d une grille). Sur l onglet Properties Editor il apparaît Property Editor Report. En sélectionnant General, définir au moins : le titre (title) : par exemple Client/Fiche de Suivi de Projet, c est ce qui apparaîtra dans les interfaces de création de rapport de Version /07/2009 9

10 Définition du titre En sélectionnant User properties, ajouter au moins : * le type (propriété type de type string) : cette propriété servira à définir le type de rapport dans Orchestra Création d une propriété type * la clé (propriété key de type string) : cette propriété servira à définir de manière unique le rapport dans. * le(s) format(s) de restitution (propriété formats de type string) : cette propriété servira à définir le(s) format(s) de restitution du rapport (html, pdf, word, excel). Version /07/

11 NB : les formats word et excel ne fonctionne que pour les versions Office 2003 et supérieures Properties Faire apparaître les propriétés du rapport en cliquant sur la feuille (hors d une cellule) ou en sélectionnant dans Outline le nom du rapport Sur l onglet Properties : * ajouter la valeur de la clé (propriété key ) : valeur unique qui identifie le rapport (ex : nom du rapport) * ajouter la valeur du type (propriété type ) : (voir tableau en 2.1.1)... com.nqi.cpms.projectreports : pour les rapports générés à partir du détail des projets * ajouter la valeur des formats (propriété formats ) : extensions (html, pdf, doc, xls) séparées par des virgules et sans espaces Définition des propriétés du rapport Version /07/

12 2.5.3 Report Parameters (voir tableau en 2.1.1) Rapport sur une entité (Ex : projet) Pour le passage de l'identifiant du projet il convient de définir un élément Report Parameter. Dans le Outline faire un clique droit sur Report Parameters et sélectionner New parameter. Créer un paramètre projectid tel que décrit dans l image ci après (pour les rapports de type projet) en lui donnant une id de projet par défaut (pour la prévisualisation du rapport) Définition du Report Parameter pour un projet * Dans les Data Set des projets définis dans le rapport, dans la requête SQL, ajouter une condition : WHERE nqi_cppj_project.id =? Cliquer ensuite sur la section Parameters. Si le paramètre n'a pas été créé automatiquement à partir de la requête SQL, le créer (voir image ci-dessous). Sélectionner, dans Linked to Report Parameter, le report parameter créé auparavant : projectid. Version /07/

13 Définition des paramètres du rapport dans un Data Set Rapport sur une liste d'entités (Ex : Liste de projets) Pour le passage de l'identifiant de la liste de projets il convient de définir un éléments Report Parameter. Dans le Data Explorer faire un clique droit sur Report Parameters et sélectionner New parameter. Créer un paramètre idlist tel que décrit dans l image ci-après (pour les rapports de type liste de projets) en lui donnant une liste d'id de projets par défaut séparées par des virgules et sans espace. Version /07/

14 Définition du Report Parameter pour une liste de Projets Il faut ensuite créer un script permettant de traiter les id données dans le report parameter : Dans l'outline ou le Data Explorer du rapport, sélectionner le Data Set de la liste des projets. Dans la fenêtre de design du rapport, sélectionner l'onglet Script, sélectionner le script beforeopen et adapter le script en fonction de la requête SQL du Data Set (voir ci-dessous) : AND/WHERE, première ligne du script : Si la requête SQL comporte une clause WHERE, mettre dans le script AND. Si la requête SQL ne comporte pas de clause WHERE, mettre dans le script WHERE. ORDER BY/GROUP BY, dernière ligne du script : Si votre requête comporte une clause ORDER BY OU GROUP BY, elle doit être placée dans ce script. La requête SQL se terminera donc obligatoirement par une balise FROM, WHERE ou AND. Version /07/

15 Script des rapports sur une liste de projets Intégration dans Copier les fichiers *.rptdesign sous l arborescence de : <Répertoire d'installation>\cpms\applications\config\specificconfig\reports\birt Les rapports apparaîtront dans les pages de création de rapports d Orchestra après re-démarrage de l application. En cas de modification de rapport existant, il n'est pas utile de redémarrer le service Orchestra pour prendre en compte les modifications. Version /07/2009