Vous êtes sur la page 1sur 60

IBM Tivoli Change and Configuration Management Database 7.1.1 IBM Maximo Asset Management 7.

1 IBM Tivoli Service Request Manager 7.1 IBM Tivoli Asset Management for IT 7.1

Guide de dveloppement des rapports

Important
Avant d'utiliser les prsentes informations et le produit associ, prenez connaissance des informations figurant la section Remarques la page 47.

LE PRESENT DOCUMENT EST LIVRE EN L'ETAT SANS AUCUNE GARANTIE EXPLICITE OU IMPLICITE. IBM DECLINE NOTAMMENT TOUTE RESPONSABILITE RELATIVE A CES INFORMATIONS EN CAS DE CONTREFACON AINSI QU'EN CAS DE DEFAUT D'APTITUDE A L'EXECUTION D'UN TRAVAIL DONNE. Ce document est mis jour priodiquement. Chaque nouvelle dition inclut les mises jour. Les informations qui y sont fournies sont susceptibles d'tre modifies avant que les produits dcrits ne deviennent eux-mmes disponibles. En outre, il peut contenir des informations ou des rfrences concernant certains produits, logiciels ou services non annoncs dans ce pays. Cela ne signifie cependant pas qu'ils y seront annoncs. Pour plus de dtails, pour toute demande d'ordre technique, ou pour obtenir des exemplaires de documents IBM, rfrez-vous aux documents d'annonce disponibles dans votre pays, ou adressez-vous votre partenaire commercial. Vous pouvez galement consulter les serveurs Internet suivants : http://www.fr.ibm.com (serveur IBM en France) http://www.can.ibm.com (serveur IBM au Canada) http://www.ibm.com (serveur IBM aux Etats-Unis) Compagnie IBM France Direction Qualit Tour Descartes 92066 Paris-La Dfense Cedex 50 La prsente dition s'applique la version 7.1.0 d'IBM Maximo Asset Management, d'IBM Tivoli Asset Management for IT et d'IBM Tivoli Service Request Manager et la version 7.1.1 d'IBM Tivoli Change and Configuration Management Database, ainsi qu' toutes les ditions et modifications ultrieures, sauf indication contraire dans les nouvelles ditions. Copyright International Business Machines Corporation 2008. All rights reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Table des matires

A propos de ce document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Chapitre 1 : Chargement et configuration de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Outil de gnration de rapports BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dfinition des composants BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BIRT Report Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation de BIRT Report Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation de BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Fichiers BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Fichiers source de BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Structure des fichiers de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dossier des bibliothques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dossier des rapports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dossier Scriptlibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dossier des modles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dossier des outils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration systme des fichiers de la phase de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prrequis de l'installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation des fichiers de la phase de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1 1 2 2 2 2 2 3 3 3 4 4 4 4 5 5 5 7

Chapitre 2 : Cration d'un rapport BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Prparation de la cration d'un premier rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Comprendre les modles de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Cration d'un rapport BIRT regroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Chapitre 3 : Fonctions de gnration de rapports BIRT avances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour . . . . Mappage des types de donnes BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remarques sur la conception SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Formatage des dates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test de la valeur Null. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Fonctions scalaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SQL conditionnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ajout de la fonctionnalit de mise jour de la base de donnes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Excution de requtes supplmentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Requtes dans la mthode d'extraction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Requtes dans la mthode d'ouverture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Association des ensembles de rsultats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mise en forme du rapport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cration d'un lien hypertexte d'un rapport vers un autre. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dbogage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enregistrement d'un rapport avec l'accs la barre d'outils de l'application. . . . . . . . . . . . . . . . . . . . . . . . . . . . Enregistrement d'un rapport pour plusieurs applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 17 18 19 19 19 20 20 20 21 22 22 23 24 24 25 26 28

Chapitre 4 : Configuration de rapports localiss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Localisation des libells de rapport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Activation des libells de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Copyright IBM Corp. 2007, 2008

iii

Importation de libells de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Localisation des donnes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exemples de donnes de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapitre 5 : Utilisation des paramtres de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Types de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres Active/Slectionne/Tout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rapports bass sur des paramtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres lis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres non lis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Active/Slectionne/Tout et Bass sur des paramtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres lis et non lis dans les instructions SQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres lis dans les instructions SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Paramtres non lis dans les instructions SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ajout de paramtres non lis au SQL d'un rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Utilisation de valeurs boolennes comme paramtres. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapitre 6 : Importation et exportation de fichiers de conception. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cration du fichier d'importation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importation de fichiers de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importation de fichiers de conception. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exportation de fichiers de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

30 30 31 31 33 33 33 33 34 34 34 34 34 35 35 37 39 39 40 41 42

Annexe A : Description des fichiers de proprits systme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Annexe B : Description des fichiers de tche Cron . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Remarques. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

iv

Guide de dveloppement des rapports

Avis aux lecteurs canadiens


Le prsent document a t traduit en France. Voici les principales diffrences et particularits dont vous devez tenir compte. Illustrations Les illustrations sont fournies titre dexemple. Certaines peuvent contenir des donnes propres la France. Terminologie La terminologie des titres IBM peut diffrer dun pays lautre. Reportez-vous au tableau ci-dessous, au besoin. IBM France ingnieur commercial agence commerciale ingnieur technico-commercial inspecteur IBM Canada reprsentant succursale informaticien technicien du matriel

Claviers Les lettres sont disposes diffremment : le clavier franais est de type AZERTY, et le clavier franais-canadien de type QWERTY. OS/2 et Windows - Paramtres canadiens Au Canada, on utilise : les pages de codes 850 (multilingue) et 863 (franais-canadien), le code pays 002, le code clavier CF.

Copyright IBM Corp. 2008

Nomenclature Les touches prsentes dans le tableau dquivalence suivant sont libelles diffremment selon quil sagit du clavier de la France, du clavier du Canada ou du clavier des tats-Unis. Reportez-vous ce tableau pour faire correspondre les touches franaises figurant dans le prsent document aux touches de votre clavier.

Brevets Il est possible quIBM dtienne des brevets ou quelle ait dpos des demandes de brevets portant sur certains sujets abords dans ce document. Le fait quIBM vous fournisse le prsent document ne signifie pas quelle vous accorde un permis dutilisation de ces brevets. Vous pouvez envoyer, par crit, vos demandes de renseignements relatives aux permis dutilisation au directeur gnral des relations commerciales dIBM, 3600 Steeles Avenue East, Markham, Ontario, L3R 9Z7. Assistance tlphonique Si vous avez besoin dassistance ou si vous voulez commander du matriel, des logiciels et des publications IBM, contactez IBM direct au 1 800 465-1234.

vi

Guide de dveloppement des rapports

A propos de ce document
Le prsent document dcrit les tches de configuration, de cration et de conception du dveloppeur de rapports. Il prsente galement les fonctions de gnration de rapports avances.

Public vis
Le prsent guide est destin aux dveloppeurs de rapports qui doivent effectuer les tches suivantes : cration d'un rapport BIRT importation et exportation de fichiers de conception de rapports chargement et configuration de BIRT Report Designer configuration de rapports localiss utilisation de fonctions de gnration de rapports BIRT avances utilisation de paramtres de rapport

Copyright IBM Corp. 2007, 2008

vii

Public vis

viii

Guide de dveloppement des rapports

Chargement et configuration de BIRT Report Designer


y

Le prsent document est destin aux programmeurs Java possdant une connaissance pratique de BIRT (Business Intelligence and Reporting Tools) Report Designer et de l'environnement Eclipse. Eclipse est une communaut de code source libre dont les projets visent laborer une plateforme de dveloppement libre. Ce chapitre contient les sections suivantes : Outil de gnration de rapports BIRT Fichiers BIRT Report Designer Fichiers source de BIRT Report Designer Structure des fichiers de BIRT Report Designer Configuration systme des fichiers de la phase de conception Configuration de BIRT Report Designer

Outil de gnration de rapports BIRT


IBM utilise BIRT comme outil de gnration de rapports. BIRT est un systme de gnration de rapports source ouverte reposant sur la technologie Eclipse pour les applications Web. Cette section dfinit les composants de BIRT.

Dfinition des composants BIRT


IBM Corporation intgre les composants BIRT suivants : BIRT Report Engine BIRT Report Designer

Copyright IBM Corp. 2007, 2008

Fichiers BIRT Report Designer

BIRT Report Engine


BIRT Report Engine est un outil Eclipse permettant d'afficher des rapports. BIRT Report Engine gnre un rapport au format HTML, CSV ou PDF pour que vous puissiez l'afficher dans votre navigateur.

Installation de BIRT Report Engine


BIRT Report Engine est imbriqu dans votre systme. Lorsque vous avez install votre application, vous avez galement install BIRT Report Engine.

BIRT Report Designer


Utilisation de BIRT Report Designer pour le dveloppement de rapports. L'outil de conception est une interface Eclipse permettant de crer des rapports qui s'intgrent dans des applications Web.

Installation de BIRT Report Designer


Pour des informations sur l'installation de BIRT Report Designer, accdez IBM developerWorks. IMPORTANT Si vous ne disposez pas de JDK 1.5 (5.0), vous devez l'installer.

Fichiers BIRT Report Designer


Les fichiers BIRT Report Design sont des fichiers xml, possdant l'extension .rptdesign. Les rapports BIRT peuvent contenir un ou plusieurs fichiers. Ces fichiers sont classs comme des fichiers de bibliothque ou des fichiers de ressources. Les fichiers de bibliothque BIRT sont galement des fichiers xml et possdent l'extension .rptlibrary. Les fichiers de bibliothque BIRT contiennent du code utilis plusieurs fois pour des lments tels que le type de police, la taille, les numros de page et l'horodatage. Chaque fichier peut tre rutilis plusieurs fois dans les conceptions et les modles de rapport BIRT. Les fichiers de ressources contiennent des lments tels que des images ou des fichiers externes. Les fichiers de ressources peuvent tre utiliss par les fichiers de conception de rapport ou les fichiers de bibliothque. Les fichiers de proprits sont galement des fichiers de ressources. De nombreuses conceptions de rapport diffrentes utilisent le mme fichier de proprits. Le fichier xml du rapport BIRT dtaille les fichiers de bibliothque et les fichiers de ressources requis par le rapport. Sans ces fichiers, le rapport BIRT n'est pas excut.

Guide de dveloppement des rapports

Fichiers source de BIRT Report Designer

Fichiers source de BIRT Report Designer


IBM vous offre plusieurs rapports pour que vous puissiez analyser des incidents spcifiques, afficher des donnes selon une mthode non disponible dans une application spcifique ou imprimer les rsultats des enregistrements pour conserver une trace des actions ou des enregistrements. IMPORTANT Pour une liste complte des rapports prts l'emploi fournis par IBM avec ce produit, reportez-vous au centre de documentation. En outre, vous pouvez personnaliser les rapports offerts par IBM pour ajouter ou supprimer un champ, ajouter le logo de votre socit ou modifier le tri. Vous pouvez galement crer vos propres rapports personnaliss pour rpondre aux besoins spcifiques de votre entreprise. Par consquent, IBM inclut les fichiers de conception de rapport pour que vous puissiez les personnaliser ou en consulter le contenu titre d'exemples pour la cration de vos propres rapports.

