BIRT Guide

Guide de développement des rapports

IBM Tivoli Change and Configuration Management Database 7.1.1IBM Maximo Asset Management 7.1IBM Tivoli Service Request Manager 7.1IBM Tivoli Asset Management for IT 7.1

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 périodiquement. Chaque nouvelle édition inclut les mises à jour. Les informations qui y sont fournies sont susceptibles d'être modifiées avant que les produits décrits ne deviennent eux-mêmes disponibles. En outre, il peut contenir des informations ou des références concernant certains produits, logiciels ou services non annoncés dans ce pays. Cela ne signifie cependant pas qu'ils y seront annoncés.

Pour plus de détails, pour toute demande d'ordre technique, ou pour obtenir des exemplaires de documents IBM, référez-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 Défense Cedex 50

La présente é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 ultérieures, 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.

ImportantAvant d'utiliser les présentes informations et le produit associé, prenez connaissance des informations figurant à la section “Remarques” à la page 47.

© Copyright IBM Corp. 2007, 2008 iii

A propos de ce document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Chapitre 1 : Chargement et configuration de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Outil de génération de rapports BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Définition des composants BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1BIRT Report Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Installation de BIRT Report Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Installation de BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Fichiers BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Fichiers source de BIRT Report Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Structure des fichiers de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Dossier des bibliothèques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Dossier des rapports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Dossier Scriptlibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Dossier des modèles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Dossier des outils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Configuration système des fichiers de la phase de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Prérequis de l'installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Installation des fichiers de la phase de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Configuration de BIRT Report Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapitre 2 : Création d'un rapport BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Préparation de la création d'un premier rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Comprendre les modèles de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Création d'un rapport BIRT regroupé . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapitre 3 : Fonctions de génération de rapports BIRT avancées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Vérification des types de base de données, des informations SQL et de la fonctionnalité de mise à jour . . . . 17

Mappage des types de données BIRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Remarques sur la conception SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Formatage des dates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Test de la valeur Null. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Fonctions scalaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20SQL conditionnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Ajout de la fonctionnalité de mise à jour de la base de données. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Exécution de requêtes supplémentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Requêtes dans la méthode d'extraction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Requêtes dans la méthode d'ouverture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Association des ensembles de résultats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Mise en forme du rapport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Création d'un lien hypertexte d'un rapport vers un autre. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Débogage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Enregistrement d'un rapport avec l'accès à la barre d'outils de l'application. . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Enregistrement d'un rapport pour plusieurs applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapitre 4 : Configuration de rapports localisés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Localisation des libellés de rapport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Activation des libellés de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Table des matières

iv Guide de développement des rapports

Importation de libellés de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Localisation des données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Exemples de données de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Mise en forme. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapitre 5 : Utilisation des paramètres de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Types de rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Paramètres Active/Sélectionnée/Tout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Rapports basés sur des paramètres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Paramètres liés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Paramètres non liés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Active/Sélectionnée/Tout et Basés sur des paramètres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Paramètres liés et non liés dans les instructions SQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Paramètres liés dans les instructions SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Paramètres non liés dans les instructions SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Ajout de paramètres non liés au SQL d'un rapport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Utilisation de valeurs booléennes comme paramètres. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapitre 6 : Importation et exportation de fichiers de conception. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Création du fichier d'importation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Importation de fichiers de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Importation de fichiers de conception. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Exportation de fichiers de conception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Annexe A : Description des fichiers de propriétés système . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Annexe B : Description des fichiers de tâche Cron . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Remarques. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

© Copyright IBM Corp. 2008 v

Avis aux lecteurs canadiensLe présent document a été traduit en France. Voici les principales différences et particularités dont vous devez tenir compte.

Illustrations

Les illustrations sont fournies à titre d’exemple. Certaines peuvent contenir des données propres à la France.

Terminologie

La terminologie des titres IBM peut différer d’un pays à l’autre. Reportez-vous au tableau ci-dessous, au besoin.

Claviers

Les lettres sont disposées différemment : le clavier français est de type AZERTY, et le clavier français-canadien de type QWERTY.

OS/2 et Windows - Paramètres canadiens

Au Canada, on utilise :

les pages de codes 850 (multilingue) et 863 (français-canadien),le code pays 002,le code clavier CF.

IBM France IBM Canada

ingénieur commercial représentant

agence commerciale succursale

ingénieur technico-commercial informaticien

inspecteur technicien du matériel

vi Guide de développement des rapports

Nomenclature

Les touches présentées dans le tableau d’équivalence suivant sont libellées différemment selon qu’il s’agit du clavier de la France, du clavier du Canada ou du clavier des États-Unis. Reportez-vous à ce tableau pour faire correspondre les touches françaises figurant dans le présent document aux touches de votre clavier.

Brevets

Il est possible qu’IBM détienne des brevets ou qu’elle ait déposé des demandes de brevets portant sur certains sujets abordés dans ce document. Le fait qu’IBM vous fournisse le présent document ne signifie pas qu’elle vous accorde un permis d’utilisation de ces brevets. Vous pouvez envoyer, par écrit, vos demandes de renseignements relatives aux permis d’utilisation au directeur général des relations commerciales d’IBM, 3600 Steeles Avenue East, Markham, Ontario, L3R 9Z7.

Assistance téléphonique

Si vous avez besoin d’assistance ou si vous voulez commander du matériel, des logiciels et des publications IBM, contactez IBM direct au 1 800 465-1234.

Copyright IBM Corp. 2007, 2008 vii

A propos de ce document

Le présent document décrit les tâches de configuration, de création et de conception du développeur de rapports. Il présente également les fonctions de génération de rapports avancées.

Public visé

Le présent guide est destiné aux développeurs de rapports qui doivent effectuer les tâches suivantes :

création d'un rapport BIRTimportation et exportation de fichiers de conception de rapportschargement et configuration de BIRT Report Designerconfiguration de rapports localisésutilisation de fonctions de génération de rapports BIRT avancéesutilisation de paramètres de rapport

Public visé

viii Guide de développement des rapports

© Copyright IBM Corp. 2007, 2008 1

y

Le présent document est destiné aux programmeurs Java possédant 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 développement libre.

Ce chapitre contient les sections suivantes :

Outil de génération de rapports BIRT

Fichiers BIRT Report Designer

Fichiers source de BIRT Report Designer

Structure des fichiers de BIRT Report Designer

Configuration système des fichiers de la phase de conception

Configuration de BIRT Report Designer

Outil de génération de rapports BIRT

IBM utilise BIRT comme outil de génération de rapports. BIRT est un système de génération de rapports à source ouverte reposant sur la technologie Eclipse pour les applications Web.

Cette section définit les composants de BIRT.

Définition des composants BIRT

IBM Corporation intègre les composants BIRT suivants :

BIRT Report Engine

BIRT Report Designer

Chargement et configuration de BIRT Report Designer 1


2 Guide de développement des rapports

BIRT Report Engine

BIRT Report Engine est un outil Eclipse permettant d'afficher des rapports.

BIRT Report Engine génère 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 système. Lorsque vous avez installé votre application, vous avez également installé BIRT Report Engine.

BIRT Report Designer

Utilisation de BIRT Report Designer pour le développement de rapports. L'outil de conception est une interface Eclipse permettant de créer des rapports qui s'intègrent dans des applications Web.

Installation de BIRT Report Designer

Pour des informations sur l'installation de BIRT Report Designer, accédez à IBM developerWorks.

IMPORTANT Si vous ne disposez pas de JDK 1.5 (5.0), vous devez l'installer.


Les fichiers BIRT Report Design sont des fichiers xml, possédant l'extension .rptdesign. Les rapports BIRT peuvent contenir un ou plusieurs fichiers. Ces fichiers sont classés comme des fichiers de bibliothèque ou des fichiers de ressources.

Les fichiers de bibliothèque BIRT sont également des fichiers xml et possèdent l'extension .rptlibrary. Les fichiers de bibliothèque BIRT contiennent du code utilisé plusieurs fois pour des éléments tels que le type de police, la taille, les numéros de page et l'horodatage. Chaque fichier peut être réutilisé plusieurs fois dans les conceptions et les modèles de rapport BIRT.

Les fichiers de ressources contiennent des éléments tels que des images ou des fichiers externes. Les fichiers de ressources peuvent être utilisés par les fichiers de conception de rapport ou les fichiers de bibliothèque. Les fichiers de propriétés sont également des fichiers de ressources. De nombreuses conceptions de rapport différentes utilisent le même fichier de propriétés.

