Académique Documents
Professionnel Documents
Culture Documents
Version 3.3
openMairie
23 04 2014
ii
Note : Cette cration est mise disposition selon le Contrat Paternit-Partage des Conditions Initiales lIdentique
2.0 France disponible en ligne http ://creativecommons.org/licenses/by-sa/2.0/fr/ ou par courrier postal Creative
Commons, 171 Second Street, Suite 300, San Francisco, California 94105, USA.
openCourrier est un logiciel de gestion de courrier entrant et sortant dans une organisation. Il est conu pour
traiter simplement larrive et le dpart de courrier sans se substituer aux traitements existants dans les logiciels
mtier (factures, demande demploi, autorisation durbanisme, ...). Il rpond un besoin de gestion de courrier
centralise avec un suivi de la relation citoyen (gestion de tches) dans une organisation ayant un organigramme
de traitement de courrier assez plat avec de nombreux mtiers comme les mairies (organigramme en rateau). De
ce fait, il ne gre quune seule numrotation de registre de dpart et darrive. (Il existe sur la forge de ladullact
dautre logiciel libre de courrier pouvant grer une multiplicit de registre de dpart et darrive).
Ce document a pour but de guider les utilisateurs et les dveloppeurs dans la prise en main du projet.
Bonne lecture et nhsitez pas nous faire part de vos remarques ladresse suivante : contact@openmairie.org !
CHAPITRE 1
Manuel de lutilisateur
1.1.2 Ergonomie
Cette partie vise prsenter lergonomie du logiciel cest--dire dcrire la connexion lapplication, la structure
de lapplication, la navigation et lutilisation du menu, ainsi que la prsentation et la description des principaux
icnes. Cette rubrique peut sappliquer toute application mtier dveloppe avec OpenMairie.
1.1.2.1 Connexion, dconnexion et permissions
Connexion
Note : Pour raliser cette tape, votre administrateur doit vous fournir une adresse Web pour accder lapplication, un identifiant utilisateur ainsi quun mot de passe. Ces lments auront t pralablement configur dans le
logiciel.
1.1.2.1.1.1 Navigateur Web Lapplication est accessible via un navigateur Web, pour y accder il faut saisir
ladresse Web fournie par votre administrateur dans la barre dadresse.
Note : Ce logiciel est dvelopp principalement sous le navigateur Mozilla Firefox, il est donc conseill dutiliser
ce navigateur pour une efficacit optimale.
1.1.2.1.1.2 Saisie des informations de connexion Cet cran de connexion est compos de deux zones de texte
et dun bouton.
Dans lcran didentification, il faut saisir son identifiant et son mot de passe puis cliquer sur le bouton Se
connecter .
Note : Lidentifiant et le mot de passe doivent tre saisis en respectant la casse, cest--dire les minuscules et
majuscules.
1.1.2.1.1.3 Connexion choue Si les identifiants saisis sont incorrects, un message derreur apparat et il faut
ressaisir les informations de connexion.
1.1.2.1.1.4 Connexion russie Si les identifiants sont corrects, vous tes redirig vers la page demande sur
laquelle le message suivant doit dafficher.
Dconnexion
Pour une question de scurit vidente, il est important de se dconnecter de lapplication pour quun autre utilisateur ne puisse pas accder au logiciel via votre compte utilisateur.
Laction Dconnexion est disponible tout moment dans les actions personnelles en haut droite de lcran.
Une fois dconnect, cest le formulaire de donnexion qui saffiche avec un message expliquant la russite de la
dconnexion.
Les droits et profils des utilisateurs permettent de limiter laccs aux informations et aux actions uniquement aux
personnes autorises. Chaque utilisateur est associ un profil. Le profil correspond un ensemble de permissions
de lutilisateur, par dfaut il existe cinq profils :
1. Consultation,
2. Utilisateur limit,
3. Utilisateur,
4. Super utilisateur,
5. Administrateur.
Chaque page de lapplication est associe un profil. Pour chaque accs une page, lapplication vrifie si lutilisateur a un profil suprieur ou gal au profil de la page consulte, si cest le cas lutilisateur donc le droit
daccder aux informations.
1.1.2.2 Ergonomie gnrale
Lapplication, sur la grande majorit des crans, conserve ses composants disposs exactement au mme endroit.
Nous allons dcrire ici le fonctionnement et lobjectif de chacun de ces composants. Cette structuration de lapplication permet donc lutilisateur de toujours trouver les outils au mme endroit et de se reprer rapidement.
Note : Les actions et affichages de lapplication diffrent en fonction du profil de lutilisateur. Il se peut donc que
dans les paragraphes qui suivent des actions soient dcrites et napparaissent pas sur votre interface ou inversement
que des actions ne soient pas dcrites mais apparaissent sur votre interface.
Le logo
Cest le logo de lapplication, il vous permet en un seul clic de revenir rapidement au tableau de bord.
Les actions personnelles
Cet lment permet dafficher des raccourcis vers des crans auxquels nous avons besoin daccder trs souvent.
Par exemple, ici nous avons un raccourci direct vers le tableau de bord.
Le menu
Cet lment permet de classer les diffrents crans de lapplication en rubriques. En cliquant sur lentte de
rubrique, nous accdons la liste des crans auxquels nous avons accs dans cette rubrique.
Le nombre de rubriques disponibles dans le menu peut varier en fonction du profil des utilisateurs. Un utilisateur
ayant le profil Consultation naura probablement pas accs aux six rubriques prsentes sur cette capture.
Les actions globales
Cet lment permet dafficher en permanence le numro de version du logiciel. Ensuite les diffrentes actions sont
des liens vers le site officiel du logiciel ou vers la documentation.
1.1.2.3 Ergonomie des formulaires
De manire gnrale, il y a une rgle simple dans les applicatifs openMairie : on accde dabord un listing
dlments puis depuis ce listing on peut ajouter un nouvel lment ou modifier un lment existant en accdant
au formulaire ddi cet lment.
Les listings
Un listing est un tableau qui liste des lments rcapitulant des informations permettant didentifier un lment
parmi les autres.
1.1.2.3.1.1
Les actions
Autre : il peut y avoir dautres actions positionnes ici qui reprsentent des actions que lon peut faire sur un lot
dlments par exemple.
1.1.2.3.1.3 A gauche devant chaque lment
Modifier : cette action permet daccder au formulaire de modification dun lment.
Supprimer : cette action permet daccder au formulaire de suppression dun lment.
Autre : il peut y avoir dautres actions positionnes ici qui permettent deffectuer des actions rapides sur llment.
Les formulaires
Un formulaire dans cet applicatif peut soit tre soit dajout, soit de modification, soit de suppression.
Voici lexemple dun formulaire en mode modification.
10
Tlcharger ldition PDF Accus de rception (ce courrier est paramtrable via le menu (Administration
Etat)
Il est possible de crer ou modifier un courrier arrive dans le formulaire ci dessous.
11
Courrier dpart
Cette fonctionnalit est optionnelle dans lapplication, il est possible dactiver ou de dsactiver la fonctionnalit
dans le paramtrage (paramtrage de loption courrier dpart).
(Courrier Courrier dpart)
Ce sont les courriers sortants de lorganisation.
12
13
Rgles :
Il est noter que si un courrier scann est associ lors de lajout du dun courrier, il est rajout un enregistrement
dans la table dossier avec sur le scan en rouge, le numro de registre et sa date darrive.
Il est conseiller de rajouter un utilisateur spcifique pour le scan.
14
La liaison stablit par un numro commun aux courriers lis qui font chacun rfrence aux autres...
1.1.3.3 Saisir une tche
Cet onglet permet de saisir les tches associes aux courriers.
1.1. Manuel de lutilisateur
15
Il est propos de dcrire dans ce paragraphe la saisie dune tache associ un courrier arrive.
Il est saisi :
la date butoire
la date excution
le Solde : Oui si solde, Non sinon. (voir traitement : courrier -> taches non soldes)
le Service de traitement de la tache (les services fils ou sous service)
observations : Texte libre
Chrono ventuellement Texte libre ou courrier li (choix dans chronoreponse (fleche))
16
17
Rsultat de la recherche
18
Il est possible de modifier une tche non solde dans le formulaire ci dessous
(Saisir une tche)
19
20
1.1.4 Traitement
Nous vous proposons dans ce chapitre de mettre en oeuvre les traitements.
Contents
Traitement
La remise zro des registres
Larchivage des courriers
Les lments permettant le traitements des courriers sont disponibles dans la rubrique (Traitement) du menu.
21
Les archives ne sont pas modifiables et ne sont pas accessibles par le moteur de recherche. Elles sont uniquement
consultables via le menu (Courrier Archive) :
(Les archives)
1.1.5 Paramtrage
Le paramtrage permet dadapter openCourrier votre organisation.
Contents
Paramtrage
Tables de rfrences
Le service
Le correspondant (metteur / destinataire)
La bible
La civilit
Le type de correspondant
Le courrier type
Paramtres gnraux
Paramtres spcifiques dans le fichier dyn/var.inc
Paramtres spcifiques dans le fichier dyn/config.inc.php
22
Le service
(Paramtrage Service)
Il est propos de dcrire dans ce paragraphe la saisie dun service dans le menu paramtrage.
Les services sont lists dans loption service du menu paramtrage
23
Il est saisi :
code
libelle
diffusion oui/non (reoit ou non du courrier en traitement)
service pre (lien hirarchique)
Rgles :
seul un service pre peut attribuer des tches un service fils
paramtrage des services en om_utilisateur :
Le paramtrage service de lutilisateur est spcifique openCourrier
cas particulier :
En affectant tous service dans la case service, les droits de l utilisateur stend tous les services
Gestion des scan
Les scans dun utilisateur sont stocks dans le repertoire trs/collectivite/utilisateur
exemple : scan/1/2 pour om_collectivite=1 et om_utilisateur=2
Le correspondant (metteur / destinataire)
24
Il est saisi :
civilite
nom
prnom
adresse
complment
cp
ville
tlphone
type de correspondant
Note : Il est possible de crer un correspondant frquent/permanent directement depuis le formulaire de cration
de courrier en cochant la case cration metteur ou cration destinataire.
La bible
(Paramtrage Bible)
La bible sert complter lobjet dun courrier. Il est donc possible de stocker des phrases rutilisables lidentique
pour chaque courrier.
Les textes bibles sont lists dans le formulaire suivant
25
Il est saisi :
un libell affich en fentre lors de la saisie du courrier
un contenu rcupr dans objet_courrier lors de la saisie du courrier
La civilit
(Paramtrage Civilit)
La civilit correspond au titre de civilit dune personne. Elle est utilise dans lapplication lors de la saisie de
correspondants.
Lcran suivant permet de lister les diffrentes civilits ainsi que les actions possibles sur ces dernires.
26
Il est saisi :
le libell
Le type de correspondant
27
Il est saisi :
le libell du type de correspondant
Le courrier type
28
Il est saisi :
le libell du courrier type
une description du courrier type
1.1.5.2 Paramtres gnraux
Ce paramtrage permet de configurer certaines options spcifiques de lapplication. Il est accessible via le menu
(Administration Paramtre).
Voici le descriptif de ces paramtres :
paramtre
registre_arrivee
registre_depart
description
Par dfaut : [annee]-[seq]. Caractristique du registre dans notre cas 2012-0001.
Par dfaut : [annee]-D-[seq]. Caractristique du registre dans notre cas 2012-D-0001.
29
Télégramme,
);
// mode de stockage des fichiers binaires
$dossierparcentaine = 1;
...
?>
/**
* Configuration de la notification par mail des nouvelles taches attribuees aux utilisateurs du s
* Default : false
*/
$config[notification_email] = false;
/**
* Mail de notification
*/
$config[notification_email_title]=utf8_decode("OpenCourrier [ville] : une nouvelle tche vous a
$config[notification_email_corps]=utf8_decode("Bonjour,
<br/><br/>
Une nouvelle tche vous a t affecte sur lapplication openCourrier.<br/>
Vous pouvez la consulter en suivant le lien prsent ci-dessous :
<br/><br/>
<a href=http://demo.openmairie.org/opencourrier/scr/form.php?obj=tache&idx=[id_task]>
Lien vers la tache.</a>
<br/><br/>
Cordialement,<br/>
Ladministrateur de openCourrier, [ville].");
/**
* Configuration du nombre de colonnes sur le tableau de bord.
*/
$config[dashboard_nb_column] = 2;
/**
* Option pour la gestion du scan automatique
* Cette option permet dactiver lors de lajout dun courrier la rcupration
* dans le rpertoire ../scan/<ID_COLLECTIVTE>/<ID_UTILISATEUR>/ dun fichier
* PDF qui aurait t pralablement scann et dpos dans ce rpertoire.
* Lors de lenregistrement du courrier ce fichier est rattach au courrier
* via longlet dossier et le numro de registre est inscrit en rouge directement
* dans le PDF. Ce fichier est alors supprim.
* Valeurs disponibles :
* - true => Option active
* - false => Option dsactive
* Default : $config[option_scanpdf] = true;
*/
$config[option_scanpdf] = true;
30
...
?>
31
32
CHAPITRE 2
Guide du dveloppeur
2.1.1.2.1.1
2.1.1.2.1.2 Dcompresser larchive zip dans le rpertoire de votre serveur web Exemple sous windows
dans wamp : wamp/www/opencourrier Exemple sous linux avec debian : /var/www/opencourrier
Cration et initialisation de la base de donnes
2.1.1.2.2.1
2.1.1.2.2.2 Initialiser la base de donnes Il faut initialiser les tables, les squences et donnes de paramtrage :
data/mysql/init.sql
data/mysql/init_metier.sql
2.1.1.2.2.3 Initialiser un jeu de donnes de dmonstration (optionnel) Il est possible dinitialiser un jeu de
donnes pour tester lapplicatif avec des donnes de dmonstration :
data/mysql/init_data.sql
33
Configuration de lapplicatif
http ://localhost/opencourrier/
Login
Utilisateur administrateur :
identifiant : admin
mot de passe : admin
Utilisateur dmonstration (si le fichier dinitalisation du jeu de donnes de dmonstration a t appliqu) :
identifiant : demo
mot de passe : demo
Le message de bienvenue doit tre affich Votre session est maintenant ouverte.
2.1.1.4 En cas derreur
Activer le mode debug
Il est possible dactiver le mode debug pour visualiser les messages derreur dtaills. Dans le fichier
dyn/debug.inc.php, il faut commenter le mode production et dcommenter le mode debug.
Mode production :
//define(DEBUG, VERBOSE_MODE);
//define(DEBUG, DEBUG_MODE);
define(DEBUG, PRODUCTION_MODE);
Mode debug :
34
//define(DEBUG, VERBOSE_MODE);
define(DEBUG, DEBUG_MODE);
//define(DEBUG, PRODUCTION_MODE);
2.1.2 Intgration
Nous vous proposons dans ce chapitre de dcrire lintgration dopenCourrier dans le systme dinformation
principes dune application composite (mashup)
les fonds de cartes internet et golocalisation des taches
le tableau de bord parametrable (widget)
2.1.2.1 Les principes dune application composite
openCourrier permet de construire une application composite en intgrant des contenus venant dapplications
externes.
Suivant wikipedia : Une application composite (ou mashup ou encore mash-up) est une application qui combine
du contenu ou du service provenant de plusieurs applications plus ou moins htrognes.
http ://fr.wikipedia.org/wiki/Application_composite
Les applications composites permettent de construire une application rapidement a un faible cot grace la fusion
de multiples services internet. Les composants sont facilement r utilisables
Il est dcrit ici les principes dintegration dopenCourrier dans le domaine de linformation gographique pour la
golocalisation des tches (option prvue dans une prochaine version).
Il est decrit ensuite lintgration au travers de tableau de bord personnalis.
2.1.2.2 La golocalisation
La golocalisation des tches est une demande de la DGST dArles non encore implment (fonctionnement prvu
sous postgresql)
2.1.2.3 Les widgets
openCourrier permet de construire une application composite en integrant des widgets dans le tableau de bord.
Le mode de fonctionnement des widget est dcrit dans le guide du dveloppeur openMairie.
Il est decrit ensuite lintegration au travers de tableau de bord personnaliss.
35
Il est donc possible de crer tout type de widget et de les intgrer dans un tableau de bord personnalis :
Dans notre cas ci dessus, lutilisateur demo a accs :
des applications externes
la mto Arles
lhoroscope du jour
les actualits via google
36
CHAPITRE 3
Bibliographie
http ://www.openmairie.org/telechargement/openMairie-Guidedudveloppeur.pdf/view
37
38
Chapitre 3. Bibliographie
CHAPITRE 4
Contributeurs
39