Structure des fichiers de BIRT Report Designer


La structure des fichiers BIRT Report Designer contient les sous-rpertoires suivants : bibliothques rapports scriptlibrary modles outils Les sections ci-aprs dcrivent ces sous-dossiers en dtail.

Dossier des bibliothques


Le dossier des bibliothques contient tous les fichiers de proprits de l'application. Le fichier de proprits contient les titres et les libells des rapports. Ce fichier est requis pour importer un rapport et pour la localisation. Le dossier des bibliothques contient galement les fichiers de bibliothque systme suivants : libraries.xml MaximoSystemLibrary.rptlibrary IMPORTANT Ne modifiez pas les deux fichiers de bibliothque systme dans le dossier des bibliothques. Si vous modifiez ces fichiers, vous risquez d'altrer vos rapports.

Chargement et configuration de BIRT Report Designer

Fichiers source de BIRT Report Designer

Dossier des rapports


Chaque application de votre systme correspond un dossier de votre sous-dossier de rapports. Votre licence contrle quelles applications vous pouvez visualiser. La structure des fichiers de conception de rapport de BIRT contient le chemin suivant :
<Racine_produit>\reports\birt\reports\<nom

du dossier

d'application>
Chacun des dossiers d'application correspond une application. Le dossier d'application contient les fichiers de conception des rapports. Par exemple, le dossier Personnes reprsente l'application Personnes. Le dossier Personnes contient le fichier person_details.rptdesign qui reprsente le rapport Dtails sur la personne. Le dossier Personnes contient galement un fichier report.xml. Ce fichier est commun tous les rapports de ce sous-dossier. Par exemple, tous les rapports du dossier Personnes utilisent le fichier reports.xml, qui se trouve galement dans le dossier Personnes. Le contenu exact du fichier varie en fonction de l'application. Le fichier report.xml contient les informations ncessaires pour que vous puissiez importer un rapport (nom du fichier, description, paramtres).

Dossier Scriptlibrary
Le dossier scriptlibrary contient le code des scripts. Le systme requiert ce code pour que vous puissiez activer les rapports IBM.

Dossier des modles


Le dossier des modles contient les modles de rapport IBM. Il s'agit des seuls modles que vous devez utiliser lorsque vous crez un rapport. Pour plus d'informations sur les modles, voir Comprendre les modles de rapport, la page 9.

Dossier des outils


Le dossier des outils contient les outils permettant d'importer et d'exporter des rapports entre votre machine client et la base de donnes systme. Pour plus d'informations sur l'importation et l'exportation, voir Chapitre 6.

Guide de dveloppement des rapports

Configuration systme des fichiers de la phase de conception

Configuration systme des fichiers de la phase de conception


Cette section contient les actions que vous devez effectuer pour configurer et installer les fichiers de la phase de conception sur votre systme. Une fois que vous avez pris connaissance des informations de cette section, vous pouvez commencer personnaliser ou crer vos rapports.

Prrequis de l'installation
Avant de crer ou personnaliser des rapports BIRT, vous devez avoir tlcharg Eclipse et BIRT Report Designer sur votre machine client. Cette dition utilise et prend en charge les versions suivantes : BIRT Report Designer version 2.1.2. Pour des informations sur l'installation de BIRT Report Designer, accdez IBM developerWorks. Eclipse version 3.2.2 Si Eclipse n'est pas encore charg sur votre machine, demandez les informations de tlchargement votre administrateur systme.

Installation des fichiers de la phase de conception


Les instructions ci-aprs dcrivent comment installer les fichiers de la phase de conception. Dans les chemins d'accs aux fichiers ci-aprs, v20060926-0959 correspond un numro de version et peut tre diffrent selon votre version.

1 Recherchez les classes compiles pour la gnration des scripts de rapport


dans l'emplacement <Racine_produit>.
<Racine_produit>\reports\birt\scriptlibrary\classes

2 Copiez l'intgralit du dossier \com dans l'emplacement suivant :


eclipse\plugins\org.eclipse.birt.report.viewer_2.1.2.v200609260959\birt\WEB-INF\classes

Si ncessaire, crez le dossier \classes.

3 Copiez mxreportdatasources.properties en utilisant les dossiers source et cible


de l'tape 1.

Chargement et configuration de BIRT Report Designer

Configuration systme des fichiers de la phase de conception

4 Editez le fichier comme suit : a Dfinissez les proprits de l'URL, du pilote, du nom d'utilisateur, du mot
de passe et du propritaire de schma, en suivant l'exemple de format fourni.

b Remplacez #<DataSourceName> par maximoDataSource.


Informations complmentaires En tant que dveloppeur de rapports, vous avez besoin du fichier mxreportdatasources.properties pour les informations de connexion.
#<DataSourceName>.<propertyName>=value # # # # # # # # # # # # # # # # # # # driver for ORACLE oracle.jdbc.driver.OracleDriver sample url for ORACLE jdbc:oracle:thin:@<HOST>:<PORT>:<SID> sample schemaowner for ORACLE maximo driver for SQLServer com.inet.tds.TdsDriver sample url for SQLServer jdbc:inetdae7a:hostname:port?database=dbname&language=us_ english&nowarnings=true sample schemaowner for SQLServer dbo driver for DB2 com.ibm.db2.jcc.DB2Driver sample url for DB2 jdbc:db2://localhost:50000/dbalias sample schemaowner for DB2 maximo

#<DataSourceName>.url=value #<DataSourceName>.driver=value #<DataSourceName>.username=value #<DataSourceName>.password=value #<DataSourceName>.schemaowner=value

Les valeurs localhost et dbalias (nom de votre base de donnes) sont des variables. Vous pouvez vrifier les informations sur votre base de donnes en slectionnant Dmarrer> Programmes>IBM DB2>Outils de configuration>Assistant de configuration. maximoDataSource est l'ensemble par dfaut actuel de tous les rapports.

5 Copiez les pilotes JDBC suivants :


<Racine_produit>\applications\maximo\lib ou partir du fichier zip

spcifique la base de donnes vers :


eclipse\plugins\org.eclipse.birt.report.viewer_2.1.1.v200609260959\birt\WEB-INF\lib

Ces pilotes ne sont utiliss que par BIRT Report Designer.

Guide de dveloppement des rapports

Configuration de BIRT Report Designer

IMPORTANT Pour Oracle, utilisez oraclethin.zip. Pour SQL Server, utilisez opta.jar. Pour DB2, utilisez db2jcc.jar et db2jcc_license_cu.jar Vous venez de terminer l'installation de vos fichiers de la phase de conception.

Configuration de BIRT Report Designer


Pour configurer BIRT Report Designer, procdez comme suit : IMPORTANT Crez un raccourci vers eclipse .exe. Incluez bien le chemin d'accs pointant vers l'installation de JDK 1.5 : C:\eclipse_download\BIRT\eclipse\eclipse.exe -vm C:\program files\IBM\Java50\bin\javaw.exe vmargs -Xmx512m

1 Ouvrez BIRT Report Designer dans Eclipse.


IMPORTANT Utilisez des barres obliques ou le bouton Slectionner lorsque vous spcifiez les chemins d'accs aux dossiers dans Eclipse.

2 Spcifiez l'emplacement du dossier des ressources. a Slectionnez Fentre>Prfrences b Dveloppez Conception de rapport et slectionnez Ressource. c Spcifiez l'emplacement de la bibliothque des rapports :
<Racine_produit>\reports\birt\libraries

3 Spcifiez l'emplacement du dossier des modles. a Slectionnez Fentre>Prfrences b Dveloppez Conception de rapport et slectionnez Modles. c Spcifiez l'emplacement des modles :
<Racine_produit>\reports\birt\templates

4 Dsactivez le modle Commentaire de la manire suivante : a Ouvrez la fentre Prfrences en slectionnant Fentre>Prfrences. b Dveloppez le dossier Conception de rapport et slectionnez le modle
Commentaire.

c Dslectionnez l'option spcifiant de gnrer un commentaire lors de la


cration d'une conception de rapport.

Chargement et configuration de BIRT Report Designer

Configuration de BIRT Report Designer

5 Importez le projet de rapport. a Slectionnez Fichier>Importer b Dveloppez le dossier gnral et slectionnez les projets existants dans
Espace de travail.

c Cliquez sur Suivant. d Accdez l'emplacement des fichiers de rapport :


<Racine_produit>\reports\birt\reports

e Slectionnez le projet YourReports. Cliquez sur Terminer. 6 Importez le projet de bibliothque. Cette tape est facultative et ne s'applique
que si vous modifiez les bibliothques.

a Slectionnez Fichier>Importer b Dveloppez le dossier gnral et slectionnez les projets existants dans
Espace de travail. Cliquez sur Suivant.

c Accdez l'emplacement de la bibliothque de rapports partir de


l'tape 2.

d Slectionnez le projet YourReportLibraries. Cliquez sur Terminer. 7 Importez le projet du script du rapport. Cette tape est facultative et ne
s'applique que si vous gnrez les classes du script du rapport.

a Extrayez tous les fichiers source dans l'emplacement suivant :


<Racine_produit>\applications\maximo\maximouiweb\webmodule\ WEB-INF\birt

b Slectionnez Fichier>Importer. c Dveloppez le dossier gnral et slectionnez les projets existants dans
Espace de travail, puis cliquez sur Suivant.

d Accdez l'emplacement suivant :


<Racine_produit>\applications\maximo\maximouiweb\webmodule\ WEB-INF\birt\script

e Slectionnez le projet YourReportScriptLibrary. Cliquez sur Terminer.

Guide de dveloppement des rapports

Cration d'un rapport BIRT

Ce chapitre dcrit comment crer votre premier rapport BIRT l'aide de BIRT Report Designer. Ce chapitre contient les sections suivantes : Prparation de la cration d'un premier rapport Comprendre les modles de rapport Cration d'un rapport BIRT regroup

Prparation de la cration d'un premier rapport


Avant de crer un rapport dans BIRT Report Designer, IBM recommande de dvelopper et de tester toutes les requtes requises dans un outil d'interrogation de base de donnes. BIRT ne valide pas le code SQL et un outil d'interrogation peut gnrer des messages d'erreur plus clairs. En outre, vous devez connatre les types de donnes de tous les champs de votre rapport. Dterminez les types de donnes (maxtypes) des champs utiliss dans vos requtes l'aide de l'une des mthodes suivantes : interrogez directement l'attribut maxattribute, comme indiqu dans l'instruction SQL suivante :
select attributename, maxtype from maxattribute where objectname = 'WORKORDER' order by attributename

ouvrez l'application Configuration de base de donnes et utilisez le champ Type de l'onglet Attributs de votre objet slectionn.

Comprendre les modles de rapport


