Services Communauté Forum Documentation Contact : info@maarch.org +33 1 47 24 51 59

Maarch LetterBox/Guide d'installation et d'administration

De Maarch // Wiki.

Sommaire

Installation & configuration

Configurations pré requises

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

Configuration de PHP5

Maarch LetterBox nécessite PHP 5.0 au minimum et 5.2.x au maximum. Le fichier de configuration de PHP est php.ini.

Gestion des erreurs
 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.

Gestion des données
 register_globals = Off

Pour des raisons de sécurité, il est préférable de laisser ce paramètre à Off.

Session
 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.

Autoriser les balises PHP courtes
 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 Quotes
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.

Extensions dynamiques

Les extensions suivantes doivent être activées :

  • mysqli
  • GD ou GD2.


Configuration du serveur MySQL

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.

Installation de la solution

Création du DocServer

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).

Création et configuration de la Base de Données

Création de la base

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.

Picto infos.gif Vous devez avoir les droits de création et de modifications de base pour passer ces scripts. Dans le cas contraire, supprimez les 2 premières instructions (création et sélection de base) dans le fichier structure.sql .

Cela peut être fait en ligne de commande ou par l'intermédiaire de l'interface web PHPMyAdmin.

Warning.gif 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).
Warning.gif 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.

Configuration de la base

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.

Installation des fichiers PHP

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.

Configuration de l'application

fichier config.xml

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 :

  • Databaseserver : nom ou IP du serveur de base de données
  • databasename : nom de la base de données Maarch LetterBox
  • databaseuser : utilisateur Maarch LetterBox de la base de données
  • databasepassword : mot de passe de l'utilisateur Maarch LetterBox
  • nblinetoshow : nb de ligne pour les listes (recherche, admin,...)
  • limitcharsearch : nb de caractères minimal pour une recherche
  • lang : langue par défaut de Maarch LetterBox (fr ou en)
  • adminmail : mail de l'administrateur Maarch LetterBox
  • adminname : nom de l'administrateur Maarch LetterBox
  • enabledadvsearch : activation de la recherche avancée (true ou false)
  • enabledindexfile : activation de l'indexation (true ou false)
  • enabledvalidation : activation de la validation du courrier (true ou false)
  • enabledprocess : activation du traitement de courrier (true ou false)
  • enablestats : activation de la visualisation des statistiques (true ou false)
  • xmlpath : répertoire où sont stockés les fichiers de config xml
  • debug : affichage des variables de debug (true ou false)
  • applicationname : Nom de l'application affiché dans votre navigateur
  • css : fichier css de Maarch LetterBox
  • css_ie : fichier css de Maarch LetterBox propre à internet explorer
  • css_ie7 : fichier css de Maarch LetterBox propre à internet explorer 7
  • img : chemin du répertoire des images de Maarch LetterBox
  • MaarchURL : Url de Maarch LetterBox (utilisé pour la notification)
  • DefaultPage : page par défaut de Maarch LetterBox
  • exportlist : chemin vers le fichier de définition de l’export cs
  • CookieTime : Durée de la session Maarch LetterBox en minutes
  • RESOURCES : nom de la table de ressources, si des modifications sont effectuées ici, il ne faut pas oublier de modifier les droits d'accès aux ressources dans l'administration de l'application.
    • Tablename : identifiant de la table
    • Comment : commentaire associé à la table. Il sert dans la liste déroulante des collections de la recherche avancée.

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 :

Mlbag23fr-login.png

fichier history.xml

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.

fichier features.xml

