Création de rapports personnalisés

Data Crow permet aux utilisateurs d'ajouter leurs propres rapports ou de modifier les rapports existants.
Les rapports sont créés avec le logiciel Jaspersoft Studio. Ce logiciel peut être téléchargé gratuitement.

Conditions préalables #

• Pour créer un rapport, le logiciel Jaspersoft Studio doit être installé. Téléchargez le logiciel à partir de : https://community.jaspersoft.com/project/jaspersoft-studio. Téléchargez la dernière version disponible.
• Vous avez besoin de Data Crow version 4.0.7 ou supérieure.
• Vous devez avoir installé Java (version 17 ou supérieure). Il peut être téléchargé sur le site d'Oracle : https://www.oracle.com/java/. Il s'agit également d'une exigence pour l'exécution de Data Crow.

Le processus de rapport
#

Modèles de rapport

Data Crow utilise des rapports compilés de Jaspersoft (fichier .jasper). Ceux-ci sont placés dans le dossier des rapports du dossier d'installation de Data Crow.
Lors de la mise à jour du logiciel, il sera demandé à l'utilisateur s'il souhaite copier les rapports dans le dossier des rapports de l'installation vers le dossier de l'utilisateur. Lorsque vous souhaitez tester les rapports que vous avez créés ou modifiés, copiez-les dans le dossier des rapports de l'installation vers le dossier de l'utilisateur. dossier de l'utilisateur.

Chaque fois que la boîte de dialogue de rapport est ouverte, Data Crow analyse le dossier des rapports de l'application dossier de l'utilisateur pour les fichiers de rapports .jasper existants. Data Crow étant composé de plusieurs modules, les rapports doivent être placés dans le dossier des rapports du module. La structure du dossier pour les rapports d'un module particulier est la suivante
suit : /Rapports/<nom du module

Exemple pour Microsoft Windows :

D:\N- Data Crow (données) - Rapports - Logiciels

D:\N- Data Crow\N- Data Crow\N- Data Crow\N- Data Crow\N- Data Crow\N-Rapports\N- Film

Exemple pour Linux :

/Home/Data Crow Data/Reports/Software

Remarque : il se peut que votre dossier utilisateur contienne également des sous-répertoires appelés PDF et HTML. Il s'agit de restes d'anciennes versions de Data Crow. Ils ne sont plus utilisés et peuvent être supprimés en toute sécurité. Il en va de même pour les fichiers qu'ils contiennent.

Création d'un rapport

Lorsque vous exécutez un rapport à partir de Data Crow (Outils > Créer un rapport), Data Crow fait trois choses :

• Data Crow crée une exportation XML des éléments sélectionnés.
• Data Crow remplit le fichier de rapport .jasper avec les données XML.
• Enfin, le rapport rempli est enregistré dans le format cible sélectionné (RTF, PDF ou HTML).

La chose la plus importante à noter est que Data Crow utilise des extraits XML pour créer les rapports plutôt que d'accéder directement à la base de données. Nous utiliserons le XML dans le chapitre suivant pour concevoir un nouveau rapport (ou modifier un rapport existant).

Deuxièmement, il n'est plus nécessaire d'exporter les images dans le cadre du processus de création de rapports. Jaspersoft le fait automatiquement en cas de besoin, comme c'est le cas pour les rapports HTML.

Création d'un nouveau rapport #

Concevons un nouveau rapport ! Nous aurons besoin d'un fichier XML contenant des éléments Data Crow (en tant que source) pour créer et concevoir un rapport dans Jaspersoft.

Créer une exportation XML

Tout d'abord, nous devons disposer d'un exemple de fichier XML afin de pouvoir l'utiliser pour concevoir notre rapport.

1. Démarrer Data Crow
2. Sélectionnez le module pour lequel vous souhaitez créer un rapport
3. Sélectionnez un ou plusieurs éléments dans la vue d'ensemble, cliquez avec le bouton droit de la souris et sélectionnez Assistant d'exportation d'articles:
   
4. Sélectionnez l'exportation XML et appuyez sur Suivant
5. Sélectionnez le fichier cible et appuyez sur Suivant
   
   Laisser l'option images par défaut
   
6. Laissez tous les champs sélectionnés et appuyez sur Suivant
   
7. Le fichier XML est maintenant créé et stocké sur le disque.

Notez que nous n'utiliserons ce XML qu'à titre d'exemple pour créer notre nouveau rapport. Data Crow créera l'extrait XML automatiquement lorsque vous exécuterez le rapport à partir de Data Crow (Outils > Créer un rapport). Il est important que vous sélectionniez les éléments qui contiennent le plus d'informations ainsi que quelques éléments avec des informations très limitées. Ceci est toujours utile pour tester le rapport.

JasperSoft Studio #

Ensuite, démarrez Jaspersoft Studio. Lors du premier démarrage, il vous sera demandé de sélectionner l'emplacement de l'espace de travail. Choisissez l'emplacement de votre choix. Une fois lancé, fermez les écrans de bienvenue jusqu'à ce que vous soyez dans l'espace de travail proprement dit.

