ioi Report Builder – quel Framework utilisé? #
Silicon ioi utilise le framework ReportBro pour générer des rapports au format PDF et XLSX. Les modèles de rapport peuvent être créés grâce à la fonctionnalité intégrée “Designer” de ReportBro, accessible depuis Silicon ioi.
Site du Framework ReportBro : https://www.reportbro.com
Github : https://github.com/jobsta/reportbro-lib
→ Il est possible d’y consulter l’évolution du moteur de génération des rapports.
Exemple:
La version du moteur de génération des rapports utilisée dans l’environnement Silicon ioi est accessible dans la partie aide/à propos :
Comment utiliser un format d’impression? #
- Cliquez sur le bouton d’impression.
- Une fenêtre apparait et vous propose de choisir le format d’impression à utiliser.
- Si la fenêtre de sélection du modèle d’impression est vide, cela signifie qu’aucun modèle d’impression n’est configuré pour être utilisé à partir de ce module.
- Dans ce cas il sera nécessaire de créer un modèle d’impression dans le module ioi Report.
Family #
La fonctionnalité Family permet de classer les différents formats d’impression. Pour ajouter ou modifier des familles, rendez-vous dans la section ioi Report Family.
Type #
Type est la description du format d’impression. Il est possible d’avoir plusieurs formats d’impression pour une même famille.
Language #
Permet de sélectionner la langue de la mise en page du document à générer.
Génération du document #
En appuyant sur le bouton Print le format d’impression sera utilisé dans la langue spécifiée.
Ensuite utilisez des fonctions du browser web utilisé pour imprimer et enregistrer le document généré.
Comment configurer un modèle d’impression? #
Pour créer un modèle d’impression il est nécessaire de se rendre dans le module ioi Report et d’appuyer sur le bouton Add ioi Report.
Soit en recherchant le module ioi Report List dans la barre de recherche de Silicon ioi ou en retrouvant le module dans la partie ioi Configuration – Reporting.
Dans le module ioi Report utiliser le bouton Add ioi Report pour créer un nouveau format d’impression.
→ La fenêtre de configuration d’un nouveau format d’impression s’affichera.
Cette fenêtre de configuration possède plusieurs onglets : Main – Output – Questions – Files Link.
Main #
Dans cette section, vous trouverez toutes les options pour rendre le format d’impression disponible dans Silicon ioi.
Report Name: Le nom interne du format d’impression que vous voulez attribuer (son identification).
Doctype: Le nom du doctype dans lequel sera disponible le format d’impression.
Type view: Le type de vue à partir duquel le format d’impression sera disponible.
Family: Pour permettre de classifier le format d’impression.
Possibilité de créer d’autres classifications à partir du module ioi Report Family.
-
Type: La description du format d’impression -
Group: Possibilité d’utiliser cette zone pour mettre des informations supplémentaires sur le format d’impression. Exemple la version du fichier, évaluation, à valider,…
Parmi les Options :
-
Enabled: A cocher pour rendre le format d’impression disponible aux utilisateurs. -
Attachment: A cocher pour activer l’utilisation des documents liés. -
Bulk printing: A cocher pour permettre d’utiliser ce format d’impression en mode liste multiselection.
Data Source : Pour spécifier quelle source de données utiliser dans le format d’impression.
Data Source Query pour définir si le format d’impression se repose sur une requête SQL à créer soi-même.
Dans le cas d’une configuration en Data Source Query, il est nécessaire de spécifier une requête SQL et le résultat de cette requête SQL sera utilisé comme source de données pour la mise en page du format d’impression.
Data Source DocType si le format d’impression doit se reposer sur les données d’un DocType.
Dans le cas d’une configuration en Data Source DocType, il est nécessaire de renseigner une valeur dans la partie Test Document. Ce document sera utilisé comme source de données pour la mise en page du format d’impression.
Output #
Dans cette partie vous retrouverez toutes les options pour configurer le fichier généré par l’exécution du format d’impression.
Format : Permet de spécifier le type de fichier généré (PDF par défaut).
Filename : Permet de spécifier le nom du fichier qui sera généré. Ne pas oublier de spécifier son extension (.pdf dans cet exemple).
Le nom du fichier peut utiliser toutes variables disponibles lors de la génération de l’impression.
Exemple : Les variables _{
system.xxx}, _{company.xxx} et _{master.xxx}.
Pour consulter la liste des variables utilisables, voir la partie Reporting help disponible en appuyant sur le bouton ?.
Destination : Permet de spécifier si le fichier est destiné à être généré pour être télécharger ou si le fichier doit être envoyé par mail directement.
→ Si la destination est en mode Email, d’autres options sont disponibles pour permettre de configurer le mail à envoyer.
Recipients : Le destinataire du mail
Recipients CC : Le destinataire en copie
Recipients BCC : Le destinataire en copie masquée
Plusieurs destinataires sont possibles, il faut juste séparer les adresses avec un ;.
Les variables _{system.xxx}, _{company.xxx} et _{master.xxx} sont aussi utilisables pour alimenter la partie Recipients.
Email template : Permet de sélectionner une mise en page d’un mail prédéfini.
Pour configurer la mise en page d’un mail prédéfini, voir le module Email Template.
Questions #
Dans cette partie vous retrouverez la possibilité d’ajouter des questions qui seront posées aux utilisateurs lors de la génération de l’impression.
Les réponses à ces questions pourront être utilisées pour agir sur la source de données (si la source de données est en mode Query) ou agir sur des éléments de mise en page du format d’impression.
Files Link #
Dans cette partie vous retrouverez la possibilité de configurer le comportement des documents liés lors de la génération de l’impression.
Comment créer/modifier une mise en page? #
Dans le cas d’un nouveau format d’impression qui n’a pas encore de mise en page ou pour un format d’impression avec une mise en page déjà existante, il est nécessaire d’appuyer sur le bouton Edit report pour accéder à l’outil Designer du format d’impression.
→ Le mode Designer de ioi Report Builder s’affiche.
On y retrouve quelques boutons dans la partie haute de l’éditeur du format d’impression.
L’aide #
Pour afficher l’aide sur le reporting comme par exemple les informations sur les variables.
Settings #
Pour revenir à la configuration du format d’impression.
Document Structure #
Pour afficher la structure de la source de données.
Cette fonctionnalité permet en utilisant automatiquement tous les champs liens entre les tables de pouvoir récupérer des informations qui se trouvent dans des tables périphériques et de les afficher dans le rapport.
Panel Settings #
Ce bouton permet d’accéder au panneau de configuration d’affichage de l’utilisateur.
Detail Panel Size : Permet de définir la largeur de l’affichage des propriétés.
Sidebar menu permet de localiser la barre des outils sur le côté au lieu du haut de la fenêtre.