Permet d'activer des fonctionalités complémentaires pour Maarch LetterBox

  • enablechangenotif : Permet l'envoi de mail lors de la redirection des documents
  • redirect_list : Remplace la redirection par la rediffusion
  • gdi_index : Numéro tampon (i.e. référence externe d'un document)
  • mail_for_answer_by_index_file : Envoi d'un mail au destinataire principal du document lors de l'ajout d'une réponse par le formulaire d'enregistrement
  • show_welcome_graph : Affiche le graphique sur la page d'accueil de Letterbox :: Désactivez ce paramètre si les performances de l'application se dégradent
  • search_max_size : Nombre d'occurrences maximum renvoyées par la recherche avancée
  • printsep : Impression des séparateurs de documents pour les services. Utilisé pour la numérisation de masse.
  • modifycopylist : Lors de la redirection, le destinataire principal devient copie + ajout possible de destinataires en copie depuis la page de traitement
  • update_limit_date : Permet la mise à jour de la date limite de traitement à l'ajout d'une nouvelle pièce jointe
  • tag100_for_copy : Tag la copie à 100 lors de la redirection ?????
  • collectivities : Active la gestion des collectivités. Dans les faits, cette option permet de regrouper des services dans des entités virtuelles de niveau supérieures.
  • action_waitingdoc : Autorise la mise en attente d'une affaire durant la phase de traitement.
  • before_waiting_doc : Autorise la mise en attente d'une affaire durant la qualification.
  • mail_for_new_note : Envoi d'un mail lors de l'ajout d'une annotation
fichier extensions.xml

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>
fichier letterbox.xml

Dans ce fichiers, plusieurs sections permettent de définir :

  • les civilités (M., Mme, etc.)
    • Ex : <CIV>M.</CIV>
  • les natures de courrier (recommandé, coursier, etc.)
    • Ex : <NAT>Courrier simple</NAT>
  • les quartiers de l'agglomération (pour les collectivités, utilisé dans les informations complémentaires d'une affaire.
    • Ex : <QUA>Bords de Seine</QUA>

Administration de Maarch LetterBox

On accède à l'administration de Maarch LetterBox en cliquant sur « Administration » dans le menu puis « Sommaire » :

Mlbag23fr-accueil.png

Mlbag23fr-menu.png

Mlbag23fr-pannadmin.png

Services

Liste des services

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les services » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-servlist.png

Les actions possibles sur services

  • Modifier les informations d'un service
  • Supprimer un service
  • Ajouter un nouveau service

Création / Modification d'un service

Mlbag23fr-servmod.png

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 :

Mlbag23fr-listdiffmod.png

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 ».

Suppression d'un service

Mlbga23fr-servdel.png

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.


Collectivités

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.

Picto infos.gif Cette fonctionnalité permet de regrouper des services au sein d'entités supérieures, un service pouvant appartenir à plusieurs entités. Si vous souhaitez utiliser cette fonctionnalité mais que le terme "collectivité" ne vous convient pas, vous pourrez le remplacer par le terme de votre choix dans le fichier addon_collectivities_lang_fr.php

Groupes

Liste des groupes

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les groupes » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-groupeliste.png

Les actions possibles sur les groupes :

  • Modifier les informations d'un groupe
  • Suspendre / Autoriser un groupe
  • Supprimer un groupe
  • Ajouter un nouveau groupe

Modifier / Ajouter un groupe

Création / Modification d'un groupe : mode simple :

Mlbag23fr-groupemodsimple.png

Création / Modification d'un groupe : Mode avancé :

Mlbag23fr-groupemodav.png

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 :

  • Droits d'administration : permet l'accès au menu « Administration »
  • Droit de paramétrage : permet l'accès au menu « Paramétrage »
  • Droit de modification : Autorise la modification des index sur la page d'accueil
  • Droits visualisation statistiques : permet l'accès au menu « Statistiques »
  • Droits visualisation courrier en retard : enrichit la recherche avancée en rajoutant 2 nouveaux statuts : 1ere relance et retard
  • Droits d'export : permet d'exporter les résultats de recherche au format CSV
  • Droits d'impression : permet d'imprimer les résultats de recherche, la liste des documents présents dans une bannette, ainsi que les fiches détail
  • Droits de suppression : permet de supprimer un document

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 :

  • Mode simple : création automatique à l'aide des listes de services (bouton « Droits de consultation » coché)
  • Mode avancé : création manuelle, comme dans le Framework Maarch. Le mode simple permet de créer rapidement des groupes dont les droits porteront sur les services destinataires. Le mode avancé permet une gestion plus fine des droits. (bouton « Autres droits » coché)
Mode Avancé

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 :

  • Suppression
  • Ajout
  • Mise à jour des droits

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 ».

Utilisateurs

Liste des utilisateurs

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les utilisateurs » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-userlist.png

Les actions possibles sur les utilisateurs :

  • Modifier les informations d'un utilisateur
  • Suspendre / Autoriser un utilisateur
  • Supprimer un utilisateur
  • Ajouter un nouvel utilisateur

Modifier / Ajouter un utilisateur

Mlbag23fr-usermod.png

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 :

  • Supprimer l'utilisateur d'un groupe
  • Ajouter l'utilisateur à un groupe existant
  • Choisir le groupe primaire de l'utilisateur
  • Gérer les absences (pour un utilisateur déjà crée) : permet en cas d'absence de rediriger les courriers vers une autre personne.

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 ».

Bannettes

Liste des bannettes

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les bannettes » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-corblist.png

Les actions possibles sur bannettes

  • Modifier les informations d'une bannette
  • Supprimer une bannette (seulement pour les bannettes non génériques)
  • Ajouter une nouvelle bannette

Modifier / Ajouter une bannette

Mlbag23fr-corbmod.png

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 :

  • @user: est remplacé par l'identifiant de l'utilisateur courant
  • @groupuser: est remplacé par l'identifiant du groupe primaire de l'utilisateur courant
  • @entities : remplacé par le service de l'utilisateur courant
  • @my_entity : remplacé par la liste des services auxquels l'utilisateur a accès

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 :

Mlbag23fr-corbassgroup.png

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 :

  • Traitement du courrier
  • Validation courrier
  • Courriers en copie
  • Services autorisés

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.

Historique

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Visualiser l'historique » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

Mlbag23fr-histo.png

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.

Réouverture de courrier

Mlbag23fr-reopen.png

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 ».


Paramétrage de Maarch LetterBox

Les utilisateurs autorisés (dont le groupe primaire a le droit de paramétrage) ont accès au menu "paramétrage".

Mlb26-menuparam.png

Mlb26-parampanel.png

Types de documents

Liste des types de documents

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les types de documents » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-typelist.png

Les actions possibles sur les types de documents :

  • Modifier les informations d'un type
  • Supprimer un type
  • Ajouter un nouveau type

Modifier / Ajouter un type de document

Mlbag23fr-typemod.png

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.

Modèles de document

Les modèles de document permettent la génération de réponse lors du traitement d'un courrier.

Liste des modèles

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les modèles » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d'administration

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 ».

Mlbag23fr-modliste.png

Les actions possibles sur les modèles

  • Modifier les informations d'un modèle
  • Supprimer un modèle
  • Ajouter un nouveau modèle

Modifier / Ajouter un modèle

Mlbag23fr-modmod.png

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 ».

Émetteurs/Expéditeurs

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.

Liste

Vous pouvez accéder à cette page de deux façons :

  • Cliquer sur le lien « Gérer les émetteurs » dans le menu déroulant
  • Cliquer sur le lien à partir de la page d’administration

Mlbag23fr-emetliste.png

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

  • Modifier les informations d’un émetteur
  • Supprimer un émetteur
  • Ajouter un nouvel émetteur

Création / Modification

Mlbag23fr-emetmod.png

Seul le nom est obligatoire. Toutes les autres informations sont facultatives.

Utilisation des scripts de notification

Maarch LetterBox offre 3 types d'alertes différentes :

  • Arrivée de nouveaux courriers à traiter ou en copie (notif.php)
  • Notification qu'il ne reste qu'une semaine pour le traitement (relance1.php)
  • Notification du courrier en retard (relance2.php)

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.

Paramétrage des scripts : fichier config_notif.xml

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.

  • <CONFIG>
    • <databaseserver> : Nom de votre serveur de base de données
    • <databasename> : Nom de la base de données Maarch LetterBox
    • <databaseuser> : Utilisateur de la base de données
    • <databasepassword> : Mot de passe de la base de données
    • <lang> : Langue choisie, pour l'instant seulement le français est disponible (fr)
    • <mailfrom> : Mail utilisé pour la notification
    • <debug> : Activation du mode debug (true/false)
    • <UNIXserver> : Serveur de type Unix ou non (true/false)
    • <MaarchDirectory> : Chemin de l'application Maarch : doit se terminer par un slash
    • <MaarchURL> : URL de l'application Maarch LetterBox
  • <TABLENAME>
    • <doctypes>  : Table contenant les types de documents gérés (demande, réunion, plainte...)
    • <history> : Table historique des transactions sur la base penser à la vider quand elle devient trop grosse
    • <listinstance> : Table contenant les différentes listes de diffusion selon le type de documents
    • <users> : Table des utilisateurs
    • <services>  : Table des services
  • <RESOURCES> (nom de la table de ressources)
    • <tablename>  : Table contenant les informations sur les documents
    • <comment> : Commentaire sur la table

Activation des scripts sous Windows

Sous Windows, le moyen le plus simple est de créer une tache planifiée.

Etape 1 : Créer un fichier bat

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

Etape 2: Créer une tache planifiée

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 ».

Mlbag23en-step1.png

Cliquez sur le bouton « Parcourir » et choisissez le fichier bat que vous venez de créer.

Mlbag23en-step2.png

Nommez ensuite la nouvelle tache comme vous le souhaitez puis choisissez « Tous les jours ».

Mlbag23en-step3.png

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.

Activation des scripts sous Linux/Unix

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
Outils personnels
Language