help: complete version of the documentation

This commit is contained in:
Pierre Cros 2013-12-14 10:28:54 +01:00 committed by Frédéric Péters
parent cb6acff856
commit ee7f5ddfbd
21 changed files with 295 additions and 844 deletions

View File

@ -5,8 +5,8 @@
<title>2. Ajouter des champs dans un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
<link type="guide" xref="index#formulaires" />
<desc>Éditer le contenu d'un formulaire</desc>
</info>
<section id="creation">
@ -29,15 +29,15 @@
</figure>
<p>
Le <em>Libellé</em> est le texte qui sera affiché à l'utilisateur et <em>Type</em> propose une liste de <link xref="types_champs">différents types de champ</link>. Les types disponibles permettent de proposer à l'usager d'entrer une information texte, une date, de télécharger un fichier, de choisir une réponse dans une liste, de lui afficher une information ou encore de créer plusieurs pages, etc.</p>
Le <em>Libellé</em> est le texte qui sera affiché à l'utilisateur et <em>Type</em> propose une liste de <link xref="types_champs">différents types de champ</link>. Les types disponibles permettent au concepteur du formulaire de créer une information texte, une date, de télécharger un fichier, de choisir une réponse dans une liste, de lui afficher une information ou encore de créer plusieurs pages, etc.</p>
<p>Pour créer un champ il faut obligatoirement saisir son libellé et choisir son type, puis, il faut cliquer sur <em>Ajouter</em>. Une fois crée le champ apparaît sur la page :</p>
<p>Pour créer un champ il faut obligatoirement saisir son libellé et choisir son type, puis, il faut cliquer sur <em>Ajouter</em>. Une fois créé le champ apparaît sur la page :</p>
<figure>
<media type="image" src="figures/liste_champ.png" />
</figure>
<p>Chaque ligne est un champ, à gauche se trouve le libellé et à droite son type afin d'identifier rapidement les champs.</p>
<p>Les champs sont affichés les uns en dessous des autres. Pour chacun, le libellé et le type sont affichés.</p>
<p>Pour éditer un champ placez votre souris sur celui qui vous intéresse, un petit menu apparaît :</p>
@ -47,7 +47,7 @@
<p>Vous pouvez supprimer le champ, le dupliquer ou l'éditer.</p>
<p>Selon le type de champ, la page d'édition vous proposera divers champs et options à paramétrer.</p>
<p>Pour chacun, la page d'édition vous proposera diverses options à paramétrer.</p>
</section>
@ -56,13 +56,13 @@
<title>Options des champs</title>
<p>Chaque champ peut-être édité en cliquant sur le lien éditer qui apparaît au moment du survol.</p>
<p>Il existe deux types de champs, ceux qui demandent à l'usager d'entrer une information et ceux qui lui donnent une information (les champs de mise en forme). À l'exception des champs de mise en forme (<link xref="form_champs#champ_affiche_info">Nouvelle page, Titre, Sous-titre, Commentaire</link>), ils offrent tous les options suivantes :</p>
<p>Il existe deux types de champs, ceux qui demandent à l'usager d'entrer une information et ceux qui lui donnent une information (les champs de mise en forme). À l'exception des champs de mise en forme (<link xref="form_champs#champ_affiche_info">Nouvelle page, Titre, Sous-titre, Commentaire</link>), tous offrent les options suivantes :</p>
<list>
<item><p>Libellé : le texte du champs tel qu'il sera présenté à l'utilisateur.</p></item>
<item><p>Obligatoire : il s'agit d'une case à cocher qui fixe le caractère obligatoire d'une réponse pour le répondant, si la case n'est pas cochée, la réponse à la question est optionnelle.</p></item>
<item><p>Remarque : permet d'apporter une aide au répondant. Dans le cas d'un champ adresse électronique, on pourra faire figurer dans cette option : "par exemple : francis.kuntz@wanagro.com", et ce message sera affiché à l'utilisateur en-dessous du champ adresse électronique.</p></item>
<item><p>Affichage dans les listings : il n'est pas forcément pertinent que tous les champs figurent dans le listing de back-office d'autant que dans le cas de formulaires comprenant beaucoup de champs, le listing n'est pas très lisible si tous sont affichés. Cette option permet donc, par le biais d'une case à cocher de déterminer si le champ concerné doit figurer dans le listing back-office.</p></item>
<item><p>Affichage dans les listings : il n'est pas forcément pertinent que tous les champs figurent dans le listing de back-office (optimisation de la lisibilité). Cette option permet donc, par le biais d'une case à cocher de déterminer si le champ concerné doit figurer ou non dans ce listing.</p></item>
<item><p>Classe supplémentaire pour les styles CSS : permet d'indiquer une classe CSS pour le champ. Cette classe doit évidemment exister dans la feuille de style du thème choisi pour être opérante.</p></item>
<item><p>Nom de variable : permet d'attribuer un identifiant au champ en question. Cet identifiant pourra ensuite être utilisé pour faire des <link xref="form_conditionnel">formulaires conditionnels</link>.</p></item>
</list>
@ -75,7 +75,7 @@
<section id="champ_demande_info">
<title>Champs demandant une information</title>
<p>Ces champs exigent que l'utilisateur entre du texte, une date, choisissent une ou plusieurs réponse(s), joigne un fichier....</p>
<p>Ces champs exigent que l'utilisateur entre du texte, une date, choisissent une ou plusieurs réponse(s), joigne un fichier...</p>
<list>
<item><p>Texte : C'est le champ de base, utilisé pour demander au répondant de fournir une information en texte libre. Le champ texte permet, dans sa configuration de base, une réponse comprenant des lettres et des chiffres et limitée à 20 caractères. Tout ceci peut être modifié aisément en éditant le champs. En plus des options communes, il offre :
@ -89,34 +89,46 @@
<item><p>Valeur numérique : \d+$</p></item>
</list>
</p></item>
<item><p>La liste déroulante "Préremplir", permet, de 3 façon différente, de pré-remplir le champ :</p></item>
<item><p>La liste déroulante « Préremplir », permet de pré-remplir de 3 façons différentes le champ :</p></item>
<list>
<item><p>« Texte », qui en cliquant sur le bouton "appliquer" vous permettra de saisir une valeur fixe qui sera affichée indifféremment à tous les répondants.</p></item>
<item><p>« Champ utilisateur» qui permet de sélectionner une des caractéristiques du profil de l'utilisateur (nom, adresse téléphone...) pour alimenter le champs</p></item>
<item><p>« Texte », qui en cliquant sur le bouton « appliquer » vous permettra de saisir une valeur fixe qui sera affichée indifféremment à tous les répondants.</p></item>
<item><p>« Champ utilisateur » qui permet de sélectionner une des caractéristiques du profil de l'utilisateur (nom, adresse téléphone...) pour alimenter le champs</p></item>
<item><p>« Formule Python » qui permet d'écrire une requête Python pour aller récupérer une information pouvant pré-remplir le champ.</p></item>
</list>
<item>Source de données externe : permet d'aller interroger un référentiel distant pour en extraire une information destinée à alimenter le formulaire.</item>
<item>Source de données externe : permet d'aller interroger un référentiel distant pour en extraire une information destinée à alimenter le formulaire. La source de données peut être de type webservice formattée en JSON.</item>
</list>
</p></item>
<item><p>Texte long : identique au champ Texte mais il s'étend sur plusieurs lignes. Dans les navigateurs récents, la taille du bloc de texte est modifiable par l'utilisateur en cliquant/déplaçant son coin inférieur droit. Par défaut le nombre de caractères par ligne est fixé à 20 et le nombre de lignes à 3. Pour un affichage occupant la largeur de la page, 70 caractères par ligne est une bonne valeur. 10 lignes par bloc permettent une réponse longue, sachant que si l'utilisateur dépasse, il disposera d'une barre d'ascenseur. L'option « texte préformatté » Permet de conserver les sauts à la lignes et les espaces supérieur à 1 caractère dans la réponse de l'usager.</p></item>
<item><p>Texte long : identique au champ Texte mais il s'étend sur plusieurs lignes. Dans les navigateurs récents, la taille du bloc de texte est modifiable par l'utilisateur en cliquant/déplaçant son coin inférieur droit. Par défaut le nombre de caractères par ligne est fixé à 20 et le nombre de lignes à 3. Pour un affichage occupant la largeur de la page, 70 caractères par ligne est une bonne valeur. 10 lignes par bloc permettent une réponse longue, sachant que si l'utilisateur dépasse, il disposera d'une barre d'ascenseur. L'option « texte préformaté » Permet de conserver les sauts à la lignes et les espaces supérieur à 1 caractère dans la réponse de l'usager.</p></item>
<item><p>Courriel : C'est un champ Texte sur lequel un contrôle est opéré pour vérifier que c'est bien une adresse électronique valable qui est saisie. Le répondant devra donc mentionner dans ce champ une adresse de courriel valide. Le contrôle porte à la fois sur la forme de l'adresse et sur la validité du nom de domaine.</p></item>
<item><p>Case à cocher : il s'agit d'une case à cocher permettant par exemple d'obtenir le consentement du demandeur.</p></item>
<item><p>Upload de fichier : permet à l'utilisateur de joindre un fichier au formulaire, par exemple une pièce justificative scannée.</p></item>
<item><p>Date : Propose à l'utilisateur de choisir une date (en l'écrivant ou en la sélectionnant dans un calendrier). Ce champs offre les options suivantes :
<list>
<item><p>Date minimale : empêche l'utilisateur de choisir une date
antérieure à celle définie ici.</p></item>
<item><p>La date doit être dans le futur : impose à l'utilisateur de choisir une date postérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date minimale</em>.</p></item>
<item><p>Date maximale : empêche l'utilisateur de choisir une date postérieure à la date définie ici.</p></item>
<item><p>La date doit être dans le passé : impose à l'utilisateur de choisir une date antérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date maximale</em>.</p></item>
<item><p>La date peut être le jour présent : option qui n'est utile que combinée aux options précédentes et qui leur ajoute la possibilité de saisir la date du jour.</p></item>
antérieure à celle définie ici.</p>
<item><p>La date doit être dans le futur : impose à l'utilisateur de choisir une date postérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date minimale</em>.</p></item>
<item><p>Date maximale : empêche l'utilisateur de choisir une date postérieure à la date définie ici.</p></item>
<item><p>La date doit être dans le passé : impose à l'utilisateur de choisir une date antérieure à la date du jour. Cette option n'est pas compatible avec l'option <em>Date maximale</em>.</p></item>
<item><p>La date peut être le jour présent : option qui n'est utile que combinée aux options précédentes et qui leur ajoute la possibilité de saisir la date du jour.</p></item>
</item>
</list>
</p></item>
<item><p>Liste : Ce champ permet l'affichage d'une liste déroulante au répondant. « Éléments », permet de définir les différentes possibilités de réponse. Ajoutez autant d'éléments que nécessaire à votre liste. Vous pouvez choisir d'afficher les réponses sous forme de bouton radio à l'aide de la case à cocher prévue à cet effet.</p></item>
<item><p>Liste à choix multiples : identique à liste mais permet à l'utilisateur de choisir plusieurs répondes. Il est possible de limiter le nombre de choix possible avec l'option <em>Nombre maximal de choix</em>, 0 signifiant qu'il n'y a aucune limitation.</p></item>
<item><p>Tableau : Ce champ permet de mettre en place un tableau dans le formulaire. Lorsqu'on le paramètre on choisit le nombre de colonnes et de lignes qu'il va compter et les libellés choisis apparaîtront au-dessus des colonnes (pour les éléments saisis sous "Colonne") et devant les lignes (pour les éléments saisis sous "Lignes").</p></item>
<item><p>Tableau de listes : identique au type « Tableau » mais le contenu de chaque cellule est une liste définie dans l'option « Éléments » du champs</p></item>
<item><p>Liste : Ce champ permet l'affichage d'une liste déroulante au répondant. « Éléments », permet de définir les différentes possibilités de réponse. Ajoutez autant d'éléments que nécessaire à votre liste. Vous pouvez choisir d'afficher les réponses sous forme de bouton radio à l'aide de la case à cocher prévue à cet effet.
<item><p>La liste déroulante « Préremplir », permet de pré-remplir de 3 façons différentes le champ :</p></item>
<list>
<item><p>« Texte », qui en cliquant sur le bouton « appliquer » vous permettra de saisir une valeur fixe qui sera affichée indifféremment à tous les répondants.</p></item>
<item><p>« Champ utilisateur » qui permet de sélectionner une des caractéristiques du profil de l'utilisateur (nom, adresse téléphone...) pour alimenter le champs</p></item>
<item><p>« Formule Python » qui permet d'écrire une requête Python pour aller récupérer une information pouvant pré-remplir le champ.</p></item>
</list>
<item>Source de données externe : permet d'aller interroger un référentiel distant pour en extraire une information destinée à alimenter le formulaire. La source de données peut être de type webservice formattée en JSON.</item>
</p></item>
<item><p>Liste à choix multiples : identique à liste mais permet à l'utilisateur de choisir plusieurs réponses. Il est possible de limiter le nombre de choix avec l'option <em>Nombre maximal de choix</em>, 0 signifiant qu'il n'y a aucune limitation.</p></item>
<item><p>Tableau : Ce champ permet de mettre en place un tableau dans le formulaire. Lorsqu'on le paramètre on choisit le nombre de colonnes et de lignes qu'il va compter et les libellés choisis apparaîtront au-dessus des colonnes (pour les éléments saisis sous « Colonne ») et devant les lignes (pour les éléments saisis sous « Lignes »).</p></item>
<item><p>Tableau de listes : identique au type « Tableau » mais le contenu de chaque cellule est une liste définie dans l'option « Éléments » du champs.</p></item>
<item><p>Tableau de longueur libre : identique au type « Tableau » mais chaque fois qu'une ligne est remplie par l'utilisateur, il peut compléter une nouvelle ligne, le nombre de ces dernières n'est pas limité. Ce type offre par ailleurs la possibilité de faire le total des colonnes en cochant l'option « Ajouter une ligne de total ».</p></item>
<item><p>Éléments classés : Affiche à l'usager une liste de propositions précédées d'une zone de saisie permettant d'indiquer par un chiffre le classement qu'il souhaite donner à chacune d'entre elles. </p></item>
</list>
@ -132,12 +144,12 @@
<item><p>Titre : permet d'insérer un titre dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Sous-titre : permet d'insérer un sous-titre dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Commentaire : permet d'insérer un commentaire dans le formulaire. La forme de son affichage dépend de la feuille de style du thème. Il est possible de spécifier une classe de la feuille de style dans le champs prévu à cet effet.</p></item>
<item><p>Nouvelle page : permet de spécifier qu'une nouvelle page doit commencer à cet endroit. Le champ nouvelle page permet donc de créer des <link xref="form_multipage">formulaires multi-pages</link>. Le libellé des champs nouvelle page sera affiché à l'utilisateur dans un cadre à part, lui permettant d'avoir une vue d'ensemble du formulaire et de savoir sur quelle page il se trouve. Le champ nouvelle page permet également de gérer la notion d'affichage conditionnel : certaines pages ne seront affichées qu'en fonction d'une réponse à une question précédente (cf. les <link xref="form_conditionnel">formulaires conditionnels</link>). À noter qu'un formulaire multi-pages doit obligatoirement commencer par un champ de ce type.</p></item>
<item><p>Nouvelle page : permet de spécifier qu'une nouvelle page doit commencer à cet endroit. Le champ nouvelle page permet donc de créer des <link xref="form_multipage">formulaires multi-pages</link>. Le champ nouvelle page permet de gérer la notion d'affichage conditionnel : certaines pages ne seront affichées que lorsqu'une réponse particulières est donnée (cf. les <link xref="form_conditionnel">formulaires conditionnels</link>). À noter qu'un formulaire multi-pages doit obligatoirement commencer par un champ de ce type. Le tite des pages sera affiché à l'utilisateur à côté du formulaire, lui permettant d'avoir une vue d'ensemble et de savoir sur quelle page il se trouve.</p></item>
</list>
<note>
<title>Différences entre champs « Commentaire » et option « Remarque »</title>
<p>Il est souvent préférable de ne pas utiliser le champs « Commentaire » pour donner des indications sur la façon de remplir un champ particulier : il est préférable d'utiliser l'option « Remarque » du champ en question pour ce faire, le texte sera alors plus explicitement lié à ce dernier.</p>
<p>Il est généralement déconseillé d'utiliser le champs « Commentaire » pour donner des indications sur la façon de remplir un champ particulier : il est préférable d'utiliser l'option « Remarque » du champ en question pour ce faire, le texte sera alors plus explicitement lié à ce dernier.</p>
</note>
</section>

