Gestion des rapports

Jasper report - Généralités

Pour imprimer des documents dans Open-Prod, il faut tout d'abord paramétrer le masque de ces documents. Les masques se créent automatiquement en installant le module Données des rapports de base. Pour les rapports comptables, il faut installer le module Données des rapports de comptabilité en complément. Finaliser ensuite la configuration du serveur Jasper. 

Formulaire des rapports Jasper 

En-tête 

L'en-tête contient les informations de base : le nom du rapport dans Open-Prod, le format du fichier qui sera généré (pdf, fichier Excel, Open Office, ...), et la séquence qui définira l'ordre de priorité si deux rapports sont lancés en même temps. 

 

 

Onglet "Généralités" 

Cadre Configuration 

Cet onglet rassemble l'ensemble des éléments de base de configuration du rapport : 

Exemple : si l'option est décochée sur le rapport des factures de vente, en sélectionnant plusieurs factures de ventes à imprimer, on obtiendra un fichier PDF unique contenant toutes les factures. Si l'option est cochée, on n'obtiendra qu'une seule facture, celle du premier enregistrement de la sélection. 

  Dans le cas du rapport des factures, un champ spécifique Exemplaire de facture permet de définir le nombre d'exemplaires directement dans l'onglet Règlement (hérité de la fiche partenaire). Pour les autres rapports, c'est bien ici que l'on définit le nombre d'exemplaires imprimés. 

Cadre Pièce jointe 

Certains champs concernent la pièce jointe et l'aspect graphique du rapport : 

Cadre Divers  

D'autres paramètres sont disponibles dans le cadre Divers : 

Enfin, il est possible d'ajouter un domaine sur le rapport et une contrainte. Le domaine est une fonction qui ajoute des domaines au fichier pour permettre de les filtrer. Ainsi seuls les enregistrements dans ce domaine seront imprimés. Ce domaine peut être exprimé sous forme de SQL ou via le formalisme habituel des domaines. Si l'option Ajouter une contrainte est cochée, un champ permettra de renseigner cette dernière sous forme de requête SQL, et d'indiquer un message d'erreur dans le cas où elle n'est pas vérifiée. 

Jasper report - Groupe et blocage

L'onglet Groupes permet d'ajouter l'ensemble des groupes d'utilisateurs autorisés à imprimer le rapport. 

L'onglet Blocage permet quant à lui de définir les conditions d'impression du rapport. Celles-ci se gèrent à partir de trois champs : 

 o.state in ('draft', 'open') : l'impression sera possible uniquement aux états Brouillon et Ouverte 

Jasper report - Fusion des PDF

La fusion des PDF sert à rattacher un premier PDF à un second lors de l'impression de ce dernier. 

La fusion est gérée depuis l'onglet « Fusion de PDF » des Jasperreports. La fusion peut s'effectuer avec autant de documents qu'on le souhaite 

1ère possibilité : Fichier(s) à fusionner toujours identique(s) 

Il suffit d'ajouter l'ensemble des documents dans la vue liste du cadre Éditions : 

Cette fonction permettra par exemple d'attacher des conditions générales de vente à l'édition de la commande de vente. 

2e possibilité : Fichier(s) à fusionner qui dépendent d'un paramètre 

Le cadre Documents par référence va permettre d'aller récupérer des documents propres à l'enregistrement en question. Le fonctionnement est expliqué dans les modèles de mail où l'on retrouve ce même principe. 

Cette fonction, en type champ, permettra par exemple de fusionner dans le rapport Ordre de fabrication à la fois le rapport Jasper OF ainsi que tous les autres documents rattachés à l'OF. 
Cette fonction, en type SQL, permettra par exemple de fusionner dans le rapport Ordre de fabrication à la fois le rapport Jasper OF ainsi que tous les autres documents rattachés au produit de l'OF.

Jasper report - Textes additionnels

Il est également possible de rajouter des lignes de texte à faire apparaître sur tous les exemplaires d'un même rapport, depuis l'onglet Textes additionnels. 

En ajoutant un élément à la liste, une fenêtre s'ouvre. Deux champs sont affichés : 

Le cadre Texte permet d'écrire le message à afficher. Le texte s'affichera en bas de page. Voir images ci-dessous. 

 

Jasper report - paramètres et libellés

Les deux derniers onglets des Jasper Reports concernent les éléments que l'on souhaite afficher sur le rapport. 

L'onglet Paramètres va permettre de chercher des informations qui ne sont pas accessibles via des requêtes. Pour information, un rapport est construit à partir de requêtes SQL qui viennent chercher les données dans la base de données. Cependant certaines informations ne sont pas présentes dans la base de données ou du moins pas accessibles à partir d'une requête SQL. Par exemple, il est impossible de connaître l'utilisateur qui imprimera le rapport. On va donc utiliser un paramètre pour obtenir cet information. Les principaux paramètres sont souvent liés à l'utilisateur courant, à la société courante, à des informations dynamiques en quelque sorte...  