Le fichier xml du rapport BIRT détaille les fichiers de bibliothèque et les fichiers de ressources requis par le rapport. Sans ces fichiers, le rapport BIRT n'est pas exécuté.




IBM vous offre plusieurs rapports pour que vous puissiez analyser des incidents spécifiques, afficher des données selon une méthode non disponible dans une application spécifique ou imprimer les résultats des enregistrements pour conserver une trace des actions ou des enregistrements.

IMPORTANT Pour une liste complète des rapports prêts à 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 société ou modifier le tri. Vous pouvez également créer vos propres rapports personnalisés pour répondre aux besoins spécifiques de votre entreprise.

Par conséquent, IBM inclut les fichiers de conception de rapport pour que vous puissiez les personnaliser ou en consulter le contenu à titre d'exemples pour la création de vos propres rapports.

Structure des fichiers de BIRT Report Designer

La structure des fichiers BIRT Report Designer contient les sous-répertoires suivants :

bibliothèquesrapportsscriptlibrarymodèlesoutils

Les sections ci-après décrivent ces sous-dossiers en détail.

Dossier des bibliothèques

Le dossier des bibliothèques contient tous les fichiers de propriétés de l'application. Le fichier de propriétés contient les titres et les libellés des rapports. Ce fichier est requis pour importer un rapport et pour la localisation.

Le dossier des bibliothèques contient également les fichiers de bibliothèque système suivants :

libraries.xmlMaximoSystemLibrary.rptlibrary

IMPORTANT Ne modifiez pas les deux fichiers de bibliothèque système dans le dossier des bibliothèques. Si vous modifiez ces fichiers, vous risquez d'altérer vos rapports.



Dossier des rapports

Chaque application de votre système correspond à un dossier de votre sous-dossier de rapports. Votre licence contrôle 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 représente l'application Personnes. Le dossier Personnes contient le fichier person_details.rptdesign qui représente le rapport Détails 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 nécessaires pour que vous puissiez importer un rapport (nom du fichier, description, paramètres).

Dossier Scriptlibrary

Le dossier scriptlibrary contient le code des scripts. Le système requiert ce code pour que vous puissiez activer les rapports IBM.

Dossier des modèles

Le dossier des modèles contient les modèles de rapport IBM. Il s'agit des seuls modèles que vous devez utiliser lorsque vous créez un rapport. Pour plus d'informations sur les modèles, voir “Comprendre les modèles 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 données système. Pour plus d'informations sur l'importation et l'exportation, voir Chapitre 6.




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

Prérequis de l'installation

Avant de créer ou personnaliser des rapports BIRT, vous devez avoir téléchargé 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, accédez à IBM developerWorks.

Eclipse version 3.2.2

Si Eclipse n'est pas encore chargé sur votre machine, demandez les informations de téléchargement à votre administrateur système.

Installation des fichiers de la phase de conception

Les instructions ci-après décrivent comment installer les fichiers de la phase de conception.

Dans les chemins d'accès aux fichiers ci-après, v20060926-0959 correspond à un numéro de version et peut être différent selon votre version.

1 Recherchez les classes compilées pour la génération des scripts de rapport dans l'emplacement <Racine_produit>.

<Racine_produit>\reports\birt\scriptlibrary\classes

2 Copiez l'intégralité du dossier \com dans l'emplacement suivant :

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

Si nécessaire, créez le dossier \classes.

3 Copiez mxreportdatasources.properties en utilisant les dossiers source et cible de l'étape 1.



4 Editez le fichier comme suit :

a Définissez les propriétés de l'URL, du pilote, du nom d'utilisateur, du mot de passe et du propriétaire de schéma, en suivant l'exemple de format fourni.

b Remplacez #<DataSourceName> par maximoDataSource.

Informations complémentaires

En tant que développeur 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 données) sont des variables. Vous pouvez vérifier les informations sur votre base de données en sélectionnant Démarrer> Programmes>IBM DB2>Outils de configuration>Assistant de configuration.

maximoDataSource est l'ensemble par défaut actuel de tous les rapports.

5 Copiez les pilotes JDBC suivants :

<Racine_produit>\applications\maximo\lib ou à partir du fichier zip spécifique à la base de données

vers :

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

Ces pilotes ne sont utilisés que par 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.


Pour configurer BIRT Report Designer, procédez comme suit :

IMPORTANT Créez un raccourci vers eclipse .exe. Incluez bien le chemin d'accès 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 Sélectionner lorsque vous spécifiez les chemins d'accès aux dossiers dans Eclipse.

2 Spécifiez l'emplacement du dossier des ressources.

a Sélectionnez Fenêtre>Préférences

b Développez Conception de rapport et sélectionnez Ressource.

c Spécifiez l'emplacement de la bibliothèque des rapports :

<Racine_produit>\reports\birt\libraries

3 Spécifiez l'emplacement du dossier des modèles.

a Sélectionnez Fenêtre>Préférences

b Développez Conception de rapport et sélectionnez Modèles.

c Spécifiez l'emplacement des modèles :

<Racine_produit>\reports\birt\templates

4 Désactivez le modèle Commentaire de la manière suivante :

a Ouvrez la fenêtre Préférences en sélectionnant Fenêtre>Préférences.

b Développez le dossier Conception de rapport et sélectionnez le modèle Commentaire.

c Désélectionnez l'option spécifiant de générer un commentaire lors de la création d'une conception de rapport.



5 Importez le projet de rapport.

a Sélectionnez Fichier>Importer

b Développez le dossier général et sélectionnez les projets existants dans Espace de travail.

c Cliquez sur Suivant.

d Accédez à l'emplacement des fichiers de rapport :

<Racine_produit>\reports\birt\reports

e Sélectionnez le projet YourReports. Cliquez sur Terminer.

6 Importez le projet de bibliothèque. Cette étape est facultative et ne s'applique que si vous modifiez les bibliothèques.

a Sélectionnez Fichier>Importer

b Développez le dossier général et sélectionnez les projets existants dans Espace de travail. Cliquez sur Suivant.

c Accédez à l'emplacement de la bibliothèque de rapports à partir de l'étape 2.

d Sélectionnez 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 générez 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 Sélectionnez Fichier>Importer.

c Développez le dossier général et sélectionnez les projets existants dans Espace de travail, puis cliquez sur Suivant.

d Accédez à l'emplacement suivant :

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

e Sélectionnez le projet YourReportScriptLibrary. Cliquez sur Terminer.


Ce chapitre décrit comment créer votre premier rapport BIRT à l'aide de BIRT Report Designer. Ce chapitre contient les sections suivantes :

Préparation de la création d'un premier rapport

Comprendre les modèles de rapport

Création d'un rapport BIRT regroupé

Préparation de la création d'un premier rapport

Avant de créer un rapport dans BIRT Report Designer, IBM recommande de développer et de tester toutes les requêtes requises dans un outil d'interrogation de base de données. BIRT ne valide pas le code SQL et un outil d'interrogation peut générer des messages d'erreur plus clairs.

En outre, vous devez connaître les types de données de tous les champs de votre rapport. Déterminez les types de données (maxtypes) des champs utilisés dans vos requêtes à l'aide de l'une des méthodes 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 données et utilisez le champ Type de l'onglet Attributs de votre objet sélectionné.

Comprendre les modèles de rapport

IBM a développé un certain nombre de modèles de rapport pour vous aider à créer des rapports. Pour afficher ces modèles, à partir de BIRT Report Designer, sélectionnez Fichier>Nouveau>Rapport ou choisissez Nouveau rapport dans la liste déroulante. De nombreux modèles sont affichés, mais vous ne devez sélectionner que ceux qu'IBM crée et active spécifiquement pour vous. Ces modèles sont identifiés par les termes “Tivoli Maximo”. Ces modèles contiennent le code nécessaire pour l'intégration et permettent d’obtenir une présentation cohérente des rapports.

Création d'un rapport BIRT 2



Le tableau suivant décrit ces modèles :


Cette section décrit comment créer un rapport BIRT regroupé. Le rapport utilisé par cet exemple est le rapport Configuration de base de données. Le nom de fichier de ce rapport est listtabl.rptdesign. Ce fichier se trouve à l'emplacement suivant :

<Racine_produit>\reports\birt\reports\configur

