Documentation openCourrier 4.0
Documentation openCourrier 4.0
Version 4.0
openMairie
30 05 2017
Table des matires
1 Manuel de lutilisateur 3
1.1 Manuel de lutilisateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1 Prambule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2 Ergonomie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2.1 Connexion, dconnexion et permissions . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.1.1 Connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.1.1.1 Navigateur Web . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2.1.1.2 Saisie des informations de connexion . . . . . . . . . . . . . . 5
1.1.2.1.1.3 Connexion choue . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2.1.1.4 Connexion russie . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2.1.2 Dconnexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2.1.3 Les droits et profils des utilisateurs . . . . . . . . . . . . . . . . . . . 7
1.1.2.2 Ergonomie gnrale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.2.2.1 Le logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.2.2.2 Les actions personnelles . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.2.2.3 Les raccourcis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.2.2.4 Le menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.2.5 Les actions globales . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.3 Ergonomie des formulaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.3.1 Les listings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.3.1.1 Les actions . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.3.1.2 En haut gauche . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2.3.1.3 A gauche devant chaque lment . . . . . . . . . . . . . . . . 9
1.1.2.3.1.4 Sur llment . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.2.3.1.5 Divers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.2.3.2 Les formulaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.2.3.2.1 Les onglets . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.1.3 Gestion des courriers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.1.3.1 Saisir un courrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.1.3.1.1 Courrier arrive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.1.3.1.2 Courrier dpart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.1.3.2 Lier un courrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.1.3.3 Saisir une tche . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.1.3.4 Tlcharger un fichier / dossier . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.1.3.5 La recherche de courriers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.1.3.6 La recherche de tches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.1.3.7 Les tches non soldes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.1.3.8 Les archives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.1.4 Traitement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.1.4.1 La remise zro des registres . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.1.4.2 Larchivage des courriers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.1.5 Paramtrage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
i
1.1.5.1 Tables de rfrences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.1.5.1.1 Le service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.1.5.1.2 Le correspondant (metteur / destinataire) . . . . . . . . . . . . . . . 26
1.1.5.1.3 La bible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.1.5.1.4 La civilit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
1.1.5.1.5 Le type de correspondant . . . . . . . . . . . . . . . . . . . . . . . . 29
1.1.5.1.6 Llu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.1.5.1.7 La catgorie des courriers . . . . . . . . . . . . . . . . . . . . . . . . 30
1.1.5.1.8 La catgorie des tches . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.1.5.1.9 Ltat des tches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.1.5.2 Paramtres gnraux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.1.5.3 Paramtres spcifiques dans le fichier dyn/var.inc . . . . . . . . . . . . . . . . . 33
1.1.5.4 Paramtres spcifiques dans le fichier dyn/config.inc.php . . . . . . . . . . . . . 34
1.1.5.5 Paramtres spcifiques dans le fichier dyn/mail.inc.php . . . . . . . . . . . . . 34
2 Guide du dveloppeur 37
2.1 Guide du dveloppeur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.1.1.1 Pr-requis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.1.1.2 Dploiement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.1.1.2.1 Installation des fichiers de lapplicatif . . . . . . . . . . . . . . . . . 37
2.1.1.2.1.1 Tlcharger larchive zip . . . . . . . . . . . . . . . . . . . . 37
2.1.1.2.1.2 Dcompresser larchive zip dans le rpertoire de votre serveur
web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
2.1.1.2.2 Cration et initialisation de la base de donnes . . . . . . . . . . . . . 37
2.1.1.2.2.1 Crer la base de donnes . . . . . . . . . . . . . . . . . . . . 37
2.1.1.2.2.2 Initialiser la base de donnes . . . . . . . . . . . . . . . . . . 37
2.1.1.2.2.3 Initialiser un jeu de donnes de dmonstration (optionnel) . . . 37
2.1.1.2.3 Configuration de lapplicatif . . . . . . . . . . . . . . . . . . . . . . 38
2.1.1.2.3.1 Positionner les permissions ncessaires au serveur web . . . . 38
2.1.1.2.3.2 Configuration de la connexion la base de donnes . . . . . . 38
2.1.1.3 Connexion lapplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.1.1.3.1 Ouverture dans le navigateur . . . . . . . . . . . . . . . . . . . . . . 38
2.1.1.3.2 Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.1.1.4 En cas derreur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.1.1.4.1 Activer le mode debug . . . . . . . . . . . . . . . . . . . . . . . . . 38
2.1.2 Intgration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.1.2.1 Les principes dune application composite . . . . . . . . . . . . . . . . . . . . 39
2.1.2.2 La golocalisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2.1.2.3 Les widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3 Bibliographie 41
4 Contributeurs 43
ii
openCourrier Documentation, Version 4.0
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 : [email protected] !
Manuel de lutilisateur
Manuel de lutilisateur
Prambule
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.
3
openCourrier Documentation, Version 4.0
Contents
Ergonomie
Connexion, dconnexion et permissions
Connexion
Navigateur Web
Saisie des informations de connexion
Connexion choue
Connexion russie
Dconnexion
Les droits et profils des utilisateurs
Ergonomie gnrale
Le logo
Les actions personnelles
Les raccourcis
Le menu
Les actions globales
Ergonomie des formulaires
Les listings
Les actions
En haut gauche
A gauche devant chaque lment
Sur llment
Divers
Les formulaires
Les onglets
Connexion
Note : Pour raliser cette tape, votre administrateur doit vous fournir une adresse Web pour accder lapplica-
tion, 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 utili-
sateur 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. Les profils sont hirarchiques et lists de faon croissante, cest dire que les permissions dun
profil son valable pour les suivants, par dfaut il existe cinq profils :
1. Consultation : peut visualiser les courriers arrives/dparts, les courriers archivs et les tches non sol-
des de son service, ainsi que les courriers recherchs de chaque service.
2. Utilisateur limit : peut modifier les tches non soldes de son service.
3. Utilisateur : peut ajouter ou modifier les courriers arrives/dparts de son service et les objets lis celui-
ci. Il peut aussi paramtrer lapplication : ajouter/modifier/supprimer les metteurs/destinataires, la
bible, les civilits, les types de correspondants et les courriers types.
4. Super utilisateur : peut faire les traitements concernant le registre et larchivage, les exports des ditions
et des requtes mmorises, le paramtrage des services, des tats, des sous-tats et des lettres type.
5. Administrateur : peut paramtrer les collectivits, les paramtres de lapplication, les profils, les droits,
les utilisateurs, les widgets, importer des tables et utiliser le gnrateur.
Chaque page de lapplication est associe un profil. Pour chaque accs une page, lapplication vrifie si luti-
lisateur a un profil suprieur ou gal au profil de la page consulte, si cest le cas lutilisateur donc le droit
daccder aux informations.
Les profils ainsi que leurs permissions associes sont modifiables par ladministrateur.
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 lap-
plication 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 raccourcis
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.
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.
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.
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.5 Divers
Afficher les lments expirs : sur les lements qui possdent une date de validit, par dfaut les l-
ments qui sont dans le pass napparaissent pas, il est ncessaire de cliquer sur cette action pour les faire
apparatre. Laction se situe au dessus du tableau.
Imprimer le listing en PDF : sur les lments pour lesquels ldition existe une action reprsente par une
imprimante permet de tlcharger un pdf qui reflte le contenu du listing sans aucun filtre de recherche.
Laction se situe au dessus du tableau.
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.
1.1.2.3.2.1 Les onglets Sur le formulaire dun lment, il peut apparatre plusieurs onglets qui correspondent
des lments lis llment en cours. Un onglet prsente un listing de ces lments lis avec des actions qui
permettent galement daccder des formulaires sur ces lments lis.
Par exemple sur limage suivante, on peut voir sur le profil un onglet tableau de bord qui liste les tableaux de
bord lis au profil utilisateur.
Contents
Gestion des courriers
Saisir un courrier
Courrier arrive
Courrier dpart
Lier un courrier
Saisir une tche
Tlcharger un fichier / dossier
La recherche de courriers
La recherche de tches
Les tches non soldes
Les archives
Les lments permettant la gestion du courrier sont disponibles dans la rubrique (Courrier) du menu.
Saisir un courrier
Les courriers sont saisis soit en courrier arrive soit en courrier dpart.
Courrier arrive
est visible seulement si loption autocreation_tache est activ paramtrable par ladministrateur technique.
la nature : lettre mail ... (paramtrable par ladministrateur technique)
la date arrive (date du jour par dfaut) et date du courrier [obligatoire] (Vous pouver utilisez le calendrier)
lmetteur : nom, prnom, adresse, CP, Ville, type de correspondant. Il est possible de chercher un metteur
actif dans la table metteur en appuyant sur la flche et de sauvegarder un metteur en cochant la case (en
ajout seulement). Si un emetteur est choisi, l ensemble des donnes de lemetteur est rapatri dans la table
courrier
lObjet : possibilit dutiliser des textes paramtrs en appuyant sur le lien bible
la catgorie de courrier
le service : service charg du traitement, obligatoire et eventuellement le rfrent
la diffusion : service(s) ou lu(s) ayant une copie (facultatif)
Tableau de bord dun courrier arrive
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.
lObjet : possibilit dutiliser des textes paramtrs en appuyant sur le lien bible
le service : service charg du traitement : obligatoire et eventuellement le rfrent
la diffusion : service(s) ou lu(s) ayant une copie (facultatif)
Tableau de bord dun courrier sortant
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.
Lier un courrier
La liaison stablit par un numro commun aux courriers lis qui font chacun rfrence aux autres...
Il est saisi :
ltat de la tche
la catgorie de la tche
la date butoir
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)
Avertissement : Il est impratif de sauvegarder le rpertoire trs/ o sont stocks les documents. Il faut donc
conserver ce rpertoire en cas de changement de version. Il faut donner apache les droits dcriture sur ce
rpertoire.
La recherche de courriers
La recherche de tches
Il est possible de modifier une tche non solde dans le formulaire ci dessous
(Saisir une tche)
Les archives
(Courrier Archive)
Avertissement : Larchivage des courriers une date prcise se fait sur la date du courrier sans vrification
des dates ou de lexcution des taches associes
Traitement
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.
Ce traitement est faire chaque dbut danne. Il remet zro la squence utilise pour les registres (les identi-
fiants des squences sont registre_seq pour les courriers arrive et registre_depart_seq pour les courriers dpart).
Ce traitement est accessible via le menu (Traitement Registre) :
Ce traitement archive les courriers, dossiers et tches partir dune date. Il permet dacclrer les recherches.
Ce traitement est accessible via le menu (Traitement Archivage) :
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)
Paramtrage
Contents
Paramtrage
Tables de rfrences
Le service
Le correspondant (metteur / destinataire)
La bible
La civilit
Le type de correspondant
Llu
La catgorie des courriers
La catgorie des tches
Ltat des tches
Paramtres gnraux
Paramtres spcifiques dans le fichier dyn/var.inc
Paramtres spcifiques dans le fichier dyn/config.inc.php
Paramtres spcifiques dans le fichier dyn/mail.inc.php
Tables de rfrences
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
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
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
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.
Il est saisi :
le libell
Le type de correspondant
Il est saisi :
le libell du type de correspondant
Llu
(Paramtrage lu)
Les lus peuvent tre mise en copie sur les courriers.
Lcran suivant permet de lister les lus.
Il est saisi :
la civilit
le nom de llu
le prnom de llu
activer lauto-insertion en copie sur chaque courrier, pour cela il faut activer loption (voir paramtrable
par ladministrateur)
Il est possible de crer ou modifier une catgorie de courrier dans le formulaire suivant.
Il est saisi :
le libell de la catgorie de courrier
Il est possible de crer ou modifier une catgorie de tche dans le formulaire suivant.
Il est saisi :
le libell de la catgorie de tche
Il est saisi :
le libell de ltat de tche
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 Description
Nom du maire.
maire
Nom de la ville.
ville
Par dfaut : [annee]-[seq]. Caractristique du registre dans notre cas 2012-0001.
re-
gistre_arrivee
Par dfaut : [annee]-D-[seq]. Caractristique du registre dans notre cas 2012-D-0001.
re-
gistre_depart
Par dfaut : true. Utilisation du courrier dpart.
op-
tion_courrier_depart
Par dfaut : 1. Indique si les tches peuvent tre affectes uniquement aux services enfants
ser-
du service qui traite le courrier (1) ou tous les services de la commune (0).
vice_tache
Par dfaut : false. Affiche la gestion des lus sur les courriers (identique aux services).
option_elu
Par dfaut : false. Ajoute une case cocher sur les services et les lus pour quils soient
autoinser-
automatiquement en diffusion lors de lajout dun courrier.
tion_diffusion
Par dfaut : true. Cration automatique dune tche de rponse lors de la cration dun
autocrea-
courrier.
tion_tache
Par dfaut : 15. Dlai de rponse un courrier. Permet de saisir la date butoir dune tche
de-
cre automatiquement.
lai_reponse
Par dfaut : false. Possibilit au service de voir les lments de ses sous services.
vue_sous_service
Par dfaut : false. Active la golocalisation des tches.
vop-
tion_localisation
Ce paramtrage est rserv ladministrateur technique de lapplication. Il permet de configurer des options
critiques ou des listes de rfrences non destines tre modifies rgulirement. Il est accessible via le systme de
fichiers directement sur le serveur. Il nest pas possible de modifier ce paramtrage via linterface de lapplication.
paramtres de dyn/var.inc
<?php
...
...
?>
Ce paramtrage est rserv ladministrateur technique de lapplication. Il permet de configurer des options
critiques ou des listes de rfrences non destines tre modifies rgulirement. Il est accessible via le systme de
fichiers directement sur le serveur. Il nest pas possible de modifier ce paramtrage via linterface de lapplication.
paramtres de dyn/config.inc.php
<?php
...
/**
* 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 l'application 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/>
L'administrateur 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 d'activer lors de l'ajout d'un courrier la rcupration
* dans le rpertoire ../scan/<ID_COLLECTIVTE>/<ID_UTILISATEUR>/ d'un fichier
* PDF qui aurait t pralablement scann et dpos dans ce rpertoire.
* Lors de l'enregistrement du courrier ce fichier est rattach au courrier
* via l'onglet 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;
...
?>
Ce paramtrage est rserv ladministrateur technique de lapplication. Il permet de configurer des options
critiques ou des listes de rfrences non destines tre modifies rgulirement. Il est accessible via le systme de
fichiers directement sur le serveur. Il nest pas possible de modifier ce paramtrage via linterface de lapplication.
paramtres de dyn/config.inc.php
<?php
...
/**
*
*/
$mail = array();
/**
* Informations sur $mail
*
* La variable $mail est un tableau associatif. Ce tableau peut, de ce
* fait, contenir plusieurs configurations de serveur mail diffrentes.
*
* Chaque serveur est reprsente par une cle de tableau. Ces cles se
* retrouvent dans le fichier database.inc.php et permettent d'associer
* une base de donnees precise a un serveur mail precis.
*
* Les autres cles de configuration :
*
* mail_host -> Adresse du serveur de mail
* mail_port -> Port d'ecoute du serveur de mail
*
* mail_username -> Identifiant de l'utilisateur du serveur de mail
* mail_pass -> Mot de passe de cet utilisateur
*
* mail_from -> Adresse email de l'expediteur
* mail_from_name -> Nom de l'expediteur
*/
$mail["mail-default"] = array(
'mail_host' => '',
'mail_port' => '',
'mail_username' => '',
'mail_pass' => '',
'mail_from' => '',
'mail_from_name' => '',
);
...
?>
Guide du dveloppeur
Guide du dveloppeur
Installation
Pr-requis
Dploiement
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
2.1.1.2.2.1 Crer la base de donnes Par dfaut la base de donnes sappelle opencourrier.
2.1.1.2.2.2 Initialiser la base de donnes Il faut initialiser les tables, les squences et donnes de param-
trage :
data/pgsql/init.sql
data/pgsql/init_metier.sql
data/pgsql/init_parametrage.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/pgsql/init_data.sql
37
openCourrier Documentation, Version 4.0
Configuration de lapplicatif
2.1.1.2.3.1 Positionner les permissions ncessaires au serveur web Exemple sous linux avec debian : chown
-R www-data :www-data /var/www/opencourrier
Connexion lapplication
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.
En cas derreur
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 :
//define('DEBUG', VERBOSE_MODE);
define('DEBUG', DEBUG_MODE);
//define('DEBUG', PRODUCTION_MODE);
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)
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.
La golocalisation
La golocalisation des tches est une demande de la DGST dArles non encore implment (fonctionnement prvu
sous postgresql)
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.
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
l'horoscope du jour
les actualits via google
des applications internes
Bibliographie
http://www.openmairie.org/telechargement/openMairie-Guidedudveloppeur.pdf/view
41
openCourrier Documentation, Version 4.0
42 Chapitre 3. Bibliographie
CHAPITRE 4
Contributeurs
43