IBM a dvelopp un certain nombre de modles de rapport pour vous aider crer des rapports. Pour afficher ces modles, partir de BIRT Report Designer, slectionnez Fichier>Nouveau>Rapport ou choisissez Nouveau rapport dans la liste droulante. De nombreux modles sont affichs, mais vous ne devez slectionner que ceux qu'IBM cre et active spcifiquement pour vous. Ces modles sont identifis par les termes Tivoli Maximo. Ces modles contiennent le code ncessaire pour l'intgration et permettent dobtenir une prsentation cohrente des rapports.

Copyright IBM Corp. 2007, 2008

Cration d'un rapport BIRT regroup

Le tableau suivant dcrit ces modles : Nom Modle de sous-rapport Tivoli Maximo Description Ce modle cre un rapport avec un ou plusieurs sous-rapports. Chaque sous-rapport peut comporter des champs de donnes diffrents. Ce modle cre un rapport avec un ou plusieurs groupes. Chaque groupe possde des champs de donnes identiques. Ce modle cre un rapport avec un seul en-tte. Ce rapport contient gnralement plusieurs lignes, suivant la quantit de donnes disponibles.

Modle de rapport regroup Tivoli Maximo Modle de rapport Liste Tivoli Maximo

Les modles ci-aprs incluent des lments graphiques, en plus des formats de gnration de rapports standard. Chaque modle inclut trois types de diagramme (un diagramme secteurs, un diagramme de Gantt et un diagramme courbe). Slectionnez un type de diagramme pour votre rapport et supprimez les deux autres. Modle de diagramme de sous-rapport Tivoli Maximo Modle de rapport de diagramme regroup Tivoli Maximo Modle de rapport de diagramme Liste Tivoli Maximo Ce modle cre un rapport avec un ou plusieurs sous-rapports. Chaque sous-rapport peut comporter des champs de donnes diffrents. Ce modle cre un rapport avec un ou plusieurs groupes. Chaque groupe possde des champs de donnes identiques. Ce modle cre un rapport avec un seul en-tte. L'en-tte contient plusieurs lignes de donnes.

Cration d'un rapport BIRT regroup


Cette section dcrit comment crer un rapport BIRT regroup. Le rapport utilis par cet exemple est le rapport Configuration de base de donnes. Le nom de fichier de ce rapport est listtabl.rptdesign. Ce fichier se trouve l'emplacement suivant :
<Racine_produit>\reports\birt\reports\configur

1 Dveloppez et testez toutes les requtes SQL de base de donnes dans un outil
d'interrogation. Crez un rapport

2 Slectionnez Fichier>Nouveau>Autre. Dveloppez le dossier Business


Intelligence and Reporting Tools.

3 Cliquez sur Rapport, puis sur Suivant. Affectez le rapport un projet et


nommez-le.

4 Cliquez sur Suivant. Slectionnez le modle de rapport regroup Tivoli


Maximo.

5 Cliquez sur Terminer. La conception du rapport apparat.

10

Guide de dveloppement des rapports

Cration d'un rapport BIRT regroup

Spcifiez la requte

6 Dans la vue de l'explorateur de donnes, slectionnez le fichier. Cliquez sur


l'onglet Script. Slectionnez la mthode d'ouverture dans la liste droulante.

7 Copiez votre requte de l'outil d'interrogation dans le corps de la mthode


sous l'exemple de requte existant. Mettez en forme votre requte conformment l'exemple. Crez les colonnes de sortie

8 Cliquez deux fois sur le fichier pour ouvrir la bote de dialogue Proprits.
Dans l'diteur de colonnes de sortie, entrez une colonne pour chaque champ de votre requte et chaque colonne tabulations. Si vous laissez la mthode d'ouverture visible lors de cette opration, vous pouvez l'utiliser comme rfrence dans les colonnes. Vous pouvez affecter aux colonnes de sortie des noms autres que les champs de base de donnes ou conserver les noms existants. Dfinissez le type de donnes de chaque colonne de sortie en fonction du paramtre maxtype du champ, comme spcifi dans le diagramme Mappage des types de donnes BIRT. Pour plus d'informations, voir Mappage des types de donnes BIRT, la page 18. IMPORTANT Si vous avez besoin de plusieurs fichiers, vous pouvez copier le fichier existant avant de poursuivre cette procdure. Des fichiers supplmentaires sont souvent ncessaires lorsque vous crez des sous-rapports.

Extrayez les lignes de donnes

9 Dans la page Script, choisissez la mthode d'extraction dans la liste


droulante. Conformment l'exemple fourni dans le modle, ajoutez une ligne pour chaque colonne qui extrait la valeur du fichier et met jour la colonne de sortie avec cette valeur. Utilisez la mthode approprie en fonction du type de donnes du champ, conformment au mappage des types de donnes BIRT.

Activez le dbogage

10 Cliquez sur la vue Structure, slectionnez le rapport, puis l'onglet Script.


Slectionnez bien la mthode d'initialisation dans la liste droulante. Ajoutez les lignes de dbogage.

Ajoutez les paramtres de rapport

11 Accdez la vue Fichier, cliquez l'aide du bouton droit de la souris sur


Paramtres de rapport, puis slectionnez Nouveau. Remplissez les donnes. Cliquez sur OK.

Incorporez le paramtre de rapport dans votre clause SQL dans la mthode d'ouverture de fichier

12 Ajoutez un paramtre non li facultatif.


Crez le SQL appropri l'aide de la mthode createParamWhereClause(). Voici un exemple de texte que vous pouvez ajouter la mthode d'ouverture :
// Gnration de la clause where avec le paramtre non li DBTable var where = params["where"]; if (params ["DBTable"].value) where = where + " and " + MXReportSqlFormat.createParamWhereClause ("mo.objectname", params["DBTable"]);

Crez la prsentation du rapport

13 Slectionnez l'onglet Mise en page et ajoutez le titre du rapport. 14 Si le rapport ne requiert pas l'affichage des paramtres d'entre dans l'en-tte,
supprimez la grille contenant les paramtres.

Cration d'un rapport BIRT

11

Cration d'un rapport BIRT regroup

Ajoutez les donnes de dtail

15 Dans la vue Donnes, dveloppez le fichier. A l'aide de la souris, dplacez des


colonnes de sortie sur la ligne de dtail de la mise en page. Pour ajouter d'autres colonnes au tableau, slectionnez l'onglet Table, puis l'onglet Colonne. Pour viter toute discontinuit dans la prsentation, insrez toujours les colonnes gauche.

16 Vrifiez l'apparence de votre prsentation.


Ajoutez les en-ttes de colonne

17 Accdez la vue Palette. Faites glisser un libell existant sur les autres en-ttes
de colonne. Par exemple, si l'en-tte de la premire colonne s'intitule Statut, vous pouvez ajouter ce libell aux autres colonnes.

Ajoutez les dtails du groupe

18 Ouvrez la vue Structure et cliquez sur Corps>Table> Groupes. Cliquez deux


fois sur l'entre Groupe de la table pour afficher l'diteur de groupe. Ajoutez la colonne de regroupement. Cliquez sur OK pour ajouter les dtails du groupe.

Prvisualisez le rapport

19 Cliquez sur l'onglet Aperu. Le rapport est excut avec les paramtres par
dfaut.

20 Pour spcifier des paramtres autres que ceux par dfaut, cliquez sur Afficher
les paramtres de rapport et entrez des valeurs valides.

21 Ajoutez des libells de groupe.


Associez le rapport un fichier de proprits de localisation de libells qui stocke les paires cl/ valeur des libells

22 Pour effectuer cette tche, procdez comme suit : a Slectionnez la vue Structure. b Dans la page Proprits, slectionnez Ressources. c S'il existe un fichier de proprits pour votre application, slectionnez-le.
Sinon, entrez le nom du nouveau fichier de proprits. Le nom que vous entrez doit correspondre au nom de votre dossier d'applications dans les rapports. Le systme cre le fichier de proprits l'emplacement suivant :
...\reports\BIRT\libraries

Le nom du fichier de proprits du rapport Configuration de base de donnes est configur.properties.

d Cliquez sur OK.


Slectionnez un libell localiser dans l'diteur de prsentation

23 Effectuez les tapes suivantes : a Dans la page Proprits, slectionnez le paramtre Localisation. b Cliquez sur Dtail () en regard du champ Cl du texte . c Entrez une nouvelle paire de valeurs de cl ou slectionnez-en une
existante.

d Cliquez sur OK.


Rptez cette tape pour tous les libells de votre prsentation. Pour plus d'informations sur l'activation des rapports localiss, voir Chapitre 4, Configuration de rapports localiss.
12
Guide de dveloppement des rapports

Cration d'un rapport BIRT regroup

Dfinissez les longueurs de colonne pour garantir un affichage correct dans les fichiers PDF Affichez le rapport au format PDF

24 Slectionnez un onglet et la colonne correspondante du tableau. Vous pouvez


redimensionner la colonne pour dfinir une largeur spcifique. Procdez de mme pour toutes les colonnes de tableau et de grille.

25 Pour afficher le rapport au format PDF, slectionnez l'icne d'affichage des


rapports. Cliquez sur Afficher le rapport comme PDF.

26 Le rapport apparat. Retournez l'diteur de prsentation et ajustez les


colonnes si ncessaire.

27 Crez le fichier d'importation du rapport, reports.xml. Il existe un fichier


d'importation dans chaque rpertoire de rapport d'application. Pour plus d'informations sur le fichier reports.xml, voir Chapitre 6.

Cration d'un rapport BIRT

13

Cration d'un rapport BIRT regroup

Le texte suivant reprsente le fichier reports.xml du rapport Configuration de base de donnes :


<!-Ce fichier permet de dfinir quels rapports doivent tre imports pour l'application CONFIGUR --> <reports> <report name="listtabl_1.rptdesign"> <attribute name="filename">listtabl.rptdesign</attribute> <attribute name="description">Database Configuration</attribute> <attribute name="toolbarlocation">NONE</attribute> <attribute name="toolbaricon">NONE</attribute> <attribute name="toolbarsequence"></attribute> <attribute name="attacheddoc">0</attribute> <attribute name="norequestpage">0</attribute> <attribute name="detail">0</attribute> <attribute name="reportfolder">CONFIGUR</attribute> <parameters> <parameter name="DBTable"> <attribute name="attributename"></attribute> <attribute name="lookupname"></attribute> <attribute name="sequence"></attribute> <attribute name="labeloverride"> Database Table</attribute> <attribute name="defaultvalue"></attribute> <attribute name="required">0</attribute> <attribute name="hidden">0</attribute> <attribute name="operator"></attribute> <attribute name="multilookup">0</attribute> </parameter> </parameters> <resources> <resource> <reference>configur.properties</reference> <filename>${libraryfolder}/configur.properties< /filename> </resource> </resources> </report> </reports>

Pour plus d'informations sur la cration du fichier d'importation, voir Enregistrement d'un rapport avec l'accs la barre d'outils de l'application, la page 26. Importez le rapport

28 Ouvrez une invite de commande et accdez l'emplacement suivant :


<Racine_produit>\reports\birt\tools

29 Pour importer tous les rapports de l'application Configuration de base de


donnes, excutez la commande suivante :
importreports configur

Pour plus d'informations sur l'importation de rapports, voir Chapitre 6.

