Générer un document depuis l’e-guichet#
L’action « Création de document »#
Généralités#
L’action « Création de document » permet de générer un document relatif à une demande d’usager lorsqu’elle atteint le statut auquel cette action appartient.
Note
Si une donnée de traitement de type « fichier » existe dans le workflow, il sera possible de lier le document créé à cette donnée en sélectionnant cette donnée de traitement qui apparaît dans la liste déroulante « Enregistrer le document généré comme donnée de traitement ».
Édition#
Les étapes d’édition de l’action « Création de document » sont les suivantes :
Sélectionner toute fonction ou tout rôle d’utilisateur habilité à générer le document.
Cocher le champ « Joindre le document généré à l’historique du formulaire » lorsque le document doit être intégré au sein du Journal d’une demande d’usager.
Saisir le texte du bouton qui, une fois actionné par le gestionnaire en cours de traitement d’une demande, activera la génération du document lorsque la demande atteindra le statut qui contient cette action.
Choisir le modèle du document à générer s’il existe.
Rédiger le texte d’information qui explicitera, pour le gestionnaire, l’effet induit en cliquant sur le bouton « Création de document ».
Créer un modèle de document#
Les modèles de document sont des documents au format Open Document (faits par exemple avec LibreOffice ou un MS Office ultérieur à 2010) de n’importe quel type (texte, feuille de calcul, présentation, graphique) dans lesquels sont insérés des variables LibreOffice qui ont pour valeur une variable issue de Publik.
Insérer des variables#
- Pour insérer une variable :
Aller dans Insertion -> Champs -> Autres… -> Onglet « Variables ».
Choisir « Champ utilisateur » dans la colonne Type.
Choisir « Texte » dans la colonne Format.
Définir un nom explicite ; ex : Civilité.
Donner comme valeur une variable ({{form_number}}, {{form_var_champchoisi}}, …) ou une expression, par exemple :
{% if form_var_pays == "France" %}0800 123 456{% else %}+33 1 1234 5678{% endif %}.
Vous pouvez réutiliser cette variable plusieurs fois dans le document, elle aura toujours la même valeur. Pour insérer une donnée de tableau, utilisez les indices. Par exemple :
{{ form_var_test.0 }}
Voici à quoi ressemble la boîte de dialogue d’insertion dans LibreOffice :
Insérer des images#
Il est possible d’inclure des images tirées des données d’une demande dans le document. Pour cela il faut inclure une image dans le modèle de document et éditer son nom (dans LibreOffice, clic droit, « Propriétés », onglet « Options »). Il faut alors indiquer, dans le champ nom, le nom de variable de l’image souhaitée, préfixé de « = » et suffixé de « _raw », comme suit :
=form_var_image_raw
Transmettre le document à l’usager#
Il y a plusieurs façons de permettre à l’usager d’accéder à un document généré dans Publik, elles peuvent être utilisées concomitamment.
Envoyer par courriel#
Il est possible d’envoyer par mail l’adresse vers le document en utilisant dans le template du mail la variable : .. code-block:: python
{{attachments.nom-de-variable-du-document.url}}
Joindre le document à l’historique de la demande#
En cochant la case appropriée, le document apparaîtra dans l’historique de la demande quand l’usager consultera sa demande sur le portail citoyen.
Déposer le document dans le porte-document#
En utilisant une action webservice, le document généré peut-être envoyé dans le porte-document de l’usager. L’action de webservice doit alors être configurée comme suit :
URL : {{porte_doc_url}}api/documents/push/
Ne pas cocher la case « Envoyer les données du formulaire »
Données (POST) envoyées :
origin : le nom du service ayant produit le document (ex: Service population)
file_b64_content : =attachments.nom de la variable.content
user_nameid : =form_user_name_identifier_0
file_name : =attachements.nom de la variable.filename
Mettre le document dans une donnée de traitement#
Si, parmi les champs de traitement du workflow, il existe au moins un champ de type « fichier », vous aurez dans l’action de création de document une case à cocher « Enregistrer le document généré comme donnée de traitement » qui vous permet de choisir parmi les champs de type fichier.
Une fois l’enregistrement effectué, vous pourrez vous référer à cette donnée de traitement pour utiliser le document (par exemple pour l’envoyer ultérieurement en utilisant un webservice).
Si une question subsiste, veuillez ouvrir un ticket, nous tenterons d’y répondre et de mettre à jour cette documentation.
📣 Signaler un problème dans cette page