La première chose à faire est de configurer le fichier XML que nous avons exporté en tant que fichier Adaptateur de données. Les adaptateurs de données sont utilisés pour remplir les rapports avec des données. Sélectionnez l'adaptateur Explorateur de référentiel et cliquez avec le bouton droit de la souris sur l'onglet Adaptateurs de données. Dans le menu du clic droit, sélectionnez Créer un adaptateur de données.

Sélectionnez Document XML ;

Appuyez sur Suivant pour poursuivre la configuration de l'adaptateur de données XML

Remplissez au moins les champs suivants (les autres champs sont facultatifs et expliqués dans la documentation de Jaspersoft Studio) :

• Nom : saisissez le nom de votre choix, reconnaissable par vous-même.
• Fichier : sélectionnez l'exportation XML telle qu'elle a été créée par Data Crow. Dans mon cas, il s'agissait de text.xml. Notez que ce fichier ne sera pas utilisé pour l'exécution du rapport par Data Crow, mais uniquement pour la conception du rapport.
• Cochez la case "Utiliser l'expression Xpath du rapport pour remplir le rapport". C'est très important, car sinon vous obtiendrez un rapport vide pour vos tests.

Presse Test pour tester votre installation.
Presse Finition pour terminer la création de l'adaptateur de données.

Créer un rapport vierge

Nous disposons donc maintenant d'un fichier XML qui est configuré en tant qu'adaptateur de données dans votre environnement Jaspersoft. La prochaine étape logique consiste à créer un nouveau rapport, en utilisant l'adaptateur de données comme entrée.

Accédez à l'explorateur de projets. Par défaut, il contient un projet nommé MyReports. Vous pouvez utiliser n'importe quel autre nom de projet, ce n'est pas important pour les rapports Data Crow.

Cliquez avec le bouton droit de la souris sur le projet et sélectionnez Nouveau, Jasper Report.

Vous pouvez maintenant sélectionner un Modèle de rapport. Pour les rapports Data Crow, vous pouvez choisir n'importe quel modèle de rapport. Pour plus de détails sur ces modèles, je vous renvoie à la documentation de Jaspersoft Studio. Pour l'instant, je choisirai le modèle A4 vierge. Appuyez sur Suivant.

Ensuite, Jaspersoft Studio vous demandera de nommer le rapport afin qu'il puisse être enregistré dans votre projet.
Donnez-lui un nom qui ait du sens ; le nom du fichier de rapport est indiqué dans la sélection du rapport Data Crow. Pour cet exemple, j'appellerai ce rapport Test. Appuyez sur la touche Suivant pour passer à l'étape suivante.

Nous en sommes maintenant à l'étape où nous allons lier l'adaptateur de données au rapport. Cela permettra au rapport de trouver les champs disponibles et de les remplir avec des informations lors de l'exécution du rapport.

• Sélectionnez l'adaptateur de données dans la liste déroulante. Dans mon cas, il s'appelle Test XML.
• La structure du fichier XML est indiquée dans le champ ci-dessous. Nous devons maintenant définir comment Jaspersoft Studio doit utiliser les informations XML. Pour ce faire, il faut définir la structure du fichier XML.
  Dans l'exemple, vous pouvez voir que j'ai exporté des éléments logiciels. Il y a au total 4 éléments, chacun d'eux étant représenté par un élément logiciel. En regardant un seul élément, nous pouvons voir tous les champs :
  
• Double-cliquez sur le nœud qui contient tous les champs. Tous les éléments sont alors disponibles dans le rapport.
  
  Notez que pour les exportations XML provenant d'autres modules, vous verrez par exemple Movie, Book, Music Album, etc. au lieu de logiciel-élément. Les étapes à suivre sont exactement les mêmes. Appuyer sur Suivant.
• Dans l'étape suivante, vous devrez choisir les champs à inclure dans le rapport. Si aucun champ n'est listé ou si cette étape est sautée, cela signifie que vous avez fait une erreur à l'étape précédente. J'ai sélectionné tous les champs en appuyant sur le bouton >>. Je recommande d'ajouter tous les champs car c'est ce qui donne le plus de flexibilité.
  
• À ce stade, vous pouvez choisir Finition l'assistant. Vous pouvez également continuer en appuyant sur Suivant ce qui vous amène à l'option de configuration du regroupement. Le regroupement n'est toutefois pas abordé dans ce guide ; je vous renvoie à la documentation de Jaspersoft Studio. Il est pris en charge par Data Crow, ce qui ne pose aucun problème.

Nous avons maintenant un rapport vierge avec un adaptateur de données configuré.

Conseils et astuces en matière de design #

Pour une documentation complète sur la conception de votre rapport dans le logiciel Jaspersoft Studio, nous vous renvoyons à la documentation disponible sur le site de Jaspersoft :
https://community.jaspersoft.com/project/jaspersoft-studio

Des manuels et des wikis sont disponibles.

Pour vous aider à démarrer, je vais vous expliquer quelques principes de base.