14

Guide de dveloppement des rapports

Cration d'un rapport BIRT regroup

Connectez-vous au systme pour vrifier que vous avez charg votre rapport

30 Connectez-vous votre systme en tant qu'administrateur de rapport et


ouvrez l'application Administration des rapports. Dans le champ Nom du fichier de rapport, entrez Base de donnes pour filtrer dans le rapport Configuration de base de donnes.

31 Slectionnez votre rapport ; l'onglet des dtails du rapport apparat. Si


ncessaire, appliquez les privilges de scurit. IMPORTANT Vous dfinissez la scurit au niveau du rapport dans l'onglet Scurit. Vous dfinissez la scurit au niveau de l'application via l'action Dfinir la scurit de l'application.

32 Avant d'excuter le rapport pour la premire fois, cliquez sur Gnrer la page
de demande.

33 Pour prvisualiser votre rapport, cliquez sur Aperu. Entrez une valeur pour
la table de base de donnes Paramtre ou cliquez sur Soumettre pour excuter le rapport sur tous les enregistrements. Le rapport BIRT regroup apparat dans le navigateur de rapports.

Cration d'un rapport BIRT

15

Cration d'un rapport BIRT regroup

16

Guide de dveloppement des rapports

Fonctions de gnration de rapports BIRT avances

Ce chapitre contient des informations sur les fonctions de gnration de rapports avances pour vous aider utiliser BIRT Report Designer. Il aborde les sujets suivants : Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour Excution de requtes supplmentaires Mise en forme du rapport Cration d'un lien hypertexte d'un rapport vers un autre Dbogage Enregistrement d'un rapport avec l'accs la barre d'outils de l'application Enregistrement d'un rapport pour plusieurs applications

Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour
Cette section contient les sous-sections suivantes pour vous aider crer un rapport BIRT : Mappage des types de donnes BIRT Remarques sur la conception SQL Formatage des dates Test de la valeur Null Fonctions scalaires SQL conditionnel Ajout de la fonctionnalit de mise jour de la base de donnes

Copyright IBM Corp. 2007, 2008

17

Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour

Mappage des types de donnes BIRT


Ce diagramme indique le type de base de donnes, le type de donnes BIRT correspondant et la mthode utilise dans BIRT Designer pour extraire sa valeur. Ce diagramme dfinit les champs de donnes utiliss lors de la mthode d'extraction et la manire dont les colonnes de sortie des ensembles de donnes sont alimentes. Type de base de donnes Type de donnes BIRT Chane Chane DateHeure Dcimal Mthode de fichier utilise pour l'extraction getString(String attributeName) getBooleanString(String attributeName) getTimestamp(String attributeName) getDouble(String attributeName)

ALN, CLOB, GL, LONGALN, LOWER, UPPER YORN (Voir la section suivante sur le type de base de donnes YORN) DATE, DATETIME, TIME AMOUNT, DECIMAL, DURATION (Voir la section suivante sur le type de base de donnes DURATION.) FLOAT DURATION (Voir la section suivante sur le type de base de donnes DURATION.) INTEGER, SMALLINT IMPORTANT Type de base de donnes YORN

Variable flottante Chane Entier

getFloat(String attributeName) getDuration(String attributeName) getInteger(String attributeName)