1 Développez et testez toutes les requêtes SQL de base de données dans un outil d'interrogation.

Créez un rapport 2 Sélectionnez Fichier>Nouveau>Autre. Développez 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. Sélectionnez le modèle de rapport regroupé Tivoli Maximo.

5 Cliquez sur Terminer. La conception du rapport apparaît.

Nom Description

Modèle de sous-rapport Tivoli Maximo Ce modèle crée un rapport avec un ou plusieurs sous-rapports. Chaque sous-rapport peut comporter des champs de données différents.

Modèle de rapport regroupé Tivoli Maximo Ce modèle crée un rapport avec un ou plusieurs groupes. Chaque groupe possède des champs de données identiques.

Modèle de rapport Liste Tivoli Maximo Ce modèle crée un rapport avec un seul en-tête. Ce rapport contient généralement plusieurs lignes, suivant la quantité de données disponibles.

Les modèles ci-après incluent des éléments graphiques, en plus des formats de génération de rapports standard. Chaque modèle inclut trois types de diagramme (un diagramme à secteurs, un diagramme de Gantt et un diagramme à courbe). Sélectionnez un type de diagramme pour votre rapport et supprimez les deux autres.

Modèle de diagramme de sous-rapport Tivoli Maximo

Ce modèle crée un rapport avec un ou plusieurs sous-rapports. Chaque sous-rapport peut comporter des champs de données différents.

Modèle de rapport de diagramme regroupé Tivoli Maximo

Ce modèle crée un rapport avec un ou plusieurs groupes. Chaque groupe possède des champs de données identiques.

Modèle de rapport de diagramme Liste Tivoli Maximo

Ce modèle crée un rapport avec un seul en-tête. L'en-tête contient plusieurs lignes de données.



Spécifiez la requête 6 Dans la vue de l'explorateur de données, sélectionnez le fichier. Cliquez sur l'onglet Script. Sélectionnez la méthode d'ouverture dans la liste déroulante.

7 Copiez votre requête de l'outil d'interrogation dans le corps de la méthode sous l'exemple de requête existant. Mettez en forme votre requête conformément à l'exemple.

Créez les colonnes de sortie

8 Cliquez deux fois sur le fichier pour ouvrir la boîte de dialogue Propriétés. Dans l'éditeur de colonnes de sortie, entrez une colonne pour chaque champ de votre requête et chaque colonne à tabulations. Si vous laissez la méthode d'ouverture visible lors de cette opération, vous pouvez l'utiliser comme référence dans les colonnes. Vous pouvez affecter aux colonnes de sortie des noms autres que les champs de base de données ou conserver les noms existants.

Définissez le type de données de chaque colonne de sortie en fonction du paramètre maxtype du champ, comme spécifié dans le diagramme Mappage des types de données BIRT. Pour plus d'informations, voir “Mappage des types de données BIRT”, à la page 18.

IMPORTANT Si vous avez besoin de plusieurs fichiers, vous pouvez copier le fichier existant avant de poursuivre cette procédure. Des fichiers supplémentaires sont souvent nécessaires lorsque vous créez des sous-rapports.

Extrayez les lignes de données

9 Dans la page Script, choisissez la méthode d'extraction dans la liste déroulante. Conformément à l'exemple fourni dans le modèle, ajoutez une ligne pour chaque colonne qui extrait la valeur du fichier et met à jour la colonne de sortie avec cette valeur.

Utilisez la méthode appropriée en fonction du type de données du champ, conformément au mappage des types de données BIRT.

Activez le débogage 10 Cliquez sur la vue Structure, sélectionnez le rapport, puis l'onglet Script. Sélectionnez bien la méthode d'initialisation dans la liste déroulante. Ajoutez les lignes de débogage.

Ajoutez les paramètres de rapport

11 Accédez à la vue Fichier, cliquez à l'aide du bouton droit de la souris sur Paramètres de rapport, puis sélectionnez Nouveau. Remplissez les données. Cliquez sur OK.

Incorporez le paramètre de rapport dans votre clause SQL dans la méthode d'ouverture de fichier

12 Ajoutez un paramètre non lié facultatif.

Créez le SQL approprié à l'aide de la méthode createParamWhereClause(). Voici un exemple de texte que vous pouvez ajouter à la méthode d'ouverture :

// Génération de la clause where avec le paramètre non lié DBTablevar where = params["where"];if (params ["DBTable"].value)where = where + " and " + MXReportSqlFormat.createParamWhereClause ("mo.objectname", params["DBTable"]);

Créez la présentation du rapport

13 Sélectionnez l'onglet Mise en page et ajoutez le titre du rapport.

14 Si le rapport ne requiert pas l'affichage des paramètres d'entrée dans l'en-tête, supprimez la grille contenant les paramètres.



Ajoutez les données de détail

15 Dans la vue Données, développez le fichier. A l'aide de la souris, déplacez des colonnes de sortie sur la ligne de détail de la mise en page. Pour ajouter d'autres colonnes au tableau, sélectionnez l'onglet Table, puis l'onglet Colonne. Pour éviter toute discontinuité dans la présentation, insérez toujours les colonnes à gauche.

16 Vérifiez l'apparence de votre présentation.

Ajoutez les en-têtes de colonne

17 Accédez à la vue Palette. Faites glisser un libellé existant sur les autres en-têtes de colonne. Par exemple, si l'en-tête de la première colonne s'intitule Statut, vous pouvez ajouter ce libellé aux autres colonnes.

Ajoutez les détails du groupe

18 Ouvrez la vue Structure et cliquez sur Corps>Table> Groupes. Cliquez deux fois sur l'entrée Groupe de la table pour afficher l'éditeur de groupe. Ajoutez la colonne de regroupement. Cliquez sur OK pour ajouter les détails du groupe.

Prévisualisez le rapport 19 Cliquez sur l'onglet Aperçu. Le rapport est exécuté avec les paramètres par défaut.

20 Pour spécifier des paramètres autres que ceux par défaut, cliquez sur Afficher les paramètres de rapport et entrez des valeurs valides.

21 Ajoutez des libellés de groupe.

Associez le rapport à un fichier de propriétés de localisation de libellés qui stocke les paires clé/valeur des libellés

22 Pour effectuer cette tâche, procédez comme suit :

a Sélectionnez la vue Structure.

b Dans la page Propriétés, sélectionnez Ressources.

c S'il existe un fichier de propriétés pour votre application, sélectionnez-le. Sinon, entrez le nom du nouveau fichier de propriétés. Le nom que vous entrez doit correspondre au nom de votre dossier d'applications dans les rapports. Le système crée le fichier de propriétés à l'emplacement suivant :

...\reports\BIRT\libraries

Le nom du fichier de propriétés du rapport Configuration de base de données est configur.properties.

d Cliquez sur OK.

Sélectionnez un libellé à localiser dans l'éditeur de présentation

23 Effectuez les étapes suivantes :

a Dans la page Propriétés, sélectionnez le paramètre Localisation.

b Cliquez sur Détail (“…”) en regard du champ Clé du texte .

c Entrez une nouvelle paire de valeurs de clé ou sélectionnez-en une existante.

d Cliquez sur OK.

Répétez cette étape pour tous les libellés de votre présentation. Pour plus d'informations sur l'activation des rapports localisés, voir Chapitre 4, “Configuration de rapports localisés.”



Définissez les longueurs de colonne pour garantir un affichage correct dans les fichiers PDF

24 Sélectionnez un onglet et la colonne correspondante du tableau. Vous pouvez redimensionner la colonne pour définir une largeur spécifique. Procédez de même pour toutes les colonnes de tableau et de grille.

Affichez le rapport au format PDF

25 Pour afficher le rapport au format PDF, sélectionnez l'icône d'affichage des rapports. Cliquez sur Afficher le rapport comme PDF.

26 Le rapport apparaît. Retournez à l'éditeur de présentation et ajustez les colonnes si nécessaire.

27 Créez le fichier d'importation du rapport, reports.xml. Il existe un fichier d'importation dans chaque répertoire de rapport d'application.

Pour plus d'informations sur le fichier reports.xml, voir Chapitre 6.

Le texte suivant représente le fichier reports.xml du rapport Configuration de base de données :



<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 création du fichier d'importation, voir “Enregistrement d'un rapport avec l'accès à la barre d'outils de l'application,” à la page 26.

Importez le rapport 28 Ouvrez une invite de commande et accédez à l'emplacement suivant :

