Affiche un bouton qui permet de lancer une tache de publipostage MailMerge s’appuyant sur les données d’un ou plusieurs dataset(s).
Hérite de WidgetBase.
Fonction
Rendu
Ce widget sert à lancer une tâche dans MailMerge et à afficher le résultat au format pdf.
Utilisation
Exemple complexe
Dans l’exemple ci-dessous, on a :
- Un widget Mailmerge qui peut être lu ainsi :
id_mm="1538"
: c’est la tâche n°1538 du module de mailmerge qui va être appelédataset="example"
: Si cet attribut est fourni, Voozanoo va y chercher une clef primaire (id_data). S’il en trouve une, il va la passer en paramètre à Mailmerge comme dans le cas de l’attributdataset_filter
. Le cas d’utilisation classique est le suivant :- On est sur une fiche
patient
qui a donc un datasetpatient
contenant un unique enregistrement qui a unid_data
. - On utilise l’attribut
dataset="patient"
dans le widget Mailmerge et on a une condition attendant un paramètreid_data
dans le dataquery qui sert de source de données pour la tâche Mailmerge. - Ainsi, le document généré ne concernera que la fiche courante.
- On est sur une fiche
dataset_filter="filter"
: on transmet aussi les données du dataset appeléfilter
comme paramètre (voir plus bas)option_name="use_current_user" value="true"
: on souhaite utiliser les droits de l’utilisateur courant pour obtenir les données (donc l’utilisateur courant est sur le même projet et a accès aux bonnes données), c’est une alternative à l’utilisation d’un compte de service
Exemple simple
On aurait aussi pu se limiter à ceci si l’on ne souhaitait pas envoyer de paramètres à l’exception du paramètre id_mm
que nous devrions envoyer.
Le dataset_filter
et l’envoi de paramètres
Si l’attribut dataset_filter
est utilisé :
- Voozanoo va trouver le dataset signalé et s’en servir pour envoyer des paramètres au module de mailmerge
- On peut ensuite les utiliser :
- Dans les dataqueries qui servent de source de données a la tâche mailmerge (pour des conditions par exemple)
Ceci est souvent utilisé pour permettre à l’utilisateur d’exécuter les tâches dans mailmerge et rendre leurs résultats dynamiques : il fait des choix dans un court formulaire avant de lancer la tâche.
Utilisation des paramètres dans les dataqueries
L’exemple ci-dessous attend des paramètres username
et date_max
pour les utiliser comme conditions dans un dataquery qui sert de source de données. L’attribut optional='true'
sert à ignorer ces conditions si les attributs ne sont pas transmis. Si l’attribut dataset_filter
du widget Mailmerge est utilisé, les paramètres que le dataset signalé contient seront transmis au dataquery automatiquement.
Exemple illustré
Attributs
Les attributs nécessaires au bon fonctionnement du widget sont signalés par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetBase pour vérifier si d’autres attributs sont disponibles.
Options
Les options nécessaires au bon fonctionnement du widget sont signalées par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetBase pour vérifier si d’autres options sont disponibles.
asynchrone
Permet de lancer la tâche de façon asynchrone.
-
Version : >=2.15
-
Valeurs possibles : Boolean
env
Groupe d’options permettant de définir une configuration du WidgetMailmerge différente selon l’URL du projet où il est utilisé. Cela permet notamment de paramétrer un comportement différent selon l’environnement (production ou préproduction) en n’utilisant qu’un seul WidgetMailmerge.
-
Version : >=2.26
-
Valeurs possibles : integer or string
env_id_mm_n
id_data de la tâche Mailmerge à exécuter
-
Version : >=2.26
-
Valeurs possibles : integer
env_url_n
URL Mailmerge pour laquelle la configuration s’applique. L’URL attendue correspond à la concaténation des directives ini “voozanoo.protocole”, “voozanoo.host” et “voozanoo.baseurl” avec le nom du projet courant : [protocole][vhost][baseurl][projectname]/. Ex : [https://][sandbox.preprod.vooozanoo.net][/][beethoven]/
-
Version : >=2.26
-
Valeurs possibles : string
env_label_n
Libellé à affficher sur le bouton selon la configuration
-
Version : >=2.26
-
Valeurs possibles : integer or string
output_file_name
Query ou chaîne de caractères correspondant au(x) nom(s) de(s) fichier(s) qui seront générés par MailMerge.
-
Version : >=2.26
-
Valeurs possibles : string
-
Valeur par défaut : export
output_format
Définit le format de document généré. Seul les modèles en docx peuvent générer des documents docx.
-
Version : >=2.15
-
Valeurs possibles : docx ou pdf
-
Valeur par défaut : pdf
save_before_execute
Enregistre la fiche avant de lancer la tâche.
-
Version : >=2.26
-
Valeurs possibles : Boolean
use_current_user
Permet de garder le contexte de l’utilisateur courant lors de l’appel à mailmerge. Cette option ne fonctionne que si l’application appelante est l’application contenant les données.
-
Version : >=2.15
-
Valeurs possibles : Boolean