1. Présentation des Rapports |
|
|
Back to TopMailFlow Analyzer dispose d'un module de génération de Rapports sous forme de fichiers Word ou Excel. Il s'agit de pouvoir mettre à disposition des personnes intéressées, une vision synthétique des statistiques présentes dans les bases Mail Flow Server et Mail Flow User. L'utilisation d'un format de type fichier Word et Excel autorise l'impression du document sans perte de qualité et facilite sa diffusion par mail.
Rapport de type Word
Rapport de type Excel
La création de ces rapports peut se faire à la demande ou être planifiée automatiquement (fréquence quotidienne, hebdomadaire, mensuelle ou annuelle) et leur diffusion s'effectue soit par envoi du document par mail ou par publication dans une base tierce. L'accès au module de rapport passe par l'ouverture de la base Mail Flow Report accessible depuis votre espace de travail :
ou en utilisant directement l'entrée Search depuis le navigateur principal de la base Mail Flow :
La personnalisation des rapports fournis nativement avec l'application ou la création de nouveaux types rapports s'effectue très simplement en manipulant des documents Report Template (Modèles de Rapports) présents dans la vue Reports / Report Templates de la base Mail Flow Report.
2. Création d'un Modèle de Rapport |
|
|
La création d'un Modèle de Rapport (Report Template) vous permet de définir quelles sont les informations qui seront affichées dans le rapport (fichier Word ou Excel). Mail Flow Analyzer est livrée avec un ensemble de modèles de rapports couvrant différents domaines et permettant de se faire une idée sur les capacités du moteur de génération de rapports. Pour créer un nouveau modèle de rapport, cliquez sur le présent dans la vue Reports / Report Templates de la base Mail Flow Report.
L'entête document Report Template contient les informations essentielles à la génération du rapport comme le nom du document (Alias). Les champs commentaire (Comment) et catégorie (Category) permettent de définir l'usage du rapport et de le classer dans la vue :
Le champ Report File Format définit le type de fichier utilisé (Word, Excel ou HTML). Il doit correspondre à l'extension du fichier attaché dans le champ Report Template File.
Le champ Report Template File contient un fichier Word, Excel ou HTML, vide de toute donnée. Lors de la génération du rapport, ce fichier est remplit avec les informations demandées (textes, chiffres, tableaux, graphiques...)
Le champ Report File Name contient le nom du rapport final. Il est possible de rendre dynamique le nom du rapport en lui incorporant des informations d'horodatage, au moyen des mots clés %Y (année en cours) %M (mois en cours) et %D (jour). Par exemple, le fichier nommé Organization_ByVolume_%Y%M%D deviendra Organization_ByVolume_20150419.xlsx si le rapport de type Excel est généré le 19 avril 2015.
Si l'option Compression est cochée, le rapport sera zippé avant d'être rattaché au document résultat. Avec les fichiers Word et Excel ayant les extensions .docx et .xlsx, la compression Zip est devenue inutile. Elle reste pertinente pour les anciennes versions de fichiers (.doc et .xls).
L'option Enable Debug Mode permet d'afficher le rapport dans l'application Excel ou Word pendant de sa création. Cela permet de voir s'afficher les messages d'erreur pouvant bloquer la génération du rapport. Cette option ne devrait être utilisée que de façon ponctuelle, en cas d'erreur lors de la création du rapport.
Un document Report Template est ensuite découpé en 6 onglets : Data Origin, Scheduling, Delivery Options, Appearance, @Formula Repository et Actions List, comme affiché ci-dessous. Chaque onglet est détaillé ci-dessous (cliquez sur chaque onglet pour accéder à sa documentation) :
Data Origin
L'onglet Data Origin permet de sélectionner les documents statistiques provenant des bases Mail Flow Server ou Mail Flow User dont les données vont être affichées dans le rapport final. Les rapports de type Word utilisent habituellement les données provenant de 1 ou 2 documents de statistiques (documents Infrastructure) alors que les rapports Excel peuvent faire appel à plusieurs milliers de documents (documents User).
Pour les modèle de rapport Word, on saisit les références individuelles aux documents ;
Les radios bouton Previous / Current permettent d'adapter la période des documents par rapport à la date de génération du rapport. Dans l'exemple précédent le premier bloc fait référence au document Infrastructure de l'année courante (Current) et le deuxième bloc fait référence au document Infrastructure de l'année précédente (Previous).
Le suffixes situés à droite des blocs (ici _2 pour le bloc numéro 2) permettent d'indiquer dans le Template de rapport Word de quels documents proviennent les champs. Dans le Template ci-dessous, le Tag [Total_Nb] correspond au champ Total_Nb du premier document (Infrastructure Year Current) alors que le tag [Total_Nb_2] correspond au champ Total_Nb du deuxième document (Infrastructure Year Previous) :
Il existe deux suffixes par défaut couvrant deux périodes associées au premier document déclaré dans le tableau :
_1 : Indique la période précédente (si c'est une année, alors l'année précédente, si c'es un mois le mois précédent...)
_0 : Indique la période englobante (si c'est un jour, alors la semaine contenant le jour, si c'est un mois, alors l'année contenant ce mois...)
Pour les modèles de rapport Excel, on utilise des @Formula pour sélectionner les documents :
Scheduling
L'onglet Scheduling affiche les options liées à la planification du rapport :
Si l'option Schedule Report Creation est sélectionnée, le rapport sera automatiquement généré sur la machine hébergeant le moteur de traitement Mail Flow à la fréquence indiquée. Il faut choisir la période (Jour, Semaine, Mois, Année), la Date et l'Heure souhaitée.
Pour que le moteur de traitement puisse générer automatiquement les rapports de types Word ou Excel, il faut que ces logiciels soient installés sur la machine de traitement des données (serveur domino).
Delivery Options
L'onglet Delivery Options affiche les options liées à la diffusion du rapport final :
Si l'option Attach the Report File to a document est sélectionnée, le rapport final (fichier Word, Excel ou HTML) est attaché dans un nouveau document Report qui est créé spécialement dans la base MailFlowReport et affiché dans la vue Reports / Report Documents. Les document Report sont automatiquement supprimés de la base après l'expiration de leur délai du purge (défini dans le champ Purge delay).
De plus, le rapport peut automatiquement être envoyé par Mail si l'option Send Report File by Mail est cochée. Il vous faudra alors remplir les champs Sender Name, Recipient Names et Subject pour permettre l'envoi du message contentant le rapport final. Le champ Recipient Names est multi-valué et les noms de groupes y sont autorisés.
Enfin, le rapport final peut être publié sous la forme d'un nouveau document dans une base Notes tierce. Vous définirez alors la liste des champs à créer dans le document, en précisant le nom du champ (Field Name), sa valeur (Field Value) et son type (Field Type). Le rapport final (un fichier Excel, Word ou HTML) sera ajouté à ce document, sous la forme d'un fichier attaché.
Appearance
L'onglet Appearance permet de définir les caractères utilisés pour le formatage des nombres dans les rapport Word :
La section Regional Settings définit les caractères utilisés comme séparateur décimal (Decimal Symbol) et comme séparateur de millier (Digit Grouping Symbol) pour le formattage des nombres dans les rapport Word.
La section Graphic parameters permet de personnaliser la couleur utilisée dans les graphiques. Cela permet de choisir des couleurs en harmonie avec la charte graphique de l'entreprise.
Note: Cet onglet n'est pas visible quand vous générez des rapports basés sur des fichiers Excel.
@Formula Repository
L'onglet @Formula Repository est utilisé pour simplifier l'écriture des @Formula dans les champs des Template de rapport basés sur des fichiers Word. Vous utilisez cet onglet pour y saisir vos @Formula et vous y faites références dans vos Template Word via leur numéro. Par exemple, insérez un [#1] dans le Template Word pour y afficher le résultat de l'évaluation de la @formula suivante dans le rapport final :
Note: Cet onglet n'est pas visible quand vous générez des rapports basés sur des fichiers Excel.
Action List
L'onglet Action List n'est accessible que pour les rapports basés sur un fichier Excel. Il permet la création et la gestion de lignes et de colones supplémentaires, utilisées pour simplifier la création des rapports. L'option Compact est similaire à la notion de Catégorisation dans les vues Notes : Vous ne conservez qu'un exemplaire de chaque valeur unique d'un ensemble de données.
Exemple: dans l'onglet Data Origin (2 ème onglet dans le document Report Template), vous spécifiez que la colonne du fichier Excel contenant le tag [MAIL_SERVER] doit afficher le résultat de l'évaluation d'une @Formula (ici @Name([CN]; MailServer)), et vous ajoutez en plus l'action Unique_case, comme indiqué ci-dessous :
Dans l'onglet Action List, vous spécifiez le nom de votre action (ici Unique_Case) dans le champ Action Name, vous ouvrant la possibilité de créer automatiquement du contenu dans les lignes (Rows) et les 3 colonnes suivantes (Columns). Dans l'exemple qui suit, les lignes sont au nombre de 11 (Top 10 + 1 Extra line Other), avec 2 colonnes additionelles : la première (#+1) affiche le nombre de documents statistiques (SCORE) ayant comme valeur celle affichée dans la colonne [MAIL_SERVER] et les colonnes (#+2 et #+3) affichent la somme (SUM) des évaluations des @Formula @Subset(Y_Nb;1) et @Subset(Y_Sz;1) :
Note : En sélectionnant NONE dans le champ #+3 de la colonne Operator, la 3 ème colonne Priority devient inactive.
In Excel Template File:
Données brutes provenant de la base Mail Flow User :
Une fois l'application du Compact + Action :
La colonne Mail Server ne conserve qu'un seule exemplaire de chaque nom de serveur (UNIQUE). La colonne # User affiche le nombre d'utilisateurs (SCORE) ayant comme serveur de Mail ce nom de serveur. Les colonnes # Message et Size (MB) affichent la somme (SUM) du nombre de messages envoyés+reçus et de leur taille, pour les utilisateurs ayant ce serveur comme serveur de Mail.
3. Creation d'un Modèle de Rapport basé sur Word |
|
|
Pour créer un rapport Word, sélectionnez Word comme format de rapport (Report File Format) et attachez un fichier Word dans le champ Report Template file. Il est généralement plus simple de réutiliser un fichier Word existant dans la base Mail Flow Report et d'y apporter des modifications souhaitées. L'application Word ou Office 2003 (ou supérieur) doit avoir été installée sur la machine utilisée pour générer les rapports (serveur Domino hébergeant le moteur de traitement des données ou en local sur le PC de l'utilisateur).
Dans l'onglet Data Origin du modèle de rapport, vous devez sélectionner le nombre de documents statistiques (champ Number) depuis lesquels vous allez extraire les données qui seront affichées dans le rapport final Word. Chaque document doit être sélectionné manuellement, en indiquant son Type (Type), sa Période (Period) et son identifiant (ID) :
Exemple de Rapport Word
Veuillez trouver ci-dessous un exemple de Modèle Word. Le moteur de rapport va automatiquement rechercher et remplacer toutes les données situées entre crochets ([Total_Nb], [Total_Size/1024], [Evolution_Nb], [@Right(TypeExtension;2) + ...]...) par leurs valeurs respectives (valeur d'un champ ou évaluation d'une @Formula) et ainsi créer le rapport final Word. Si les @Formulas sont trop longues pour tenir dans le fichier Modèle Word, vous pouvez toujours utiliser l'onglet @Formula Repository pour les y écrire et utiliser les mot clés [#1], [#2], [#3]... pour y faire référence.
Le modèle Word :
Le rapport Word :
Modèle de Rapport de type Word PDF
Les rapports de type Word PDF sont similaires aux rapports de type Word. La différence provient du format du fichier généré (ici un fichier PDF à la place d'un fichier Word). Il suffit de configurer dans le champ PDF Printer Name le nom d'une imprimante générant le fichier PDF depuis l'application Word. L'utilitaire générant les fichier PDF (ici adobe distiller) doit avoir été installé sur la machine utilisée pour générer les rapports (serveur Domino hébergeant le moteur de traitement des données ou en local sur le PC de l'utilisateur).
Modèle de Rapport de type HTML (Firefox)
Les rapports de type HTML sont similaires aux rapports de type Word et sont habituellement générés en ré-enregistrant un rapport Word existant en format HTML :
La différence provient du format du fichier généré (ici un fichier HTML à la place d'un fichier Word). L'avantage du format HTML est de ne pas avoir besoin d'installer l'application Word sur la machine générant les rapports. Par contre, le rendu visuel d'un fichier HTML est en deçà d'un fichier Word.
Modèle de Rapport de type Mime HTML (Internet Explorer)
Les rapports de type Mime HTML sont similaires aux rapports de type Word et sont habituellement générés en ré-enregistrant un rapport Word existant en format Mime HTML :
La différence provient du format du fichier généré (ici un fichier Mime HTML à la place d'un fichier Word). L'avantage du format Mime HTML est de ne pas avoir besoin d'installer l'application Word sur la machine générant les rapports. Par contre, le rendu visuel d'un fichier Mime HTML est en deçà d'un fichier Word. A la différence d'un fichier HTML, le format Mime HTML autorise l'encapsulation des images dans le fichier, permettant d'obtenir un rendu un peu moins brut que celui du HTML simple.
4. Creation d'un Modèle de Rapport basé sur Excel |
|
|
Pour créer un modèle de rapport au format Excel, sélectionnez Excel dans le champ Report File Format et attachez le fichier Excel servant de modèle dans le champ Report Template file. Il sera probablement plus simple de commencer à modifier un des fichiers Excel fourni en exemple avec l'application pour l'adapter à vos besoins. L'application Excel ou Office 2003 (ou supérieure) doit être installée sur la machine utilisée pour la génération des rapports (serveur Domino hébergeant le moteur de traitement des données ou en local sur le PC de l'utilisateur).
Le format Excel est un bon choix pour la création de rapports affichant les données provenant de plusieurs documents statistiques (provenant des bases Mail Flow Server ou Mail Flow User). L'onglet Data Origin rassemble les champs de définition des données.
La section Data Origin contient la @Formula de sélection définissant la liste des documents Statistiques utilisés pour remplir le rapport :
La section Excel Data Cells est utilisée pour définir les cellules dont les valeurs ne sont pas en relation directe avec les documents statistiques préalablement sélectionnés. Le tag [TITLE] peut être utilisé pour ajouter un titre au fichier Excel et le tag [COUNT] peut être utilisé pour afficher le nombre de documents statistiques récupérés par la @Formula de sélection ou pour le calcul de %. Les champs Extra Cell sont utilisés pour calculer tout autre type de valeurs (Date et heure de génération du rapport, nom du créateur de rapport, ...) :
La section Excel Data Rows vous permet de limiter le nombre de documents statistiques à afficher dans le rapport (Maximum Number of rows) et vous donne la possibilité de trier vos colonnes (ordre croissant / décroissant). Si vous combinez ces deux possibilités, vous pouvez facilement construire des rapport de type TOP 100, où ne sont affichés que les 100 premiers documents statistiques basés sur un critère spécifique (taille, nombre de document, activité...).
Dans la section Excel Columns @Formula, vous définissez la liste des [Tag] que vous pouvez rencontrer dans votre fichier Excel et la valeur associée (qui se définit au moyen d'un nom de champ ou d'une @Formula calculée dans le contexte du document statistique) :
Vous pouvez utiliser les Action avec l'option Compact pour compacter les données affichés dans le rapport Excel, à la manière des catégorisations dans les vues Notes. Se reporter au chapitre Création d'un Modèle de Rapport de la documentation pour plus de détails.
Vous pouvez également faire appel à la capacité d'Excel de créer des automatiquement des graphiques basés sur les données présentes dans le fichier Excel. Il vous suffit de placer les données provenant des documents statistiques dans une feuille du classeur Excel et de définir le graphique à proximité ou dans une autre feuille du classeur Excel :
Exemple de Rapport Excel
Voici un exemple de modèle de rapport Excel avec le rapport final généré. Les cellules du fichier Excel modèle affichent des tags entre crochets comme [#1], [#5], etc., permettant au moteur de génération de rapport de les localiser et de les remplacer par leurs valeurs respectives. En général, le moteur de génération de rapport calcule préalablement les valeurs des champs basés sur des @Formula ([TITLE] + Extra cells) et analyse ensuite le fichier Excel pour localiser les tags associés aux colonnes et y insérer les données. Chaque ligne du fichier Excel contiendra les valeurs provenant d'un document de statistique.
Dans le Modèle Excel :
Dans le Rapport Excel :
5. Création d'un Modèle de Rapport Cross-Server ou Cross-Population |
|
|
Les rapports de type Cross-Server ou Cross-Population sont utilisés pour produire des graphiques de flux entre deux entitées (flux entre serveurs, flux entre populations). On choisit une statistique provenant des documents de statistiques (par exemple de nombre de mails envoyés entre deux serveurs) et on demande une modélisation des flux. Les noms serveurs apparaissent dans une bulle bleue et des flèches indiquent le nombre de messages envoyés entre les différents serveurs. Les lignes épaisses représentent des flux plus importants :
Pour créer un modèle de rapport de type Cross-Server ou Cross-Population, sélectionnez CrossServer or CrossPopulation Graphic dans le champ Report File Format et spécifiez un nom pour le graphique.
L'onglet Data Origin rassemble les champs de définition des données.
La section Statistics Data Origin contient type de documents de statistiques à traiter (Cross Server ou Cross Population), la période concernée (jour, semaine, mois , année...) et la liste des documents de statistiques souhaités (Document ID) :
La section Graphic / Table Data est utilisée pour préciser le titre du rapport (Graphic Title), le formattage des noms dans les bulles bleues (Name @Formula) et la valeur (sous la forme d'un nom de champ ou d'une @Formula) qui sera utilisée pour l'affichage des lignes (ici le champ Total_Nb désigne le nombre de messages envoyés entre les deux serveurs au cours de la période).
Les options de la section Graphic Options permettent de rendre le graphique plus lisible. On peut décider de ne pas afficher les lignes représentant un très faible flux (Don't draw arrows if the value is lower than X %) ou ne dessiner que les flux venant ou allant vers un serveur principal (Draw arrows showing mail flow FROM / TO the Main Server).
L'onglet Appearance contient les champs permettant de choisir les couleurs utilisées pour le graphique et le style de représentation.
La couleur de fond de l'image est définie par le champ Background Color, la couleur des bulles est définie par le champ Node Color et celle des flèches par le champ Arrow Color. Le champ Arrow Style indique la manière dont les bulles vont être placées sur le graphique (organisation hiérarchique ou Indirecte).
6. Génération de rapports en utilisant les composants locaux |
|
|
Pour demander la création immédiate d'un rapport en local, il faut ouvrir la vue Reports / Report Templates de la base Mail Flow Report, sélectionner le ou les documents correspondant au(x) rapports à générer et cliquer sur le bouton /
. Il n'y a pas besoin d'installer manuellement des composants sur le poste de travail car le code du bouton
s'en charge automatiquement. Les fichiers sont installés dans le répertoire Data du client Notes, dans le sous répertoire CTReport\Files\ReportFile\.
La fenêtre suivante est affichée pour vous indiquer qu'un rapport est en cours de création en arrière plan :
et l'icône est affichée dans la zone de notification de Windows (en bas à droite, à côté de l'heure). En plaçant le pointeur de la souris sur cette icône, vous pouvez suivre la progression de la création du/des rapport(s). Vous pouvez également ouvrir la vue Reports / Report Documents et y attendre la création du document Rapport. Pour localiser facilement votre document, il vous suffit de trier la vue en cliquant sur la colonne Created et votre document devrait se retrouver tout en haut.
La génération à la demande de rapports depuis votre machine va faire appel aux logiciels Microsoft Office Word ou Excel installés localement sur votre ordinateur et faire travailler le CPU de votre machine. Afin de pouvoir créer des rapports de types Word ou Excel depuis votre PC, vous devez préalablement vous assurer que ces logiciels ont bien été installés sur votre PC.
Génération de rapports sur le serveur
Pour demander la création immédiate d'un rapport sur le serveur Domino, il faut ouvrir la vue Reports / Report Templates de la base Mail Flow Report, sélectionner le ou les documents correspondant au(x) rapports à générer et cliquer sur le bouton /
. Le moteur de traitement de Mail Flow va récupérer la demande de création du/des rapport(s) et va construire celui/ceux-ci sur le serveur, en utilisant les logiciels Microsoft Office Word et Excel installés sur le serveur Domino. Vous devez vérifier que ces logiciels ont été correctement installés et que l'identité utilisée pour faire démarrer le serveur Domino a bien accès à ces deux logiciels.
Pour les rapports nécessitant de charger un grand nombre de documents de statistiques, il est plus rapide de les créer sur le serveur car le moteur de génération de rapports dispose d'un accès local aux données (bases Mail Flow Server et Mail Flow User). A l'inverse, la tâche locale de création de rapport saura à interroger le serveur et devra rapatrier en local tous les documents de statistiques utiles à la création du rapport final.
La planification de la génération des rapports sur le serveur passe par les options disponibles dans l'onglet Scheduling des documents Report Template :
Accéder au Rapport
Une fois le rapport généré, vous trouverez un nouveau document dans la vue Reports / Report Document qui contient le rapport sous la forme d'un fichier attaché :
Fichier de Trace
Pendant la création du rapport en arrière plan, des fichiers temporaires (Value_pid.txt, Template_pid.xls, Report_pid.xls...) sont créés dans le répertoire Data Notes, au niveau du sous répertoire CTReport\Files\ReportFile\. Ces fichiers sont automatiquement supprimés une fois le rapport créé.
De plus, des fichiers de traces sont générés dans le répertoire temporaire de la machine (%Temp%). Ils se nomment ReportTaskLog_yyyymmdd_hhmmss_pid.txt et MailFlowReportLog_yyyymmdd_hhmmss_pid.txt. Les fichiers temporaires et les fichiers de trace peuvent être utilisés pour diagnostiquer les problèmes en cas de non génération des rapports (ou si ceux-ci sont mal construits).
Résolution des Problèmes
Si vous n'arrivez pas à générer votre rapport, la première chose à faire est d'essayer de la générer depuis votre client Notes (en local). C'est beaucoup plus facile à diagnostiquer. Vous pouvez facilement accéder aux fichiers de trace, aux fichiers temporaires et vous assurer que Excel et Word fonctionnent normalement.
Si le problème semble venir de Word ou d'Excel, vous pouvez cocher l'option Enable Debug Mode dans le document modèle de rapport :
Cela va forcer l'affichage à l'écran de la fenêtre de l'application Word ou d'Excel, pendant la génération du rapport. Si un message d'erreur provenant de Word ou d'Excel est affiché, vous pourrez le voir. Faites attention à utiliser le bonne extension de fichier (comme .xlsx ou .docx) si vous utilisez une version moderne de Word ou d'Excel (et non pas .doc ou .xls) afin d'éviter les messages d'avertissement concernant la perte de compatibilité entre les formats de fichiers.
Si le rapport est généré correctement en local mais pas sur le serveur, vérifier la liste suivante d'erreurs possibles :
- Vérifier que le répertoire CTReport\ est présent dans le répertoire Data sur serveur Domino et qu'il contient l'ensemble des fichiers requis (il suffit de comparer avec l'installation en local).
- Si le serveur Domino est en 64 bits, utilisez la tâche ReportTask.exe en 64 bits. Si le serveur Domino est en 32 bits, utilisez la tâche ReportTask.exe en 32 bits.
- Vérifier que Excel et Word ont bien été installé sur le serveur et démarrés au moins une fois, car la première exécution de Word ou d'Excel termine l'installation des logiciels.
- Si le serveur est en Windows 64 bit, vérifier que le répertoire suivant existe : "c:\Windows\SysWOW64\config\systemprofile\Desktop\". Si ce n'est pas le cas, créez le.
Commentaires
0 commentaire
Cet article n'accepte pas de commentaires.