openRéussiteÉducative 1.0 documentation¶
Note
Cette création est mise à disposition selon le Contrat Paternité-Partage des Conditions Initiales à l’Identique 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.
openRéussiteÉducative a pour objet de gérer le programme de réussite éducative. http://www.openmairie.org/catalogue/openreussiteeducative
Vous trouverez dans ce document :
- les principes d’ergonomie
- l’utilisation d’openReussite_Educative
- le paramétrage
Il reste à compléter les chapitres suivants (dans une prochaine édition)
- les widgets
Ce document a pour but de guider les utilisateurs et les développeurs dans la prise en main du projet. Bonne lecture et n’hésitez pas à venir discuter du projet avec la communauté à l’adresse suivante : https://communaute.openmairie.org/c/autres-applications-openmairie
Ergonomie¶
Ergonomie¶
Cette partie vise à présenter l’ergonomie du logiciel c’est-à-dire à décrire la connexion à l’application, la structure de l’application, la navigation et l’utilisation du menu, ainsi que la présentation et la description des principaux icônes. Cette rubrique peut s’appliquer à toute application métier développée avec OpenMairie.
Connexion, déconnexion et permissions¶
Connexion¶
Note
Pour réaliser cette étape, votre administrateur doit vous fournir une adresse Web pour accéder à l’application, un identifiant utilisateur ainsi qu’un mot de passe. Ces éléments auront été préalablement configuré dans le logiciel.
Navigateur Web
L’application est accessible via un navigateur Web, pour y accéder il faut saisir l’adresse Web fournie par votre administrateur dans la barre d’adresse.
Note
Ce logiciel est développé principalement sous le navigateur Mozilla Firefox, il est donc conseillé d’utiliser ce navigateur pour une efficacité optimale.
Saisie des informations de connexion
Cet écran de connexion est composé de deux zones de texte et d’un bouton.
Dans l’écran d’identification, il faut saisir son identifiant et son mot de passe puis cliquer sur le bouton « Se connecter ».
Note
L’identifiant et le mot de passe doivent être saisis en respectant la casse, c’est-à-dire les minuscules et majuscules.
Connexion échouée
Si les identifiants saisis sont incorrects, un message d’erreur apparaît et il faut ressaisir les informations de connexion.
Connexion réussie
Si les identifiants sont corrects, vous êtes redirigé vers la page demandée sur laquelle le message suivant doit d’afficher.
Déconnexion¶
Pour une question de sécurité évidente, il est important de se déconnecter de l’application pour qu’un autre utilisateur ne puisse pas accéder au logiciel via votre compte utilisateur.
L’action « Déconnexion » est disponible à tout moment dans les actions personnelles en haut à droite de l’écran.
Une fois déconnecté, c’est le formulaire de donnexion qui s’affiche avec un message expliquant la réussite de la déconnexion.
Les droits et profils des utilisateurs¶
Les droits et profils des utilisateurs permettent de limiter l’accès aux informations et aux actions uniquement aux personnes autorisées. Chaque utilisateur est associé à un profil. Le profil correspond à un ensemble de permissions de l’utilisateur, par défaut il existe cinq profils :
- Consultation,
- Utilisateur limité,
- Utilisateur,
- Super utilisateur,
- Administrateur.
Chaque page de l’application est associée à un profil. Pour chaque accès à une page, l’application vérifie si l’utilisateur a un profil supérieur ou égal au profil de la page consultée, si c’est le cas l’utilisateur à donc le droit d’accéder aux informations.
Ergonomie générale¶
L’application, sur la grande majorité des écrans, conserve ses composants disposés exactement au même endroit. Nous allons décrire ici le fonctionnement et l’objectif de chacun de ces composants. Cette structuration de l’application permet donc à l’utilisateur de toujours trouver les outils au même endroit et de se repérer rapidement.
Note
Les actions et affichages de l’application diffèrent en fonction du profil de l’utilisateur. Il se peut donc que dans les paragraphes qui suivent des actions soient décrites et n’apparaissent pas sur votre interface ou inversement que des actions ne soient pas décrites mais apparaissent sur votre interface.
Le logo¶
C’est le logo de l’application, il vous permet en un seul clic de revenir rapidement au tableau de bord.
Les actions personnelles¶
Cet élément affiche plusieurs informations importantes.
La première information est l’identifiant de l’utilisateur actuellement connecté ce qui permet de savoir à tout moment si nous sommes bien connectés et avec quel utilisateur. Ensuite est noté le nom de la collectivité sur laquelle nous sommes en train de travailler. En mode multi, une action est disponible sur cette information pour permettre de changer de collectivité. Ensuite la liste sur laquelle nous sommes en train de travailler, une action est disponible sur cette information pour permettre de changer de liste. Enfin l’action pour permettre de changer de mot de passe et pour se déconnecter sont disponibles en permanence.
Les raccourcis¶
Cet élément permet d’afficher des raccourcis vers des écrans auxquels nous avons besoin d’accéder très souvent. Par exemple, ici nous avons un raccourci direct vers le tableau de bord.
Les actions globales¶
Cet élément permet d’afficher en permanence le numéro de version du logiciel. Ensuite les différentes actions sont des liens vers le site officiel du logiciel ou vers la documentation.
Ergonomie des formulaires¶
De manière générale, il y a une règle simple dans les applicatifs openMairie : on accède d’abord à un listing d’éléments puis depuis ce listing on peut ajouter un nouvel élément ou modifier un élément existant en accédant au formulaire dédié à cet élément.
Les listings¶
Un listing est un tableau qui liste des éléments récapitulant des informations permettant d’identifier un élément parmi les autres.
Les actions
En haut à gauche
- Ajouter : cette action représentée par un plus permet d’accéder au formulaire de création d’un élément.
- Autre : il peut y avoir d’autres actions positionnées ici qui représentent des actions que l’on peut faire sur un lot d’éléments par exemple.
A gauche devant chaque élément
- Visualiser : cette action permet d’accéder au formulaire de visualisation d’un élément.
- Autre : il peut y avoir d’autres actions positionnées ici qui permettent d’effectuer des actions rapides sans avoir besoin d’accéder au formulaire de l’élément en visualisation puis de cliquer sur une action parmi les actions contextuelles de l’élément.
Sur l’élément
- Visualiser : cette action permet d’accéder au formulaire de visualisation d’un élément.
Les formulaires¶
Un formulaire dans cet applicatif peut soit être de visualisation soit d’action (ajout, modification, suppression, …). La différence est que le premier contient un portlet d’actions contextuelles et que le deuxième contient un bouton qui permet de valider le formulaire en question.
Voici l’exemple d’un formulaire en mode visualisation.
Voici l’exemple d’un formulaire en mode modification.
Les actions
Le portlet d’actions contextuelles se trouve sur le formulaire d’un élément en mode visualisation. Il contient normalement toutes les actions possibles sur cet élément par l’utilisateur. Il est situé en haut à droite du formulaire.
Actions de formulaires
- Modifier : cette action permet de transformer le mode visualisation de l’élément en mode modification. Une fois le formulaire de modification validé alors un bouton retour nous permet de revenir au formulaire en mode visualisation.
- Supprimer : cette action permet de transformer le mode visualisation de l’élément en mode suppression. Une fois le formulaire de suppression validé alors un bouton retour nous permet de revenir au listing des éléments.
Autres actions
- Le portlet d’acctions contextuelles peut contenir toutes les actions disponibles sur l’élément. Par exemple : il peut y avoir une action qui permet d’imprimer une édition PDF de l’élément, une autre action permettant de changer une valeur spécifique de l’élément comme « Marquer comme lu », …
Les onglets
Sur le formulaire d’un élément, il peut apparaître plusieurs onglets qui correspondent à des éléments liés à l’élément en cours. Un onglet présente un listing de ces éléments liés avec des actions qui permettent également d’accéder à des formulaires sur ces éléments liés.
Par exemple sur l’image suivante, on peut voir sur le « profil » un onglet « tableau de bord » qui liste les tableaux de bord liés au profil utilisateur.
Utilisation¶
Utilisation¶
Il est proposer de décrire l’utilisation de l’application dans ce chapitre
Dossiers¶
Saisie des dossiers¶
Il est possible de modifier les dossiers dans le menu application -> dossier
En appuyant sur
vous transferez le dossier sur tableur (en fonction de la recherche simple)
Vous pouvez alors faire les statistiques (tableau croisé dynamique) et les graphes.
En appuyant sur modification :
Entrez le début de la voie et eventuellement le numéro et en appuyant sur
vous accédez aux adresses postales
Si celle ci existe le dossier est géolocalisé automatiquement.
Il est possible d accéder à la géolocalisation du dossier (utilisation de la table adresse_postale)
Les referents¶
Il est possible de saisir d” autres referents pour la dossier concernée dans le sous formulaire referent
En appuyant sur modification :
La composition familiale¶
Il est possible de completer la composition familiale pour la dossier concernée dans le sous formulaire composition_familiale
En appuyant sur modification :
La critères de repérage¶
les critére de repérage sont saisis pour la dossier concernée dans le sous formulaire critere reperage
En appuyant sur modification :
Les actions du dossier¶
Il est possible de saisir les actions pour la dossier concernée dans le sous formulaire dossier_action
En appuyant sur modification :
Les événements¶
Il est possible de completer par les evenements pour la dossier concernée dans le sous formulaire evenement
En appuyant sur modification :
Les interventions¶
Il est possible de completer les interventions pour la dossier concernée dans le sous formulaire intervention
En appuyant sur modification :
Intervenant¶
Les intervenants interviennent lors d’évenement
Saisie des intervenants¶
Il est possible de modifier les intervenants dans le menu application -> intervenant
En appuyant sur modification :
Les événements¶
Il est possible de visualiser les evenements pour l’intervenant concerné dans le sous formulaire evenement
Paramétrage¶
Paramétrage¶
Il est proposer de décrire le paramétrage de l’application.
om_parametre¶
Les om_parametres sont accessibles dans le menu administration -> om_parametre
Ils sont initialisés pour chaque organisme / collectivité.
Les paramètres suivants sont à initialiser
Paramètres généraux¶
- option_localisation : sig_interne
- registre : forme du registre
- ville
Domaine¶
Saisie des domaines¶
Il est possible de modifier les domaines dans le menu paramètrage -> domaine
En appuyant sur modification :
Les objectifs¶
Il est possible de visualiser les objectifs pour le domaine concerné dans le sous formulaire objectif
Entrez dans le formulaire pour modifier
Objectif¶
Saisie des objectifs¶
Il est possible de modifier les objectifs dans le menu paramétrage -> objectif
En appuyant sur modification :
Les dossiers¶
Il est possible de visualiser les dossiers pour l’objectif concerné dans le sous formulaire critere_reperage
Les evenements¶
Il est possible de visualiser les evenements pour l’objectif concerné dans le sous formulaire evenement
Action¶
Saisie des actions¶
Il est possible de modifier les actions dans le menu parametrage -> action
En appuyant sur modification :
Les dossiers¶
Il est possible de visualiser les dossiers pour l” action concerné dans le sous formulaire intervention
Motif¶
Saisie des motifs¶
Il est possible de modifier les motifs dans le menu paramétrage -> motif
En appuyant sur modification :
Les dossiers¶
Il est possible de visualiser les dossiers pour le motif concerné dans le sous formulaire dossier
Civilite¶
Saisie des civilites¶
Il est possible de modifier les civilites dans le menu parametrage -> civilite
En appuyant sur modification :
La situation familiale¶
Saisie des situation_familiales¶
Il est possible de modifier les situation_familiales dans le menu application -> situation_familiale
En appuyant sur modification :
Prescripteur¶
Saisie des prescripteurs¶
Il est possible de modifier les prescripteurs dans le menu application -> prescripteur
En appuyant sur modification :
Les dossiers¶
Il est possible de visualiser les dossiers pour le prescripteur concerné dans le sous formulaire dossier
Referent familial¶
Saisie des referents¶
Il est possible de modifier les partenaires dans le menu paramétrage -> referent familial
En appuyant sur modification :
Référent parcours¶
Saisie des referent_parcours¶
Il est possible de modifier les referents parcours dans le menu paramétrage -> referent_parcours
En appuyant sur modification :
Etablissement scolaire¶
Saisie des etablissements¶
Il est possible de modifier les etablissements dans le menu application -> etablissement
En appuyant sur modification :
Entrez le début de la voie et eventuellement le numéro et en appuyant sur
vous accédez aux adresses postales
Si celle ci existe l’etablissement est géolocalisé automatiquement.
Visualisation de la position géographique (d’après l adresse postale)
Les dossiers¶
Il est possible de visualiser les dossiers pour l’etablissement concerné dans le sous formulaire établissement
Les types d’établissements¶
Saisie des type_etablissements¶
Il est possible de modifier les type_etablissements dans le menu paramétrage -> type_etablissement
En appuyant sur modification :
Les établissements¶
Il est possible de visualiser les etablissements pour le type_etablissement concerné dans le sous formulaire établissement
Niveau scolaire¶
Saisie des niveaux¶
Il est possible de modifier les niveaus dans le menu parametrage -> niveau
En appuyant sur modification :
Les dossiers¶
Il est possible de visualiser les dossiers pour le niveau concerné dans le sous formulaire intervention
Rivoli¶
Sert pour l’adressage automatique
Saisie des rivolis¶
Il est possible de modifier les rivolis dans le menu paramétrage -> rivoli
En appuyant sur modification :
Les adresses postales¶
Il est possible de visualiser les adresses postales pour le rivoli concerné dans le sous formulaire adresse postale
adresse_postale¶
Saisie des adresse_postales¶
Il est possible de modifier les adresse_postales dans le menu application -> adresse_postale
En appuyant sur modification :
Visualisation de la position géographique
Tableaux de bord¶
Tableaux de bord¶
Il est proposer de décrire l’utilisation de widget dans ce chapitre.
Widget¶
Il s’agit des widgets pour le tableau de bord
L’accès en saisie se fait par le menu administrateur -> widget :
Dashboard¶
La composition du tableau de bord se fait par le composeur de tableau de bord par profil d utilisateur
L’accès en saisie se fait par le menu administrateur -> composition :
Les tableaux de bord sont les suivants :
administrateur :
super utilisateur :
utilisateur :