Guide de démarrage

Ce guide a pour but d'aider les utilisateurs à prendre le logiciel en main facilement. Il contient les informations nécessaires au bon usage du logiciel.

Installation et préparation à l'utilisation du logiciel

• Télécharger et installer node.js
• Depuis l'invite de commande, se placer dans le répertoire contenant le logiciel
• Installer les modules requis avec les commandes suivantes:npm install caporal, npm install fs, npm install vega, npm install vega-lite, npm install colors, npm install async
• Les boîtes mails à analyser (dossier portant le nom d'un collaborateur et contenant ses mails) doivent être placés dans le répertoire du logiciel.

Utilisation du logiciel et des commandes

Pour voir l'ensemble des commandes que le logiciel peut effectuer, il faut écrire la commande suivante dans l'invite de commande: node AnalyseEmail.js. Cela vous affichera un petit guide des différentes possibilités du logiciel. Pour avoir plus d'informations à propos d'une commande en particulier, il suffit d'ajouter l'option -h à la fin de la commande (par exemple node AnalyseEmail.js topObjects -h).
Voici la liste des commandes du logiciel avec leurs arguments et les options disponibles:

topObjects
Renvoi le top 10 des termes les plus utilisés dans les objets des emails d'un collaborateur.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
<email> Adresse mail du collaborateur requis
Options :
-e, --export <répertoire> Exporte le résultat dans un fichier texte optionnel

topContacts
Renvoi le top 10 des contatcs les plus sollicités par un collaborateur.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
<email> Adresse mail du collaborateur requis
Options :
-e, --export <répertoire> Exporte le résultat dans un fichier texte optionnel

nbEmails
Renvoi le nombre de mails échangés sur une période donnée.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
<email> Adresse mail du collaborateur requis
Options :
-b, --dateStart <dateStart> Permet d'ajouter la date de début d'analyse (format: MM/JJ/AAAA) optionnel
-s, --dateStop <dateStop> Permet d'ajouter la date de fin d'analyse (format: MM/JJ/AAAA) optionnel

buzzyDays
Renvoi les mails envoyés dans des buzzydays (mails envoyés le week-end ou entre 22h et 8h en semaine).
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
Options :
-e, --export <répertoire> Exporte le résultat dans un fichier texte optionnel
-b, --dateStart <dateStart> Permet d'ajouter la date de début d'analyse (format: MM/JJ/AAAA) optionnel
-s, --dateStop <dateStop> Permet d'ajouter la date de fin d'analyse (format: MM/JJ/AAAA) optionnel

graph
Exporte un graphique du nombre d'échange effectués par un collaborateur avec les autres collaborateurs au format svg.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
<email> Adresse mail du collaborateur requis
<dateStart> Date de début d'analyse requis
<dateStop> Date de fin d'analyse requis
<export> Répertoire dans lequel exporter le résultat requis

find
Effectue une recherche de mails selon un terme particulier (utilisé en objet), un nom ou un surnom.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
Options :
-o, --object <objet> Permet de rechercher les mails contenant un terme particulier en objet optionnel
-n, --name <nom> Permet d'ajouter un nom comme critère de recherche optionnel
-s, --surname <surnom> Permet d'ajouter un surnom comme critère de recherche optionnel
-e, --export <répertoire> Exporte le résultat dans un fichier texte optionnel

extraire
Exporte un mail au format txt
Arguments :
<fichier> fichier correspondant à l'email à exporter requis
<répertoire> Répertoire dans lequel exporter le mail requis

addressBook
Renvoi le carnet d'adresses d'un collaborateur.
Arguments :
<répertoire> Répertoire contenant les mails du collaborateur requis
<email> Adresse mail du collaborateur requis
Options :
-e, --export <répertoire> Exporte le résultat dans un fichier texte optionnel