View File

@ -4,8 +4,8 @@
<title>4. Créer un formulaire conditionnel</title>
<info>
<link type="guide" xref="index#formulaires" group="#first"/>
<link type="guide" xref="formulaires" group="#first" />
<link type="guide" xref="index#formulaires" />
<desc>N'afficher à l'usager que les pages correspondant à sa situation</desc>
</info>
<p>Les formulaire conditionnels permettent de rendre un formulaire dynamique, d'afficher ou non certaines pages en fonction des réponses de l'utilisateur à certaines questions. L'affichage des pages peut en effet être soumis à des « conditions ». Ces conditions sont remplies, ou non, en fonctions des réponses de l'utilisateur.</p>
@ -13,30 +13,17 @@
<section id="form_variable">
<title>Nom de variable</title>
<p>Les noms de variable sont des identifiants que l'on peut donner à chaque champ. Donner un nom de variable est généralement inutile, mais cela devient intéressant lorsque le champ est une question qui va être utilisée pour conditionner l'affichage d'une page. On utilisera en effet ce nom de variable pour écrire la condition décidant de l'affichage d'une page.</p>
<p>Les noms de variables sont des identifiants que l'on peut donner à chaque champ. Donner un nom de variable est utile lorsque le champ est une question qui va être utilisée pour conditionner l'affichage d'une page. On utilisera en effet ce nom de variable pour écrire la condition décidant de l'affichage de la page en question.</p>
<p>Les noms de variables sont soumis à des règles, ils doivent contenir des chiffres ou des lettres, sans accentuation ni espaces (on remplace généralement ces derniers par le caractère underscore).</p>
<p>Les noms de variables sont soumis à des règles, ils doivent contenir des chiffres ou des lettres, sans caractères spéciaux (on remplace généralement les espaces par le caractère underscore).</p>
</section>
<section>
<title>Pages conditionnelles</title>
<p>Les champs de type « Nouvelle page » sont les seuls à posséder une option particulière « Condition » accessible lorsqu'on les édite. C'est dans ce champ que l'on va écrire la règle décidant si cette page doit être affichée ou non. Il existe deux façons d'écrire cette condition :</p>
<p>Les champs de type « Nouvelle page » sont les seuls à posséder une option particulière - accessible lorsqu'on les édite - « Condition » . C'est dans ce champ que l'on va écrire la règle décidant si cette page doit être affichée ou non.</p>
<section>
<title>Avec un nom de variable</title>
<p>Nous avons vu que l'on pouvait donner un nom de variable à un champ :</p>
<figure>
<media type="image" src="figures/nom_var.png" />
</figure>
<p>Le champs en question est une liste qui contient plusieurs réponses, disons deux réponses pour l'exercice : </p>
<list>
<item><p>1ère catégorie</p></item>
<item><p>2ème catégorie</p></item>
</list>
<p>Nous avons vu que l'on pouvait donner un nom de variable à un champ, cette variable peut être utilisée pour écrire la condition d'affichage de la page. </p>
<p>La condition s'écrira alors selon la forme suivante :</p>
@ -44,35 +31,17 @@
<media type="image" src="figures/condition_type_chasse.png" />
</figure>
<p>On voit que l'on ajoute avant le nom de la variable le préfixe <em>var_</em>. Puis, on utilise l'opérateur <em>==</em> qui signifie « égal à », enfin on ajoute entre guillemets la valeur de la réponse attendue pour que la condition soit respectée. Si l'utilisateur sélectionne « 1ère catégorie » dans la liste déroulante, la page « Chien de 1ère catégorie » lui sera affichée, si il choisit autre chose, il ne la verra pas et passera directement à la page suivante (ou aura terminé le questionnaire s'il n'y a pas de page suivante).</p>
<p>Il est nécessaire d'ajouter, avant le nom de la variable, le préfixe <em>var_</em>. Puis, d'utiliser l'opérateur <em>==</em> qui signifie « égal à ». Enfin il faut faire figurer, entre guillemets, la valeur exacte (respect de la casse et de l'accentuation) de la réponse attendue pour que la condition soit respectée. Si la réponse de l'utilisateur correspond à la conditino, la page est affichée, dans le cas inverse elle ne l'est pas.</p>
<note style="warning">
<title>Respectez la casse !</title>
<p>La casse est importante (majuscule / minuscule). Si vous ne la respectez pas dans l'écriture de la condition, cela ne fonctionnera pas.</p>
</note>
</section>
<section>
<title>Avec l'identifiant de l'URL</title>
<p>Plutôt que d'utiliser un nom de variable, on peut se contenter de son identifiant, récupérable dans l'URL du champ lorsqu'on l'édite. Par exemple l'URL http://wcs.exemple.org/admin/forms/28/fields/15/ nous permet de savoir que le champs édité a le numéro 15. Il suffit de faire précéder ce chiffre d'un f (pour « field ») afin d'obtenir l'identifiant.</p>
<p>La condition peut alors s'écrire sous la forme :</p>
<figure>
<media type="image" src="figures/condition_id_type_chasse.png" />
</figure>
<p>f15 remplace ici le nom de variable utilisé dans l'exemple précédent, tout le reste est identique. Cette forme de notation est utile pour les experts qui ne souhaitent pas s'embarrasser avec des noms de variable mais elle est moins lisible.</p>
<note style="warning">
<title>Respectez la case !</title>
<p>La casse est importante (majuscule / minuscule). Si vous ne la respectez pas dans l'écriture de la condition, cela ne fonctionnera pas.</p>
</note>
</section>
<note style="advanced">
<title>Champs servant de base à une condition</title>
<p>Une condition porte uniquement sur la réponse apportée à des champs de type « liste » ou « case à cocher ».</p>
</note>
</section>
</page>

View File