Les types de base de donnes suivants ne sont pas pris en charge dans les rapports : BLOB, CRYPTO et CRYPTOX. Les champs YORN sont stocks dans la base de donnes sous forme de nombres (0 et 1), mais sont prsents dans le systme sous forme de texte localis. La mthode getBooleanString(String attributeName) effectue les deux tches : elle extrait la valeur numrique et la convertit en texte. Vous pouvez galement obtenir la valeur convertie partir de l'entier, l'aide de la mthode getBooleanString(int intValue). La base de donnes stocke DURATION sous forme de nombre (fractions d'heure), mais le systme prsente DURATION sous forme de chane au format HH:MM. La mthode getDuration renvoie la chane formate. Si vous avez besoin de la valeur numrique la place, utilisez la mthode getDecimal. Une mthode utilitaire supplmentaire, MXReportUtil.getDuration(String attributeName)permet de convertir la chane du format "double" au format "single".

Type de base de donnes DURATION

18

Guide de dveloppement des rapports

Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour

Remarques sur la conception SQL


Utilisez bien un SQL indpendant de la base de donnes chaque fois que possible. Utilisez la syntaxe des jointures SQL ANSI (jointures externes gauches, jointures externes droites). Par ailleurs, utilisez des fonctions ANSI, telles que CASE et COALESCE au lieu des fonctions propritaires, telles que DECODE et ISNULL. N'utilisez pas de qualification de propritaire (MAXIMO.workorder) et rfrencez tous les objets de base de donnes en minuscules.

Formatage des dates


Le systme offre des mthodes MXReportSqlFormat statiques pour prendre en charge le formatage des dates. Toutes les chanes renvoyes des fonctions de date formates par JDBC peuvent tre utilises dans les instructions SQL des rapports pour toutes les bases de donnes prises en charge. Les instructions suivantes offrent un exemple :
"where actualdate <=" + MXReportSqlFormat.getCurrentDateFunction() a pour rsultat :

where actualdate <= { ts '2007-04-01 00:00:00' } getCurrentDateFunction() date du jour getCurrentTimestampFunction() date et heure actuelles getDateFunction(Date d) date base sur la date entre getTimeFunction(Date d) heure base sur la date entre getTimestampFunction(Date d) date et heure bases sur la date entre getStartDayTimestampFunction(Date d) date base sur la date entre, avec le composant heure correspondant au dbut de la journe (pour les paramtres de date de dbut) getEndDayTimestampFunction(Date d) date base sur la date entre, avec le composant heure correspondant la fin de la journe (pour les paramtres de date de fin)

Test de la valeur Null


La fonction COALESCE est prise en charge sur tous les types de base de donnes et peut tre utilise directement dans la requte. Si vous devez utiliser une fonction de conversion null propritaire, IBM fournit la mthode de fichier suivante :
maximoDataSet.getNullValueFunction(String param, String nullVal)

Cette mthode renvoie NVL, ISNULL ou COALESCE suivant le type de base de donnes. Par exemple :
"select " + maximoDataSet.getNullValueFunction("parent", "wonum")

a pour rsultat : Oracle :select nvl(parent, wonum) DB2 :select coalesce(parent, wonum) SQL Server :select isnull(parent, wonum

Fonctions de gnration de rapports BIRT avances

19

Vrification des types de base de donnes, des informations SQL et de la fonctionnalit de mise jour

Si nullVal correspond un littral chane ; placez-le entre apostrophes : "select" + maximoDataSet.getNullValueFunction("parent", "NONE") Soyez prudent lorsque vous utilisez des littraux de chane de cette manire car le systme ne les localise pas.

Fonctions scalaires
La mthode MXReportSqlFormat.getScalarFunction(functionName, paramtres variables) renvoie une fonction scalaire JDBC base sur le nom de la fonction et une liste de paramtres variable. Vous pouvez utiliser cette mthode pour accder aux fonctions de base de donnes indpendamment de la base de donnes, comme recommand dans la spcification JDBC pour les fonctions couramment utilises.

SQL conditionnel
Lorsque vous devez utiliser un SQL spcifique la base de donnes, crez la requte de manire conditionnelle en fonction du type de base de donnes. Pour cela, utilisez les mthodes suivantes sur le fichier :
Boolean isOracle(), Boolean isSQLServer(), Boolean isDB2() String getDatabaseProductName() Renvoie le nom de la base de

donnes partir de la connexion Si seules quelques lignes sont diffrentes, vous pouvez les isoler et les dfinir de manire approprie, comme illustr dans l'exemple suivant :
var dbText = ""; if (maximoDataSet.isOracle()) { dbText = <Oracle-specific syntax>; } else { dbText = <DB2 & SQL Server syntax>; } sqlText = "select wonum, description, " + dbText + " from workorder";

Ajout de la fonctionnalit de mise jour de la base de donnes


Cette section dcrit comment ajouter une fonctionnalit de mise jour de la base de donnes des rapports. Avec cette fonctionnalit, les rapports doivent pouvoir excuter les instructions UPDATE/INSERT/DELETE du SQL de la base de donnes sur une source de donnes spcifique : IMPORTANT Les exemples ci-aprs illustrent l'instruction SQL UPDATE, mais vous pouvez galement utiliser les instructions SQL INSERT et DELETE.

20

Guide de dveloppement des rapports

Excution de requtes supplmentaires

1 Excutez la mise jour dans un fichier (l'une des mthodes open/describe/


fetch/close/beforeOpen/beforeClose/onFetch/afterOpen/afterClose).
myTxn = MXReportTxnProvider.create(this.getDataSource().getName()); myStmt = myTxn.createStatement(); myStmt.setQuery("update ... set .... = ...."); myTxn.save();

2 Excutez la mise jour en dehors d'un fichier.


myTxn = MXReportTxnProvider.create("MAXIMODATASOURCE"); myStmt = myTxn.createStatement(); myStmt.setQuery("update ... set .... = ...."); myTxn.save();

3 Excutez plusieurs mises jour.


myTxn = MXReportTxnProvider.create(this.getDataSource().getName()); myStmt1 = myTxn.createStatement(); myStmt1.setQuery("update ... set .... = ...."); myStmt2 = myTxn.createStatement(); myStmt2.setQuery("update ... set .... = ...."); myTxn.save();

4 Excutez le code avec des paramtres.


myTxn = MXReportTxnProvider.create(this.getDataSource().getName()); myStmt = myTxn.createStatement(); myStmt.setQuery("update ... set .... = ?, ... = ?"); myStmt.setQueryParameterValue(1, new Integer(0));// utilisation d'un objet Entier comme exemple. Notez galement que l'index des paramtres commence 1 myStmt.setQueryParameterValue(2, "MyValue");// utilisation d'un objet Chane comme exemple myTxn.save();

Excution de requtes supplmentaires


Vous pouvez excuter des requtes supplmentaires dans les mthodes d'ouverture et d'extraction. Chaque mthode peut comporter une ou plusieurs requtes supplmentaires renvoyant un ou plusieurs champs. Les sections ci-aprs dcrivent ces types de requte.

Fonctions de gnration de rapports BIRT avances

21

Excution de requtes supplmentaires

Requtes dans la mthode d'extraction


Une mme instruction SQL ne fournit pas toujours tous les champs de donnes d'un rapport. Utilisez la requte principale afin d'alimenter la plupart des colonnes de sortie et excuter des requtes supplmentaires pour extraire les donnes restantes, comme illustr dans l'exemple suivant : if (!maximoDataSet.fetch()) return (false);
// Dfinition de colonnes de sortie partir de la requte principale row["assetnum"] = maximoDataSet.getString("assetnum"); // Excution de la requte secondaire classStrucDataSet = MXReportDataSetProvider.create(this.getDataSource().getName(), "class"); classStrucDataSet.open(); sqlText = "select description from classstructure where classstructureid=? "; classStrucDataSet.setQuery(sqlText); // Utilisation de la valeur de la requte principale comme cl externe dans la requte secondaire classStrucDataSet.setQueryParameterValue(1, maximoDataSet.getString("classstructureid"));

if (classStrucDataSet.fetch()) { // Dfinition de colonnes de sortie partir de la requte secondaire row["description"] = classStrucDataSet.getString ("description"); } // Toujours fermer le fichier classStrucDataSet.close();
return(true);

Requtes dans la mthode d'ouverture


Ces types de requte sont utiles pour rechercher les valeurs statiques dont le rapport a besoin. Vous pouvez insrer ces valeurs dans des variables globales et les utiliser dans tout le rapport. Par exemple, il existe trois champs de cot dans invcost et celui utiliser pour un article donn dpend du site de l'article. Un type de cot par dfaut est affect aux sites dans maxvars. Le rapport contenant un paramtre une valeur sur Site, vous pouvez rechercher le cot spcifique un site et l'utiliser dans tout le rapport. La procdure est la mme que celle dcrite pour la mthode d'extraction, mais des variables sont utilises la place des colonnes de sortie pour stocker les rsultats.

22

Guide de dveloppement des rapports

Excution de requtes supplmentaires

Association des ensembles de rsultats


Lorsque vous excutez des requtes supplmentaires dans la mthode d'extraction, vous devez gnralement les associer la ligne de donnes en cours. Pour cela, vous incluez directement la valeur ou vous utilisez des paramtres de fichier. Le texte ci-aprs est extrait de l'exemple prcdent relatif l'excution de requtes dans la mthode d'extraction :
sqlText = "select description from classstructure where classstructureid=?"; classStrucDataSet.setQuery(sqlText); // Utilisation de la valeur de la requte principale comme cl externe dans la requte secondaire classStrucDataSet.setQueryParameterValue(1, maximoDataSet.getString("classstructureid"));

Dans cet exemple, vous affectez au paramtre la valeur d'un champ d'un fichier. Le champ correspondant une chane, vous utilisez la mthode de fichier getString. Vous pouvez galement utiliser la mthode getTimestamp, mais pas les mthodes d'extraction qui renvoient des types de donnes primitifs. Au lieu de la mthode d'extraction, utilisez la mthode suivante :
getDoubleObject(String attributeName)

getFloatObject(String attributeName)
getIntegerObject(String attributeName)

Une autre situation courante, lorsque vous devez associer des ensembles de rsultats, se prsente lors de l'association de sous-rapports. Les requtes de sousrapport sont similaires aux requtes de la mthode d'ouverture dans la mesure o elles sont toutes deux excutes chaque fois que vous extrayez un enregistrement de la requte principale. Par contre, les requtes de sous-rapport possdent leurs propres fichiers. Le contenu du sous-rapport peut tre inclus dans une table enfant indpendante, qui est lie au fichier secondaire et imbrique dans une cellule de la table parent. Pour associer une requte de sous-rapport une requte principale, incluez les champs de liaison (cls externes) dans la requte principale. Dans la requte de sous-rapport, rfrencez les champs de liaison l'aide de la variable rows, comme illustr dans l'exemple suivant :
sqlText = "select laborcode, craft from labtrans where refwo = '" + rows[0][ "wonum"] + "' and siteid = '" + rows[0]["siteid"] + "'";

Fonctions de gnration de rapports BIRT avances

23

Mise en forme du rapport

Mise en forme du rapport


Faites glisser les champs du fichier vers le rapport. Dfinissez une largeur fixe pour chaque colonne, afin que le rapport soit correctement mis en forme lorsque vous l'imprimez au format PDF partir du navigateur de rapport. Par exemple, si vous utilisez une feuille 8,5 x 11 et que vous prvoyez une marge de 0,5 de chaque ct, vous devez espacer vos colonnes de 10 (car IBM fournit les modles de rapport au format paysage). Pour un rapport en cinq colonnes, vous pouvez prvoir 2 pour chaque colonne. Dfinissez les champs d'affichage des paramtres. Ne faites pas glisser l'aide de la souris des paramtres de l'explorateur de donnes dans le rapport. Par contre, faites glisser un lment de donnes et affectez le paramtre comme expression de valeur. S'il existe des groupes, dfinissez les cls.

Cration d'un lien hypertexte d'un rapport vers un autre


De nombreux rapports contiennent des liens hypertextes pour que vous puissiez explorer les rapports dtaills. Dans l'exemple ci-aprs, vous accdez au rapport Dtails de la gamme d'oprations (jobplan_print.rptdesign) partir du rapport Liste des gammes d'oprations (jobplan.rptdesign). Vous pouvez utiliser cet exemple lorsque vous crez vos propres liens hypertexte. Lorsque vous spcifiez un rapport associer, BIRT vrifie que ce rapport existe et lit les informations sur ses paramtres. Par consquent, pour pouvoir dfinir les proprits de lien hypertexte d'un champ, vous devez crer une marque de rservation .rptdesign pour le rapport cible. Cette marque de rservation doit se trouver dans le dossier d'application appropri et possder le nom de fichier correct. Il n'est pas ncessaire que la conception du rapport soit termine. Une fois que le rapport cible est en place, crez le lien l'aide des tapes suivantes :

1 Slectionnez l'lment de donnes dans le rapport source et choisissez Lien


hypertexte dans la bote de dialogue Proprits. Slectionnez l'ellipse pour ouvrir la bote de dialogue Options du lien hypertexte. Dfinissez le type de lien hypertexte pour l'exploration.

2 Sous le champ de slection d'un rapport cible, slectionnez le chemin relatif


permettant d'accder au rapport associ. Si le rapport se trouve dans le mme dossier, n'entrez que le nom du rapport. Si le rapport se trouve dans un autre dossier, utilisez le chemin relatif. Par exemple, pour associer Liste des gammes d'oprations (dans le dossier JOBPLAN) Dtails de la gamme d'oprations (galement dans le dossier JOBPLAN), entrez le texte suivant :
..\JOBPLAN\jobplan_print.rptdesign 24
Guide de dveloppement des rapports

Dbogage

3 Dans le champ Paramtres de rapport, slectionnez le paramtre where. Dans


le champ Valeurs, entrez une clause where qui spcifie la relation entre la ligne actuelle et le rapport associ. Par exemple, pour associer Liste des gammes d'oprations Dtails de la gamme d'oprations, entrez le texte suivant :
"jobplan.jpnum='" + row["jpnum"] + "' and jobplan.siteid='" + row["siteid"] + "'"

Dbogage
Pour consigner des informations prdfinies sur le rapport, ajoutez les lignes suivantes la mthode d'initialisation du rapport (remplacez le chemin d'accs du fichier par un chemin valide) :
mxReportScriptContext.setDefaultLogLevel("DEBUG"); mxReportScriptContext.setDefaultLogFile("c:/temp/myreport.log");

Ces lignes ne sont pas utilises lors de la phase d'excution ; elles ne le sont que lorsque vous prvisualisez le rapport partir du concepteur. Les niveaux de consignation pris en charge par IBM sont DEBUG, INFO, WARN, ERROR, FATAL. Pour consigner des informations personnalises, vous pouvez utiliser la variable mxReportScriptContext dans votre rapport pour obtenir le consignateur de script.
scriptLogger = mxReportScriptContext.getReportScriptLogger(); if (scriptLogger.isDebugEnabled()) { scriptLogger.debug("***My Debug Message ****");

} Contrairement la consignation par dfaut, le systme enregistre ces messages dans les fichiers journaux lorsque vous excutez le rapport sur le systme. ReportLogger contient les mthodes suivantes que vous pouvez utiliser pour consigner des informations :
boolean isDebugEnabled(); boolean isErrorEnabled(); boolean isFatalEnabled(); boolean isInfoEnabled(); boolean isWarnEnabled(); void debug(Object message); void info(Object message); void warn(Object message); void error(Object message); void fatal(Object message);

Fonctions de gnration de rapports BIRT avances

25

Enregistrement d'un rapport avec l'accs la barre d'outils de l'application

Enregistrement d'un rapport avec l'accs la barre d'outils de l'application


Les rapports qui ne contiennent pas de paramtres entrs par l'utilisateur peuvent tre activs pour l'accs la barre d'outils de l'application. BV (Vue du navigateur) Un rapport de vue de navigateur est un rapport accessible partir de la barre d'outils de l'application qui s'ouvre immdiatement dans le navigateur de rapport. Lorsque vous cliquez sur l'icne Rapport de la barre d'outils de l'application, le rapport BIRT apparat dans un nouveau navigateur de rapport. DP (Impression directe) Un rapport impression directe est un rapport qui ouvre immdiatement Adobe Acrobat et s'imprime sur l'imprimante par dfaut de l'utilisateur. Lorsque l'utilisateur final clique sur l'icne Rapport de la barre d'outils de l'application, le rapport s'imprime sur l'imprimante par dfaut de l'utilisateur. DPA (Impression directe avec les pices jointes) Une impression directe avec les pices jointes est similaire un rapport impression directe. Si des pices jointes sont associes un enregistrement, l'utilisateur final peut les imprimer avec le rapport. Si l'utilisateur clique sur Oui, les documents joints sont imprims sur l'imprimante par dfaut avec le rapport. Si l'utilisateur clique sur Non, seul le rapport s'imprime automatiquement sur l'imprimante par dfaut. Le tableau ci-aprs dcrit les types d'accs la barre d'outils de l'application : Description BV DP DPA Vue du navigateur Impression directe Impression directe avec les pices jointes Champ de base de donnes REPORT.QL REPORT.DP REPORT.PAD Emplacement dans la barre d'outils REPORT.QLLOC REPORT.DPLOC REPORT.PADLOC Squence REPORT.TOOLBARSEQUENCE REPORT.TOOLBARSEQUENCE REPORT.TOOLBARSEQUENCE

Pour activer l'accs la barre d'outils de l'application, ces champs doivent tre dfinis dans le fichier reports.xml lors de l'importation du rapport. En outre, le champ du nombre limite d'enregistrements (dtail) doit tre activ et le champ recordlimit doit tre dfini pour les fonctionnalits DP et DPA.

26

Guide de dveloppement des rapports

Enregistrement d'un rapport avec l'accs la barre d'outils de l'application

Le rapport Liste des interventions du dossier WOTRACK est un exemple de rapport activ par IBM pour une vue de navigateur. Le texte suivant affiche le fichier xml du rapport :
<reports> <report name="wotrack.rptdesign"> <attribute name="nomfichier">../WOTRACK/wotrack.rptdesign</ attribute> <attribute name="description">Activity List</attribute> <attribute name="qlloc">ALL</attribute> <attribute name="ql">1</attribute> <attribute name="toolbarsequence">1</attribute> <attribute name="attacheddoc">0</attribute> <attribute name="norequestpage">0</attribute> <attribute name="detail">0</attribute> <attribute name="reportfolder">WOTRACK</attribute> <resources> <resource> <reference>wotrack.properties</reference> <nomfichier>${libraryfolder}/wotrack.properties</nomfichier> </resource> </resources> </report>

Fonctions de gnration de rapports BIRT avances

27

Enregistrement d'un rapport pour plusieurs applications

Enregistrement d'un rapport pour plusieurs applications


Les rapports sont accessibles partir de plusieurs applications. Au lieu de copier les fichiers de conception, stockez le rapport dans le dossier principal des rapports de l'application. Enregistrez le rapport dans les autres applications en l'incluant dans le fichier reports.xml de chaque application. A titre d'exemple, les tapes ci-aprs montrent comment IBM a enregistr le rapport Liste des interventions (wotrack.rptdesign) dans plusieurs applications.

1 Vrifiez l'entre d'importation dans le fichier reports.xml pour l'application


interne (WOTRACK).

2 Affichez les entres dans le fichier reports.xml des autres dossiers


d'application qui utilisent le rapport (QUICKREP, CHANGE, RELEASE, ACTIVITY).

3 Notez le remplacement de l'entre <nomfichier> par le chemin relatif de


l'emplacement rel du rapport. Par exemple, les lignes suivantes apparaissent sous le dossier Activit :
<attribute name="nomfichier">../WOTRACK/wotrack.rptdesign </attribute> <attribute name="reportfolder">../WOTRACK</attribute>

4 Les autres valeurs d'administration des rapports sont modifies de manire


approprie. IMPORTANT Lorsqu'IBM enregistre un rapport dans plusieurs applications, il est prudent lorsqu'il entre des informations dans les champs suivants de l'application Administration des rapports : Nom du fichier de rapport IBM a entr le nom de fichier du rapport tel qu'il a t cr dans BIRT Report Designer. Ce nom de fichier doit possder l'extension .rptdesign. Application IBM a entr l'application que les utilisateurs finaux utiliseront pour ouvrir ce rapport. Plusieurs rapports et noms d'application peuvent correspondre au mme nom de fichier de conception de rapport (.rptdesign). S'il existe des paramtres lis, il se peut qu'ils doivent tre modifis car les liaisons qui fonctionnent dans une application peuvent ne pas fonctionner dans une autre.

28

Guide de dveloppement des rapports

Configuration de rapports localiss

Ce chapitre contient des informations sur la configuration des rapports localiss. Pour activer les rapports pour la localisation, vous devez effectuer les oprations suivantes : Localisation des libells de rapport Localisation des donnes Mise en forme

Localisation des libells de rapport


Vous activez la localisation des libells et des titres de rapport par l'intermdiaire des fichiers de proprits. Le systme stocke les fichiers de proprits l'emplacement suivant :
<Racine_produit>\reports\birt\libraries

Un fichier de proprits distinct est disponible pour chaque application qui contient des rapports. Par exemple, tous les rapports Intervention de l'application Intervention utilisent le fichier de proprits suivant :
<Racine_produit>\reports\birt\libraries\wotrack.properties

En utilisant une proprit unique pour chaque application, vous minimisez le nombre de fois que vous devez dfinir et localiser les valeurs de libell souvent rptes, telles que la description ou le statut.

Activation des libells de rapport


Pour activer les libells pour la localisation, suivez les instructions de cette section.

1 Slectionnez un rapport et ouvrez-le dans BIRT Report Designer. 2 Cliquez sur l'onglet Mise en page et ouvrez l'diteur de proprits. 3 Slectionnez la proprit Localisation 4 Si aucune valeur n'apparat, cliquez sur Parcourir pour rechercher le fichier
de ressources (proprits) partir duquel vous pouvez accder au rapport.

Copyright IBM Corp. 2007, 2008

29

Localisation des donnes

IMPORTANT Un fichier de proprits est disponible pour chaque application systme.

5 Slectionnez la valeur de texte correcte dans la liste des valeurs existantes. Si


le texte requis n'est pas disponible, vous devez entrer une nouvelle valeur et la sauvegarder dans le fichier de ressources. Les fichiers de ressources sont sauvegards dans l'emplacement suivant :
<Racine_produit>\reports\birt\libraries

Importation de libells de rapport


Une fois que vous avez localis un rapport, importez les rapports pour charger les valeurs du fichier de ressources dans la table de base de donnes REPORTLABEL. Une fois que les valeurs se trouvent dans la table REPORTLABEL, le systme les active pour la localisation.

Localisation des donnes


Vous pouvez activer la traduction des donnes d'excution en fonction de la langue de l'utilisateur en appelant une mthode pour chaque colonne de fichier traduire. La requte du rapport doit inclure les colonnes ID unique (UID) des tables contenant les champs traduits. Vous n'avez pas besoin de crer de colonnes de sortie pour ces champs. Appelez la mthode ci-aprs la fin de la mthode d'ouverture de fichier. Il n'est pas ncessaire de respecter la casse des arguments.
registerDataTranslation(queryColumn, queryUIDColumn, mboName, mboAttributeName) queryColumn champ de la requte traduire queryUIDColumn champ ID unique dans la requte de la table contenant le

champ traduit paramtre maxattribute objectname de l'attribut traduit mboAttributeName- paramtre maxattribute attributename de l'attribut traduit
mboName maximoDataSet = MXReportDataSetProvider.create(this.getDataSource().getName(), this.getName()); maximoDataSet.open(); var sqlText = new String(); sqlText = "select itemnum, description, itemid from item" maximoDataSet.setQuery(sqlText); maximoDataSet.registerDataTranslation("description", "itemid", "ITEM", "DESCRIPTION");

30

Guide de dveloppement des rapports

Mise en forme

Prenez connaissance des informations suivantes : Utilisez la mthode getBooleanString pour extraire et convertir les champs YORN. N'appliquez pas les symboles montaires. Utilisez plutt le champ du code devise systme. N'utilisez que les formats de date spcifis.

Exemples de donnes de rapport


Comme vous possdez vos propres exigences de localisation, chaque contrle de donnes qu'IBM met votre disposition dans les rapports prts l'emploi NE sera PAS activ pour la localisation. IBM active les champs de donnes et de rapport ci-aprs. Vous pouvez les utiliser comme exemples. Emplacement du rapport <Product_root>\reports\birt\reports\JOBPLAN Nom du rapport Liste des gammes d'oprations Nom de fichier du rapport jobplan.rptdesign Champ du rapport Description

Mise en forme
Consultez les questions suivantes relatives la mise en forme car elles concernent la localisation de vos rapports :

1 Les largeurs de tous les lments de table doivent tre 100%. 2 IBM a ajout un nouveau style appel Titlesub. Vous pouvez l'utiliser pour le
texte qui apparat directement sous le titre. De nombreux rapports dtaills utilisent ce style pour la cl (telle que wonum) et la description. Dtails de l'intervention est un exemple de rapport qui utilise ce type de sous-titre.

3 IBM a apport des modifications au modle de sous-rapport pour traiter


diverses questions. Evaluez vos rapports pour savoir si vous devez appliquer les modifications suivantes : Lorsque le sous-rapport ne contenait pas d'enregistrements, l'espace de la ligne tait tout de mme occup dans la version .PDF. Pour remdier cela, tous les sous-rapports se trouvent maintenant dans des cellules uniques empiles les unes sur les autres. Des styles taient appliqus aux lignes contenant les sous-rapports. Vous devez supprimer tous les styles sur les lignes ou les cellules qui contiennent des tables.

Configuration de rapports localiss

31

Mise en forme

Pour rsoudre les incidents relatifs l'activation des sauts de page aprs le dernier sous-rapport, IBM a ajout un groupe. La cl de ce groupe correspond la cl unique du rapport. Par exemple, dans Dtails sur la personne (person_details.rptdesign), la cl a la valeur Personid. Le saut de page aprs la proprit dans le groupe a la valeur Always excluding last". Il y aura donc un saut de page aprs chaque enregistrement de personne (y compris les sous-rapports associs), mais pas aprs la dernire personne pour viter qu'il n'y ait une page vierge la fin. IBM a supprim les lignes de bas de page des rapports pour les derniers enregistrements pour viter une page de blanc de fin. En outre, IBM a galement supprim les lignes de bas de page des tables de sous-rapport pour rduire le rapport au format PDF.

4 Pour les champs Date et/ou Date et heure, utilisez toujours les formats
suivants : Date - Date abrge Heure - Heure moyenne

32

Guide de dveloppement des rapports

Utilisation des paramtres de rapport


Ce chapitre contient les sections suivantes : Types de rapport Paramtres lis et non lis dans les instructions SQL Utilisation de valeurs boolennes comme paramtres

Types de rapport
Le systme possde trois types de rapport, selon qu'il existe des paramtres ou non. Les paramtres filtrent les informations qui apparaissent sur les rapports. Active/Slectionne/Tout Bass sur des paramtres Active/Slectionne/Tout et Bass sur des paramtres Les sections ci-aprs dcrivent ces trois types de rapport.

Paramtres Active/Slectionne/Tout
Les rapports Active/Slectionne/Tout sont des rapports sans paramtre qu'un utilisateur final excute en slectionnant l'enregistrement actuel, des enregistrements slectionns ou tous les enregistrements d'une application. Le rapport Dtails de la gamme d'oprations (jobplan_print.rptdesign) est un exemple de rapport Active/Slectionne/Tout.

Rapports bass sur des paramtres


Les rapports bass sur des paramtres sont des rapports qui contiennent des paramtres que l'utilisateur final excute avec les valeurs dfinies par le dveloppeur ou l'administrateur du rapport. Il existe deux types de rapport bas sur des paramtres : Li et Non li. Pour dterminer si un paramtre est li, slectionnez le rapport dans l'application Administration des rapports et slectionnez le champ Nom de l'attribut. Si le systme renseigne le champ, le paramtre est li. S'il ne le renseigne pas, le paramtre est non li.

Copyright IBM Corp. 2007, 2008

33

Paramtres lis et non lis dans les instructions SQL

Le rapport Rcapitulatif des incidents d'installation par emplacement est un exemple de rapport bas sur des paramtres. Les sections ci-aprs dcrivent les deux types de rapport bas sur des paramtres en plus amples dtails : Paramtres lis Paramtres non lis

Paramtres lis
Un paramtre li existe dans la table principale de l'application dans laquelle le rapport est inscrit ou, via un paramtre maxrelationship configur pour l'application. Les paramtres lis sont ajouts la clause Where de Maximo. Le paramtre personid du rapport Dtails sur la personne (person_details.rptdesign) est un exemple de paramtre li.

Paramtres non lis


Les paramtres non lis n'existent pas dans la table principale de l'application et ne sont pas disponibles via un paramtre maxrelationship de la table principale. Les paramtres non lis ne sont pas inclus dans la clause Where de Maximo. Le paramtre dbtable des rapports Transactions d'audit lectronique (eAudit_trans.rptdesign) est un exemple de paramtre non li.

Active/Slectionne/Tout et Bass sur des paramtres


Les rapports Active/Slectionne/Tout et les rapports bass sur des paramtres sont des rapports avec des paramtres qu'un utilisateur final excute sur des rapports actifs, certains rapports ou tous les rapports d'une application.

Paramtres lis et non lis dans les instructions SQL


Cette section dcrit l'utilisation des paramtres lis et non lis dans les instructions SQL, ainsi que d'autres informations relatives SQL (utilisation de valeurs boolennes comme paramtres).

Paramtres lis dans les instructions SQL


Les paramtres lis sont inclus dans le paramtre where et n'ont pas besoin d'tre explicitement inclus dans le SQL du rapport. Vous devez inclure le paramtre where dans le SQL, comme illustr dans l'exemple suivant :
sqlText="select wonum, description from workorder where " + params["where"];

34

Guide de dveloppement des rapports

Paramtres lis et non lis dans les instructions SQL

Paramtres non lis dans les instructions SQL


Les paramtres non lis sont transmis au rapport dans une chane dlimite par des virgules et peuvent contenir des oprateurs ; les valeurs doivent donc tre analyses syntaxiquement avant d'tre incluses dans le SQL du rapport. La mthode suivante analyse ces valeurs pour que vous puissiez les inclure dans le SQL du rapport :
MXReportSqlFormat.createParamWhereClause(String columnName, String paramValue)

Cette mthode cre une clause SQL Where base sur une liste spare par des virgules des valeurs contenues dans paramValue. La valeur du paramtre peut tre spcifie avec un oprateur prfixe. Cet oprateur peut correspondre l'un des symboles suivants : <=, <, >=, >, !=, = . Si vous ne spcifiez pas d'oprateur, le systme suppose que la recherche est base sur l'oprateur SQL LIKE, comme dans l'exemple suivant :
createParamWhereClause("siteid", "=BEDFORD,=MCLEAN")

a pour rsultat :
((siteid = 'BEDFORD') or (siteid = 'MCLEAN')) createParamWhereClause("siteid", "!=BEDFORD,!=MCLEAN,TEXAS")

a pour rsultat :
((siteid != 'BEDFORD') and (siteid != 'MCLEAN')) or ((siteid like '%TEXAS%'))

Ajout de paramtres non lis au SQL d'un rapport


Les paramtres non lis doivent tre inclus manuellement dans le SQL du rapport. La mthode utilise varie suivant que vous ayez autoris la multislection ou non pour le paramtre dans l'application Administration des rapports. Les paramtres autorisant la multislection sont transmis sous forme de chane dlimite par des virgules et doivent tre convertis dans la syntaxe correcte l'aide de createParamWhereClause, comme illustr dans l'exemple suivant :
"select wonum, description from workorder where " + params["where"] + " and " + createParamWhereClause("workorder.status", params["status"]);

Les paramtres n'acceptant qu'une slection, tels que le paramtre where, peuvent tre inclus directement. Les paramtres de chane doivent tre placs entre apostrophes et les paramtres de date doivent tre convertis en fonction JDBC. Les nombres ne requirent pas de formatage spcial, comme illustr dans l'exemple suivant :
sqlText = "select jobplan, description from jobplan where " + params["where"] + " and jobplan.siteid = " + params["siteid"] + "" //Chane entre guillemets + " and jobplan.wopriority = " + params["wopriority"]//Entier + " and jobplan.installdate >= " + MXReportSqlFormat.getStartDayTimestampFunction(params ["startDate"]);

Utilisation des paramtres de rapport

35

Paramtres lis et non lis dans les instructions SQL

Les paramtres n'acceptant qu'une seule slection peuvent galement tre utiliss avec des paramtres de fichier. Vous crez des marqueurs de paramtre en insrant un point d'interrogation dans le SQL chaque emplacement d'une valeur de paramtre. Vous utilisez ensuite la mthode de fichier setQueryParameterValue(int index, Object value) pour les convertir. Si une requte comporte plusieurs paramtres, la mthode les indexe suivant l'ordre dans lequel ils apparaissent dans le SQL, en commenant par 1. La requte ci-avant peut tre rcrite au format suivant :
sqlText = "select jobplan, description from jobplan where " + params["where"] + " and jobplan.siteid = ? and jobplan.wopriority = ? " + " and jobplan.duration >= " + MXReportSqlFormat.getStartDayTimestampFunction (params["startDate"]); maximoDataSet.setQuery(sqlText); maximoDataSet.setQueryParameterValue(1, params["siteid"]); maximoDataSet.setQueryParameterValue (2, params[prioritiy]);

Notez que les paramtres where et date utilisent toujours le format d'origine. Le paramtre where doit toujours tre inclus directement. Les paramtres de date non formats peuvent tre traits comme des paramtres de requte, mais actuellement, les mthodes au format JDBC, telles que getStartDayTimestampFunction ne peuvent pas tre utilises avec des paramtres de requte. Le meilleur moyen de traiter les paramtres facultatifs est l'inclusion directe. Dans l'exemple ci-aprs, le site et la date de dbut sont facultatifs. Si des valeurs sont spcifies, elles sont ajoutes au paramtre where (pour conserver le contenu existant du paramtre where). La priorit de l'intervention reste obligatoire.
var where = params["where"]; if (params["siteid"].value) where = where + " and " + jobplan.siteid = " + params["siteid"] + ; if (params["startdate"].value) where = where + " and matusetrans.actualdate >= " + MXReportSqlFormat.getStartDayTimestampFunction(params["startdate"] ); sqlText = "select job plan, description from job plan where " + params["where"] + " and job plan.wopriority = " + params["wopriority"];

36

Guide de dveloppement des rapports

Utilisation de valeurs boolennes comme paramtres

Utilisation de valeurs boolennes comme paramtres


Les rapports qui acceptent des valeurs boolennes comme paramtres doivent suivre les instructions suivantes :

1 Vous devez dfinir le paramtre dans la conception du rapport comme


paramtre de type chane.

2 Si la valeur du paramtre doit tre transmise une instruction SQL, la valeur


du paramtre doit tre convertie en entier (1 ou 0) car la base de donnes en a 1 ou 0. Pour cela, IBM a ajout un appel d'API au code du fichier (getBooleanInteger(string)). En voici un exemple :
var isActiveFlag = params["isactive"]; mySQL = "select isactive from collection where isactive=?"; myDataSet.setQuery(mySQL); myDataSet.setQueryParameterValue(1, myDataSet.getBoolenanInteger(isActiveFlag));

or
mySQL = "select isactive from collection where isactive=?"; myDataSet.setQuery(mySQL); myDataSet.setQueryParameterValue(1, myDataSet.getBooleanInteger(params["isactive"]));

3 N'utilisez pas de valeur par dfaut pour les paramtres YORN. Si des valeurs
par dfaut sont requises, vous pouvez utiliser true ou false.

Utilisation des paramtres de rapport

37

Utilisation de valeurs boolennes comme paramtres

38

Guide de dveloppement des rapports

Importation et exportation de fichiers de conception


Ce chapitre contient les sections suivantes : Cration du fichier d'importation Importation de fichiers de conception Exportation de fichiers de conception

Cration du fichier d'importation


Deux mthodes permettent d'importer des rapports BIRT dans la base de donnes systme : importation des rapports l'aide de l'application Administration des rapports utilisation de l'utilitaire d'importation. Si vous utilisez cet utilitaire, vous devez crer un fichier xml correspondant. Chaque dossier d'application sous <Racine_produit>\reports\birt\reports contient un fichier d'importation intitul reports.xml. Par exemple, le dossier des rapports Configuration de base de donnes (CONFIGUR) contient un fichier reports.xml. Si vous avez dfini les paramtres du rapport dans le fichier xml avec les attributs appropris, l'outil d'importation insre ou met jour le tableau des paramtres du rapport (reportlookup) en y intgrant ces informations. Les noms d'attribut des paramtres correspondent aux colonnes du tableau reportlookup. Si le nom de paramtre que vous avez dfini dans le fichier reports.xml d'un rapport donn n'existe pas dans ce rapport, le systme l'ignore. Certaines des valeurs d'attribut utilisent les valeurs du rapport comme valeurs par dfaut si ces valeurs ne sont pas spcifies dans le fichier d'importation.

Copyright IBM Corp. 2007, 2008

39

Importation de fichiers de conception

Lorsque vous spcifiez un symbole "suprieur " ou "infrieur " comme oprateur de paramtre, vous devez le prcder d'un caractre d'chappement, comme suit : &lt; &gt; &amp; &apos; &quot; < > & ' " infrieur suprieur perlute apostrophe guillemet

Le rapport Groupe de scurit (security_group.rptdesign) du dossier SECURGROUP est un exemple de rapport contenant des paramtres. Le rapport Liste des gammes d'oprations (jobplan.rptdesign) du dossier JOBPLAN est un exemple de rapport sans paramtre.

Importation de fichiers de conception


L'importation d'un rapport a pour objet de charger report.xml et les fichiers de conception dans la base de donnes. Ces deux types de fichier sont ncessaires pour importer un rapport : Fichier reports.xml Ce fichier varie en fonction de l'application et contient toutes les informations ncessaires pour que vous puissiez importer un rapport (nom du fichier, description, paramtres). Fichier de conception Il peut s'agir d'un fichier de bibliothque (code utilis plusieurs fois pour le type de police, la taille, les numros de page et l'horodatage) ou d'un fichier de ressources (images ou fichiers externes). Pour importer un fichier, utilisez l'application Administration des rapports. Pour plus d'informations, reportez-vous l'aide en ligne. Pour importer plusieurs fichiers, utilisez la commande d'importation de rapports (importreports.cmd). La section ci-aprs dcrit les types de commande d'importation.

40

Guide de dveloppement des rapports

Importation de fichiers de conception

Importation de fichiers de conception


Effectuez les oprations suivantes pour importer plusieurs fichiers de conception :

1 Accdez l'emplacement suivant :


<Racine_produit>\reports\birt\tools et ouvrez le fichier

reporttools.properties.

2 Mettez jour ou vrifiez les proprits suivantes :


maximo.report.birt.hostname maximo.report.birt.mxename maximo.report.birt.registryport maximo.report.birt.username maximo.report.birt.password maximo.report.birt.outputfolder

3 Sur un serveur d'applications, accdez au dossier suivant l'aide de l'invite de


commande :
<Racine_produit>\reports\birt\tools

4 Excutez la commande importreports.cmd pour importer des rapports, des


bibliothques et des fichiers de ressources. Les commandes d'importation suivantes sont disponibles : Commande importreports.cmd Description importe tous les rapports, les fichiers de ressources et toutes les bibliothques fournit des dtails sur la manire d'excuter la commande et divers paramtres importe toutes les bibliothques importe tous les rapports importe tous les rapports. Par exemple, si vous excutez : importreports CONFIGUR La commande importe tous les rapports de l'application Configuration de base de donnes.

importreports help

importreports libraries importsreports importreports <nom application>

Importation et exportation de fichiers de conception

41

Exportation de fichiers de conception

Exportation de fichiers de conception


Utilisez la commande d'exportation (exportreport.cmd) pour exporter des fichiers de conception. Les commandes suivantes sont disponibles pour exporter des fichiers : Commande exportreports Description exporte toutes les bibliothques, les rapports et divers sous-dossiers de rapports exporte tous les rapports et divers sous-dossiers de rapports exporte toutes les bibliothques exporte tous les rapports de l'application spcifie. Par exemple, si vous excutez : exportreports CHANGE La commande exporte tous les rapports dans le dossier de rapports WOTRACK. Le rapport est export dans le dossier que vous avez dfini dans les emplacements suivants : la proprit maximo.report.birt.outputfolder du fichier reporttools.properties le champ Dossier du rapport de l'application Administration des rapports

exportreports report exportreports library exportreports <nom application>

42

Guide de dveloppement des rapports

Description des fichiers de proprits systme


..

Le tableau suivant identifie et dcrit brivement les fichiers spcifiques aux rapports du fichier de proprits systme : Fichier de proprits mxe.report.birt.maxconcurrentrun mxe.report.birt.queueideltimeseconds Description Nombre maximal de rapports que vous pouvez excuter simultanment. Nombre de secondes d'inactivit du Gestionnaire de file d'attente de rapport aprs que vous ayez excut un rapport. Contrles ActiveX que vous activez pour pouvoir imprimer un rapport avec des documents en pices jointes. Nombre de rapports devant tre affichs dans une page de rapports en ligne. La valeur par dfaut est 5.

mxe.activex

mxe.report.reportsInAPage

Copyright IBM Corp. 2007, 2008

43

44

Guide de dveloppement des rapports

Description des fichiers de tche Cron


x

Le tableau suivant identifie et dcrit brivement les fichiers spcifiques aux rapports du fichier de tche Cron : Tche Cron REPORTLOCKRELEASE REPORTSCHEDULE REPORTUSAGECLEANUP Description Signaler tche de libration de file d'attente verrouille Signaler tche priodique de planification Signaler tche de nettoyage du journal d'utilisation

Copyright IBM Corp. 2007, 2008

45

46

Guide de dveloppement des rapports

Remarques
Le prsent document contient des informations sur les produits et services disponibles aux Etats-Unis. Le prsent document peut contenir des informations ou des rfrences concernant certains produits, logiciels ou services IBM non annoncs dans ce pays. Pour plus de dtails, rfrez-vous aux documents d'annonce disponibles dans votre pays, ou adressez-vous votre partenaire commercial IBM. Toute rfrence un produit, logiciel ou service IBM n'implique pas que seul ce produit, logiciel ou service puisse tre utilis. Tout autre lment fonctionnellement quivalent peut tre utilis, s'il n'enfreint aucun droit d'IBM. Il est de la responsabilit de l'utilisateur d'valuer et de vrifier lui-mme les installations et applications ralises avec des produits, logiciels ou services non expressment rfrencs par IBM. IBM peut dtenir des brevets ou des demandes de brevet couvrant les produits mentionns dans le prsent document. La remise de ce document ne vous donne aucun droit de licence sur ces brevets ou demandes de brevet. Si vous dsirez recevoir des informations concernant l'acquisition de licences, veuillez en faire la demande par crit l'adresse suivante : IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. Pour le Canada, veuillez adresser votre courrier : IBM Director of Comercial Relations IBM Canada Ltd. 3600 Steeles Avenue East Markham, Ontario L3R 9Z7 Canada Les informations sur les licences concernant les produits utilisant un jeu de caractres double octet peuvent tre obtenues par crit l'adresse suivante : IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan Le paragraphe suivant ne s'applique ni au Royaume-Uni, ni dans aucun pays dans lequel il serait contraire aux lois locales.

Copyright IBM Corp. 2007, 2008

47

LE PRESENT DOCUMENT EST LIVRE "EN L'ETAT" SANS AUCUNE GARANTIE EXPLICITE OU IMPLICITE. IBM DECLINE NOTAMMENT TOUTE RESPONSABILITE RELATIVE A CES INFORMATIONS EN CAS DE CONTREFACON AINSI QU'EN CAS DE DEFAUT D'APTITUDE A L'EXECUTION D'UN TRAVAIL DONNE. Certaines juridictions n'autorisent pas l'exclusion des garanties implicites, auquel cas l'exclusion ci-dessus ne vous sera pas applicable. Le prsent document peut contenir des inexactitudes ou des coquilles. Ce document est mis jour priodiquement. Chaque nouvelle dition inclut les mises jour. IBM peut, tout moment et sans pravis, modifier les produits et logiciels dcrits dans ce document. Les rfrences des sites Web non IBM sont fournies titre d'information uniquement et n'impliquent en aucun cas une adhsion aux donnes qu'ils contiennent. Les lments figurant sur ces sites Web ne font pas partie des lments du prsent produit IBM et l'utilisation de ces sites relve de votre seule responsabilit. IBM pourra utiliser ou diffuser, de toute manire qu'elle jugera approprie et sans aucune obligation de sa part, tout ou partie des informations qui lui seront fournies. Les licencis souhaitant obtenir des informations permettant : (i) l'change des donnes entre des logiciels crs de faon indpendante et d'autres logiciels (dont celui-ci), et (ii) l'utilisation mutuelle des donnes ainsi changes, doivent adresser leur demande : IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Ces informations peuvent tre soumises des conditions particulires, prvoyant notamment le paiement d'une redevance. Le logiciel sous licence dcrit dans ce document et tous les lments sous licence disponibles s'y rapportant sont fournis par IBM conformment aux dispositions de l'ICA, des Conditions internationales d'utilisation des logiciels IBM ou de tout autre accord quivalent. Les informations concernant des produits non IBM ont t obtenues auprs des fournisseurs de ces produits, par l'intermdiaire d'annonces publiques ou via d'autres sources disponibles. IBM n'a pas test ces produits et ne peut confirmer l'exactitude de leurs performances ni leur compatibilit. Elle ne peut recevoir aucune rclamation concernant des produits non IBM. Toute question concernant les performances de produits non IBM doit tre adresse aux fournisseurs de ces produits. Toute instruction relative aux intentions d'IBM pour ses oprations venir est susceptible d'tre modifie ou annule sans pravis, et doit tre considre uniquement comme un objectif.

48

Guide de dveloppement des rapports

Le prsent document peut contenir des exemples de donnes et de rapports utiliss couramment dans l'environnement professionnel. Ces exemples mentionnent des noms fictifs de personnes, de socits, de marques ou de produits des fins illustratives ou explicatives uniquement. Toute ressemblance avec des noms de personnes, de socits ou des donnes relles serait purement fortuite. Si vous visualisez ces informations en ligne, il se peut que les photographies et illustrations en couleur n'apparaissent pas l'cran.

Marques
Les termes qui suivent sont des marques d'International Business Machines Corporation aux Etats-Unis et/ou dans certains autres pays : IBM AIX DB2 developerWorks Everyplace ibm.com Lotus Maximo Notes QuickPlace Tivoli WebSphere Adobe, le logo Adobe, PostScript et le logo PostScript sont des marques d'Adobe Systems Incorporated aux Etats-Unis et/ou dans certains autres pays. Java ainsi que tous les logos et toutes les marques incluant Java sont des marques de Sun Microsystems, Inc. aux Etats-Unis et/ou dans certains autres pays. Linux est une marque de Linus Torvalds aux Etats-Unis et/ou dans certains autres pays. Intel, le logo Intel, Intel Inside, le logo Intel Inside, Intel Centrino, le logo Intel Centrino, Celeron, Intel Xeon, Intel SpeedStep, Itanium, et Pentium sont des marques d'Intel Corporation ou de ses filiales aux Etats-Unis et dans certains autres pays. Microsoft, Windows, Windows NT et le logo Windows sont des marques de Microsoft Corporation aux Etats-Unis et/ou dans certains autres pays. UNIX est une marque enregistre de The Open Group aux Etats-Unis et/ou dans certains autres pays.

49

50

Guide de dveloppement des rapports

Index

A
accs la barre d'outils de l'application 26 activation des libells de rapport pour localisation 29

type de base de donnes 18

E
enregistrement d'un rapport avec l'accs la barre d'outils de l'application 26 pour plusieurs applications 28 ensembles de rsultats association 23 exportation fichiers de conception 42

B
BIRT composants 1 Report Designer 2 Report Engine 2 BIRT Report Designer 39 ajout de la fonctionnalit de mise jour de la base de donnes 20 association des ensembles de rsultats 23 configuration 7 cration d'un lien hypertexte entre des rapports 24 cration d'un rapport 10 dossier des bibliothques 3 dossier des modles 4 dossier des outils 4 dossier des rapports 4 dossier scriptlibrary 4 fichiers 2 fichiers source 3 fonctions scalaires 20 formatage des donnes 19 mise en forme du rapport 24 modles 9 remarques sur la conception SQL 19 SQL conditionnel 20 test de la valeur null 19 types de donnes 18

F
fichier de tche cron REPORTLOCKRELEASE 45 REPORTSCHEDULE 45 fichiers de conception exportation 42 importation 40 fichiers de la phase de conception configuration systme 5 installation 5 fonctionnalit de mise jour de la base de donnes ajout 20 fonctions scalaires 20 format pour localisation 31 formatage des dates 19

I C
cration du fichier d'importation 39 importation cration du fichier 39 fichiers de conception 40 libells de rapport pour localisation 30

D
dbogage de BIRT Report Designer 25 dossier des bibliothques 3 dossier des modles 4 dossier des outils 4 dossier des rapports 4 dure Copyright IBM Corp. 2007, 2008

51

Index

L
liens hypertextes 24 localisation donnes 30 libells de rapport 29 mise en forme 31 localisation des donnes 30

R
rapport activation des libells pour localisation 29 cration d'un premier rapport 10 importation de libells 30 liens hypertextes 24 localisation des libells 29 mise en forme 24 types 33 rapports bass sur des paramtres 33 remarques sur la conception SQL 19 requtes excution de requtes supplmentaires dans la mthode d'extraction 22 excution de requtes supplmentaires dans la mthode d'ouverture 22

M
mthode d'extraction pour l'excution de requtes 22 mthode d'ouverture pour l'excution de requtes 22 modles 9 diagramme de sous-rapport Tivoli Maximo 10 rapport de diagramme Liste Tivoli Maximo 10 rapport de diagramme regroup Tivoli Maximo 10 Rapport Liste Tivoli Maximo 10 Rapport regroup Tivoli Maximo 10 Sous-rapport Tivoli Maximo 10

S
scriptlibrary 4 SQL conditionnel 20 SQL d'un rapport ajout de paramtres non lis 35 system properties mxe.activex 43 mxe.report.birt.maxconcurrentrun 43 mxe.report.birt.queueideltimeseconds 43 mxe.report.reportsInAPage 43

P
paramtres Active/Slectionne/Tout 33 ajout de paramtres non lis au SQL d'un rapport 35 lis 34 lis dans les instructions SQL 34 non lis 34 non lis dans les instructions SQL 35 utilisation de valeurs boolennes 37 paramtres Active/Slectionne/Tout 33 paramtres lis 34 dans les instructions SQL 34 paramtres non lis 34 dans les instructions SQL 35 plusieurs applications 28 prrequis de l'installation 5 pour la cration d'un premier rapport 9

T
test de la valeur null 19 type de base de donnes dure 18 YORN 18 types de donnes 18 types de rapport 33

V
valeurs boolennes utilisation comme paramtres 37

Y
YORN type de base de donnes 18

52

Guide de dveloppement des rapports