<Racine_produit>\reports\birt\tools

29 Pour importer tous les rapports de l'application Configuration de base de données, exécutez la commande suivante :

importreports configur

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



Connectez-vous au système pour vérifier que vous avez chargé votre rapport

30 Connectez-vous à votre système en tant qu'administrateur de rapport et ouvrez l'application Administration des rapports. Dans le champ Nom du fichier de rapport, entrez Base de données pour filtrer dans le rapport Configuration de base de données.

31 Sélectionnez votre rapport ; l'onglet des détails du rapport apparaît. Si nécessaire, appliquez les privilèges de sécurité.

IMPORTANT Vous définissez la sécurité au niveau du rapport dans l'onglet Sécurité. Vous définissez la sécurité au niveau de l'application via l'action Définir la sécurité de l'application.

32 Avant d'exécuter le rapport pour la première fois, cliquez sur Générer la page de demande.

33 Pour prévisualiser votre rapport, cliquez sur Aperçu. Entrez une valeur pour la table de base de données Paramètre ou cliquez sur Soumettre pour exécuter le rapport sur tous les enregistrements.

Le rapport BIRT regroupé apparaît dans le navigateur de rapports.


Ce chapitre contient des informations sur les fonctions de génération de rapports avancées pour vous aider à utiliser BIRT Report Designer. Il aborde les sujets suivants :

Vérification des types de base de données, des informations SQL et de la fonctionnalité de mise à jour

Exécution de requêtes supplémentaires

Mise en forme du rapport

Création d'un lien hypertexte d'un rapport vers un autre

Débogage

Enregistrement d'un rapport avec l'accès à la barre d'outils de l'application

Enregistrement d'un rapport pour plusieurs applications


Cette section contient les sous-sections suivantes pour vous aider à créer un rapport BIRT :

Mappage des types de données 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 données

Fonctions de génération de rapports BIRT avancées 3



Mappage des types de données BIRT

Ce diagramme indique le type de base de données, le type de données BIRT correspondant et la méthode utilisée dans BIRT Designer pour extraire sa valeur. Ce diagramme définit les champs de données utilisés lors de la méthode d'extraction et la manière dont les colonnes de sortie des ensembles de données sont alimentées.

IMPORTANT Les types de base de données suivants ne sont pas pris en charge dans les rapports : BLOB, CRYPTO et CRYPTOX.

Type de base de données YORN

Les champs YORN sont stockés dans la base de données sous forme de nombres (0 et 1), mais sont présentés dans le système sous forme de texte localisé. La méthode getBooleanString(String attributeName) effectue les deux tâches : elle extrait la valeur numérique et la convertit en texte. Vous pouvez également obtenir la valeur convertie à partir de l'entier, à l'aide de la méthode getBooleanString(int intValue).

Type de base de données DURATION