@ -5,15 +5,15 @@
<title>5. Importer / exporter un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first"/>
<link type="guide" xref="formulaires" group="#first" />
<link type="guide" xref="index#formulaires" />
<desc>Échanger des formulaires entre sites différents</desc>
</info>
<p>Il est possible d'importer ou exporter un formulaire sous forme de fichier texte structuré portant l'extension .wcs. C'est-à-dire que vous pouvez ajouter dans votre solution Au Quotidien un formulaire conçu ailleurs, mais également partager un de vos formulaires en l'exportant dans un fichier de ce type.</p>
<p>Il est possible d'importer ou d'exporter un formulaire sous forme de fichier texte structuré portant l'extension .wcs. C'est-à-dire que vous pouvez ajouter dans votre solution Au Quotidien un formulaire conçu ailleurs, mais également partager un de vos formulaires en l'exportant.</p>
<note style="important">
<p> Il existe un <link href="http://www.au-quotidien.com/fr/community/">site communautaire</link> pour uploader et télécharger des formulaires Au Quotidien, vous êtes encouragé à partager vos créations et à récupérer les formulaires vous intéressant.</p>
<p> Il existe un <link href="http://www.au-quotidien.com/fr/community/">site communautaire</link> pour uploader et télécharger des formulaires Au Quotidien, vous pouvez partager vos créations et à récupérer les formulaires vous intéressant.</p>
</note>
<section>
@ -21,7 +21,7 @@
<p>L'import de formulaire s'effectue depuis un fichier au format .wcs.</p>
<p>Pour importer un formulaire enregistré sur votre ordinateur, allez dans votre espace personnel, <em>Admin</em>, puis dans <em>Formulaires</em>. Vous avez le lien <em>Import</em> : </p>
<p>Pour importer un formulaire enregistré sur votre ordinateur, allez dans « Admin », puis dans « Formulaires ». Cliquez sur le lien « Import » : </p>
<figure>
<media type="image" src="figures/form_lien_import.png" />
@ -34,7 +34,7 @@
<section>
<title>Export</title>
<p>Pour exporter un formulaire vous devez vous rendre sur sa page d'édition, dans votre espace personnel, <em>Admin</em> puis dans <em>Formulaires</em> et cliquez sur le formulaire à exporter.</p>
<p>Pour exporter un formulaire vous devez vous rendre sur la page d'édition de ce dernier, cliquez sur « Admin » puis sur « Formulaires » et sur le formulaire à exporter.</p>
<p>Sur la page vous avez un menu à droite :</p>
@ -42,7 +42,7 @@
<media type="image" src="figures/form_lien_export.png" />
</figure>
<p>Lorsque vous cliquez dessus, une fenêtre de votre navigateur s'affiche pour exporter le formulaire dans un fichier au format .wcs sur votre ordinateur.</p>
<p>Lorsque vous cliquez dessus, vous avez la possibilité de télécharger le formulaire au format .wcs sur votre ordinateur.</p>
</section>

View File

@ -4,23 +4,23 @@
<title>3. Créer un formulaire multipages</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
<link type="guide" xref="index#formulaires" />
<desc>Découper un formulaire en plusieurs pages</desc>
</info>
<p>Pour créer un formulaire multi-page il suffit de faire figurer comme premier champ du formulaire, un champ de type « Nouvelle page », de mettre à sa suite tous les champs appartenant à la première page. On met ensuite un autre champ nouvelle page et à sa suite tous les champs relatifs à cette nouvelle page et ainsi de suite.</p>
<p>Pour créer un formulaire multi-page il suffit de faire figurer comme premier champ du formulaire, un champ de type « Nouvelle page », puis de mettre à sa suite tous les champs appartenant à la première page. On met alors un second champ « Nouvelle page » et à sa suite tous les champs relatifs à celle-ci et ainsi de suite.</p>
<figure>
<title>Formulaire multi-page</title>
<media type="image" src="figures/form_multipage.png" />
</figure>
<p>Les différentes pages créées apparaissent dans un cadre spécifique sur l'interface publique, dans la colonne de gauche :</p>
<p>Les différents titres des pages créées apparaissent dans un cadre spécifique sur l'interface publique, en marge du formulaire :</p>
<figure>
<title>Titre des pages dans la colonne de gauche</title>
<title>Titre des pages à côté du formulaire</title>
<media type="image" mime="image/png" src="figures/colonne_multipage.png" >
</media>
</figure>
<p>Cette liste de titres permet de visualiser le déroulé du formulaire, la page en cours de saisie apparaissant en gras dans la liste.</p>
</page>

View File

@ -5,8 +5,8 @@
<title>1. Créer un formulaire</title>
<info>
<link type="guide" xref="index#formulaires" group="#first" />
<link type="guide" xref="formulaires" group="#first" />
<link type="guide" xref="index#formulaires" />
<desc>Caractéristiques basiques d'un formulaire</desc>
</info>
@ -78,24 +78,7 @@ xref="workflows_form">attribution d'un workflow à un formulaire</link>.</p>
<section id="champs">
<title>Champs</title>
<p> Cette partie vous permet de créer les différents champs de votre formulaire, voyez la page consacrée à l'<link xref="champs">ajout de champs</link>. Les champs peuvent être de différents types :</p>
<list>
<item><p><link xref="form_champs#types_champs">Texte</link></p></item>
<item><p><link xref="form_champs#types_champs">Texte Long</link></p></item>
<item><p><link xref="form_champs#types_champs">Courriel</link></p></item>
<item><p><link xref="form_champs#types_champs">Case à cocher</link></p></item>
<item><p><link xref="form_champs#types_champs">Upload de fichier</link></p></item>
<item><p><link xref="form_champs#types_champs">Date</link></p></item>
<item><p><link xref="form_champs#types_champs">Liste</link></p></item>
<item><p><link xref="form_champs#types_champs">Liste à choix multiple</link></p></item>
<item><p><link xref="form_champs#types_champs">Tableau</link></p></item>
<item><p><link xref="form_champs#types_champs">Tableau de listes</link></p></item>
<item><p><link xref="form_champs#types_champs">Éléments classés</link></p></item>
<item><p><link xref="form_champs#types_champs">Titre</link></p></item>
<item><p><link xref="form_champs#types_champs">Sous-titre</link></p></item>
<item><p><link xref="form_champs#types_champs">Commentaire</link></p></item>
<item><p><link xref="form_champs#types_champs">Nouvelle page</link></p></item>
</list>
<p> Cette partie vous permet de créer les différents champs de votre formulaire lorsque vous cliquez sur le lien « Édition », voyez la page consacrée à l'<link xref="champs">ajout de champs</link> pour voir les différents types de champs disponibles.</p>
</section>

View File

@ -1,19 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="formulaires">
<title>Formulaires</title>
<info>
<link type="guide" xref="index" group="1"/>
<desc>Comment gérer les formulaires</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<p>Les formulaires permettent aux usagers d'effectuer une demande auprès de la collectivité. Ils autorisent un niveau de personnalisation important, les rendant adaptés à de nombreux usages.</p>
</page>

View File