L'onglet Libellés permet de remplacer les noms des champs placés sur le rapport par des noms, dans la langue du rapport, plus compréhensibles (voir ci-contre image du bas). Un champ est l'intitulé auquel l'on vient ajouter la valeur de la donnée. Par exemple, PRODUCT_NAME est le champ que l'on vient traduire dans le rapport par « Produit » et la valeur de la donnée sera « Résistance 1K ». Le champ (en capitales) sera aussi présent tel quel sur le serveur Jasper. Il faut donc que les champs soient identiques dans Open-Prod et dans le serveur Jasper. Par convention, ces champs sont écrits en capitales d'imprimerie. 

 Configuration serveur Jasper

Pour imprimer des documents depuis Open-Prod, il est nécessaire d'utiliser un serveur Jasper. Ce serveur devra être renseigné dans la configuration des documents pour permettre l'impression. 

Il faut donc configurer le lien entre l'ERP et le serveur Jasper, qui sont tous deux des machines virtuelles créées sur un même serveur physique (voir schéma ci-contre). Pour cela il faut installer le module Interfaçage JasperReport Server. La configuration s'effectue ensuite depuis le sous-menu Configuration > Jasper Report > Configuration JasperServer. 

 

 

Cadre Connexion jasper 

Le cadre Connexion Jasper regroupe les paramétrages de base : 

Selon la version sélectionnée, des paramétrages complémentaires s'afficheront : se reporter un paragraphe correspondant ci-dessous. 

Serveur Jasper v5 

Pour un serveur Jasper v5, il faut en plus configurer le dépôt, qui correspond au chemin de stockage. Ce champ est pré-paramétré, et il est recommandé de ne pas le modifier. 

Une fois les informations paramétrées, cliquer sur Vérifier l'authentification en haut à gauche. L'État de vérification et d'identification s'affichera en bas. 

 Pour imprimer des rapports avec un serveur Jasper v5, la base Open-Prod doit se nommer « opendprodX », le « X » étant compris entre 1 et 9. En raison d'une limitation technique sous cette version, tout autre nom de base provoquera des erreurs à l'impression. 

Serveur Jasper V7 

Pour les serveurs en version V7.x.x, certaines requêtes nécessitent de passer un utilisateur et son mot de passe en paramètres. Cet utilisateur doit disposer des droits utilisateurs sur les différents modules. 
 Pour des questions de sécurité, il est recommandé de créer un utilisateur « jasper » avec un mot de passe spécifique à cette fonction. 

 

Les champs spécifiques aux serveurs v7 s'affichent dans un cadre Connexion Open-Prod : 

Le cadre Configuration de l'import permet de définir les paramètres et libellés qui pourront être passés dans la requête au serveur Jasper : 

 L'illustration ci-contre montre le paramétrage défini par défaut : 

 Exemple : le paramètre OERP_company_name, qui correspond au nom de la société, fait partie des exclusions. Si une requête passe ce paramètre, le serveur l'exclura d'office et récupérera la valeur directement dans le champ correspondant ; 

Le module complémentaire « Rapport Excel » offre la possibilité de créer et de générer des rapports au format XLSX. Il existe au téléchargement du module plus de 15 rapports XLSX déjà paramétrés. Il est possible d’en créer de nouveaux ou de les modifier si besoin. 

Il y a donc 2 manières d’éditer des rapports après l’installation : soit par Jasper, soit par Excel. 

 

Il n'y a pas de règle fixe et tout dépend des besoins/ressources des clients et du projet mais globalement une des bonnes pratiques est la suivante : 

- Utiliser les rapports Jasper pour les documents standards (déjà paramétrés, juste à personnaliser). Cela permet d'avoir de "beaux" documents pour être envoyés à l'extérieur de l'entreprise. 

- Utiliser les rapports Excel pour créer des rapports de toute pièce, pour des besoins spécifiques qui ne se rapprochent pas de ceux du standard. Ils sont plutôt destinés à un usage en interne ou alors à un usage externe si le besoin est d'obtenir un export au format modifiable (XLSX). 

 

 

Prérequis 

Les rapports fonctionnent avec des polices du pack freefont. Il faut donc impérativement installer le pack sur le serveur OpenProd avec la commande suivante : sudo apt install fonts-freefont-ttf 
Il faut également installer la police "code128.ttf" qui permettra l'impression des codes barre (notamment pour les rapports étiquette). 

Ajouts du module 

Il y a deux modules à installer : 

Utilisation du module 

Afin de pouvoir utiliser les rapports, nous allons détailler ici les paramétrages. On se place dans la vue formulaire d’un rapport. 

1) L'en-tête 

On peut utiliser une expression Python afin d’adapter le nom du rapport. Exemple : « "BL "+object.name+"_"+time.strftime('%d-%m-%Y')» donnera BL OUT/00002_12-05-2021  

 On peut utiliser une expression Python : ‘object.partner_id.lang’ 

 

 

2) Onglet Section 

Les sections du rapport contiennent les requêtes et le traitement des données. 

Une fois l'entête remplie, il faut insérer la requête SQL dans l'onglet Requête pour récupérer les données. Une fois la requête remplie, l'action Générer les champs remonte automatiquement tous les champs trouvés dans la requête. 

Si le bouton est grisé, il faut d'abord sauvegarder puis générer. 

