Sommaire
|
Nous vous conseillons vivement l'installation de XAMPP (dans une version inférieure à 1.7.2), dont le module d'installation permet d'installer sur une machine vierge les bonnes versions de PHP, MySQL, et Filezilla. Le site de référence de XAMPP est ici : http://www.apachefriends.org/fr/index.html
Maarch LetterBox nécessite PHP 5.0 au minimum et 5.2.x au maximum. Le fichier de configuration de PHP est php.ini.
error_reporting = E_ALL & ~E_NOTICE display_errors = on
PHP vous montrera ainsi toutes les erreurs qu'il rencontrera dans les scripts. Une fois votre serveur en production, mettez display_errors à off.
register_globals = Off
Pour des raisons de sécurité, il est préférable de laisser ce paramètre à Off.
session.save_path = "T:\TEMP\SessionsPHP" session.auto_start = 0 session.bug_compat_42= off session.bug_compat_warn= off
Renseignez ici le répertoire de stockage des fichiers de sessions (adaptez le chemin en fonction de votre configuration). Par défaut gérées en mode fichier. auto_start est à faux, il
est préférable de le laisser ainsi.
short_open_tag = On
Cela permet d'accepter également les balise <? en plus des balise <?php. Si ce paramètre est à Off, l'application ne démarre pas.
Magic_quote_gpc = On
Si les magic_quotes_gpc sont à Off, Maarch LetterBox ne fonctionnera pas.
Dans la version 1.7 de Xampp ce tag n'existe plus.
Les extensions suivantes doivent être activées :
Maarch LetterBox est compatible avec MySQL à partir de la version 4.x. Le connecteur ODBC pour MySQL est nécessaire sur le serveur hébergeant le module d'auto import pour le fonctionnement des scripts de chargement.
Le DocServer est le répertoire où sont stockés les fichiers indexés dans Maarch LetterBox. Il faut donc qu'il soit accessible en lecture et en écriture pour le serveur Apache. Il faut donc que le propriétaire de ce répertoire soit l'utilisateur qui lance Apache (il faut au moins qu'il appartienne au groupe Apache).
Importer le fichier sql structure.sql qui va créer la base de données et les tables de l'application, puis le fichier data_minimal_fr.sql ou le fichier data_demo_fr.sql. data minimal contient juste un administrateur alors que data demo contient un certain nombre d'utilisateurs, services et groupes pour une utilisation immédiate.
Cela peut être fait en ligne de commande ou par l'intermédiaire de l'interface web PHPMyAdmin.
| | PHPMyAdmin ne gérant pas correctement l'utf-8, nous vous conseillons de ne pas l'utiliser pour injecter les scripts sql dans la base (un correctif se trouve sur les forums de Développez.net). |
| | Pour améliorer la gestion de l'utf-8 par phpMyAdmin, une solution semble être non pas de modifier les fichiers de phpmyadmin mais directement la section [mysqld] du fichier my.cnf comme expliqué dans le forum ubuntu et s'assurer que le jeu de caractère est bien utf8_unicode_ci :
1. A l'aide de Notepad++, donner le format utf-8 sans BOM aux fichiers structure.sql et data_minimal_fr.sql (BOM différent entre Windows et Linux). 2. Dans le fichier structure.sql, preciser pour toutes les tables : ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci 3. Editer le fichier my.cnf et ajouter dans la section [mysqld] : # utf8 init-connect='SET NAMES utf8' character-set-server=utf8 collation-server=utf8_unicode_ci 4. Redémarrer apache2 et mysql. 5. Sur l'écran de connexion de phpMyAdmin, choisir la langue Français - French (utf-8). 6. Une fois connecté, fixer la variable Interclassement pour la connexion MySQL à la valeur utf8_unicode_ci. 7. Il n'y a plus qu'à utiliser la commande Importer, en vérifiant que le jeu de caractère du fichier est bien sur utf-8. |
Il faut ensuite modifier le chemin du DocServer dans la base. Il faut mettre le chemin du DocServer dans le champ PATH_TEMPLATE de mondocserver de la table docservers.
NB : Attention à bien terminer le chemin par un slash.
Il faut placer le dossier letterbox dans le répertoire racine du serveur Apache (ou de votre serveur web). Ce dossier contient les fichiers PHP et les fichiers de paramètres de l'application.
Comme pour le DocServer, il est important de partager le répertoire letterbox/tmp si vous utilisez l’application en réseau. Et si vous utilisez Linux, il faut également que l’utilisateur Apache ait les droits de lecture et d’écriture sur ce répertoire.
Il faut ensuite correctement paramétrer le fichier de configuration : dans le dossier letterbox/xml, renommez le fichier config.xml.default en config.xml.
Pour une installation rapide, remplissez les informations
concernant la base de données (databaseserver,
databasename, databaseuser et
databasepassword).
Description des balises du fichier config.xml :
Pour tester que l'application est bien installée et correctement configurée, tapez l'adresse URL correspondante dans un navigateur Web, vous devez accéder à la page de login :
Ce fichier permet de définir quels évements doivent être historisés. Par défaut, tous le sont. Vous pouvez désactiver ceux que vous ne souhaitez pas dans ce fichier.
Permet d'activer des fonctionalités complémentaires pour Maarch LetterBox
C'est dans ce fichier que sont définis les types de documents qui peuvent être enregistrés dans l'application.
Par défaut, la majorité des types de documents bureautiques et multimédia sont activés.
Exemple pour le format PDF :
<FORMAT> <name>PDF</name> <mime>application/pdf</mime> </FORMAT>
Dans ce fichiers, plusieurs sections permettent de définir :
On accède à l'administration de Maarch LetterBox en cliquant sur « Administration » dans le menu puis « Sommaire » :
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les services. Comme pour les groupes et les utilisateurs, les services sont classés par ordre alphabétique. En cliquant sur une des lettres visibles, seuls les services commençant par cette lettre sont affichés. Il est possible de chercher un service quand on connaît son identifiant en tapant son identifiant ou le début de son identifiant dans la boîte de recherche. La liste des services est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur services
L'identifiant et la description du service sont obligatoires.
Une fois un service créé, comme pour les groupes et les utilisateurs, pour des raisons de cohérence, on ne peut plus modifier son identifiant. L'identifiant d'un service est composé de lettres et de chiffres uniquement.
Il est possible d'associer un modèle de liste de diffusion à chaque service, mais ce n'est pas obligatoire. Cette liste sera automatiquement présentée à l'indexation dés le choix du service. Bien entendu, lors de l'indexation la liste de diffusion sera modifiable. Les modèles de liste sont une aide à l'enregistrement de courrier.
Pour créer ou modifier une liste de diffusion cliquez sur le bouton « Créer la liste » ou « Modifier la liste », la fenêtre suivante s'ouvre alors :
Pour ajouter des nouveaux utilisateurs à la liste, il suffit de cliquer sur « Ajouter » au niveau de celui que vous souhaitez ajouter. Pour modifier la liste existante, vous pouvez supprimer des utilisateurs de la liste en cliquant sur « Supprimer » et enfin réorganiser les utilisateurs en cliquant sur les boutons « Descendre » et « Monter ».
Vous ne pouvez pas supprimer un service qui possède des documents, vous devez réaffecter les documents à un autre service. En effet, il est important que les documents appartiennent à un service existant pour qu'on puisse y accéder.
Ce menu n'apparaitra que si l'option collectivities est activée dans feature.xml.
Les collectivités sont définies dans le fichier collectivities.xml :
Exemple :
<ELEMENT> <ID>COLL1</ID> <LABEL>Collec A</LABEL> </ELEMENT>
Le panneau d'administration des collectivités permet d'associer des services à chaque collectivités.
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les groupes. Tous les groupes sont classés par identifiant par ordre alphabétique. En cliquant sur une des lettres visibles, seuls les groupes commençant par cette lettre sont affichés. Il est possible de chercher un groupe quand on connaît son identifiant en tapant son identifiant dans la boîte de recherche. La liste des groupes est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur les groupes :
Création / Modification d'un groupe : mode simple :
Création / Modification d'un groupe : Mode avancé :
Les informations obligatoires sont le groupe (correspond à l'identifiant groupe) et au moins un accès défini.
Une fois un groupe créé, pour des raisons de cohérence, on ne peut plus modifier son identifiant. L'identifiant d'un groupe est composé de lettres et de chiffres seulement.
La description permet de renseigner le rôle du groupe, elle est utile mais pas obligatoire.
Les cases à cocher représentent des droits fonctionnels :
Un « accès à une ressource » est en fait une restriction sur les documents contenus dans la base. Un accès est donc composé d'un nom de table de la base de données, d'une clause Where et de la présence ou non des droits d'insertion et de mise à jour.
Il y a deux modes de création d'accès :
La clause Where est une clause de restriction SQL sans le mot « Where ». Si elle est vide, cela signifie que le groupe a accès à tous les documents de la table. Une fois un accès créé, on ne peut plus le modifier, il faut en recréer un nouveau.
Les actions possibles sur les accès :
A chaque fois que l'on modifie les droits d'insertion et de mise à jour sur un ou plusieurs accès, il faut cliquer sur le bouton « Mise à jour des droits » pour qu'ils soient bien pris en compte.
Une fois tous les changements terminés, il faut valider en appuyant sur le bouton « Accepter les changements ». Si c'est une création de groupe, valider en appuyant sur le bouton « Ajouter un groupe ».
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les utilisateurs. Comme pour les groupes, les utilisateurs sont classés par ordre alphabétique. En cliquant sur une des lettres visibles, seuls les utilisateurs commençant par cette lettre sont affichés. Il est possible de chercher un utilisateur quand on connaît son nom en tapant son nom ou le début de son nom dans la boîte de recherche. La liste des utilisateurs est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur les utilisateurs :
Les informations obligatoires sont l'identifiant, le nom, le prénom, le service, le mail et le groupe primaire.
Une fois un utilisateur créé, comme pour les groupes, pour des raisons de cohérence, on ne peut plus modifier son identifiant. L'identifiant d'un utilisateur est composé de lettres et de chiffres uniquement.
Les autres champs sont facultatifs. Le champ Service est affiché entre parenthèses à coté du nom de l'utilisateur en haut à droite de l'écran, dans la barre de situation dans la page d'accueil.
Un utilisateur peut appartenir à plusieurs groupes, il est donc important de définir son groupe primaire. En effet, le groupe primaire a une importance capitale pour l'utilisation des bannettes.
Les actions possibles sur les groupes :
Quand un nouvel utilisateur est créé, son mot de passe est "test". Il lui sera demandé de le changer à sa première connexion.
Il est possible de réinitialiser le mot de passe d'un utilisateur en cliquant sur le bouton « Réinitialisation mot de passe ». Le nouveau mot de passe est alors "demo". L'utilisateur devra à nouveau changer son mot de passe à sa première connexion.
Une fois tous les changements terminés, il faut valider en appuyant sur le bouton « Modifier l'utilisateur ». Si c'est une création de groupe, valider en appuyant sur le bouton « Ajouter l'utilisateur ».
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les bannettes. Comme pour les groupes et les utilisateurs, les bannettes sont classées par ordre alphabétique. En cliquant sur une des lettres visibles, seules les bannettes commençant par cette lettre sont affichées. Il est possible de chercher une bannette quand on connaît son identifiant en tapant son identifiant ou le début de son identifiant dans la boîte de recherche. La liste des bannettes est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur bannettes
Une fois une bannette créé, comme pour les groupes et les utilisateurs, pour des raisons de cohérence, on ne peut plus modifier son identifiant. L'identifiant d'une bannette est composé de lettres et de chiffres uniquement.
La bannette correspond au nom de la bannette qui sera affichée dans toute l'application, elle est donc obligatoire.
La description n'est pas obligatoire.
La table correspond à la collection documentaire, Maarch LetterBox ne contient pour le moment qu'une seule collection, la collection 'Courriers'.
Le champs « Vue sur la table » est en fait une clause de restriction SQL sans le mot clé « Where » (comme pour le mode avancé de la gestion des groupes). Si elle est vide, cela signifie que la bannette renverra tous les documents de la table.
Il y a 2 variables que l'on peut utiliser dans la clause where qui sont propres à Maarch :
Enfin, pour qu'une bannette soit efficace, il faut l'associer à des groupes d'utilisateurs. En effet, un utilisateur a accès à toutes les bannettes qui ont été associées à son groupe primaire.
Pour associer un nouveau groupe, cliquez sur le bouton « Associer un nouveau groupe à la bannette », la fenêtre suivante s'ouvre :
Il faut d'abord choisir le groupe dans la liste déroulante. Ensuite choisir ou non d'autoriser la redirection dans cette bannette. Si la case redirection est cochée, il faut ensuite déterminer vers quels services et quels groupes d'utilisateurs la redirection est possible. Enfin, il faut déterminer la page de résultat, c'est-à -dire la page qui sera utilisée pour l'affichage de la bannette.
Il y a 4 pages disponibles pour le moment :
Une fois toutes les informations remplies, il faut cliquer sur le bouton « Ajouter le groupe ».
Le nom du groupe apparait alors dans la liste des groupes associés. Pour modifier des paramètres liés à un groupe, cliquez sur le nom du groupe et la fenêtre ci-dessus apparait.
Une fois le paramétrage de la bannette terminé, n'oubliez pas de cliquer sur le bouton « Modifier la bannette », sinon les paramètres (y compris les groupes associés) ne seront pas pris en compte.
Vous pouvez accéder à cette page de deux façons :
Les événements tracés dans l'historique dépendent des choix faits dans le fichier de configuration config.xml.
L'historique se présente sous la forme d'une liste paginée. On peut trier cette liste sur la date de l'événement, l'utilisateur responsable de l'événement, la table concernée et le type d'action. On peut ainsi avoir accès rapidement aux informations que l'on recherche.
En cas d'erreur d'un utilisateur qui aurait clôturé un courrier trop vite, il est toujours possible à l'administrateur de « rouvrir » ce courrier. Il lui suffit de rentrer le numéro GED du courrier et de cliquer sur le bouton « Modifier le statut ».
Les utilisateurs autorisés (dont le groupe primaire a le droit de paramétrage) ont accès au menu "paramétrage".
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les types de documents. Comme pour les groupes et les utilisateurs, les types de documents sont classés par ordre alphabétique. En cliquant sur une des lettres visibles, seuls les types commençant par cette lettre sont affichés. Il est possible de chercher un type quand on connaît son identifiant en tapant son identifiant ou le début de son identifiant dans la boîte de recherche. La liste des types de documents est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur les types de documents :
Toutes les informations demandées sont obligatoires.
Une fois un type de document créé, comme pour les groupes et les utilisateurs, pour des raisons de cohérence, on ne peut plus modifier son identifiant. L'identifiant d'un type est composé de lettres et de chiffres uniquement.
Les types de document dépendent des collections documentaires, c'est pourquoi il faut choisir une collection. Par défaut, il n'y a qu'une seule collection dans Maarch LetterBox, la collection « Courriers ».
Le champ « Délai de traitement » correspond au nombre de jours maximum de traitement pour ce type. Il est calculé à partir de la date d'enregistrent du courrier dans la base.
Le champ « Délai première relance » est utilisé pour la notification. C'est le nombre de jours avant la date limite durant lequel la première notification est envoyée.
Le champ « Délai deuxième relance » correspond à la notification de retard. C'est le nombre de jours après la date limite durant lequel sera envoyée la notification.
Les modèles de document permettent la génération de réponse lors du traitement d'un courrier.
Vous pouvez accéder à cette page de deux façons :
C'est à partir de cette page que l'on gère les modèles. Comme pour les groupes et les utilisateurs, les modèles sont classés par ordre alphabétique. En cliquant sur une des lettres visibles, seules les modèles commençant par cette lettre sont affichés. Il est possible de chercher un modèle quand on connaît son identifiant en tapant son identifiant ou le début de son identifiant dans la boîte de recherche. La liste des modèles est paginée, il est possible de naviguer entre les pages à l'aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur les modèles
Le nom du modèle permettra de choisir, lors du traitement, quel type de réponse sera généré, il est donc obligatoire.
Il est possible d'ajouter des commentaires à un modèle, mais cela reste facultatif.
Maarch utilise une version personnalisée de l'éditeur de texte open source tiny_mce. Il est possible de placer des champs variables dans le modèle grâce à la liste déroulante « Maarch options ». Les éléments contenus dans cette liste correspondent à des informations associées au courrier lors de l'indexation ou du traitement. Ces champs seront automatiquement remplacés lors de la génération de la réponse par les informations correspondantes (dates, noms, etc...).
Les modèles sont associés aux services. Un modèle peut être associé à plusieurs services. Si un modèle n'est associé à aucun service, il ne sera jamais présenté lors du traitement.
Lors du traitement d'un courrier, la liste des modèles de réponse présentée correspond à tous les modèles associés au service destinataire du courrier.
Une fois les informations entrées, cliquez sur le bouton « Valider les changements ».
Les premiers sont les "émetteurs" des courriers que vous recevez. Ils vous permettent de pré-définir un certain nombre d'émetteurs plutôt institutionnels qui vous envoie du courrier très fréquemment.
Les expéditeurs permettent de définir une liste d'expéditeur récurrents utilisée lors de l'enregistrement du courrier sortant.
Ces deux écrans de paramétrage ont été regroupés dans cette doc parce que leur fonctionnement est semblable en tout point.
Vous pouvez accéder à cette page de deux façons :
C’est à partir de cette page que l’on gère les émetteurs. Comme pour les groupes et les utilisateurs, les émetteurs sont classés par ordre alphabétique. En cliquant sur une des lettres visibles, seuls les émetteurs commençant par cette lettre sont affichés. Il est possible de chercher un émetteur quand on connaît son nom en tapant son nom ou le début de son nom dans la boîte de recherche. La liste des émetteurs est paginée, il est possible de naviguer entre les pages à l’aide de la liste des pages ou des liens « Page Précédente » et « Page suivante ».
Les actions possibles sur émetteurs
Seul le nom est obligatoire. Toutes les autres informations sont facultatives.
Maarch LetterBox offre 3 types d'alertes différentes :
A ces 3 types d'alertes correspondent 3 scripts que vous pouvez choisir d'activer ou non selon vos besoins. Les scripts doivent être activés en mode batch quotidien, ils sont en effet conçus pour être lancés quotidiennement.
Il est nécessaire pour les notifications d'avoir un serveur mail actif.
Le fichier config_notif.xml permet de paramétrer tous les scripts de notifications. Il fonctionne sur le même principe que le fichier config.xml.
Sous Windows, le moyen le plus simple est de créer une tache planifiée.
Ce fichier va servir à lancer une commande php en ligne. Cette commande va correspondre au lancement du script de notifications.
Ouvrez un éditeur de texte simple (bloc notes ou wordpad) et tapez cette ligne (tout le texte est sur la même ligne) sur la même :
Chemin vers votre php.exe\php
"Chemin vers Maarch LetterBox\scripts connexions\nom du script à activer"
"Chemin vers Maarch LetterBox\scripts connexions\config_notif.xml"
Exemple avec xampp:
C:\ProgramsFiles\xampp\php\php
"C:\ProgramsFiles\xampp\htdocs\maarch_letterbox\scripts connexions\notif.php"
"C:\ProgramsFiles\xampp\htdocs\maarch_letterbox\scripts connexions\config_notif.php"
Enregistrer ensuite ce fichier avec l'extension bat, ex : script_notif.bat
Une tache planifiée, comme son nom l'indique, permet de programmer le lancement d'une application ou d'un script.
Pour cela ouvrez le « Panneau de Configuration » windows, puis cliquez sur « Taches planifiées », enfin cliquez sur « Créer une tache planifiée ».
Cliquez sur le bouton « Parcourir » et choisissez le fichier bat que vous venez de créer.
Nommez ensuite la nouvelle tache comme vous le souhaitez puis choisissez « Tous les jours ».
Choisissez l'heure de début de la nouvelle tâche. Nous vous conseillons de lancer la tâche à une heure où vous êtes certains qu'il n'y aura plus d'ajout de courrier. Choisissez ensuite à partir de quelle date vous souhaitez le lancer.
Cliquez ensuite sur « Suivant » et faites ce qu'on vous demande.
Vous devez recommencer tout le processus pour chaque notification que vous souhaitez activer.
Sous Linux, il n'y a pas besoin de faire un fichier bat et de créer une tache planifiée, il suffit de lancer le script PHP à partir de crontab.
Pour acceder à la configuration de crontab, ouvrez un terminal (console) et tapez :
~ $ crontab -e
Dans l'éditeur ouvert, il faut ajouter une ligne de ce type :
50 23 * * * Chemin_de_php Chemin_script_à _lancer (avec d'éventuels arguments)
Ici on lance le script tous les jours à 23h50.
Il faut rajouter autant de lignes dans la crontab que de scripts que l'on souhaite activer.
Pour avoir plus d'informations sur l'utilisation de crontab et sur la syntaxe des lignes à ajouter, ouvrez un terminal et tapez :
~ $ man crontab