HEFLO vous donne la possibilité de générer des rapports et de les afficher dans une page de l’espace de travail en utilisant un widget, ou de les envoyer lors de l’exécution d’un processus.
Dans cet article, nous allons montrer comment accéder à l’éditeur de rapport et créer un rapport reprenant des informations d’éléments de travail d’un processus en particulier. Nous allons ensuite ajouter ce rapport en pièce jointe d’un modèle d’e-mail.
Nous allons utiliser ce processus pour présenter cette fonctionnalité.
Et nous allons utiliser ces champs pour remplir l’enregistrement des produits.
L’objectif est d’ajouter un produit dans l’enregistrement des produits associés à cet environnement. Une fois les informations enregistrées, et le produit ajouté à l’enregistrement, le processus envoie un e-mail avec en pièce jointe un document reprenant les informations du produit concerné.
Nous allons montrer les différentes étapes pour créer le document qui sera envoyé en pièce jointe.
Activer la réplication de la base de données de votre environnement
Pour récupérer les informations d’un élément de travail d’un processus, nous allons devoir créer une requête dans l’éditeur de processus utilisant les informations de la base de données associée à votre environnement.
Si vous avez déjà activé cette fonctionnalité sur votre environnement, vous pouvez alors ignorer cette partie.
Pour activer la réplication de la base de données de votre environnement, suivez ces étapes :
- Allez dans l’éditeur de processus.
- Cliquez sur l’icône de « Mode de visualisation ».
- Cliquez sur « Export de données ».
- Cliquez sur « Activer cette fonctionnalité ».
- Attendez que la réplication de la base de données soit terminée.
Une fois la réplication de la base de données terminée, vous pouvez accéder à la structure de celle-ci, consulter les données et l’exporter. Pour en savoir plus : Tutoriel : Export des données.
Créer un rapport
Pour accéder à l’éditeur de rapport et créer un rapport, suivez ces étapes :
- Allez dans l’éditeur de processus.
- Cliquez sur l’icône de « Mode de visualisation ».
- Cliquez sur « Rapports ».
- Cliquez sur le bouton « + ».
- Donnez un nom au rapport et cliquez sur le bouton « Ouvrir l’éditeur de rapports ».
Vous êtes redirigés vers l’éditeur de rapports.
Vous pouvez utiliser les différents éléments à gauche pour ajouter des informations fixes à votre rapport ou pour le mettre en forme. Vous devez glisser et déposer ces éléments sur la zone d’édition qui se trouve sur partie centrale de l’éditeur.
Attention : La zone d’édition est divisée en trois parties : la marge supérieur, la partie centrale du rapport et la marge inférieure. Vous pouvez augmenter la taille de ces différentes parties, et ajouter de nouvelles parties si besoin.
Dans notre exemple, nous allons ajouter un titre à ce rapport et un tableau qui contiendra les informations de l’élément de travail.
Lier le rapport à des informations d’un processus
Pour récupérer les données d’un processus en particulier, il faut lier le rapport à la vue du processus contenue dans la réplication de la base de données de votre environnement.
Pour en savoir plus sur les vues de la réplication de la base de données et comment les consulter : Tutoriel : Export des données.
Récupérer le nom de la vue du processus
Tout d’abord, il faut récupérer le nom de la vue du processus concerné. Suivez ces étapes pour obtenir cette information :
- Ouvrez le processus dans l’éditeur de processus.
- Allez dans l’onglet « Actions » et cliquez sur le bouton « Afficher le schéma ».
- Recherchez le processus.
Pour information : Vous pouvez accéder à cet écran en passant par la fonctionnalité « Export de données » vue précédemment. Pour en savoir plus sur l’export de données : Tutoriel : Export des données. - Vous aurez alors accès à deux vues. Si vous souhaitez utiliser les informations liées aux éléments de travail, copiez alors le nom de la vue contenant l’information « wi ». Si vous souhaitez utiliser les informations des sous tokens, dans le cas par exemple de sous tokens créés par un branchement parallèle, copiez alors le nom de la vue contenant l’information « tk ».
Vous pouvez cliquer sur « + » pour voir les différentes propriétés de la vue.
Pour information : Vous pouvez également créer une requête de consultation pour sélectionner des champs ou des propriétés du processus souhaité. Vous pouvez également utiliser ce type de requête pour faire une jointure entre plusieurs processus. - Retournez dans l’éditeur de processus et cliquez sur « Compilation des vues » pour mettre à jour la base de données.
Retournez maintenant dans l’éditeur de rapports et ouvrez le rapport précédemment créé.
Créer une requête pour récupérer les données de la vue
Une fois le nom de la vue du processus récupéré, nous allons pouvoir créer une requête pour lier le rapport aux informations des éléments de travail de ce processus. Suivez ces étapes pour faire cette configuration :
- Cliquez sur l’icône de base de données.
- Cliquez sur cette icône , ensuite cliquez sur « Replica database » . L’éditeur de rapports récupère alors les informations de la réplication de la base de données.
- Cliquez sur « Replica_database1 », ensuite cliquez sur cette icône .
- Donnez un nom à la requête.
- Écrivez la requête dans la partie « Chaîne SQL » pour récupérer les informations de la vue du processus concerné. Cette requête est de type « select ». Elle doit être écrite de cette façon :select * from « nom de la vue du processus »C’est donc dans la partie « nom de la vue du processus » que vous devez coller le nom de la vue précédemment copié.Pour information : si votre processus contient des caractères spéciaux, mettez le « nom de la vue du processus » entre : « , comme ceci : `nom de la vue du processus`.
- Cliquez sur « Terminer ». Une icône de flèche apparaît alors à gauche de « Replica_database1 ».
- Cliquez sur cette icône de flèche, ensuite cliquez sur l’icône de flèche à gauche du nom de votre requête. La liste des différentes propriétés, colonnes, de la vue de votre processus est alors affichée.
Pour une meilleure expérience utilisateur, nous vous suggérons d’utiliser le mode sombre.
Mettre les propriétés de la vue dans le rapport
Vous pouvez maintenant faire glisser les informations correspondantes aux champs ou aux propriétés du processus dans le rapport. Suivez ces étapes pour ajouter ces informations :
- Cliquez sur la propriété souhaitée.
- Faites-là glisser à l’endroit où vous souhaitez afficher l’information dans le rapport. Si vous souhaitez afficher l’ensemble des informations des éléments de travail du processus, il faudra alors placer cette propriété dans la partie centrale. Les propriétés placées dans la marge supérieure ou inférieure afficheront les informations d’un seul élément de travail.
Pour information : vous pouvez sélectionner plusieurs propriétés en restant appuyer sur la touche « ctrl ». Faites-les ensuite glisser sur le rapport. - Mettez en forme la taille et l’emplacement de ces informations.
Changez le type de données associé à la propriété concernée si besoin.
- Cliquez sur la propriété.
- Cliquez sur l’icône de roue crantée.
- Cliquez sur cette icône dans le champ « Text Format String ».
- Mettez à jour le type de donnée associé à cette propriété.
- Ne sélectionnez aucun élément du rapport et cliquez sur l’icône de roue crantée.
- Dans le champ « Propriétés » sélectionnez « XtraReport (Rapport) ».
- Choisissez la requête que vous avez créée dans le champ « Données membres ».
Lier les propriétés à un élément de travail
Maintenant que nous avons configuré notre rapport pour afficher les informations des champs et propriétés, il faut maintenant restreindre l’affichage à un élément de travail. Cette configuration permettra d’afficher uniquement les informations de l’élément de travail exécuté. Suivez ces étapes pour configurer cette restriction :
- Cliquez sur l’icône de base de données.
- Cliquez sur « Paramètres », cliquez ensuite sur le bouton « + ».
- Donnez un nom à ce paramètre dans le champ « Nom » et mettez une description dans le champ « Description ».
- Choisissez le type « Entier ».
- Cliquez sur « OK » pour valider la création de ce paramètre.
- Cliquez sur l’icône de flèche à gauche de « Replica_database1 » pour afficher votre requête.
- Cliquez sur le nom de votre requête, ensuite cliquez sur cette icône .
- Mettez à jour la requête dans la partie « Chaîne SQL » avec ces informations :
select * from « nom de la vue du processus » where number = ?« nom du paramètre »
Vous devez mettre dans la partie « nom du paramètre » le nom que vous avez mis dans la troisième étape de cette partie. - Cliquez sur « Suivant », puis sur « Ajouter ».
- Cliquez sur la flèche à gauche du nom du paramètre.
- Dans le champ « Nom », mettez le nom choisi dans la requête de la partie « Chaîne SQL ». Dans notre exemple, vous devez mettre « pnumber ». L’objectif est d’avoir le même nom que celui utilisé dans la requête.
- Dans le champ « Type », choisissez « Expression ».
- Dans le champ « Valeur », cliquez sur cette icône .
- Cliquez sur la flèche à gauche de « Paramètres » et cliquez ensuite sur le nom de votre paramètre.
- Dans la partie d’édition d’expression mettez « ?« Nom du paramètre » ». Dans notre cas, nous mettons : « ?pnumber ».
- Cliquez sur « OK », et ensuite sur « Terminer ».
- Cliquez sur le bouton « Prévisualisation ».
Vous pouvez mettre le numéro d’un élément de travail correspondant au processus dans le champ correspondant au nom que vous avez donné au paramètre. Assurez-vous de choisir un élément de travail correspondant au processus de la vue choisie dans votre requête.
L’éditeur du rapport va alors afficher le rapport configuré avec les données de l’élément de travail correspondant.
- Cliquez sur le bouton « Création » pour revenir sur l’écran d’édition.
- Sauvegardez votre rapport, quittez l’éditeur de rapports et revenez à votre éditeur de processus.
Mettre un rapport en pièce jointe d’un modèle d’e-mail
Vous devez maintenant mettre ce rapport en pièce jointe d’un modèle d’e-mail. Pour configurer cela, suivez ces étapes :
- Allez dans l’éditeur de processus.
- Cliquez sur l’icône de « Mode de visualisation ».
- Cliquez sur « Modèle de Message ».
- Choisissez le modèle souhaité ou créez un nouveau en cliquant sur l’icône « + ».
- Cliquez sur le bouton « Pièces jointes » en bas de la boîte de dialogue.
- Faites défiler vers le bas, et dans la section des modèles, cliquez sur le bouton « + ».
- Cliquez sur le bouton « Rapport ».
- Choisissez le nom qui sera donné à cette pièce jointe.
- Sélectionnez le rapport souhaité.
- Faites correspondre le paramètre créé dans votre rapport au numéro de l’élément de travail. Pour cela :
- Cliquez sur l’icône des deux flèches.
- Ajoutez « : » et sélectionnez la propriété « Nombre ».
- Cliquez sur « Confirmer » pour valider l’ajout du rapport comme pièce jointe.
Pour information : si vous souhaitez mettre à jour un rapport qui est déjà annexé et qui n’avait pas de paramètre configuré dans le modèle de message, vous devez alors cliquer sur « Paramètres de récupération ».
- Cliquez sur « Confirmer » pour valider le modèle d’e-mail. Pour en savoir plus sur comment configurer un modèle d’e-mail : Création de modèles d’e-mails et de pièces jointes.
Lors de l’exécution d’un élément de travail de production, les valeurs remplies dans celui-ci seront automatiquement affichées dans les paramètres reprenant ces informations dans le rapport et apparaîtront dans le document PDF en pièce jointe de l’e-mail.
Pour information : Les rapports des éléments de travail de test ne génèrent pas de données.
Attention : Vous pouvez choisir uniquement des rapports qui ont été édités dans l’éditeur de rapports. Si vous avez simplement créé un rapport sans l’avoir personnalisé, celui-ci sera alors visible dans la liste des rapports mais vous ne pourrez pas le sélectionner.
Vous pouvez également consulter cet article : Créer un rapport avec les informations d’un enregistrement et l’envoyer par e-mail.