<page xmlns="http://projectmallard.org/1.0/"
      type="topic"
      id="workflows_variables">
      
<info>
	<title type="sort">7</title>
	<link type="guide" xref="index#workflows" />
	  <desc>Les variables disponibles pour personnaliser les mails, le thème et les workflows</desc>
</info>

<title>Utiliser les variables dans les workflows</title>

<section id="generalites">
	<title>Généralités</title>
	<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>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>
		<p>Dans le corps du modèle de message, les variables doivent toujours impérativement être mise entre crochets : <code>[nom_de_la_variable]</code></p>
	</note>

	<note style="advanced">
		<title>Utiliser les variables dans les thèmes</title>
		<p>Les variables sont également accessibles dans les <link xref="perso_themes">thèmes</link> et les <link xref="perso_templates">templates</link>, pour le préremplissage des champs par exemple.</p>
	</note>

</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>
		<item><p><code>[form_details]</code> : L'ensemble des données du formulaire</p></item>
		<item><p><code>[form_name]</code> : Nom du formulaire</p></item>
		<item><p><code>[form_number]</code> : Numéro du formulaire</p></item>
		<item><p><code>[form_receipt_date]</code> : Date de réception du formulaire</p></item>
		<item><p><code>[form_receipt_time]</code> : Heure de réception du formulaire</p></item>
		<item><p><code>[form_evolution]</code> : L'ensemble de l'historique du traitement</p></item>
		<item><p><code>[form_status]</code> : Statut actuel du formulaire</p></item>
		<item><p><code>[form_previous_status]</code> : Statut précédent du formulaire</p></item>
		<item><p><code>[form_status_changed]</code> : Un booléen précisant que le formulaire vient de changer de statut</p></item>
		<item><p><code>[form_status_url]</code> : URL du statut du formulaire</p></item>
		<item><p><code>[form_uri]</code> : URI du formulaire</p></item>
		<item><p><code>[form_url]</code> : URL du formulaire</p></item>
		<item><p><code>[form_url_backoffice]</code> : L'adresse du backoffice du formulaire</p></item>
		<item><p><code>[form_number]</code> : Le numéro attribué au formulaire</p></item>
		<item><p><code>[form_user]</code> : Expéditeur du formulaire</p></item>
		<item><p><code>[form_user_display_name]</code> : Nom de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_email]</code> : Courriel de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_var_adresse]</code> : Champ de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_var_codepostal]</code> : Champ de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_var_nom]</code> : Champ de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_var_prenom]</code> : Champ de l'expéditeur du formulaire</p></item>
		<item><p><code>[form_user_var_ville]</code> : Champ de l'expéditeur du formulaire</p></item>
	</list>
	
</section>

<section id="variables_site">
	<title>Variables système liées au site</title>
	<list>
		<item><p><code>[site_name]</code> : Titre du site</p></item>
		<item><p><code>[site_theme]</code> : Nom du thème actuel</p></item>
		<item><p><code>[site_url]</code> : L'adresse du site</p></item>
		<item><p><code>[site_url_backoffice]</code> : L'adresse du backoffice du site</p></item>
		<item><p><code>[site_lang]</code> : le code de langue utilisée par le site</p></item>
		<item><p><code>[today]</code> : Date actuelle</p></item>
		<item><p><code>[now]</code> : Date et heure actuelles</p></item>
	</list>
	
</section>

<section id="variables_categories">
	<title>Variables système liées aux catégories</title>
	<list>
		<item><p><code>[category_name]</code> : L'intitulé de la catégorie</p></item>
		<item><p><code>[category_description]</code> : La description de la catégorie</p></item>
		<item><p><code>[category_id]</code> : L'identifiant de la catégorie</p></item>
	</list>
</section>

	
<section id="utilisateur">
	<title>Variables système liées à l'utilisateur</title>
	<list>
		<item><p><code>[session_user]</code> : Utilisateur connecté</p></item>
		<item><p><code>[session_user_display_name]</code> : Nom complet de l'utilisateur connecté</p></item>
		<item><p><code>[session_user_email]</code> : Courriel de l'utilisateur connecté</p></item>
		<item><p><code>[session_user_var_adresse]</code> : Champ utilisateur connecté : Adresse</p></item>
		<item><p><code>[session_user_var_codepostal]</code> : Champ utilisateur connecté : Code postal</p></item>
		<item><p><code>[session_user_var_nom]</code> : Champ utilisateur connecté : Nom</p></item>
		<item><p><code>[session_user_var_prenom]</code> : Champ utilisateur connecté : Prénom</p></item>
		<item><p><code>[session_user_var_ville]</code> : Champ utilisateur connecté : Ville</p></item>
	</list>

</section>
</section>

</page>