@ -1,42 +1,54 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="index">
<info>
<revision docversion="1.1" date="2013-12-13" status="final"/>
<license>
<p>Ce travail est publié à la fois sous <link href="http://creativecommons.org/licenses/by-sa/3.0/fr/">licence Creative Commons Paternité - Partage à l'Identique 3.0</link> et sous <link href="http://www.gnu.org/licenses/gpl.html">licence GPL v3.</link></p>
</license>
<credit type="author">
<name>Victor Claudet</name>
<email>vclaudet@entrouvert.com</email>
</credit>
<credit type="author">
<name>Pierre Cros</name>
<email>pcros@entrouvert.com</email>
</credit>
<credit type="author">
<name>Kévin Gaspard</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<title>Documentation Au quotidien</title>
<p>L'offre Au quotidien s'appuie sur le logiciel libre w.c.s.</p>
<p>w.c.s est un logiciel permettant de générer des formulaires et des consultations en ligne et de les intégrer dans un workflow. Configuré par défaut pour des besoins basiques, il offre une personnalisation poussée permettant de l'adapter à de nombreux usages différents. Un ensemble de formulaires mettant en avant différentes fonctionnalités de w.c.s est disponible :</p>
<links type="topic" groups="
1
2
3
4
5
6
"/>
<p>w.c.s est un logiciel permettant de générer des formulaires et des consultations en ligne et de les intégrer dans un workflow. Configuré par défaut pour des besoins basiques, il offre une personnalisation poussée permettant de l'adapter à de nombreux usages différents.</p>
<section id="formulaires" style="2column">
<info>
<title type="link" role="trail">Formulaires</title>
</info>
<title>Formulaires</title>
<p>Les formulaires permettent aux usagers d'effectuer une demande auprès de la collectivité. Ils sont très simples à mettre en place et ne nécessitent pas de compétences informatiques importantes.</p>
</section>
<section id="workflows" style="2column">
<title>Workflows</title>
<p>Le workflow consiste en une succession d'étapes suivies par la demande d'un usager. Il commence à l'enregistrement de la demande pour s'achever lorsque son traitement est terminé (élaboration d'un document, réponse à la demande, interventions, etc.). Ce circuit est entièrement paramétrable dans Au quotidien. Il peut être différent pour chaque formulaire ou commun à plusieurs formulaires. Le workflow définit comment, où et qui traite la demande.</p>
</section>
<section id="utilisateur_et_role" style="2column">
<section id="utilisateurs" style="2column">
<title>Utilisateurs et rôles</title>
<p>Au Quotidien propose un système basé sur des utilisateurs et des rôles pour utiliser et administrer l'application. Les autorisations dont dipose un utilisateur sur la plateforme proviennent de son ou ses rôle(s).</p>
</section>
<section id="personnalisation" style="2column">
<section id="personnaliser" style="2column">
<title>Personnaliser Au Quotidien</title>
</section>
<section id="avancee" style="2column">
<title>Utilisation avancée</title>
<p>Au quotidien utilise un système de template (modèles) qui permet de personnaliser aussi bien la structure d'une page que des messages, des mails, des SMS... Par ailleurs le thème graphique utilisé peut être modifié et même remplacé par un autre.</p>
</section>
</page>

View File

@ -1,255 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="perso_aq">
<title>Personnaliser Au Quotidien</title>
<info>
<link type="guide" xref="index" group="4"/>
<desc>Comment personnaliser l'apparence et le comportement d'Au Quotidien</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<section id="param_apparance_aq">
<title>Paramétrer l'apparence d'Au Quotidien</title>
<section id="creer_modifier_theme_graph">
<title>Créer ou modifier un thème graphique</title>
<p>Le thème établit le style général des pages publiques. Un certain nombre de thèmes sont disponibles et définissent
(grâce à l'utilisation de feuilles de style) les éléments de base de la mise en forme des pages publiques. Vous pouvez
définir votre propre thème (avec votre bandeau, votre logo...) si vous avez les compétences requises en matières de
CSS.</p>
<p>Un thème se compose au minimum de deux fichiers : desc.xml et wcs.css. Le ficher desc.xml est un fichier XML
comprenant quelques informations de bases sur le thème : son nom, sa version, son étiquette, sa description, son auteur.
La feuille de style définit les différentes propriétés appliquées aux éléments de chaque page.</p>
<p>Ces deux fichiers doivent être uploader, pour cela allez dans votre espace personnel, <em>Admin</em>,
<em>Paramètres</em> et cliquez sur <em>Thèmes</em> dans la section personnalisation. Cliquez sur <em>Uploader un nouveau
thème :</em>
</p>
<figure>
<media type="image" src="figures/theme_upload.png" />
</figure>
<p>Choisissez dans votre ordinateur votre thème archivé au format .zip.</p>
</section>
<section id="creer_modifier_squelette">
<title>Créer ou modifier le squelette HTML utilisé</title>
<p>Le squelette définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire
qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en modifiant
le squelette utilisé. Les squelettes sont de simples fichiers texte qui contiennent (entre autres choses) un certain
nombre de variables, écrites entre crochets. Ces variables sont remplacées dans la page publique, par la valeur qui leur
a été attribuée. Voici les variables à connaître pour faire des modifications dans le squelette :</p>
<terms>
<item>
<title>title :</title>
<p>Titre de la page affichée en haut de celle-ci</p>
</item>
<item>
<title>site_name :</title>
<p>Nom du site</p>
</item>
<item>
<title>css : </title>
<p>Le nom du fichier contenant la feuille de style</p>
</item>
<item>
<title>script :</title>
<p>Javascripts utilisés par Au quotidien pour certaines fonctionnalités comme le tri des listes</p>
</item>
<item>
<title>onload :</title>
<p>Instructions en javascript déclenchées lors d'un évènement. Cette variable a vocation à être placée comme valeur
de l'attribut onload dans la balise body</p>
</item>
<item>
<title>breadcrumb :</title>
<p>Le fil d'Ariane</p>
</item>
<item>
<title>body :</title>
<p>Contenu principal de la page, habituellement situé entre le titre et le pied de page</p>
</item>
</terms>
<p>Pour modifier le squelette rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Squelette</em>
dans la partie <em>Personnalisation</em>, vous arrivez sur cette page :</p>
<figure>
<media type="image" src="figures/squelette.png" />
</figure>
<p>Le champ contient le code HTML, avec les variables définit ci-dessus, vous permettant d'éditer depuis l'interface
d'administration l'ensemble du squelette. Cliquez sur <em>Valider</em> pour appliquer le nouveau squelette.</p>
<p>Le bouton <em>Restaurer le squelette par défaut</em> vous permet de récupérer le squelette d'origine.</p>
</section>
</section>
<section id="">
<title>Paramétrer les textes et les messages</title>
<section id="envoyer_annonce_utilisateur">
<title>Envoyer des annonces aux utilisateurs</title>
<p>Les annonces sont un moyen de communiquer une information à l'ensemble de vos abonnés par e-mail ou par SMS, ainsi
que de diffuser une copie dans la section <em>Annonces aux citoyens</em> qui ne nécessite aucun abonnement.</p>
<p>Dans votre espace personnel, allez dans <em>Back-office</em>, puis dans <em>Annonces</em> et cliquez sur <em>Nouvelle
Annonce</em>
.</p>
<p>Vous êtes redirigé sur une page vous permettant d'écrire votre nouvelle annonce :</p>
<figure>
<media type="image" src="figures/annonce.png" />
</figure>
<p>Vos devez écrire obligatoirement un
titre et un texte. Vous pouvez choisir une date de publication de votre annonce ou l'envoyer automatiquement en cliquant
sur <em>Valider</em>. Vous pouvez aussi choisir une date d'expiration, date à laquelle l'annonce
disparaîtra de la page
<em>Annonces aux citoyens</em>.</p>
</section>
<section id="perso_texte_affiche">
<title>Personnaliser les textes affichés sur le front-office</title>
<p>L'ensemble des textes présents sur le front-office peuvent être modifiés directement depuis ce dernier en cliquant
sur le bouton <em>Modifier le texte</em> près du texte désiré:</p>
<figure>
<media type="image" src="figures/modifier_texte_frontoffice.png" />
</figure>
<p>Ou en allant dans votre espace personnel en cliquant sur <em>Admin</em>, puis rendez-vous dans <em>Paramètres</em> et
cliquez sur <em>Textes</em> dans la section <em>Personnalisation</em>.</p>
<p>La liste de l'ensemble des textes personnalisables est présente :</p>
<figure>
<media type="image" src="figures/texte_personnalise.png" />
</figure>
<p>Il suffit de cliquer sur le titre du texte que l'on souhaite éditer. Vous êtes redirigé sur une
page comprenant un champ de saisie de texte et de la liste des
<em>Variables de substitution</em>.</p>
</section>
<section id="perso_courriel_envoye">
<title>Personnaliser les courriels envoyés</title>
<p>Les annonces permettent de diffuser à l'ensemble des abonnés (et à ceux qui lisent la section <em>Annonces aux
citoyens</em>
sur la page d'accueil) des messages importants.</p>
<p>Dans votre espace personnel, allez dans <em>Admin</em>, puis dans <em>Paramètres</em> et cliquez sur
<em>Courriels</em> dans la section <em>Personnalisation</em>. Dans <em>Divers</em> cliquez
sur <em>Publication de l'annonce aux abonnés</em>, cette page vous permet de personnaliser la forme de vos annonces
:</p>
<figure>
<media type="image" src="figures/courriels.png" />
</figure>
<p>Ci-dessous sont listés les <em>Variables de substitution</em> qui permettent d'automatiser l'affichage de certains
informations (nom et prénom de l'utilisateur, le nom du site, la date actuelle etc).</p>
<p><em>[title]</em> affichera automatiquement le sujet qui a été rédigé pour l'annonce (voir
<em><link xref="perso_aq#envoyer_annonce_utilisateur">Envoyer des annonces aux utilisateurs</link></em>
),
tout comme <em>[text]</em> affichera le corps du message rédigé. Cela vous permet par exemple de
rajouter une signature en fin de corps, après la variable <em>[text]</em>, afin d'automatiser son affichage sans
intervention humaine.</p>
<p>En cliquant sur <em>Validez</em> vous appliquerez les modifications de la structure de vos annonces.</p>
</section>
<section id="perso_sms_envoye">
<title>Personnaliser les SMS envoyés</title>
<p>Il existe deux types d'envoie d'SMS :</p>
<terms>
<item>
<title>Par annonce</title>
<p>Un SMS sera envoyé au même titre qu'une annonce par e-mail mais dans un format plus court aux abonnés. Des
variables peuvent être utilisées tout comme pour les e-mails (Voir <link xref="#perso_courriel_envoye">Personnaliser les
courriels envoyés</link>
).</p>
</item>
<item>
<title>Par le workflow</title>
<p>Un SMS sera envoyé à l'expéditeur d'une demande. Cela se produit lorsque la demande de l'expéditeur passe dans un
statut où l'envoie d'un SMS a été paramétré.</p>
</item>
</terms>
<p>Pour configurer les options des annonces par SMS rendez-vous dans votre espace personnel, allez dans <em>Admin</em>,
puis dans <em>Panneau de contrôle</em> et cliquez sur <em>Options des annonces</em> :</p>
<figure>
<media type="image" src="figures/option_annonce.png" />
</figure>
<p>L'option <em>Support des SMS</em> permet d'activer ou désactiver les annonces par SMS. Le <em>Masque pour les numéros
de mobiles</em>
indique quel type de numéro sont compatibles pour s'abonner. Pour la France le format à utiliser est
<em>0XXXXXXXXX</em> (comprenant les numéros en 06 et 07).</p>
</section>
<section id="langue">
<title>Configurer la langue du site</title>
<p>Au Quotidien peut être configuré dans toutes les langues. Il suffit de disposer du fichier de
traduction (.po) pour la langue souhaité et l'installé dans Au Quotidien (contactez votre hébergeur web).</p>
<p>Puis, rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et <em>Langue</em>. Une liste déroulante vous
propose de choisir parmis les langues disponibles sur le système.</p>
</section>
<section id="nom_adresse_site">
<title>Configurer le nom et les adresses du site</title>
<p>Il est possible de modifier le nom du site ainsi que son adresse pour l'adapter à vos besoins.</p>
<p>Modifiez le nom à votre guise. Le nom du site apparaît dans la back-office :</p>
<figure>
<media type="image" src="figures/nom_back_office.png" />
</figure>
<p>Et dans le front-office :</p>
<figure>
<media type="image" src="figures/nom_front_office.png" />
</figure>
<p>Les URLs changeront uniquement dans vos mails et lorsqu'il sera donné à l'utilisateur. Il doit être strictement
identique à celui utilisé dans votre navigateur, qui lui est configuré chez l'hébergeur web.</p>
</section>
</section>
</page>

View File

@ -1,20 +1,22 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" id="perso_templates" xml:lang="fr">
<title>2. Mécanique de template</title>
<info>
<revision docversion="0.1" date="2013-07-06" status="draft"/>
<credit type="author">
<name>Frédéric Péters</name>
<email>fpeters@entrouvert.com</email>
</credit>
<link type="guide" xref="index#personnalisation" />
<link type="guide" xref="perso_aq" group="#first" />
<link type="guide" xref="index#personnaliser" />
<desc>Les modèles de page et les modèles de mails</desc>
</info>
<title>2. Modèles de courriels et de pages</title>
<section id="mail">
<title>Modèles de courriels</title>
<p></p>
</section>
<p>
De nombreux éléments permettent l'utilisation d'un système simple permettant
de générer du contenu variant suivant certaines données. L'exemple le plus
@ -22,6 +24,10 @@ simple peut être le contenu d'un courriel, dans lequel l'utilisateur se voit
souhaiter la bienvenue.
</p>
<figure>
<media type="image" src="figures/courriels.png" />
</figure>
<example>
<code>
Bienvenue [session_user_display_name],
@ -69,9 +75,9 @@ détaillée</link> sur le système de template (en anglais).
</p></note>
<section id="creer_modifier_squelette">
<title>Créer ou modifier un squelette</title>
<title>Modèle de page</title>
<p>Le squelette définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en modifiant le squelette utilisé. Les squelettes sont de simples fichiers texte qui contiennent (entre autres choses) un certain nombre de variables, écrites entre crochets. Ces variables sont remplacées dans la page publique, par la valeur qui leur a été attribuée. Voici les variables à connaître pour faire des modifications dans le squelette :</p>
<p>Le squelette (modèle) définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en modifiant le squelette utilisé. Les squelettes sont de simples fichiers texte qui contiennent (entre autres choses) un certain nombre de variables, écrites entre crochets. Ces variables sont remplacées dans la page publique, par la valeur qui leur a été attribuée. Voici les variables à connaître pour faire des modifications dans le squelette :</p>
<terms>
<item>
@ -106,6 +112,10 @@ détaillée</link> sur le système de template (en anglais).
<p>Pour modifier le squelette rendez-vous dans <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Squelette</em> dans la partie <em>Personnalisation</em>.</p>
<figure>
<media type="image" src="figures/squelette.png" />
</figure>
<p>Le champ contient le code HTML, avec les variables définit ci-dessus, vous permettant d'éditer depuis l'interface d'administration l'ensemble du squelette. Cliquez sur <em>Valider</em> pour appliquer le nouveau squelette.</p>
<p>Le bouton <em>Restaurer le squelette par défaut</em> vous permet de récupérer le squelette d'origine.</p>

View File

@ -1,12 +1,12 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" id="perso_themes" xml:lang="fr">
<title>3. Themes</title>
<title>1. Themes</title>
<info>
<link type="guide" xref="index#personnalisation" />
<link type="guide" xref="perso_aq" group="#first" />
<link type="guide" xref="index#personnaliser" />
<desc>Thèmes graphiques responsables de l'habillage des pages publiques du site</desc>
</info>
@ -19,6 +19,20 @@
<p>Ces deux fichiers doivent être uploader, pour cela allez dans votre espace personnel, <em>Admin</em>, <em>Paramètres</em> et cliquez sur <em>Thèmes</em> dans la section personnalisation. Cliquez sur <em>Uploader un nouveau thème</em> et choisissez dans votre ordinateur votre thème archivé au format .zip.</p>
<figure>
<media type="image" src="figures/theme_upload.png" />
</figure>
</section>
<section id="appliquer">
<title>Appliquer un thème</title>
<p>Les thèmes disponibles apparaissent sous forme de liste, il suffit de cliquer sur le thème souhaiter pour qu'il s'applique instantanément aux pages publiques du site.</p>
<note style="advanced">
<title>Éditer le squelette (modèle)</title>
<p>Le squelette définit l'agencement de toutes les pages publiques à l'intérieur d'un thème particulier. C'est-à-dire qu'au sein du thème choisi, il est encore possible d'agir sur la présentation de toutes les pages publiques en <link xref="perso_templates#creer_modifier_squelette">modifiant le squelette utilisé</link>.</p>
</note>
</section>
</page>

View File

@ -1,98 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="roles">
<title>2. Rôles</title>
<info>
<link type="guide" xref="utilisateur_role" group="#first" />
<link type="guide" xref="index#utilisateur_et_role" />
</info>
<section id="intro_utilisateur_role">
<title>Introduction</title>
<p>Les rôles sont prépondérants pour deux choses :</p>
<list>
<item><p>Déterminer qui traitera un formulaire</p></item>
<item><p>Déterminer qui pourra compléter un formulaire</p></item>
</list>
<p>Pour les gérer, depuis l'interface d'administration, cliquez sur <em>Rôles</em>.</p>
</section>
<section id="creer_role">
<title>Créer un rôle</title>
<p>Cliquez sur <em>Nouveau rôle</em> :</p>
<figure>
<media type="image" src="figures/role_nouveau.png" />
</figure>
<p>Une fenêtre apparaît pour créer le rôle, vous pouvez attribuer :</p>
<quote>
<terms>
<item>
<title>Nom du rôle</title>
<p>Nom que portera le rôle</p>
</item>
<item>
<title>Détail du rôle</title>
<p>S'il est complété, ce champ donne une information, au niveau du récapitulatif d'une demande, sur le rôle chargé du traitement de celle-ci.</p>
</item>
<item>
<title>Courriels du rôle</title>
<p>Une ou plusieurs adresses e-mail à attribuer au rôle. Lorsque le rôle est destinataire d'un formulaire, les mails envoyés au destinataire, seront envoyés à cette adresse.</p>
</item>
<item>
<title>Propager les courriels à tous les utilisateurs ayant ce rôle</title>
<p>Si cette case est cochée, les mails ne sont plus simplement envoyé à l'adresse courriel du rôle, ils sont aussi envoyés à chaque utilisateur a qui l'on a attribué ce rôle.</p>
</item>
<item>
<title>Les utilisateurs disposant de ce rôle peuvent accéder au back-office</title>
<p>Permet de déterminer si le rôle en question donne accès ou non au backoffice de traitement des demandes. Pour un rôle concernant les citoyens, par exemple « responsable d'une association », on ne cochera pas cette case. Pour un rôle concernant les agents devant traiter les demandes, par exemple « Gestionnaire état civil », on cochera cette case.</p>
</item>
</terms>
</quote>
<p>Validez votre nouveau rôle pourle créer, il apparaît désormais dans la liste.</p>
</section>
<section id="edit_suppr_role">
<title>Éditer / Supprimer un rôle</title>
<p>Cliquez sur le rôle que vous voulez modifier :</p>
<figure>
<media type="image" src="figures/liste_role.png" />
</figure>
<p>Sur la page du rôle vous trouvez les liens <em>Éditer</em>
et <em>Supprimer</em>, permettant respectivement de modifier votre rôle ou de le
supprimer :</p>
<figure>
<media type="image" src="figures/editer_suppr_role.png" />
</figure>
<p>Lors d'une édition vous êtes redirigé sur une page similaire à la
fenêtre de création d'un rôle. Une fois vos changements effectué, validez.
Vous êtes redirigé sur la page du rôle. En cas de suppression vous serez
redirigé vers la listes des rôles.</p>
</section>
<section id="changer_role_form">
<title>Changer les rôles dans un formulaire</title>
<p>Vous pouvez <link xref="form_simple#creer_form">changer le destinataire ou l'expéditeur d'un formulaire</link> en jouant sur les rôles qui lui sont associés.</p>
</section>
</page>

View File

@ -2,20 +2,63 @@
type="guide"
id="utilisateur_role">
<title>Utilisateurs et rôles</title>
<title>2. Rôles</title>
<info>
<link type="guide" xref="index" group="3"/>
<desc>Comment gérer les utilisateurs et les rôles</desc>
<link type="guide" xref="index#utilisateurs" />
<desc>Gérer les rôles</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<p>Au Quotidien propose un système basé sur des utilisateurs et des rôles pour utiliser et administrer l'application.</p>
<p>Chaque utilisateur peut se voir offrir un ou plusieurs rôles qui détermine(nt) ce qu'il a le droit de faire dans Au quotidien.</p>
<section id="creer_role">
<title>Créer un rôle</title>
<p>Cliquez sur « Nouveau rôle » :</p>
<figure>
<media type="image" src="figures/role_nouveau.png" />
</figure>
<p>Il est alors possible de configurer :</p>
<list>
<item><p>Nom du rôle : le libellé tel qu'il apparaîtra dans l'application.</p></item>
<item><p>Détail du rôle : informations complémentaires à propos du rôle.</p></item>
<item><p>Courriel du rôle : adresse email à laquelle seront envoyés les messages destinés à ce rôle.</p></item>
<item><p>Propager les courriels à tous les utilisateurs ayant ce rôle : cocher cette case permet de faire en sorte que les emails ne soient plus seulement envoyés à l'adresse email du rôle. Ils seront envoyés aux adresses email de tous les utilisateurs ayant ce rôle.</p></item>
<item><p></p></item>
</list>
<p>Après validation, le nouveau rôle apparaît dans la liste.</p>
</section>
<section id="edit_suppr_role">
<title>Éditer / Supprimer un rôle</title>
<p>Cliquez sur le rôle que vous voulez modifier :</p>
<figure>
<media type="image" src="figures/liste_role.png" />
</figure>
<p>Sur la page du rôle les liens « Éditer »
et « Supprimer », permettant respectivement de modifier votre rôle ou le
supprimer :</p>
<figure>
<media type="image" src="figures/editer_suppr_role.png" />
</figure>
<p>Lors d'une édition vous êtes redirigé sur une une page similaire à la
fenêtre de création d'un rôle. Une fois vos changements effectué, validez.
Vous êtes redirigé sur la page du rôle. En cas de suppression vous serez
redirigé vers la page « Rôles ».</p>
</section>
<p>Il est important que chaque personne utilisant Au Quotidien dispose de son propre compte utilisateur. Chaque utilisateur dispose d'un ou de plusieurs rôles qui détermine(nt) ses droits dans l'application.</p>
</page>

View File

@ -5,233 +5,26 @@
<title>1. Utilisateurs</title>
<info>
<link type="guide" xref="utilisateur_role" group="#first" />
<link type="guide" xref="index#utilisateur_et_role" />
<link type="guide" xref="index#utilisateurs" />
<desc>Gérer les utilisateurs</desc>
</info>
<section id="intro_utilisateur_role">
<title>Introduction</title>
<p>Au Quotidien propose un système basé sur des utilisateurs et des rôles pour utiliser et administrer l'application.</p>
<p>Il est important que chaque personne utilisant Au Quotidien dispose de son propre compte utilisateur. Chaque utilisateur fait partie d'un ou plusieurs rôles qui gèrent les permissions de chacun.</p>
<p>Les rôles sont utilisés pour deux aspects différents :</p>
<list>
<item><p>Accéder aux formulaires en ligne sur le front-office de l'application</p></item>
<item><p>Accéder à la gestion et au traitement des demandes issues des formulaires</p></item>
</list>
</section>
<section id="creer_admin">
<title>Création initiale d'un administrateur</title>
<note>
<p>Cette partie ne vous concerne que si vous avez procédé vous-même à
l'installation de w.c.s, dans le cas contraire votre prestataire a
du s'en charger pour vous.</p>
</note>
<p>L'administrateur est l'utilisateur ayant le plus de droits au sein
d'Au Quotidien, il a accès à la partie <em>Admin</em>. Il peut gérer les
formulaires, les workflows, les utilisateurs, les rôles et changer les
paramètres d'Au Quotidien.</p>
<p>C'est donc l'utilisateur le plus important et il est primordial que son
accès soit restreint à une personne, désigné comme responsable, avec un bon
mot de passe.</p>
<p>Une fois w.c.s installé, vous devez ajouter cette utilisateur
manuellement via l'onglet <em>utilisateurs</em></p>
</section>
<section id="utilisateur">
<title>Les utilisateurs</title>
<p>Dans <em>Admin</em> rendez vous dans l'onglet <em>Utilisateurs</em>.</p>
<p> Les utilisateurs apparaissent sous forme de liste. Le nom de ceux qui disposent de permissions particulières est précédé d'une couleur significative</p>
<section id="creer_utilisateur">
<title>Créer un utilisateur</title>
<p>Cliquez sur <em>Nouvel utilisateur</em> :</p>
<figure>
<media type="image" src="figures/utilisateur_nouveau.png" />
</figure>
<p>Vous êtes redirigé sur un formulaire de création, il vous permet
d'attribuer :</p>
<quote>
<terms>
<item>
<title>Nom</title>
</item>
<item>
<title>Prénom</title>
</item>
<item>
<title>Courriel</title>
<p>L'adresse e-mail de l'utilisateur</p>
</item>
<item>
<title>Compte administrateur</title>
<p>Déterminer s'il sera administrateur</p>
</item>
<item>
<title>Rôles</title>
<p>Un ou plusieurs rôles</p>
</item>
<item>
<title>Identifiant</title>
<p>Le nom du compte</p>
</item>
<item>
<title>Mot de passe</title>
</item>
</terms>
</quote>
<p>Vous pouvez aussi cocher :</p>
<quote>
<terms>
<item>
<title>En attente de confirmation</title>
<p>Une personne sera chargé de valider le compte</p>
</item>
<item>
<title>En attente de modération</title>
<p>Un modérateur sera chargé de valider le compte</p>
</item>
<item>
<title>Compte désactivé</title>
<p>Désactiver le compte au lieu de le supprimer, l'accès y est impossible et tout ce qui concerne l'utilisateur est conservé.</p>
</item>
</terms>
</quote>
<p>Une fois complété, validez. Vous êtes redirigé vers la page
des <em>Utilisateurs</em> où l'utilisateur est désormais listé.</p>
</section>
<section id="editer_suppr_utilisateur">
<title>Éditer / Supprimer un utilisateur</title>
<p>Cliquez sur le nom de l'utilisateur dans la liste :</p>
<figure>
<media type="image" src="figures/liste_utilisateur.png" />
</figure>
<p>Vous êtes redirigé vers sa page, vous avez les liens <em>Éditer</em>
et <em>Supprimer</em> qui respectivement vous permettent de modifier ou
supprimer votre utilisateur :</p>
<figure>
<media type="image" src="figures/utilisateur_lien_edition_suppr.png" />
</figure>
<p>Après l'édition d'un utilisateur vous serez redirigé sur sa page. Après
une suppression vous serez redirigé sur la page <em>Utilisateurs</em>.</p>
<p>Notez qu'il peut être intéressant de désactiver un compte au lieu de le
supprimer en l'éditant. Cela vous permet d'empêcher un utilisateur de se
connecter sans pour autant supprimer son compte avec ses accès et ses
données.</p>
</section>
</section>
<section id="role">
<title>Les rôles</title>
<p>Dans votre espace personnel, allez dans <em>Admin</em> puis dans <em>Rôles</em>.</p>
<section id="creer_role">
<title>Créer un rôle</title>
<p>Cliquez sur <em>Nouveau rôle</em> :</p>
<figure>
<media type="image" src="figures/role_nouveau.png" />
</figure>
<p>Une fenêtre apparaît pour créer le rôle, vous pouvez attribuer:</p>
<quote>
<terms>
<item>
<title>Nom du rôle</title>
<p>Celui que portera le rôle</p>
</item>
<item>
<title>Détail du rôle</title>
<p>Ce sont des informations complémentaires à propos du rôle</p>
</item>
<item>
<title>Courriels du rôle</title>
<p>Une ou plusieurs adresses e-mail à attribuer au rôle</p>
</item>
<item>
<title>Propager les courriels à tous les utilisateurs ayant ce rôle</title>
<p>En cochant la case vous transférerez chaque e-mail au rôle à ses utilisateurs sur leur adresse e-mail.</p>
</item>
<item>
<title>Les utilisateurs disposant de ce rôle peuvent accéder au back-office</title>
<p>Une autorisation d'accéder au back-office à tous les utilisateurs ayant ce rôle</p>
</item>
</terms>
</quote>
<p>Validez, votre nouveau rôle est désormais dans la liste.</p>
</section>
<section id="edit_suppr_role">
<title>Éditer / Supprimer un rôle</title>
<p>Cliquez sur le rôle que vous voulez modifier :</p>
<figure>
<media type="image" src="figures/liste_role.png" />
</figure>
<p>Puis, sur la page du rôle vous avez les liens <em>Éditer</em>
et <em>Supprimer</em>, permettant respectivement de modifier votre rôle ou le
supprimer :</p>
<figure>
<media type="image" src="figures/editer_suppr_role.png" />
</figure>
<p>Lors d'une édition vous êtes redirigé sur une une page similaire à la
fenêtre de création d'un rôle. Une fois vos changements effectué, validez.
Vous êtes redirigé sur la page du rôle. En cas de suppression vous serez
redirigé vers la page <em>Rôles</em>.</p>
</section>
<section id="changer_role_form">
<title>Changer le rôle d'un formulaire</title>
<p>Pour changer le rôle d'un formulaire, rendez-vous sur la page du formulaire
et cliquez sur <em>(changer)</em> à la ligne <em>Rôle du destinataire</em> dans
la partie <em>Accès</em> :</p>
<figure>
<media type="image" src="figures/form_changer_role.png" />
</figure>
<p>Sélectionnez le nouveau rôle et validez.</p>
</section>
</section>
<p>Les comptes des utilisateurs peuvent être affichés mais ils ne sont pas modifiables (car ils sont éditables ailleurs, dans le portail d'administration). La seule action possible est de leur ajouter ou de leur enlever des <link xref="utilisateur_role">rôles</link>.</p>
</section>
<section id="role">
<title>Attribuer un rôle à un utilisateur</title>
<p>Lorsque l'on consulte la fiche d'un utilisateur, le lien à droite « Gérer les rôles » permet de lui attribuer un ou plusieurs rôles. L'utilisateur aura alors accès au traitement de tous les formulaires qui ont pour destinataire le rôle en question.</p>
</section>
</page>

View File

@ -1,18 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="utilisation_avancee">
<title>Utilisation avancée</title>
<info>
<link type="guide" xref="index" group="5"/>
<desc>Comment gérer les utilisateurs et les rôles</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
</page>

View File

@ -2,39 +2,30 @@
type="guide"
id="workflows">
<title>Workflows</title>
<title>1. Introduction</title>
<info>
<link type="guide" xref="index" group="2"/>
<desc>Comment utiliser les workflows</desc>
<link type="guide" xref="index#workflows" />
<desc>Généralités sur les workflows</desc>
<revision pkgversion="1.0" version="1.0" date="2013-04-09" status="final"/>
<credit type="author">
<name>Kévin GASPARD</name>
<email>kgaspard@entrouvert.com</email>
</credit>
</info>
<section id="def_workflow">
<title>Définition</title>
<p>Chaque demande d'un usager est envoyée dans un circuit de traitement qui commence à l'arrivée de la demande dans le service destinataire jusqu'à son traitement (élaboration d'un document, réponse à la demande, interventions, etc.). C'est ce circuit qui est appelé workflow et qui est entièrement paramétrable dans Au quotidien. Ce workflow peut être différent pour chaque formulaire ou commun à plusieurs formulaires. Le workflow définit comment, où et qui traite la demande.</p>
<p>Le workflow consiste en une succession d'étapes de traitement de la demande d'un usager. Il commence à l'enregistrement de la demande pour s'achever lorsque son traitemetn est terminé (élaboration d'un document, réponse à la demande, interventions, etc.). Ce circuit est entièrement paramétrable dans Au quotidien. Il peut être différent pour chaque formulaire ou commun à plusieurs formulaires. Le workflow définit comment, où et qui traite la demande.</p>
</section>
<section id="workflow_aq">
<title>Comment fonctionnent les workflows d'Au Quotidien</title>
<p>Même si tout est paramétrable, certains principes sont communs à la quasi-totalité des workflows. Lorsqu'une demande est envoyée, Au Quotidien alerte par e-mail le demandeur (pour lui confirmer la réception de sa demande) et le destinataire (c'est-à-dire le ou les responsable(s) chargé(s) de traiter la demande). Une série de <link xref="workflows_statuts">statuts</link> (étapes) se succèdent alors, chacun regroupant un liste d'<link xref="workflows_actions">actions</link>.</p>
<p>Même si tout est paramétrable, les principes sont communs à la quasi-totalité des workflows. Lorsqu'une demande est envoyée, le workflow permet par exemple d'alerter par e-mail le demandeur (pour lui confirmer la réception de sa demande) et le destinataire (c'est-à-dire le ou les responsable(s) chargé(s) de traiter la demande). Une série de <link xref="workflows_statuts">statuts</link> (étapes) se succèdent alors, chacun regroupant un liste d'<link xref="workflows_actions">actions</link>.</p>
<p>Ces <link xref="workflows_statuts">statuts</link> et ces <link xref="workflows_actions">actions</link> sont définis dans le workflow et guident les différents intervenants (demandeur, destinataire mais aussi des tiers parfois) vers le traitement final de la demande. Le workflow peut redéfinir le destinataire de la demande, permet de demander une validation, d'élaborer un document selon un template prédéfini, etc.</p>
<p>Ces <link xref="workflows_statuts">statuts</link> et ces <link xref="workflows_actions">actions</link> sont définis dans le workflow et guident les différents intervenants (demandeur, destinataire mais aussi des tiers parfois) vers le traitement final de la demande.</p>
<p>Au Quotidien fournit une série de workflows existants, mais il est possible d'en <link xref="workflows_gerer#creer_workflow_depuis_zero">créer de nouveau</link>, de les <link xref="workflows_gerer#import_export_workflow">importer et exporter</link> .</p>
<p>Au Quotidien fournit une série de workflows existants, mais il est possible d'en <link xref="workflows_gerer#creer_workflow_depuis_zero">créer de nouveau</link>, de les <link xref="workflows_gerer#import_export_workflow">importer et de les exporter</link> .</p>
</section>
</page>

View File

@ -2,11 +2,11 @@
type="topic"
id="workflows_actions">
<title>5. Les actions de workflow</title>
<title>6. Les actions de workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Les actions utilisables à chaque étape du workflow</desc>
</info>
<p>Les actions sont les éléments de base que l'on combine au sein d'un <link xref="workflows_statuts">statut</link> pour déterminer ce qui va se passer lorsqu'une demande atteint le statut en question.</p>
@ -14,7 +14,7 @@
<section id="ajouter-action">
<title>Ajouter une action</title>
<p>Pour ajouter une action à un statut vous cliquez sur le statut en question, vous choisissez une action dans la liste déroulante et vous cliquez sur ajouter :</p>
<p>Pour ajouter une action à un statut cliquez sur le statut en question, puis choisissez une action dans la liste déroulante et cliquez sur ajouter :</p>
<figure>
<media type="image" src="figures/ajouter_action.png" />
@ -25,7 +25,7 @@
<section id="editer-action">
<title>Éditer une action</title>
<p>Pour éditer une action, vous cliquez sur le lien éditer qui apparaît au survol de l'action :</p>
<p>Pour éditer une action, cliquez sur le lien « éditer » qui apparaît au survol de l'action :</p>
<figure>
<media type="image" src="figures/editer_action.png" />
@ -36,7 +36,7 @@
<section id="supprimer-action">
<title>Supprimer une action</title>
<p>Pour supprimer une action, vous cliquez sur le lien supprimer qui apparaît au survol de l'action :</p>
<p>Pour supprimer une action, cliquez sur le lien « supprimer » qui apparaît au survol de l'action :</p>
<figure>
<media type="image" src="figures/supprimer_action.png" />
@ -48,7 +48,7 @@
<title>Les différents types d'action</title>
<section id="afficher_formulaire">
<title></title>
<title>Afficher un formulaire</title>
<p>
Lors du traitement d'une demande il peut être nécessaire de demander des informations supplémentaires à l'usager, ou qu'un agent complète la demande avec des informations internes (à l'image d'un « cadre réservé à l'administration » sur du papier).
@ -56,16 +56,15 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<p>L'action « Afficher un formulaire » permet d'afficher des champs de formulaire supplémentaires (tous les champs w.c.s. sont disponibles) à un rôle particulier : demandeur (expéditeur), destinataire (gestionnaire de la demande) ou n'importe quel autre rôle utilisé dans w.c.s..</p>
<figure>
<title>Afficher un formulaire</title>
<media type="image" src="figures/afficher_formulaire.png" />
</figure>
<p>Lors de l'édition de cette action vous choisissez le rôle concerné, vous donnez un nom au formulaire ( « Nom de variable »), puis vous cliquez sur « Éditer les champs » pour ajouter les champs souhaités. L'ajout se fait exactemment comme pour un <link xref="form_simple">formulaire classique</link> de w.c.s., vous ajoutez autant de champs que vous le souhaitez, vous validez, le formulaire est créé au sein du statut concerné.</p>
<p>Lors de l'édition de cette action choisissez le rôle concerné, donnez un nom au formulaire ( « Nom de variable »), puis cliquez sur « Éditer les champs » pour ajouter les champs souhaités. L'ajout se fait exactemment comme pour un <link xref="form_simple">formulaire classique</link> de w.c.s., vous ajoutez autant de champs que vous le souhaitez. Après validation, le formulaire est créé, au sein du statut concerné.</p>
<note style="important"><p>
Il est important de préciser un <gui>Nom de variable</gui> pour que la valeur qui sera renseignée par le champ soit sauvegardée.
Il est important de préciser pour chaque champ du formulaire un <gui>Nom de <link xref="workflows_variables">variable</link></gui> si l'on souhaite réutiliser, ailleurs dans le workflow, la valeur saisie.
</p></note>
</section>
@ -85,7 +84,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="message_recapitulatif">
<title>Agréger dans un message de récapitulatif</title>
<p>Ce statut permet d'envoyer quotidiennement à un gestionnaire la liste des demandes qui sont dans le statut concerné. Par exemple, on pourra envoyé chaque matin à l'agent en charge du trairement un mail rappellant toutes les demandes ayant le statut "en attente de traitement".</p>
<p>Ce statut permet d'envoyer quotidiennement à un gestionnaire la liste des demandes qui sont dans le statut concerné. Par exemple, on pourra envoyé chaque matin à l'agent en charge du trairement un mail rappellant toutes les demandes ayant le statut « en attente de traitement ».</p>
<figure>
<title>Message de récapitulatif</title>
@ -97,7 +96,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="ajouter_role_expediteur">
<title>Ajouter un rôle à l'expéditeur</title>
<p>Si l'on souhaite que le demandeur se voit attribué un rôle particulier dans le statu concerné, on lui ajouter ce rôle avec cette action. Le rôle vient s'aditionner aux rôles existant pour le demandeur, pas s'y substituer.</p>
<p>Si l'on souhaite que le demandeur se voit attribué un rôle particulier dans le statut concerné, on lui ajoute ce rôle avec cette action. Le rôle vient s'aditionner aux rôles existants pour le demandeur, pas s'y substituer.</p>
<figure>
<title>Ajouter un rôle à l'expéditeur</title>
@ -109,21 +108,19 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="webservice">
<title>Appeler un webservice</title>
<p>Cette action permet de lier w.c.s. à une application tierce grâce à la saisie d'une URL web services :</p>
<p>Cette action permet de lier w.c.s. à une application tierce grâce à la saisie d'une URL webservices :</p>
<figure>
<title>Appeler un webservice</title>
<media type="image" src="figures/webservice.png" />
</figure>
<p>L'URL peut contenir un certain nombre de <link xref="workflows_variables">variables</link> prédéfinies (rappelées sous la fenêtre de texte).</p>
<p>Il faut également donner un nom à l'action ( « Nom de variable ») et préciser FIXME : Envoyer le formulaire (POST, en JSON)</p>
<p>L'URL peut contenir un certain nombre de <link xref="workflows_variables">variables</link> système ou spécifiques à la demande. Le champ nom de variable permet de préciser la variable dans laquelle sera stockeé la réponse du webservice.</p>
</section>
<section id="attribuer_fonction">
<title>Attribuer une fonction</title>
<p>Cette action permet d'attribuer la fonction de destinataire ou d'expéditeur à un rôle particulier. Il peut par exemple s'avérer utile de changer le destinataire de la demande en cours de route lorsque le destinataire initial n'est pas finalement celui qui doit traiter la demande.</p>
<p>Cette action permet d'attribuer la fonction de destinataire ou d'expéditeur à un rôle particulier. Il peut, par exemple, s'avérer utile de réaffecter la demande à un nouveau destinataire à une étape particulière (par exemple suite à une validation hiérarchique).</p>
<figure>
<title>Attribuer une fonction</title>
@ -135,8 +132,9 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="changer_statut">
<title>Changer de statut</title>
<p>Vous pouvez par ce biais définir les actions possibles pour la personne en charge du traitement du formulaire : accepté, refusé, transmis, etc.. Ces éléments correspondent aux boutons d'actions mis à disposition des gestionnaires pour traiter les demandes.</p>
<p>Cette action permet de basculer d'un statut à un autre : accepté, refusé, transmis, etc.. L'action est affichée lors du traitement de la demande, sous forme d'un bouton à disposition des gestionnaires.</p>
<p>Il vous faut définir l'intitulé du bouton pour la personne en charge du traitement, puis le statut associé, enfin les rôles pouvant interagir avec ce bouton.</p>
<p>Sur le schéma cette action est representée par une flèche associant les deux statuts concernés.</p>
<figure>
<title>Changer de statut</title>
@ -147,25 +145,23 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="changer_statut_automatique">
<title>Changer de statut automatiquement</title>
<p>Le changement de statut automatique vous permet de rediriger automatiquement une demande suite à l'exécution d'une série d'actions (envoi de courriels, validation d'un paiement...). Cet élément peut également être conditionné en fonction de la saisie de l'utilisateur. Ainsi, suivant le choix de l'usager dans une liste déroulante, il vous sera possible de rediriger la demande vers une étape de statut prédéterminée.</p>
<p>Le changement de statut automatique permet de basculer d'un statut à un autre sans intervention manuelle. Le basculement s'opère soit :<p>
<list>
<item><p>Lorsqu'une condition basée sur une variable est satisfaite (Champ « Condition »);</p></item>
<item><p>Lorsqu'un webservice déclenche une action (Champ « Déclencheur ») ;</p></item>
<item><p>Lorsqu'un délais est appliqué (Champ « Expiration »)</p></item>
</list>
<figure>
<title>Changer de statut automatiquement</title>
<media type="image" src="figures/changer_statut_automatiquement.png" />
</figure>
<p>Un formulaire de demande de contact proposant une liste de services de la collectivité pourrait être la source de la condition. En fonction du choix de l'usager (services technique, accueil, service communication...), la demande est redirigée directement vers le bon interlocuteur.</p>
<p>Par exemple pour rediriger vers le statut "demande en cours auprès du service communication", la condition sera la suivante: <code>form_var_choixService=="service communication"</code></p>
<p>Le changement de statut peut également être lié à un webservice exterieur. On parle alors de déclencheur. FIXME : Déclencheur ?</p>
<p>Après expiration : Cet élément vous permet de définir un délai de prise en charge à l'issu duquel (sans intervention sur la demande) la demande est redirigée sur un autre statut, pour une relance auprès des services par exemple.</p>
</section>
<section id="changer_statut_soumission">
<title>Changer de statut à la soumission</title>
<p>Cette fonction permet de basculer automatiquement vers un statut après avoir ajouté un commentaire et cliqué sur l'action "ajouter un commentaire" (voir l'élément <link xref="#workflow_commentaire">permettre un commentaire</link>).</p>
<p>Cette option est obsolète. Elle existe pour des raisons de compatibilité mais ne doit plus être utilisée.</p>
<figure>
<title>Changer de statut à la soumission</title>
@ -227,7 +223,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="workflow_edition">
<title>Permettre l'édition</title>
<p>Cette fonction permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) d'éditer, donc de modifier un formulaire une fois validé. Elle peut servir par exemple en cas de consultation à pouvoir changer d'avis dans le temps.</p>
<p>Cette fonction permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) d'éditer, donc de modifier un formulaire déjà validé.</p>
<figure>
<title>Permettre l'édition</title>
@ -238,7 +234,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="workflow_commentaire">
<title>Permettre un commentaire</title>
<p>Cette fonction permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) de commenter le formulaire. Cela est fréquemment utilisé pour permettre un premier échange entre expéditeur et destinataire concernant la demande : on crée alors une action « Permettre un commentaire » avec 2 rôles, expéditeur et destinataire.</p>
<p>Cette action permet à un rôle particulier (demandeur, destinataire ou tout rôle w.c.s.) de commenter le formulaire. Cela est fréquemment utilisé pour permettre un premier échange entre expéditeur et destinataire concernant la demande : on crée alors une action « Permettre un commentaire » avec 2 rôles, expéditeur et destinataire.</p>
<figure>
<title>Permettre un commentaire</title>
@ -249,7 +245,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="workflow_redirection">
<title>Redirection vers la page d'état</title>
<p>Permet directement la page d'état du formulaire au lieu du récapitulatif (après la complétion d'une demande). On peut également s'en servir pour afficher la page d'état du back-office, mais pour pouvoir la visualiser, il faut bien entendu que l'utilisateur ait les droits d'accès au backoffice.</p>
<p>Permet d'afficher directement la page d'état du formulaire au lieu de la page récapitulatif (après la complétion d'une demande). On peut également s'en servir pour afficher la page d'état du back-office, mais pour pouvoir la visualiser, il faut bien entendu que l'utilisateur ait les droits d'accès au backoffice.</p>
<figure>
<title>Redirection vers la page d'état</title>
@ -260,7 +256,7 @@ Lors du traitement d'une demande il peut être nécessaire de demander des infor
<section id="workflow_supprimer_formulaire">
<title>Supprimer le formulaire</title>
<p>Cette action permet de supprimer le formulaire, par exemple lorsque la demande est traitée si on ne souhaite pas l'archiver.</p>
<p>Cette action permet de supprimer le formulaire afin, par exemple, de respecter le délais légal de sotckage des données personnelles.</p>
<figure>
<title>Supprimer le formulaire</title>

View File

@ -2,21 +2,16 @@
type="topic"
id="workflows_defaut">
<title>1. Le workflow par défaut</title>
<title>2. Le workflow par défaut</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Description du foncitonnement du workflow de base d'Au quotidien</desc>
</info>
<section id="inamovible">
<title>Toujours installé</title>
<p>Le workflow par défaut est le seul installé systématiquement dans toutes les instances d'Au Quotidien. Il n'est pas éditable ou supprimable, vous pouvez le dupliquer pour l'adapter à vos besoins ou l'exporter.</p>
<p>Le workflow par défaut est le seul installé systématiquement dans toutes les instances d'Au Quotidien. Il n'est pas éditable ou supprimable, vous pouvez le dupliquer pour l'adapter à vos besoins ou l'exporter.</p>
</section>
<section id="statuts">
<title>Les statuts</title>
@ -26,11 +21,11 @@
<terms>
<item>
<title>Juste envoyé</title>
<p>La demande a été envoyée par l'expéditeur et n'a pas encore été traitée, une copie de la demande est envoyée par e-mail au destinataire et à l'expéditeur, le statut change alors automatiquement pour basculer vers le statut <em>Nouveau</em>.</p>
<p>La demande a été envoyée par l'expéditeur et n'a pas encore été traitée, une copie de la demande est envoyée par e-mail au destinataire et à l'expéditeur, le statut change alors automatiquement pour basculer vers le statut « Nouveau ».</p>
</item>
<item>
<title>Nouveau</title>
<p> Le destinataire et l'expéditeur peuvent laisser un commentaire (à plusieurs reprise, cela leur permet d'échanger, de préciser la demande). Le destinataire choisit ensuite d'accepter la demande (ce qui la fait passer au statut accepté) ou la refuser (ce qui la fait passer au statut Rejeté).</p>
<p> Le destinataire et l'expéditeur peuvent laisser un commentaire (à plusieurs reprises, cela leur permet d'échanger, de préciser la demande). Le destinataire choisit ensuite d'accepter la demande (ce qui la fait passer au statut accepté) ou la refuser (ce qui la fait passer au statut Rejeté).</p>
</item>
<item>
<title>Rejeté</title>
@ -45,6 +40,11 @@
<p>Un e-mail est envoyé au destinataire et à l'expéditeur. La demande est close.</p>
</item>
</terms>
<figure>
<title>Schéma du workflow par défaut</title>
<media type="image" src="figures/schema_statut.png" />
</figure>
</section>

