Recent changes to User_Guide

User_Guide modified by Alexandre Tarabah

Alexandre Tarabah — Sat, 16 Jan 2021 18:53:05 -0000

--- v3
+++ v4
@@ -6,12 +6,12 @@

 Vous trouvez dans ce guide une explication pour installer les dépendances nécessaires, utiliser les commandes, et obtenir des outputs utilisables dans vos rapports d’analyse de mail. 

-1. Explication du logiciel 
+** Explication du logiciel **

 Ce logiciel permet, grâce à des commandes développées par notre équipe, de répondre a tous les besoins énumérés dans le cahier des charges, et qui a terme permettront d’extraire des informations essentielles sur un ensemble de mail (Nombre échangé, graphique représentant les proportions par personne etc..).


-2. Installation : 
+** Installation  **

 Ce logiciel a été testé dans son intégralité sur Mac OS et Windows. Par conséquent, nous n’assurons pas un fonctionnement idéal sur Linux, bien qu’au vue des commandes développées celui-ci devrait fonctionner normalement.
 Vous allez avoir en votre possession un dossier, rendez-vous dans le dossier trunk qui comprend : 
@@ -23,7 +23,7 @@

 Important : Vous devrez vous placer dans le dossier code_source pour lancer le logiciel.

-3.Utilisation 
+**Utilisation **

 Ainsi, il faut sur votre machine l’utilitaire nodeJS. Par l’intermédiaire d’un terminal, rendez-vous dans le dossier code_source, pour utiliser les commandes voici la forme générale que vous utiliserez « node » suivi de :

User_Guide modified by Alexandre Tarabah

Alexandre Tarabah — Sat, 16 Jan 2021 18:50:31 -0000

--- v2
+++ v3
@@ -7,7 +7,7 @@
 Vous trouvez dans ce guide une explication pour installer les dépendances nécessaires, utiliser les commandes, et obtenir des outputs utilisables dans vos rapports d’analyse de mail.

 1. Explication du logiciel 
-2. 
+
 Ce logiciel permet, grâce à des commandes développées par notre équipe, de répondre a tous les besoins énumérés dans le cahier des charges, et qui a terme permettront d’extraire des informations essentielles sur un ensemble de mail (Nombre échangé, graphique représentant les proportions par personne etc..).

User_Guide modified by Alexandre Tarabah

Alexandre Tarabah — Sat, 16 Jan 2021 18:49:58 -0000

--- v1
+++ v2
@@ -1,7 +1,6 @@
 GUIDE UTILISATEUR DU LOGICIEL DE PARSING 
 développé par A2VCCorp

-Rédigé par Alexandre Tarabah

 Bonjour, et bienvenue dans ce guide destiné aux utilisateurs qui vous permettra d’utiliser notre logiciel rapidement, et d’obtenir les meilleurs résultats de façon optimale.

User_Guide modified by Alexandre Tarabah

Alexandre Tarabah — Sat, 16 Jan 2021 18:47:26 -0000

GUIDE UTILISATEUR DU LOGICIEL DE PARSING
développé par A2VCCorp

Rédigé par Alexandre Tarabah

Bonjour, et bienvenue dans ce guide destiné aux utilisateurs qui vous permettra d’utiliser notre logiciel rapidement, et d’obtenir les meilleurs résultats de façon optimale.

Vous trouvez dans ce guide une explication pour installer les dépendances nécessaires, utiliser les commandes, et obtenir des outputs utilisables dans vos rapports d’analyse de mail.

Explication du logiciel
Ce logiciel permet, grâce à des commandes développées par notre équipe, de répondre a tous les besoins énumérés dans le cahier des charges, et qui a terme permettront d’extraire des informations essentielles sur un ensemble de mail (Nombre échangé, graphique représentant les proportions par personne etc..).
Installation :

Ce logiciel a été testé dans son intégralité sur Mac OS et Windows. Par conséquent, nous n’assurons pas un fonctionnement idéal sur Linux, bien qu’au vue des commandes développées celui-ci devrait fonctionner normalement.
Vous allez avoir en votre possession un dossier, rendez-vous dans le dossier trunk qui comprend :

Le dossier code_source : contient tous les fichiers en javascript qui sont la base du logiciel.
Le dossier donnéesSujetB qui contient tous les mails récupérer des boites mails a sonder.
Le dossier node_modules qui contient tous les modules nodeJS nécessaire au fonctionnement.
Le dossier vCards qui est nécessaire pour une fonction particulière : l’exportation en VCards.

Important : Vous devrez vous placer dans le dossier code_source pour lancer le logiciel.

3.Utilisation

Ainsi, il faut sur votre machine l’utilitaire nodeJS. Par l’intermédiaire d’un terminal, rendez-vous dans le dossier code_source, pour utiliser les commandes voici la forme générale que vous utiliserez « node » suivi de :

▸ caporalCli.js <command> [ARGUMENTS...] [OPTIONS...]

A noté que vous avez accès a plusieurs command qui sont les suivantes :

: checkOneFile

le fichier à vérifier doit se trouver dans le dossier code_source

: checkAllFiles
vérifie si le dossier ne contient que des fichiers mails valides

args : <name> : name of the interlocutor (arnold-j || campbell-l)</name>

: readMe

permet d'afficher le fichier README.txt

: topInterlocutors
FR : retourne une liste des interlocuteurs classés par nombre de mails échangés.

args : <name> : nom de l'interlocuteur (arnold-j || campbell-l)
args : <number> : nombre d'interlocuteurs affichés</number></name>

consultObj

consulter les termes les plus utilisés dans les objets des mails, représentés par un graphique vega-lite

args : <path> : name of a interlocutor / nom de l'interlocuteur (arnold-j || campbell-l)
args : [n] : number of word displayed / nombre de mots affichés</path>

: consultListMails
FR : consulter une liste de mails filtrée selon des critères choisis par l'utilisateur

args : <name> : name of a interlocutor / nom du collaborateur (arnold-j || campbell-l).
args : <criteria> : the criteria chosen / critère (date, from, to, cc, bcc, subject, messageID).
args : <value>', 'The value of the criteria in quotes / valeur du critère choisi (entre guillements) (ex: date = "Mon, 18 Dec 2000 08:10:00 -0800 (PST)")</value></criteria></name>

exemple d’utilisation de cette commande :
node caporalCli.js arnold-j date "Mon, 18 Dec 2000 08:10:00 -0800 (PST)"

: getSenderInfos
FR : Extrait d'un mail les informations de l'expéditeur et les exporte sous le format Vcard

args : <name> : name of a interlocutor / nom du collaborateur (arnold-j || campbell-l).
args : <messageid> : messageid of the mail chosen, between quotes / numéro d'identification du message
entre guillemets </messageid></name>

exemple de typo pour messageid :
messageid = "5446449.1075857594451.JavaMail.evans@thyme"

: readMail
FR : Affiche un mail dans la console

args : <name> : name of a interlocutor / nom du collaborateur (arnold-j || campbell-l).
args : : messageID of the mail chosen / numéro d'identification du message entre guillemets </name>

exemple de typo pour m :
"5446449.1075857594451.JavaMail.evans@thyme"

Pour de plus amples informations, veuillez-vous référer au fichier README.txt, inclus dans code_source.
Les graphiques vega-lites seront exportés directement dans le dossier code-source, avec un nom prédéfini.