La base de données stocke DURATION sous forme de nombre (fractions d'heure), mais le système présente DURATION sous forme de chaîne au format HH:MM. La méthode getDuration renvoie la chaîne formatée. Si vous avez besoin de la valeur numérique à la place, utilisez la méthode getDecimal.

Une méthode utilitaire supplémentaire, MXReportUtil.getDuration(String attributeName)permet de convertir la chaîne du format "double" au format "single".

Type de base de données Type de données BIRT

Méthode de fichier utilisée pour l'extraction

ALN, CLOB, GL, LONGALN, LOWER, UPPER Chaîne getString(String attributeName)

YORN (Voir la section suivante sur le type de base de données YORN)

Chaîne getBooleanString(String attributeName)

DATE, DATETIME, TIME DateHeure getTimestamp(String attributeName)

AMOUNT, DECIMAL, DURATION (Voir la section suivante sur le type de base de données DURATION.)

Décimal getDouble(String attributeName)

FLOAT Variable flottante

getFloat(String attributeName)

DURATION (Voir la section suivante sur le type de base de données DURATION.)

Chaîne getDuration(String attributeName)

INTEGER, SMALLINT Entier getInteger(String attributeName)



Remarques sur la conception SQL

Utilisez bien un SQL indépendant de la base de données 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 propriétaires, telles que DECODE et ISNULL. N'utilisez pas de qualification de propriétaire (MAXIMO.workorder) et référencez tous les objets de base de données en minuscules.

Formatage des dates

Le système offre des méthodes MXReportSqlFormat statiques pour prendre en charge le formatage des dates. Toutes les chaînes renvoyées des fonctions de date formatées par JDBC peuvent être utilisées dans les instructions SQL des rapports pour toutes les bases de données prises en charge. Les instructions suivantes offrent un exemple :

"where actualdate <=" + MXReportSqlFormat.getCurrentDateFunction()a pour résultat :where actualdate <= { ts '2007-04-01 00:00:00' }getCurrentDateFunction() – date du jourgetCurrentTimestampFunction() – date et heure actuellesgetDateFunction(Date d)– date basée sur la date entréegetTimeFunction(Date d) – heure basée sur la date entréegetTimestampFunction(Date d) – date et heure basées sur la date entréegetStartDayTimestampFunction(Date d)– date basée sur la date entrée, avec le composant heure correspondant au début de la journée (pour les paramètres de date de début)getEndDayTimestampFunction(Date d) – date basée sur la date entrée, avec le composant heure correspondant à la fin de la journée (pour les paramètres de date de fin)

Test de la valeur Null

La fonction COALESCE est prise en charge sur tous les types de base de données et peut être utilisée directement dans la requête. Si vous devez utiliser une fonction de conversion null propriétaire, IBM fournit la méthode de fichier suivante :

maximoDataSet.getNullValueFunction(String param, String nullVal)– Cette méthode renvoie NVL, ISNULL ou COALESCE suivant le type de base de données.

Par exemple :

"select " + maximoDataSet.getNullValueFunction("parent", "wonum")

a pour résultat :

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



Si nullVal correspond à un littéral chaîne ; placez-le entre apostrophes :"select" + maximoDataSet.getNullValueFunction("parent", "‘NONE’")

Soyez prudent lorsque vous utilisez des littéraux de chaîne de cette manière car le système ne les localise pas.

Fonctions scalaires

La méthode MXReportSqlFormat.getScalarFunction(functionName, paramètres variables) renvoie une fonction scalaire JDBC basée sur le nom de la fonction et une liste de paramètres variable. Vous pouvez utiliser cette méthode pour accéder aux fonctions de base de données indépendamment de la base de données, comme recommandé dans la spécification JDBC pour les fonctions couramment utilisées.

SQL conditionnel

Lorsque vous devez utiliser un SQL spécifique à la base de données, créez la requête de manière conditionnelle en fonction du type de base de données. Pour cela, utilisez les méthodes suivantes sur le fichier :

Boolean isOracle(), Boolean isSQLServer(), Boolean isDB2() String getDatabaseProductName() – Renvoie le nom de la base de données à partir de la connexion

Si seules quelques lignes sont différentes, vous pouvez les isoler et les définir de manière appropriée, 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 données

Cette section décrit comment ajouter une fonctionnalité de mise à jour de la base de données à des rapports. Avec cette fonctionnalité, les rapports doivent pouvoir exécuter les instructions UPDATE/INSERT/DELETE du SQL de la base de données sur une source de données spécifique :

IMPORTANT Les exemples ci-après illustrent l'instruction SQL UPDATE, mais vous pouvez également utiliser les instructions SQL INSERT et DELETE.



1 Exécutez la mise à jour dans un fichier (l'une des méthodes 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 Exécutez la mise à jour en dehors d'un fichier.

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

3 Exécutez 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 Exécutez le code avec des paramètres.

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 paramètres commence à 1myStmt.setQueryParameterValue(2, "MyValue");// utilisation d'un objet Chaîne comme exemplemyTxn.save();


Vous pouvez exécuter des requêtes supplémentaires dans les méthodes d'ouverture et d'extraction. Chaque méthode peut comporter une ou plusieurs requêtes supplémentaires renvoyant un ou plusieurs champs. Les sections ci-après décrivent ces types de requête.



Requêtes dans la méthode d'extraction

Une même instruction SQL ne fournit pas toujours tous les champs de données d'un rapport. Utilisez la requête principale afin d'alimenter la plupart des colonnes de sortie et exécuter des requêtes supplémentaires pour extraire les données restantes, comme illustré dans l'exemple suivant :

if (!maximoDataSet.fetch())return (false);

// Définition de colonnes de sortie à partir de la requête principalerow["assetnum"] = maximoDataSet.getString("assetnum");

// Exécution de la requête secondaireclassStrucDataSet = MXReportDataSetProvider.create(this.getDataSource().getName(),"class");classStrucDataSet.open();

sqlText = "select description from classstructure where classstructureid=? ";classStrucDataSet.setQuery(sqlText);

// Utilisation de la valeur de la requête principale comme clé externe dans la requête secondaireclassStrucDataSet.setQueryParameterValue(1,maximoDataSet.getString("classstructureid"));

if (classStrucDataSet.fetch()){// Définition de colonnes de sortie à partir de la requête secondairerow["description"] = classStrucDataSet.getString("description");}// Toujours fermer le fichierclassStrucDataSet.close();

return(true);

Requêtes dans la méthode d'ouverture

Ces types de requête sont utiles pour rechercher les valeurs statiques dont le rapport a besoin. Vous pouvez insérer ces valeurs dans des variables globales et les utiliser dans tout le rapport.

Par exemple, il existe trois champs de coût dans invcost et celui à utiliser pour un article donné dépend du site de l'article. Un type de coût par défaut est affecté aux sites dans maxvars. Le rapport contenant un paramètre à une valeur sur Site, vous pouvez rechercher le coût spécifique à un site et l'utiliser dans tout le rapport.

La procédure est la même que celle décrite pour la méthode d'extraction, mais des variables sont utilisées à la place des colonnes de sortie pour stocker les résultats.



Association des ensembles de résultats

Lorsque vous exécutez des requêtes supplémentaires dans la méthode d'extraction, vous devez généralement les associer à la ligne de données en cours. Pour cela, vous incluez directement la valeur ou vous utilisez des paramètres de fichier.

Le texte ci-après est extrait de l'exemple précédent relatif à l'exécution de requêtes dans la méthode d'extraction :

sqlText = "select description from classstructure where classstructureid=?";classStrucDataSet.setQuery(sqlText);

// Utilisation de la valeur de la requête principale comme clé externe dans la requête secondaireclassStrucDataSet.setQueryParameterValue(1,maximoDataSet.getString("classstructureid"));

Dans cet exemple, vous affectez au paramètre la valeur d'un champ d'un fichier. Le champ correspondant à une chaîne, vous utilisez la méthode de fichier getString. Vous pouvez également utiliser la méthode getTimestamp, mais pas les méthodes d'extraction qui renvoient des types de données primitifs. Au lieu de la méthode d'extraction, utilisez la méthode suivante :

getDoubleObject(String attributeName)getFloatObject(String attributeName)getIntegerObject(String attributeName)

Une autre situation courante, lorsque vous devez associer des ensembles de résultats, se présente lors de l'association de sous-rapports. Les requêtes de sous-rapport sont similaires aux requêtes de la méthode d'ouverture dans la mesure où elles sont toutes deux exécutées chaque fois que vous extrayez un enregistrement de la requête principale. Par contre, les requêtes de sous-rapport possèdent leurs propres fichiers. Le contenu du sous-rapport peut être inclus dans une table enfant indépendante, qui est liée au fichier secondaire et imbriquée dans une cellule de la table parent.

Pour associer une requête de sous-rapport à une requête principale, incluez les champs de liaison (clés externes) dans la requête principale. Dans la requête de sous-rapport, référencez 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"] + "'";




Faites glisser les champs du fichier vers le rapport. Définissez 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 prévoyez une marge de 0,5” de chaque côté, vous devez espacer vos colonnes de 10” (car IBM fournit les modèles de rapport au format paysage). Pour un rapport en cinq colonnes, vous pouvez prévoir 2” pour chaque colonne.

Définissez les champs d'affichage des paramètres. Ne faites pas glisser à l'aide de la souris des paramètres de l'explorateur de données dans le rapport. Par contre, faites glisser un élément de données et affectez le paramètre comme expression de valeur.

S'il existe des groupes, définissez les clés.

Création d'un lien hypertexte d'un rapport vers un autre

De nombreux rapports contiennent des liens hypertextes pour que vous puissiez explorer les rapports détaillés. Dans l'exemple ci-après, vous accédez au rapport Détails de la gamme d'opérations (jobplan_print.rptdesign) à partir du rapport Liste des gammes d'opérations (jobplan.rptdesign). Vous pouvez utiliser cet exemple lorsque vous créez vos propres liens hypertexte.

Lorsque vous spécifiez un rapport à associer, BIRT vérifie que ce rapport existe et lit les informations sur ses paramètres. Par conséquent, pour pouvoir définir les propriétés de lien hypertexte d'un champ, vous devez créer une marque de réservation .rptdesign pour le rapport cible. Cette marque de réservation doit se trouver dans le dossier d'application approprié et posséder le nom de fichier correct. Il n'est pas nécessaire que la conception du rapport soit terminée.

Une fois que le rapport cible est en place, créez le lien à l'aide des étapes suivantes :

1 Sélectionnez l'élément de données dans le rapport source et choisissez Lien hypertexte dans la boîte de dialogue Propriétés. Sélectionnez l'ellipse pour ouvrir la boîte de dialogue Options du lien hypertexte. Définissez le type de lien hypertexte pour l'exploration.

2 Sous le champ de sélection d'un rapport cible, sélectionnez le chemin relatif permettant d'accéder au rapport associé.

Si le rapport se trouve dans le même 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'opérations (dans le dossier JOBPLAN) à Détails de la gamme d'opérations (également dans le dossier JOBPLAN), entrez le texte suivant :

..\JOBPLAN\jobplan_print.rptdesign

Débogage


3 Dans le champ Paramètres de rapport, sélectionnez le paramètre where. Dans le champ Valeurs, entrez une clause where qui spécifie la relation entre la ligne actuelle et le rapport associé. Par exemple, pour associer Liste des gammes d'opérations à Détails de la gamme d'opérations, entrez le texte suivant :

"jobplan.jpnum='" + row["jpnum"] + "' and jobplan.siteid='" + row["siteid"] + "'"

Débogage

Pour consigner des informations prédéfinies sur le rapport, ajoutez les lignes suivantes à la méthode d'initialisation du rapport (remplacez le chemin d'accès du fichier par un chemin valide) :

mxReportScriptContext.setDefaultLogLevel("DEBUG");mxReportScriptContext.setDefaultLogFile("c:/temp/myreport.log");

Ces lignes ne sont pas utilisées lors de la phase d'exécution ; elles ne le sont que lorsque vous prévisualisez le rapport à partir du concepteur. Les niveaux de consignation pris en charge par IBM sont DEBUG, INFO, WARN, ERROR, FATAL.

Pour consigner des informations personnalisées, 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 défaut, le système enregistre ces messages dans les fichiers journaux lorsque vous exécutez le rapport sur le système. ReportLogger contient les méthodes 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);




Les rapports qui ne contiennent pas de paramètres entrés par l'utilisateur peuvent être activés pour l'accès à 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 immédiatement dans le navigateur de rapport. Lorsque vous cliquez sur l'icône Rapport de la barre d'outils de l'application, le rapport BIRT apparaît dans un nouveau navigateur de rapport.

DP (Impression directe) – Un rapport à impression directe est un rapport qui ouvre immédiatement Adobe Acrobat et s'imprime sur l'imprimante par défaut de l'utilisateur. Lorsque l'utilisateur final clique sur l'icône Rapport de la barre d'outils de l'application, le rapport s'imprime sur l'imprimante par défaut de l'utilisateur.

DPA (Impression directe avec les pièces jointes) – Une impression directe avec les pièces jointes est similaire à un rapport à impression directe. Si des pièces jointes sont associées à un enregistrement, l'utilisateur final peut les imprimer avec le rapport. Si l'utilisateur clique sur Oui, les documents joints sont imprimés sur l'imprimante par défaut avec le rapport. Si l'utilisateur clique sur Non, seul le rapport s'imprime automatiquement sur l'imprimante par défaut.

Le tableau ci-après décrit les types d'accès à la barre d'outils de l'application :

Pour activer l'accès à la barre d'outils de l'application, ces champs doivent être définis dans le fichier reports.xml lors de l'importation du rapport. En outre, le champ du nombre limite d'enregistrements (détail) doit être activé et le champ recordlimit doit être défini pour les fonctionnalités DP et DPA.

Description Champ de base de données

Emplacement dans la barre d'outils

Séquence

BV Vue du navigateur REPORT.QL REPORT.QLLOC REPORT.TOOLBARSEQUENCE

DP Impression directe REPORT.DP REPORT.DPLOC REPORT.TOOLBARSEQUENCE

DPA Impression directe avec les pièces jointes

REPORT.PAD REPORT.PADLOC REPORT.TOOLBARSEQUENCE



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>




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-après montrent comment IBM a enregistré le rapport Liste des interventions (wotrack.rptdesign) dans plusieurs applications.

1 Vérifiez l'entrée d'importation dans le fichier reports.xml pour l'application interne (WOTRACK).

2 Affichez les entrées dans le fichier reports.xml des autres dossiers d'application qui utilisent le rapport (QUICKREP, CHANGE, RELEASE, ACTIVITY).

3 Notez le remplacement de l'entrée <nomfichier> par le chemin relatif de l'emplacement réel 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 modifiées de manière appropriée.

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 posséder 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 même nom de fichier de conception de rapport (.rptdesign).

S'il existe des paramètres liés, il se peut qu'ils doivent être modifiés car les liaisons qui fonctionnent dans une application peuvent ne pas fonctionner dans une autre.


Ce chapitre contient des informations sur la configuration des rapports localisés. Pour activer les rapports pour la localisation, vous devez effectuer les opérations suivantes :

Localisation des libellés de rapport

Localisation des données

Mise en forme

Localisation des libellés de rapport

Vous activez la localisation des libellés et des titres de rapport par l'intermédiaire des fichiers de propriétés. Le système stocke les fichiers de propriétés à l'emplacement suivant :


Un fichier de propriétés distinct est disponible pour chaque application qui contient des rapports. Par exemple, tous les rapports Intervention de l'application Intervention utilisent le fichier de propriétés suivant :

<Racine_produit>\reports\birt\libraries\wotrack.properties

En utilisant une propriété unique pour chaque application, vous minimisez le nombre de fois que vous devez définir et localiser les valeurs de libellé souvent répétées, telles que la description ou le statut.

Activation des libellés de rapport

Pour activer les libellés pour la localisation, suivez les instructions de cette section.

1 Sélectionnez un rapport et ouvrez-le dans BIRT Report Designer.

2 Cliquez sur l'onglet Mise en page et ouvrez l'éditeur de propriétés.

3 Sélectionnez la propriété Localisation

4 Si aucune valeur n'apparaît, cliquez sur Parcourir pour rechercher le fichier de ressources (propriétés) à partir duquel vous pouvez accéder au rapport.

Configuration de rapports localisés 4



IMPORTANT Un fichier de propriétés est disponible pour chaque application système.

5 Sélectionnez 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 sauvegardés dans l'emplacement suivant :


Importation de libellés 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 données REPORTLABEL. Une fois que les valeurs se trouvent dans la table REPORTLABEL, le système les active pour la localisation.


Vous pouvez activer la traduction des données d'exécution en fonction de la langue de l'utilisateur en appelant une méthode pour chaque colonne de fichier à traduire.

La requête du rapport doit inclure les colonnes ID unique (UID) des tables contenant les champs traduits. Vous n'avez pas besoin de créer de colonnes de sortie pour ces champs.

Appelez la méthode ci-après à la fin de la méthode d'ouverture de fichier. Il n'est pas nécessaire de respecter la casse des arguments.

registerDataTranslation(queryColumn, queryUIDColumn, mboName, mboAttributeName) queryColumn – champ de la requête à traduirequeryUIDColumn – champ ID unique dans la requête de la table contenant le champ traduitmboName – paramètre maxattribute objectname de l'attribut traduitmboAttributeName- paramètre maxattribute attributename de l'attribut traduitmaximoDataSet = 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");

Mise en forme

Configuration de rapports localisés 31

Prenez connaissance des informations suivantes :

Utilisez la méthode getBooleanString pour extraire et convertir les champs YORN.

N'appliquez pas les symboles monétaires. Utilisez plutôt le champ du code devise système.

N'utilisez que les formats de date spécifiés.

Exemples de données de rapport

Comme vous possédez vos propres exigences de localisation, chaque contrôle de données qu'IBM met à votre disposition dans les rapports “prêts à l'emploi” NE sera PAS activé pour la localisation.

IBM active les champs de données et de rapport ci-après. Vous pouvez les utiliser comme exemples.

Emplacement du rapport – <Product_root>\reports\birt\reports\JOBPLAN

Nom du rapport – Liste des gammes d'opérations

Nom de fichier du rapport – jobplan.rptdesign

Champ du rapport – Description

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

1 Les largeurs de tous les éléments de table doivent être à 100%.

2 IBM a ajouté un nouveau style appelé Titlesub. Vous pouvez l'utiliser pour le texte qui apparaît directement sous le titre. De nombreux rapports détaillés utilisent ce style pour la clé (telle que wonum) et la description.

Détails de l'intervention est un exemple de rapport qui utilise ce type de sous-titre.

3 IBM a apporté des modifications au modèle 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 même occupé dans la version .PDF. Pour remédier à cela, tous les sous-rapports se trouvent maintenant dans des cellules uniques empilées les unes sur les autres.

Des styles étaient appliqués aux lignes contenant les sous-rapports. Vous devez supprimer tous les styles sur les lignes ou les cellules qui contiennent des tables.

Mise en forme


Pour résoudre les incidents relatifs à l'activation des sauts de page après le dernier sous-rapport, IBM a ajouté un groupe. La clé de ce groupe correspond à la clé unique du rapport. Par exemple, dans Détails sur la personne (person_details.rptdesign), la clé a la valeur Personid. Le saut de page après la propriété dans le groupe a la valeur “Always excluding last".

Il y aura donc un saut de page après chaque enregistrement de personne (y compris les sous-rapports associés), mais pas après la dernière 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 réduire le rapport au format PDF.

4 Pour les champs Date et/ou Date et heure, utilisez toujours les formats suivants :

Date - Date abrégée

Heure - Heure moyenne



Types de rapport

Paramètres liés et non liés dans les instructions SQL

Utilisation de valeurs booléennes comme paramètres

Types de rapport

Le système possède trois types de rapport, selon qu'il existe des paramètres ou non. Les paramètres filtrent les informations qui apparaissent sur les rapports.

Active/Sélectionnée/Tout

Basés sur des paramètres

Active/Sélectionnée/Tout et Basés sur des paramètres

Les sections ci-après décrivent ces trois types de rapport.

Paramètres Active/Sélectionnée/Tout

Les rapports Active/Sélectionnée/Tout sont des rapports sans paramètre qu'un utilisateur final exécute en sélectionnant l'enregistrement actuel, des enregistrements sélectionnés ou tous les enregistrements d'une application. Le rapport Détails de la gamme d'opérations (jobplan_print.rptdesign) est un exemple de rapport Active/Sélectionnée/Tout.

Rapports basés sur des paramètres

Les rapports basés sur des paramètres sont des rapports qui contiennent des paramètres que l'utilisateur final exécute avec les valeurs définies par le développeur ou l'administrateur du rapport. Il existe deux types de rapport basé sur des paramètres : Lié et Non lié.

Pour déterminer si un paramètre est lié, sélectionnez le rapport dans l'application Administration des rapports et sélectionnez le champ Nom de l'attribut. Si le système renseigne le champ, le paramètre est lié. S'il ne le renseigne pas, le paramètre est non lié.

Utilisation des paramètres de rapport 5



Le rapport Récapitulatif des incidents d'installation par emplacement est un exemple de rapport basé sur des paramètres.

Les sections ci-après décrivent les deux types de rapport basé sur des paramètres en plus amples détails :

Paramètres liés

Paramètres non liés

Paramètres liés

Un paramètre lié existe dans la table principale de l'application dans laquelle le rapport est inscrit ou, via un paramètre maxrelationship configuré pour l'application. Les paramètres liés sont ajoutés à la clause Where de Maximo.

Le paramètre personid du rapport Détails sur la personne (person_details.rptdesign) est un exemple de paramètre lié.

Paramètres non liés

Les paramètres non liés n'existent pas dans la table principale de l'application et ne sont pas disponibles via un paramètre maxrelationship de la table principale. Les paramètres non liés ne sont pas inclus dans la clause Where de Maximo.

Le paramètre dbtable des rapports Transactions d'audit électronique (eAudit_trans.rptdesign) est un exemple de paramètre non lié.

Active/Sélectionnée/Tout et Basés sur des paramètres

Les rapports Active/Sélectionnée/Tout et les rapports basés sur des paramètres sont des rapports avec des paramètres qu'un utilisateur final exécute sur des rapports actifs, certains rapports ou tous les rapports d'une application.


Cette section décrit l'utilisation des paramètres liés et non liés dans les instructions SQL, ainsi que d'autres informations relatives à SQL (utilisation de valeurs booléennes comme paramètres).

Paramètres liés dans les instructions SQL

Les paramètres liés sont inclus dans le paramètre where et n'ont pas besoin d'être explicitement inclus dans le SQL du rapport.

Vous devez inclure le paramètre where dans le SQL, comme illustré dans l'exemple suivant :

sqlText="select wonum, description from workorder where " + params["where"];



Paramètres non liés dans les instructions SQL

Les paramètres non liés sont transmis au rapport dans une chaîne délimitée par des virgules et peuvent contenir des opérateurs ; les valeurs doivent donc être analysées syntaxiquement avant d'être incluses dans le SQL du rapport. La méthode suivante analyse ces valeurs pour que vous puissiez les inclure dans le SQL du rapport :

MXReportSqlFormat.createParamWhereClause(String columnName, String paramValue)

Cette méthode crée une clause SQL Where basée sur une liste séparée par des virgules des valeurs contenues dans paramValue. La valeur du paramètre peut être spécifiée avec un opérateur préfixe. Cet opérateur peut correspondre à l'un des symboles suivants : <=, <, >=, >, !=, = . Si vous ne spécifiez pas d'opérateur, le système suppose que la recherche est basée sur l'opérateur SQL LIKE, comme dans l'exemple suivant :

createParamWhereClause("siteid", "=BEDFORD,=MCLEAN")a pour résultat :((siteid = 'BEDFORD') or (siteid = 'MCLEAN'))createParamWhereClause("siteid", "!=BEDFORD,!=MCLEAN,TEXAS")a pour résultat :((siteid != 'BEDFORD') and (siteid != 'MCLEAN')) or ((siteid like '%TEXAS%'))

Ajout de paramètres non liés au SQL d'un rapport

Les paramètres non liés doivent être inclus manuellement dans le SQL du rapport. La méthode utilisée varie suivant que vous ayez autorisé la multisélection ou non pour le paramètre dans l'application Administration des rapports.

Les paramètres autorisant la multisélection sont transmis sous forme de chaîne délimitée 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 paramètres n'acceptant qu'une sélection, tels que le paramètre where, peuvent être inclus directement. Les paramètres de chaîne doivent être placés entre apostrophes et les paramètres de date doivent être convertis en fonction JDBC. Les nombres ne requièrent pas de formatage spécial, comme illustré dans l'exemple suivant :

sqlText = "select jobplan, description from jobplan where " + params["where"] + " and jobplan.siteid = ‘" + params["siteid"] + "’" //Chaîne entre guillemets+ " and jobplan.wopriority = " + params["wopriority"]//Entier+ " and jobplan.installdate >= " + MXReportSqlFormat.getStartDayTimestampFunction(params ["startDate"]);



Les paramètres n'acceptant qu'une seule sélection peuvent également être utilisés avec des paramètres de fichier. Vous créez des marqueurs de paramètre en insérant un point d'interrogation dans le SQL à chaque emplacement d'une valeur de paramètre. Vous utilisez ensuite la méthode de fichier setQueryParameterValue(int index, Object value) pour les convertir. Si une requête comporte plusieurs paramètres, la méthode les indexe suivant l'ordre dans lequel ils apparaissent dans le SQL, en commençant par 1.

La requête ci-avant peut être réécrite 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 paramètres where et date utilisent toujours le format d'origine. Le paramètre where doit toujours être inclus directement. Les paramètres de date non formatés peuvent être traités comme des paramètres de requête, mais actuellement, les méthodes au format JDBC, telles que getStartDayTimestampFunction ne peuvent pas être utilisées avec des paramètres de requête.

Le meilleur moyen de traiter les paramètres facultatifs est l'inclusion directe. Dans l'exemple ci-après, le site et la date de début sont facultatifs. Si des valeurs sont spécifiées, elles sont ajoutées au paramètre where (pour conserver le contenu existant du paramètre 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"];




Les rapports qui acceptent des valeurs booléennes comme paramètres doivent suivre les instructions suivantes :

1 Vous devez définir le paramètre dans la conception du rapport comme paramètre de type chaîne.

2 Si la valeur du paramètre doit être transmise à une instruction SQL, la valeur du paramètre doit être convertie en entier (1 ou 0) car la base de données 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 défaut pour les paramètres YORN. Si des valeurs par défaut sont requises, vous pouvez utiliser “true” ou “false”.



Création du fichier d'importation

Importation de fichiers de conception

Exportation de fichiers de conception

Création du fichier d'importation

Deux méthodes permettent d'importer des rapports BIRT dans la base de données système :

importation des rapports à l'aide de l'application Administration des rapports

utilisation de l'utilitaire d'importation. Si vous utilisez cet utilitaire, vous devez créer 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 données (CONFIGUR) contient un fichier reports.xml.

Si vous avez défini les paramètres du rapport dans le fichier xml avec les attributs appropriés, l'outil d'importation insère ou met à jour le tableau des paramètres du rapport (reportlookup) en y intégrant ces informations. Les noms d'attribut des paramètres correspondent aux colonnes du tableau reportlookup.

Si le nom de paramètre que vous avez défini dans le fichier reports.xml d'un rapport donné n'existe pas dans ce rapport, le système l'ignore. Certaines des valeurs d'attribut utilisent les valeurs du rapport comme valeurs par défaut si ces valeurs ne sont pas spécifiées dans le fichier d'importation.

Importation et exportation de fichiers de conception 6



Lorsque vous spécifiez un symbole "supérieur à " ou "inférieur à" comme opérateur de paramètre, vous devez le précéder d'un caractère d'échappement, comme suit :

Le rapport Groupe de sécurité (security_group.rptdesign) du dossier SECURGROUP est un exemple de rapport contenant des paramètres.

Le rapport Liste des gammes d'opérations (jobplan.rptdesign) du dossier JOBPLAN est un exemple de rapport sans paramètre.


L'importation d'un rapport a pour objet de charger report.xml et les fichiers de conception dans la base de données. Ces deux types de fichier sont nécessaires pour importer un rapport :

Fichier reports.xml – Ce fichier varie en fonction de l'application et contient toutes les informations nécessaires pour que vous puissiez importer un rapport (nom du fichier, description, paramètres).

Fichier de conception – Il peut s'agir d'un fichier de bibliothèque (code utilisé plusieurs fois pour le type de police, la taille, les numéros 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-après décrit les types de commande d'importation.

< < inférieur à

> > supérieur à

& & perluète

' ' apostrophe

" " guillemet


Importation et exportation de fichiers de conception 41


Effectuez les opérations suivantes pour importer plusieurs fichiers de conception :

1 Accédez à l'emplacement suivant :

<Racine_produit>\reports\birt\tools et ouvrez le fichier reporttools.properties.

2 Mettez à jour ou vérifiez les propriétés 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, accédez au dossier suivant à l'aide de l'invite de commande :

<Racine_produit>\reports\birt\tools

4 Exécutez la commande importreports.cmd pour importer des rapports, des bibliothèques et des fichiers de ressources. Les commandes d'importation suivantes sont disponibles :

Commande Description

importreports.cmd importe tous les rapports, les fichiers de ressources et toutes les bibliothèques

importreports help fournit des détails sur la manière d'exécuter la commande et divers paramètres

importreports libraries importe toutes les bibliothèques

importsreports importe tous les rapports

importreports <nom application> importe tous les rapports. Par exemple, si vous exécutez :

importreports CONFIGUR

La commande importe tous les rapports de l'application Configuration de base de données.




Utilisez la commande d'exportation (exportreport.cmd) pour exporter des fichiers de conception. Les commandes suivantes sont disponibles pour exporter des fichiers :

Le rapport est exporté dans le dossier que vous avez défini dans les emplacements suivants :

la propriété maximo.report.birt.outputfolder du fichier reporttools.properties

le champ Dossier du rapport de l'application Administration des rapports

Commande Description

exportreports exporte toutes les bibliothèques, les rapports et divers sous-dossiers de rapports

exportreports report exporte tous les rapports et divers sous-dossiers de rapports

exportreports library exporte toutes les bibliothèques

exportreports <nom application> exporte tous les rapports de l'application spécifiée. Par exemple, si vous exécutez :

exportreports CHANGE

La commande exporte tous les rapports dans le dossier de rapports WOTRACK.


. .

Le tableau suivant identifie et décrit brièvement les fichiers spécifiques aux rapports du fichier de propriétés système :

Description des fichiers de propriétés système A

Fichier de propriétés Description

mxe.report.birt.maxconcurrentrun Nombre maximal de rapports que vous pouvez exécuter simultanément.

mxe.report.birt.queueideltimeseconds Nombre de secondes d'inactivité du Gestionnaire de file d'attente de rapport après que vous ayez exécuté un rapport.

mxe.activex Contrôles ActiveX que vous activez pour pouvoir imprimer un rapport avec des documents en pièces jointes.

mxe.report.reportsInAPage Nombre de rapports devant être affichés dans une page de rapports en ligne. La valeur par défaut est 5.


x

Le tableau suivant identifie et décrit brièvement les fichiers spécifiques aux rapports du fichier de tâche Cron :

Description des fichiers de tâche Cron B

Tâche Cron Description

REPORTLOCKRELEASE Signaler tâche de libération de file d'attente verrouillée

REPORTSCHEDULE Signaler tâche périodique de planification

REPORTUSAGECLEANUP Signaler tâche de nettoyage du journal d'utilisation


Remarques

Le présent document contient des informations sur les produits et services disponibles aux Etats-Unis.

Le présent document peut contenir des informations ou des références concernant certains produits, logiciels ou services IBM non annoncés dans ce pays. Pour plus de détails, référez-vous aux documents d'annonce disponibles dans votre pays, ou adressez-vous à votre partenaire commercial IBM. Toute référence à un produit, logiciel ou service IBM n'implique pas que seul ce produit, logiciel ou service puisse être utilisé. Tout autre élément 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 vérifier lui-même les installations et applications réalisées avec des produits, logiciels ou services non expressément référencés par IBM.

IBM peut détenir des brevets ou des demandes de brevet couvrant les produits mentionnés dans le présent document. La remise de ce document ne vous donne aucun droit de licence sur ces brevets ou demandes de brevet. Si vous désirez recevoir des informations concernant l'acquisition de licences, veuillez en faire la demande par écrit à l'adresse suivante :

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

Pour le Canada, veuillez adresser votre courrier à :

IBM Director of Comercial RelationsIBM Canada Ltd.3600 Steeles Avenue EastMarkham, OntarioL3R 9Z7Canada

Les informations sur les licences concernant les produits utilisant un jeu de caractères double octet peuvent être obtenues par écrit à l'adresse suivante :

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 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.


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 présent document peut contenir des inexactitudes ou des coquilles. Ce document est mis à jour périodiquement. Chaque nouvelle édition inclut les mises à jour. IBM peut, à tout moment et sans préavis, modifier les produits et logiciels décrits dans ce document.

Les références à des sites Web non IBM sont fournies à titre d'information uniquement et n'impliquent en aucun cas une adhésion aux données qu'ils contiennent. Les éléments figurant sur ces sites Web ne font pas partie des éléments du présent produit IBM et l'utilisation de ces sites relève de votre seule responsabilité.

IBM pourra utiliser ou diffuser, de toute manière qu'elle jugera appropriée et sans aucune obligation de sa part, tout ou partie des informations qui lui seront fournies.

Les licenciés souhaitant obtenir des informations permettant : (i) l'échange des données entre des logiciels créés de façon indépendante et d'autres logiciels (dont celui-ci), et (ii) l'utilisation mutuelle des données ainsi échangées, doivent adresser leur demande à :

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Ces informations peuvent être soumises à des conditions particulières, prévoyant notamment le paiement d'une redevance.

Le logiciel sous licence décrit dans ce document et tous les éléments sous licence disponibles s'y rapportant sont fournis par IBM conformément 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 auprès des fournisseurs de ces produits, par l'intermédiaire 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 réclamation concernant des produits non IBM. Toute question concernant les performances de produits non IBM doit être adressée aux fournisseurs de ces produits.

Toute instruction relative aux intentions d'IBM pour ses opérations à venir est susceptible d'être modifiée ou annulée sans préavis, et doit être considérée uniquement comme un objectif.

49

Le présent document peut contenir des exemples de données et de rapports utilisés couramment dans l'environnement professionnel. Ces exemples mentionnent des noms fictifs de personnes, de sociétés, de marques ou de produits à des fins illustratives ou explicatives uniquement. Toute ressemblance avec des noms de personnes, de sociétés ou des données réelles 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 :

IBMAIXDB2developerWorksEveryplaceibm.comLotusMaximoNotesQuickPlaceTivoliWebSphere

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 enregistrée de The Open Group aux Etats-Unis et/ou dans certains autres pays.


A

accès à la barre d'outils de l'application 26activation des libellés de rapport

pour localisation 29

B

BIRTcomposants 1Report Designer 2Report Engine 2

BIRT Report Designer 39ajout de la fonctionnalité de mise à jour de la base de données 20association des ensembles de résultats 23configuration 7création d'un lien hypertexte entre des rapports 24création d'un rapport 10dossier des bibliothèques 3dossier des modèles 4dossier des outils 4dossier des rapports 4dossier scriptlibrary 4fichiers 2fichiers source 3fonctions scalaires 20formatage des données 19mise en forme du rapport 24modèles 9remarques sur la conception SQL 19SQL conditionnel 20test de la valeur null 19types de données 18

C

création du fichier d'importation 39

D

débogage de BIRT Report Designer 25dossier des bibliothèques 3dossier des modèles 4dossier des outils 4dossier des rapports 4durée

type de base de données 18

E

enregistrement d'un rapportavec l'accès à la barre d'outils de l'application 26pour plusieurs applications 28

ensembles de résultatsassociation 23

exportationfichiers de conception 42

F

fichier de tâche cronREPORTLOCKRELEASE 45REPORTSCHEDULE 45

fichiers de conceptionexportation 42importation 40

fichiers de la phase de conceptionconfiguration système 5installation 5

fonctionnalité de mise à jour de la base de donnéesajout 20

fonctions scalaires 20format

pour localisation 31formatage des dates 19

I

importationcréation du fichier 39fichiers de conception 40libellés de rapport pour localisation 30

Index

Index


L

liens hypertextes 24localisation

données 30libellés de rapport 29mise en forme 31

localisation des données 30

M

méthode d'extraction pour l'exécution de requêtes 22méthode d'ouverture pour l'exécution de requêtes 22modèles 9

diagramme de sous-rapport Tivoli Maximo 10rapport de diagramme Liste Tivoli Maximo 10rapport de diagramme regroupé Tivoli Maximo 10Rapport Liste Tivoli Maximo 10Rapport regroupé Tivoli Maximo 10Sous-rapport Tivoli Maximo 10

P

paramètresActive/Sélectionnée/Tout 33ajout de paramètres non liés au SQL d'un rapport 35liés 34liés dans les instructions SQL 34non liés 34non liés dans les instructions SQL 35utilisation de valeurs booléennes 37

paramètres Active/Sélectionnée/Tout 33paramètres liés 34

dans les instructions SQL 34paramètres non liés 34

dans les instructions SQL 35plusieurs applications 28prérequis

de l'installation 5pour la création d'un premier rapport 9

R

rapportactivation des libellés pour localisation 29création d'un premier rapport 10importation de libellés 30liens hypertextes 24localisation des libellés 29mise en forme 24types 33

rapports basés sur des paramètres 33remarques sur la conception SQL 19requêtes

exécution de requêtes supplémentaires dans la méthode d'extraction 22

exécution de requêtes supplémentaires dans la méthode d'ouverture 22

S

scriptlibrary 4SQL conditionnel 20SQL d'un rapport

ajout de paramètres non liés 35system properties

mxe.activex 43mxe.report.birt.maxconcurrentrun 43mxe.report.birt.queueideltimeseconds 43mxe.report.reportsInAPage 43

T

test de la valeur null 19type de base de données

durée 18YORN 18

types de données 18types de rapport 33

V

valeurs booléennesutilisation comme paramètres 37

Y

YORNtype de base de données 18

BIRT Guide

Documents

Transcript of BIRT Guide