Tout est pré-rempli automatiquement. On peut alors indiquer champ par champ le type de la cible (cellule, entête, pied de page), l’alignement voulu (gauche, centré, droite), la colonne et le type (texte, image ou code barre). 

3) Onglet Paramètres 

On retrouve dans cet onglet les paramètres spécifiques du rapport, c'est à dire les informations que l'on peut demander à l'utilisateur à l’exécution du rapport. Ces paramètres sont facultatifs. 
Il sont utilisés dans la requête SQL du rapport. 

Quand au moins un paramètre est renseigné, une case à cocher Générer une vue automatiquement apparaît. Si elle est cochée, on utilise la vue par défaut. Sinon, l'action Réinitialiser avec la vue automatiquement génère le code XML de la vue par défaut dans l'encadré Vue et on peut directement l'éditer. 

Exemple d’utilisation de paramètre dans une requête : SELECT name FROM res_partner WHERE id=%(client)s  

Client est le nom du paramètre qui est de type many2one en relation avec la table des res_partner 

4) Onglet Sous-rapports 

On retrouve la vue liste des autres rapports utilisés dans ce rapport.  

Pour les paramétrer il faut renseigner : 

 Contrairement à Jasper, un sous rapport Excel prend forcément toute la largeur du rapport initial puisque cela correspond à ajouter des lignes. 

5) Onglet Rapports parents 

On retrouve la liste des rapports qui utilisent ce rapport. Elles s’incrémentent automatiquement. 

6) Onglet Document modèle 

C'est dans cette liste qu'on ajoute les templates du rapport. Il peut y en avoir plusieurs car on peut associer au document une langue (optionnel), et donc venir chercher le bon template en fonction de la langue définie dans l'en tête.  

 

Le template est forcément un document qui est stocké dans Open-Prod. 

La réalisation du template est importante pour la mise en forme et le rendu du rapport. C'est dans ce template qu'il faut gérer la largeur des colonnes pour obtenir le bon format à l'impression (A4 dans l'exemple ici).                                                                          Utilisez la fonctionnalité excel pour afficher la délimitation des pages en pointillé.  

Même si il existe une fonction d'ajustement automatique à la hauteur (cf En tête), la définition de la hauteur des lignes et la fusion de cellules permet d'obtenir un rapport plus "joli" et lisible. 

De nombreuses fonctionnalités d'excel sont disponibles et peuvent être paramétrées directement dans le document modèle. Ainsi il est possible de définir des formules, des formatages conditionnels, etc... 

7) Onglet Images 

Cet onglet référence toutes les images à insérer dans le rapport. Les images sont forcément stockées dans Open-Prod.  

Cette manière d'insérer les images n'est pas la plus judicieuse : en effet elle était utilisée avant mais maintenant il est préférable de : 
- Si c'est une image statique (Exemple : logo de la société), commune à toutes les impressions du rapport, placer l'image directement dans le template : cela permet de dimensionner et positionner facilement. 
- Si l'image est propre à l'enregistrement (Exemple : Photo d'un colis avant envoi sur un BL) il faut appeler l'image dans la requête SQL (puisqu'elle est stockée dans Open-Prod). Au moment de la génération des champs, un champ de type Image sera importé et on pourra lui indiquer la cellule. L'image sera automatiquement redimensionnée au format de la cellule pour ne pas dépasser. 

Néanmoins, via cet onglet, quand on ajoute une image il faut indiquer le nom de la feuille du template dans laquelle l'image doit d'insérer et la cellule. L'image va s'insérer telle quelle c'est à dire qu'elle ne sera pas redimensionnée. Il est fort probable que l'image déborde. 

 Paramétrées par cet onglet, les images ne sont pas prises en compte dans les sous rapports : Si une image est ajoutée pour ce rapport, et que celui ci est utilisé dans un autre rapport en tant que sous-rapport, alors l'image ne sera pas propagée. 

8) Onglet Conditions 

On peut définir des actions qui seront exécutées (selon les conditions associées) à la fin de la génération du rapport. Elles permettent d'améliorer la mise en forme du rapport. 

Pour ajouter une condition il faut : 

 

9) Onglet Action 

10) Les boutons Actions 

Une fois le rapport passé en Actif, plusieurs actions sont disponibles : 

 Certains rapports, typiquement pour du reporting, peuvent ne prendre aucun enregistrement d'entrée, les paramètres étant déjà indiqués dans la requête SQL. 

Si un menu a été créé pour un rapport, puis que ce rapport est passé en brouillon, le menu ne disparaît pas mais n'est plus actif. En repassant le rapport en actif, le menu va aussi repasser en actif. En revanche, passer le rapport obsolète supprime le menu. 

 L'action est utilisée lorsque le rapport porte sur un enregistrement et récupère les données de celui-ci. Le menu est utilisé pour les rapports où tout est déjà dans la requête. 

 

Question fréquente : Comment importer des valeurs de la requête dans une phrase du modèle Excel (Exemple : Le prix total de la commande est de {Valeur de la requête}) ? 

La solution est d'exporter la valeur de la requête dans une cellule cachée et ensuite d'appeler cette cellule par une formule dans le rapport Excel.