 |
1. Introduction | |
| 2. Creation d'un Template de Rapport | ||
| 3. Templates de Rapport Word | ||
| 4. Template de Rapport Excel | ||
| 5. Génération de Rapports |
1. Introduction |
|
|
Back to TopArchive Mail dispose d'un module permettant la génération de rapports sous la forme de fichiers Word ou Excel files. Cela permet d'offrir une vue synthétique des informations présentes dans les documents Database.
L'utilisation de formats de fichiers tels que Word ou Excel nous permet d'imprimer les documents sans perte de qualité. La génération de ces rapport se fait de manière manuelle ou planifiée et leur diffusion peut se faire par envoi de mails ou par publication dans une base tierce.
La modification de rapports existants ou la création de nouveaux rapports de fait en manipulant les fichiers Report Template qui sont disponibles dans la vue Administration / Reports / Template de la base ArchiveMail :
2. Creation d'un Template de Rapport |
|
|
La création d'un Report Template avous permet de définir quelles sont les informations qui seront affichées dans un rapport (Word ou Excel). ArchiveMail dispose d'exemples de rapportsvous permettant de comprendre comment fonctionnent les rapport et ce qu'ils peuvent vous apporter en terme de contenu. Pour créer votre propre rapport, veuillez cliquer sur le bouton de la vue Administration / Reports / Template.
Un document Report Template contient 7 onglets : Main, Data Origin, Scheduling, Delivery Options, Appearance, @Formula Repository et Actions List, comme montré ci-dessous. Chaque onglet contient les explications de ses champs (cliquez sur chaque onglet du tableau suivant pour accéder aux détails) :
Main
L'onglet Main contient les informations essentielles comme le nom du rapport (Alias). Le champs commentaire permet de décrire l'utilisation attendu pour ce rapport.
Le champ Report Template File contient le fichier attaché du rapport (Word , Excel) sans les données. Lors de la génération du rapport, ce fichier est utilisé comme modèle et il est remplit avec toutes les informations provenant des documents Database (Texte, Nombre, Graphiques...).
Le champ Report File Name contient le nom du rapport final. Afin d'obtenir des noms de fichiers contenant la date de création du rapport, les mots clés %Y (pour l'année) %M (pour le moins) et %D (pour le jour) sont utilisés. Par exemple, le fichier nommé TPLTop30_2YActivity_%Y%M%D deviendra TPLTop30_2YActivity_20150419.doc si le rapport est généré le 19 Avril 2015.
Le champ Report File Format définit le type du fichier attaché (Word ou Excel). Si l'option Zip File est cochée, le fichier final sera compressé avec d'être attaché dans le document résultat.
Data Origin
L'onglet Data Origin est utilisé pour sélectionner les documents Database de la base ArchiveMail qui vont être utilisés comme source de données pour la création du rapport final. Les rapport utilisant un format Word récupèrent leurs données dans 1 ou 2 documents, alors que les rapports produisant des fichiers Excel peuvent en utiliser des milliers.
Pour les Rapport basés sur des fichiers Word, on défini les documents sources de manière individuelle :
Pour les Rapports basés sur des fichiers Excel, on utilise une @Formula de sélection :
Delivery Options
L'onglet Delivery Options définit la manière dont le rapport final va être diffusé :
Si l'option Attach the Report File to a document est sélectionnée, le rapport sera attaché à un nouveau document créé dans la base ArchiveMail, visible dans la vue Administration / Reports / Report. Les document Rapports peuvent être automatiquement supprimés de la base ArchiveMail après un certain temps, selon la valeur du champ Purge delay.
De plus, le rapport peut être envoyé par mail si l'option Send Report File by Mail a été cochée. Il faut alors renseigner les champs Sender Name, Recipient Names et Subject pour que le fichier puisse être attaché à un mail et expédié (les noms de groupes sont autorisés dans le champ Recipient Names, qui est lui même multi-valué).
Le rapport final peut être également publié dans une base tierce, sous la forme d'un nouveau document. Vous pouvez ajouter à ce document un certain nombre de champs (Field Name, Field Value, et Field Type) afin de respecter le modèle de doinnées de la base où le document est créé.
Appearance
L'onglet Appearance vous permet de sélectionner les types de séparateur numériques utilisés dans les rapports :
La section Regional Settings permet de définir le caractère utilisé comme séparateur décimal (Decimal Symbol) et le caractère utilisé comme séparateur d'unité (Digit Grouping Symbol). Tous deux sont utilisés pour le formatage des nombres dans les rapports.
Note: Cet onglet n'est pas affiché quand vous générez des rapports Excel.
@Formula Repository
L'onglet @Formula Repository est utilisé comme container de @Formula, dans le but d'alléger au maximum les @Formula saisie entre crochet dans les Template Word. Par exemple, saisissez [#1] dans le Template Word et placez la @Formula associée dans le champ #1 de cette section :
Lors de la génération du rapport, le Tag [#1] sera remplacé par l'évaluation de la @Formula de #1.
Note: Cet onglet n'est pas affiché quand vous générez des rapports Excel.
Action List
L'onglet Action List n'est affiché que pour les rapports de type Excel. Cela permet de créer des colonnes de données supplémentaires et facilite la création de certains types de rapports. L'option Compact fonctionne pour les rapports un peu à l'image de la Catégorisation dans les vues d'une base Notes : Vous ne gardez qu'un seul exemplaire d'un ensemble de donnée (factorisation).
Exemple : dans l'onglet Data Origin (2 ème onglet d'un document Report Template), vous indiquez dans la dernière section que la colonne contenant le label [SERVER_NAME] doit afficher le résultat de l'évaluation de la @Formula (@Name([CN];Server)) sous forme Compact, mais doit aussi ajouter l'Action Unique_case :
Dans l'onglet Action List, vous retrouvez dans le champ Action Name le nom de votre Action (Unique_Case). Vous pouvez modifier l'affichage de votre colonne (celle contenant [SERVER_NAME] dans le Template Excel) mais également des 3 colonnes de droite. Dans l'exemple ci-dessous, le nombre de ligne est limité à 11 (Top 10 + 1 Extra), sur trois colonnes : la première affiche le résultat de la @Formula définie dans l'onglet Data Origin, la deuxième (#+1) affiche le nombre de documents Database correspondant à la valeur de première colonne (SCORE) et la troisième (#+2) affiche le résultat de la @Formula (DBSize/1024) :
Note : En sélectionnant NONE dans le champ #+3 dans la colonne Operator, la 4 ème colonne devient inactive.
Dans le Template Excel :
Données brutes provenant de la baseArchive Mail ;
Une fois le Compact + Action appliqué :
La colonne Server Name conserve uniquement un exemplaire de chaque nom de serveur (UNIQUE), la colonne #Database affiche le nombre de documents Database (SCORE) ayant comme serveur ce nom de serveur et la colonne Size (GB) affiche la somme (SUM) de toutes les tailles des bases ayant ce nom de serveur.
3. Templates de Rapport Word |
|
|
Pour créer un rapport basé sur Word, sélectionnez Word dans le champ Report File Format puis attachez un fichier Word dans le champ Report Template file. Il est généralement plus simple de commencer par utiliser un Template Word existant et de la faire évoluer selon vos besoins. Word ou Office 2003 (ou supérieur) doivent être installés sur la machine qui va générer les rapports.
Dans le deuxième onglet appelé Data Origin, vous devez modifier le champ Number pour indiquer le nombre de document Database que vous souhaitez utiliser pour la création de ce rapport. La sélection des Document ID via un Wizard vous permet de sélectionner tous les documents Database. La clé est composé du nom du serveur et du nom de la base.
Exemple :
Veuillez trouver ci-dessous un exemple de rapport Word. Le moteur de génération de rapport va automatiquement remplacer les données entre crochets ([DB_Title], [DB_Path], [DB_Server], [@Text(DB_Created)]...) par leur valeur (valeur du champ associé ou évaluation des la @Formula) et génère le rapport final Word. Si les @Formula sont trop longues pour être placés entre crochets, vous pouvez utiliser l'onglet @Formula Repository pour les y écrire et utiliser le Tag associé [#1], [#2], [#3]...dans le Template.
Le Template :
Le Rapport :
4. Template de Rapport Excel |
|
|
Pour créer un rapport Excel, sélectionnez la valeur Excel pour la champ Report File Format et attachez un fichier Excel dans le champ Report Template file. Il est généralement plus simple de commencer par modifier un fichier Excel existant fournit avec la solution Archive Mail et de le faire évoluer selon vos besoins. Excel ou Office 2003 (ou supérieur) doivent être installés sur la machine qui va générer les rapports.
Le format Excel est un bon choix pour créer des rapports affichant des données provenant de plusieurs documents Database. L'onglet Data Origin rassemble la définition de toutes les données.
La section Data Origin contient la formule de sélection @Formula définissant la liste des documents Database utilisés pour créer le rapport :
La section Excel Data Cells section est utilisée pour définir les valeur des cellules qui ne sont pas reliées aux document Database sélectionnés. Le Tag [TITLE] peut être utilisé pour ajouter un Titre au fichier Excel, le Tag [COUNT] peut être utilisé pour afficher le nombre de document Database récupéré par la formule de sélection @Formula (ou utilisé pour calculer les %). Les Extra Cell sont utilisées pour calculer tous autres types de valeurs (date et heure courante, nom du créateur du rapport, ...) :
La section Excel Data Rows vous permet de limiter le nombre de documents Database affichés dans le rapport final (Maximum Number of rows : 30 lignes) et vous donne la possibilité de trier vos colonnes (Ascendant or Descendant). Si vous combinez ces deux possibilités, vous pouvez facilement construire des rapports basés sur un TOP 100, où vous n'affichez que les 100 documents Database (basé sur un critère spécifique).
Dans la section Excel Columns @Formula, vous définissez la liste des Tag [Tag] que l'on retrouve dans le Template Excel ainsi que leurs valeurs (définies via un Nom de champs ou le calcul d'une @Formula sur les documents Database) :
Vous pouvez utiliser les Action afin de construire des rapports dans un style Compact. Reportez vous à la partie Reporting : Création d'un Template de Rapport pour plus de détails.
Vous pouvez également utiliser Excel dans sa capacité à produire des graphiques à partir de données numériques. Dans la page Data du fichier Excel, les données sont importées depuis le document Database :
et dans la page Graph, on construit un graphique à partir de ces données :
Exemple de Rapport Excel :
Voici un exemple de rapport Excel avec le rapport final généré. Les cellules du Template Excel montre les mots clés utilisés comme [DATABASEPATH], [SERVERNAME], etc. Le moteur de génération de rapport va remplacer ces mots clés par leurs valeurs. En général, le moteur de génération de rapports commence par calculer les valeurs des @Formula et recherche ensuite dans le Template Excel le nom du mot clés associé pour placer la valeur. Chaque ligne du fichier Excel correspond aux valeurs d'un document Database.
Dans le Template :
Dans le Rapport :
5. Génération de Rapports |
|
|
Ouvrez la vue Administration / Report / Template, sélectionnez les rapports à créer et cliquez sur le bouton . Vous n'avez rien besoin d'installer sur votre ordinateur, car le fait d'appuyer sur le bouton
va automatiquement installer en local sur votre machine tous les fichiers requis. Les fichiers binaires sont installés dans le répertoire Data de votre client Notes, dans le sous répertoire CTReport\Files\ReportFile\.
La fenêtre suivante est affichée à l'écran pour vous prévenir que les rapports sont en cours de génération, en arrière plan :
et l'icone est affiché dans la zone de notification de la barre des Tâches Windows, indiquant le travail en cours. Vous pouvez également aller dans la vue Administration / Reports / Report et attendre la création du document Report. Triez la vue en cliquant sur la colonne Created et votre document devait s'afficher tout en haut de la vue
Création des Rapports sur le serveur (Planifiée)
Si vous voulez planifier la création de vos rapports (par exemple une fois par semaine), vous devez commencer par installer le pack Office (Word et Excel) sur votre serveur Domino (sous Windows). Vous devez aussi vérifier sous quelle identité est lancée le serveur Domino, car c'est cette même identité qui sera utilisée pour lancer Word et Excel.
Vous devez également installer sur le serveur les composants d'Archive Mail utilisés pour la génération des rapports. La manière la plus simple est d'installer d'abord les composant en local et de copier tout le contenu du répertoire CTReport\ (situé dans le répertoire Data de votre client Notes) vers le serveur Domino (à placer également sous le répertoire Data du serveur). Si vous regarder dans ce répertoire, vous trouverez des exécutables nommés MailFlowTag.exe, MailFlowTagHTML.exe, MailFlowReportHTML.exe et MailFlowReport.exe. L'autre fichier à installer est la tâche serveur ReportTask.exe. Vous la trouverez dans la vue Installation / Install Files de la base Archive Mail, dans le document Report Task. Soyez sûr de sélectionner le bon document en fonction de l'architecture de votre serveur Domino (32 bits ou 64 bits). Le fichier ReportTask.exe doit être installé dans le répertoire programme du serveur Domino,
Enfin, vous pouvez créer un document Program dans le NAB du serveur et lancer l'exécutable ReportTask.exe avec le nom du rapport que vous souhaitez créer :
Le paramètre Program name contient le nom de la tâche qui va créer les rapports (ReportTask.exe) et les paramètres sont constitués du mot clés REPORT, du chemin de la base Archive Mail et du nom du Report Template à créer.
Création de Reports utilisant des Agents LotusScript
Il y a un Template dans la base Archive Mailqui nécessite un traitement particulier pour être généré :
- Volume By Archive Server
Plutôt que d'utiliser le bouton depuis la vue Administration / Reports / Template, vous devez sélectionner le document Template depuis la vue et lancer l'agent LotusScript depuis le menu Actions :
- Create Report 'Volume By Archive Server' pour le Template Volume By Archive Server
L'agent va traiter le document Template et va créer le rapport final Excel.
Accéder au rapport final
Une fois que le rapport a été généré, vous trouverez u nouveau document dans la vue Administration / Reports / Report, contenant le rapport final, sous forme de fichier attaché au document :
Fichiers de Trace
Pendant que les rapports sont générés 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, dans le sous répertoire CTReport\Files\ReportFile\. Ces fichiers sont supprimés une fois le rapport final créé.
De plus, les fichiers de trace du processus de génération des rapports sont créés dans le répertoire Temporaire de la machine (habituellement sous %Temp%). Les noms de ces fichiers sont ReportTaskLog_yyyymmdd_hhmmss_pid.txt et MailFlowReportLog_yyyymmdd_hhmmss_pid.txt (où YYYY est l'année, MM le mois, DD le jour...). Les fichiers temporaires et les fichiers de traces peuvent être utilisés en cas de problème lors de la génération des rapports.
En cas de problèmes
Si vous n'arrivez pas à générer vos rapports, la première chose à faire est d'essayer de générer les rapports en local, depuis votre PC. Il est plus facile de debuger un processus en local car vous pouvez accéder facilement aux fichiers temporaires et aux fichiers de trace. Vous pouvez également facilement vérifier si Word et Excel ont bien été installés et qu'ils fonctionnent correctement.
Si le problème semble venir de Word ou d'Excel, vous pouvez cocher l'option Enable Debug Mode dans le Report Template :
Cela va forcer Excel ou Word à s'afficher à l'écran pendant la création du rapport. Si un message est affiché par Word ou Excel, vous le verrez à l'écran. Les erreurs les plus courantes sont liées aux formats des fichiers Excel ou Word. Utilisez les bonnes extensions de fichiers (comme .xlsx ou .docx) si vous utilisez des versions récentes de Word ou d'Excel (et pas .doc ou .xls). L'objectif est d'éviter tous les messages relatifs aux problèmes de compatibilité entre les versions de fichiers.
Si le rapport fonctionne correctement en local mais ne marche pas depuis le serveur Domino, vérifiez la liste suivante :
- Vérifier que le répertoire CTReport\ est présent dans la répertoire Data du serveur Domino, avec tous les fichiers indispensables à l'intérieur.
- Si le serveur Domino est en 64 bits, utilisez le fichier ReportTask.exe en 64 bits. Si le serveur Domino est en 32 bits, utilisez le fichier ReportTask.exe en 32 bits.
- Assurez vous que Excel & Word ont bien été installés et démarré manuellement au moins une fois. Lors du premier démarrage, l'installation des programmes se termine et l'initialisation de nombreux paramètres ont lieu.
- Si le serveur est un Windows 64 bit, assurez vous que le répertoire suivant existe : "c:\Windows\SysWOW64\config\systemprofile\Desktop\". si non, créez le.
Commentaires
0 commentaire
Cet article n'accepte pas de commentaires.