View File

@ -2,12 +2,24 @@
type="topic"
id="workflows_form">
<title>3. Attribuer un nouveau workflow à un formulaire</title>
<title>4. Attribuer un workflow à un formulaire</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Comment associer formulaires et workflows</desc>
</info>
<section id="formulaire-pas-utilise">
<title>Pour un formulaire pas encore utilisé</title>
<p>Lorsque le formulaire auquel on souhaite associer un workflow n'est pas encore en production, il suffit d'afficher la page récapitulative de se formulaire et de cliquer sur « Changer » en face de « Workflow ». On sélectionne alors dans la liste qui apparaît le workflow souhaité.</p>
<figure>
<title>Page récapitulative d'un formulaire</title>
<media type="image" mime="image/png" src="figures/page_edition_form.png"></media>
</figure>
</section>
<section id="formulaire-en-production">
<title>Formulaire en production</title>
<p>Associer un nouveau workflow à un formulaire est relativement simple si le formulaire n'est pas en production, mais cela peut s'avérer plus périlleux si le formulaire est réellement utilisé, surtout si les <link xref="workflows_statuts">statuts</link> entre l'ancien et le nouveau workflow ne sont pas tout à fait identiques.</p>
@ -17,11 +29,10 @@
<item><p>Sélectionnez le workflow désiré dans la liste déroulante et validez.</p></item>
</steps>
<p>Vous avez alors la possibilité d'associer les statuts de l'ancien workflow et ceux du nouveau. Lorsque les deux workflows comportent les mêmes statuts, il suffit de les faire correspondre un à un. Lorsque les statuts sont différents, il vous faut réfléchir à le meilleure façon d'établier la correspondance.</p>
<p>Vous avez alors la possibilité d'associer les statuts de l'ancien workflow et ceux du nouveau. Lorsque les deux workflows comportent les mêmes statuts, il suffit de les faire correspondre un à un. Lorsque les statuts sont différents, il vous faut réfléchir à la meilleure façon d'établir la correspondance.</p>
<p>Lorsque des demandes sont en cours et que vous changez le workflow vous devez vous assurer qu'il n'y aura pas de conflits (une demande pourrait être dans un état (statut) non existant dans le nouveau workflow).</p>
<figure>
<media type="image" src="figures/verification_conflit_changement_workflow.png" />
</figure>
@ -30,5 +41,5 @@
<title>Dupliquez le formulaire s'il est en production</title>
<p>Concernant les formulaires en production, il est déconseillé de changer le workflow sans tester préalablement. Il est préférable de dupliquer le formulaire original, d'appliquer le nouveau workflow sur la copie et de vérifier que tout est en ordre.</p>
</note>
</section>
</page>