Mise en page du rapport

Au centre de l'écran se trouve le rapport lui-même. Vous pouvez voir les différentes sections, telles que le titre, l'en-tête de page, etc. Vous pouvez redimensionner les sections à l'aide de la souris.

Ces sections peuvent être supprimées (ou ajoutées) à partir de la section Schéma :

Ajout de champs

Tous les champs faisant partie de l'adaptateur de données XML se trouvent dans la section "outline" de l'espace de travail. A partir de là, vous pouvez faire glisser et déposer les champs dans le rapport :

Champs à références multiples

Notez que pour chaque champ à références multiples, j'ai ajouté un champ nom du champchamp de la liste (voir ci-dessus pour des exemples, tels que liste des catégories). Il contient les valeurs séparées par des virgules. Si vous souhaitez itérer sur les éléments individuels, vous devrez ajouter un élément Liste élément.

Champs d'images (photos)

En option, vous pouvez également choisir d'ajouter d'abord un élément spécifique au rapport, puis de spécifier la valeur à utiliser. Ajoutons une image par exemple. Sur le côté droit de l'écran, vous trouverez une section appelée palette. Vous y trouverez tous les types de champs disponibles. Sélectionnez Image et glissez-déposez cet élément dans le rapport.

Dans la boîte de dialogue qui s'affiche, sélectionnez Expression personnalisée. Cela permet d'activer le champ Options.

Appuyer sur la touche bouton.

Par
par défaut, les champs sont tous affichés. Sélectionnez le champ de l'image que vous souhaitez ajouter et double-cliquez dessus. J'ai sélectionné le champ de l'image de face.

Contenu des champs vides

Jaspersoft imprimera NULL si le champ est vide. Je préfère que le champ n'affiche rien s'il est vide. Cela peut se faire par le biais des propriétés du champ. Sélectionnez le champ en cliquant dessus dans la fenêtre Rapport principal vue. Dans l'exemple ci-dessous, j'ai sélectionné le champ Titre.

Modifions les propriétés de ce champ. Cliquez sur le champ (comme dans l'exemple ci-dessus). Accédez à la section Propriétés.
Sélectionner Champ de texte.

Cochez la case Étirer avec le trop-plein. C'est exactement ce qu'il fait : lorsque le contenu est trop grand, le champ est étiré, ce qui rend tout son contenu visible.

Positionnement sur le terrain

Tout champ ajouté au rapport est automatiquement aligné par rapport à la partie supérieure. Cela peut s'avérer très utile si vous souhaitez que votre champ reste toujours au même endroit ; lorsque le rapport est étiré, la position du champ reste à la même distance relative du haut de la section du rapport.

Ce problème se pose lorsque vous avez placé le champ en dessous d'un champ de texte (voir ci-dessus) qui Étirements avec débordement.
Le champ sera placé au-dessus du champ étiré car il se positionne par rapport au haut de la section du rapport, et non par rapport au champ situé au-dessus.

Pour tenir compte de cette situation, réglez ce champ sur Type de poste. Flotteur au lieu de cela :

Autres domaines

De nombreux types de champs sont disponibles pour afficher le contenu de la source (les informations XML). Il existe également des champs tels que le numéro de page. Ces champs se trouvent dans la section Palette :

Aperçu du rapport #

À tout moment au cours du processus de conception, vous pouvez obtenir un aperçu du rapport. Cliquez sur le bouton de prévisualisation, comme indiqué ci-dessous :

La prévisualisation permet de voir à quoi ressemble le rapport pour l'utilisateur final. De plus, le rapport est vérifié pour détecter les erreurs.

Compilation et déploiement du rapport #

Lorsque le rapport est prêt, vous pouvez le créer et le mettre à la disposition de Data Crow. Tout d'abord, assurez-vous de sauvegarder le fichier du rapport. Il est préférable de toujours sauvegarder les modifications avant de construire le rapport, sinon les modifications que vous avez apportées risquent de ne pas figurer dans le résultat final.

Naviguez jusqu'à Projet > Nettoyer. Cela crée un fichier .jasper.
Il ne vous reste plus qu'à copier le fichier .jasper dans le dossier Data Crow reports du dossier utilisateur. La structure du dossier des rapports est expliquée dans le chapitre Processus des rapports ;
/Rapports/

Il n'est pas nécessaire de redémarrer Data Crow pour exécuter le rapport. Il suffit de rouvrir la boîte de dialogue du rapport. Pour cet exemple, j'ai copié le fichier Test.jasper dans le dossier Reports de mon dossier utilisateur :

• C:\NUsers\RJ\Data\NDevelopment\Ndc data\Nreports\Nsoftware

Démarrer le Créer un rapport l'outil :

Sélectionnez le Test que vous venez de créer :

Et sélectionnez l'option Type de rapport:

Et bien sûr, le fichier cible - le fichier qui contiendra votre rapport.
Sélectionnez Exécuter pour créer le rapport ;

Vous devriez maintenant avoir un fichier de rapport contenant des informations sur vos articles !