View File

@ -2,16 +2,16 @@
type="topic"
id="workflows_gerer">
<title>2. Gérer les workflow</title>
<title>3. Gérer les workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Créer, modifier, supprimer un workflow</desc>
</info>
<note style="important">
<title>Associer un workflow à un formulaire</title>
<p>La façon dont on associe un workflow à un formulaire est traitée <link xref="workflows_form">ailleurs</link></p>
<p>La façon dont on associe un workflow à un formulaire est traitée <link xref="workflows_form">sur cette page</link></p>
</note>
<section id="creer_workflow">
@ -27,13 +27,13 @@
<section id="creer_workflow_ex_nihilo">
<title>Créer un workflow ex nihilo</title>
<p>Dans l'interface d'administration, cliquez sur <em>Workflow</em> puis sur <em>Nouveau workflow</em> :</p>
<p>Dans l'interface d'administration, cliquez sur « Workflow » puis sur « Nouveau workflow » :</p>
<figure>
<media type="image" src="figures/workflow_lien_nouveau.png" />
</figure>
<p>Attribuez un nom au workflow et validez, vous êtes redirigé sur la page d'édition du workflow. Pour ajouter un statut, attribuez-lui un nom dans le menu <em>Nouveau statut</em> à droite :</p>
<p>Attribuez un nom au workflow et validez, vous êtes redirigé sur la page d'édition du workflow. Pour ajouter un statut, attribuez-lui un nom dans le menu « Nouveau statut » à droite :</p>
<figure>
<media type="image" src="figures/workflow_nouveau_statut.png" />
@ -62,9 +62,9 @@
</figure>
<p>En cliquant sur le statut dans la liste ou sur le plan en image vous êtes redirigé sur la page d'édition du statut.</p>
<p>En cliquant sur le statut - sur son nom dans la liste ou sur son nom dans le schéma - vous êtes redirigés sur la page d'édition du statut.</p>
<p>Pour ajouter un élément vous devez dans le menu <em>Nouvel élément</em> à droite choisir un type et cliquer sur <em>Ajouter</em> :</p>
<p>Pour ajouter un élément vous devez aller dans le menu « Nouvel élément « à droite choisir un type et cliquer sur « Ajouter » :</p>
<figure>
<media type="image" src="figures/workflow_ajout_element_statut.png" />
@ -135,7 +135,7 @@
<section id="import_workflow">
<title>Importer un workflow</title>
<p>Depuis l'interface d'administration, cliquez sur <em>Import</em>, vous pouvez alors choisir un fichier sur votre disque, une clé ou le réseau.</p>
<p>Depuis l'interface d'administration, cliquez sur <em>Import</em>, vous pouvez alors choisir un fichier sur votre poste de travail.</p>
<figure>
<media type="image" src="figures/workflow_lien_import.png" />

View File

@ -2,22 +2,22 @@
type="topic"
id="workflows_statuts">
<title>4. Les statuts de workflow</title>
<title>5. Les statuts de workflow</title>
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Gérer les étapes d'un workflow</desc>
</info>
<section id="general">
<title>Généralités</title>
<p>Un workflow est un ensemble d'étapes, les statuts, par lesquelles passe le formulaire. Ces statuts regroupent eux-mêmes une série d'<link xref="workflows_actions">actions</link> permettant d'interragir avec la demande, les utilisateurs et de changer de statut.</p>
<p>Un workflow est un ensemble d'étapes, les statuts, par lesquelles passe le formulaire. Chaque statut regroupe une série d'<link xref="workflows_actions">actions</link> permettant d'interragir avec la demande, d'entrer en contact avec l'usager et avancer dans les étapes de traitement.</p>
</section>
<section id="creer">
<title>Creer un statut</title>
<title>Créer un statut</title>
<p>Pour créer un nouveau statut lorsqu'on se trouve sur un workflow donné, il faut lui donner un nom et cliquer sur valider.</p>
<figure>
@ -28,7 +28,7 @@
<section id="ajouter">
<title>Ajouter des actions à un statut</title>
<p>Tant qu'il est vide, un statut n'a aucune utilité. Il faut l'alimenter avec des <link xref="workflows_actions">actions</link> de différents types, ce sont ces actions mises bout à bout qui vont définir ce qui se passe lorsque une demande est dans un statut donné.</p>
<p>Un statut doit être alimenté avec des <link xref="workflows_actions">actions</link> de différents types, ce sont ces actions mises bout à bout qui vont définir ce qui se passe lorsque une demande est dans un statut donné.</p>
<p>Vous éditez un statut en cliquant sur son nom dans la liste ou sur le schéma, vous pouvez alors lui ajouter les actions qui se trouvent dans la liste déroulante à droite.</p>
<figure>
@ -57,7 +57,7 @@
<p>Ces options permettent de :</p>
<list>
<item><p>Changer le nom du statut. Il faut noter que ce nom apparaît pour le citoyen d'une part et pour le gestionnaire du formulaire (le destinataire) d'autre part.</p></item>
<item><p>Changer la visibilité du statut. Cela permet de faire en sorte qu'un statut soit "privé", c'est à dire qu'il soit réservé au backoffice (au destinataire) et n'apparaissent pas au demandeur.</p></item>
<item><p>Changer la visibilité du statut. Cela permet de faire en sorte qu'un statut soit « privé », c'est à dire qu'il soit réservé au backoffice (au destinataire) et n'apparaissent pas au demandeur.</p></item>
<item><p>Changer le caractère final du statut. Par défaut, un statut a un caractère final s'il ne peut déboucher sur aucun autre statut. Il est parfois nécessaire de dire qu'un statut est final même si il peut déboucher sur d'autres statuts. C'est possible grâce à cette option.</p></item>
</list>

View File

@ -6,15 +6,15 @@
<info>
<link type="guide" xref="index#workflows" />
<link type="guide" xref="workflows" group="#first" />
<desc>Les variables disponibles pour personnaliser les mails, le thème et les workflows</desc>
</info>
<section id="generalites">
<title>Généralités</title>
<p>Les variables sont des éléments prédéfinis permettant d'appeler les détails de la demande ou/et de l'usager afin de personnaliser les messages. Une variable mise dans un modèle de message sera remplacée dans le message reçu par l'utilisateur par son contenu : le nom de la personne, le lien vers sa demande, etc..</p>
<p>Les variables sont des éléments permettant d'appeler les détails de la demande ou/et de l'usager afin de personnaliser les messages. Une variable mise dans un modèle de message sera remplacée dans le message reçu par l'utilisateur par son contenu : le nom de la personne, le lien vers sa demande, etc..</p><p>Il y a deux grands types de variables, les « variables système », invariables d'un formulaire à l'autre et les « variables spécifiques », propres à un formulaire ou un workflow.</p>
<p>Les variables système disponibles sont de quatre types : les variables liées au formulaire, les variables liées au site, les variables liées au catégories et les variables liées à la session de l'utilisateur en cours.</p>
<p>Les variables disponibles pour chaque type d'<link xref="workflows_actions">action</link> sont rappelées sur l'écran d'édition des actions</p>
<p>En plus des variables système, vous pouvez utiliser des <link xref="#variables_specifiques">variables spécifiques à un formulaire</link>.</p>
<p>Les variables disponibles pour chaque type d'<link xref="workflows_actions">action</link> sont rappelées sur l'écran d'édition des actions.</p>
<p>Une bonne utilisation de ces variables permettra de <link xref="perso_templates">personnaliser les mails ou les templates</link></p>
<note style="important">
<title>Toujours entre crochets</title>
@ -28,6 +28,33 @@
</section>
<section id="specifiques">
<title>Les variables spécifiques</title>
<section id="variables_specifiques_form">
<title>Variables spécifiques liées aux formulaires des demande</title>
<p>Le contenu de chaque champ d'un formulaire est stocké dans une variable. Pour appeler ces contenus il faut saisir le nom de la variable (toujours entre crochets), sous la forme :
<code><var>form</var>_var_<var>nom_de_variable_du_champ</var></code></p>
<p>Par exemple pour un formulaire de contact, on obtiendra le contenu du champ téléphone (dont le nom de variable est <code>telephone</code>) en mettant dans le modèle de message <code>[form_var_telephone]</code>).</p>
</section>
<section id="variables_specifiques_form_workflow">
<title>Variables spécifiques liés aux formulaires de workflows</title>
<p>Dans le cas des formulaires définis dans les workflows, le contenu de la totalité des champs est stocké dans une variable (un tableau).</p>
<p>Chaque champ du formulaire est ensuite stocké dans une variable. Pour appeler ces contenus il faut donc saisir le nom de la variable du formulaire suivi de celle du champ (toujours entre crochets), sous la forme :
<code><var>nom_de_variable_du_formulaire</var>_var_<var>nom_de_variable_du_champ</var></code></p>
<p>Par exemple pour un formulaire de contact dont le nom de variable est <code>contact_interne</code>, on obtiendra le contenu du champ téléphone (dont le nom de variable est <code>telephone</code>) en mettant dans le modèle de message <code>[contact_interne_var_telephone]</code>).</p>
</section>
</section>
<section id="systèmes">
<title>Les variables système</title>
<section id="variables_formulaire">
<title>Variables système liées au formulaire</title>
<list>
@ -95,26 +122,6 @@
</list>
</section>
<section id="variables_specifiques_form">
<title>Variables spécifiques liées aux formulaires des demande</title>
<p>Le contenu de chaque champ d'un formulaire est stocké dans une variable utilisable selon le même schéma que les variables prédéfinies. Pour appeler ces contenus il faut saisir le nom de la variable (toujours entre crochets), sous la forme :
<code><var>form</var>_var_<var>nom_de_variable_du_champ</var></code></p>
<p>Par exemple pour un formulaire de contact, on obtiendra le contenu du champ téléphone (dont le nom de variable est <code>telephone</code>) en mettant dans le modèle de message <code>[form_var_telephone]</code>).</p>
</section>
<section id="variables_specifiques_form_workflow">
<title>Variables spécifiques liés aux formulaires de workflows</title>
<p>Dans le cas des formulaires définis dans les workflows, le contenu de la totalité des champs est stocké dans une variable (un tableau).</p>
<p>Chaque champ du formulaire est ensuite stocké dans une variable. Pour appeler ces contenus il faut donc saisir le nom de la variable du formulaire suivi de celle du champ (toujours entre crochets), sous la forme :
<code><var>nom_de_variable_du_formulaire</var>_var_<var>nom_de_variable_du_champ</var></code></p>
<p>Par exemple pour un formulaire de contact dont le nom de variable est <code>contact_interne</code>, on obtiendra le contenu du champ téléphone (dont le nom de variable est <code>telephone</code>) en mettant dans le modèle de message <code>[contact_interne_var_telephone]</code>).</p>
</section>
</page>