Variables
Les variables permettent d'insérer des informations du dossier dans certains textes. Selon le contexte, toutes les variables ne
sont pas forcément valorisées. Par exemple, certaines variables comme ${signbook.frontUrl} ne sont pas valorisées dans les
notifications SMS pour lesquelles la taille du message est limitée. La conséquence est que la variable ne sera pas remplacée par
sa valeur mais par une chaîne vide. Ce n'est pas une anomalie, c'est le comportement attendu. Pour savoir si une variable est
utilisable dans un contexte donné, il est recommandé d'utiliser l'application center. Si l'auto-complétion ne propose pas la
variable voulue dans un contexte donné c'est qu'elle n'est pas gérée.
Les variables sont au format ${xxx}. Par exemple :
Bonjour ${participant.1.firstName}
Dossier client
| Nom | Type | Description |
|---|---|---|
| ${today} | Date | La date courante |
| ${company.name} | Texte | Le nom de l'entreprise |
| ${clientfile.id} | Texte | L'identifiant du dossier (généré par Trust and Sign, exemple : 10203) |
| ${clientfile.uuid} | Texte | L'identifiant unique interne du dossier (généré par Trust and Sign, exemple : a1e22fdd-5479-49e2-a828-b9a765b370bf) |
| ${clientfile.externalId} | Texte | L'identifiant externe du dossier (fourni lors de la création) |
| ${externalInfo.xxx} | Texte | La valeur d'une information externe fournie lors de la création (xxx = identifiant de l'information externe) |
| ${expiration.delay} | Texte | Nombre de jours restants avant que le dossier du destinataire n’expire |
| ${contract.url} | Texte | URL de téléchargement du contrat du destinataire |
| ${signbook.url} | Texte | URL vers l'iframe du SignBook |
| ${signbook.frontUrl} | Texte | URL vers la page englobante du SignBook |
| ${clientfile.url} | Texte | URL vers la page du dossier dans Center |
| ${terms.url} | Texte | URL vers les CGU du tiers de confiance (Docusign uniquement) |
Participants
Les informations des participants peuvent être insérées avec le préfix "participant.{id}", id étant l'index du participant qui démarre à 1 et qui correspond au numéro de passage du participant dans le parcours.
| Nom | Type | Description |
|---|---|---|
| ${participant.1.accessToken} | Texte | Le token d'accès du participant |
| ${participant.1.firstName} | Texte | Le prénom du participant |
| ${participant.1.lastName} | Texte | Le nom de famille du participant |
| ${participant.1.birthName} | Texte | Le nom de naissance du participant (optionnel) |
| ${participant.1.email} | Texte | L'adresse email du participant |
| ${participant.1.birthDate} | Date | La date de naissance du participant (optionnel) |
| ${participant.1.birthPlace} | Texte | La ville de naissance du participant (optionnel) |
| ${participant.1.iban} | Texte | L'IBAN du participant (optionnel) |
| ${participant.1.phone} | Texte | Le numéro de téléphone fixe du participant (optionnel) |
| ${participant.1.mobilePhone} | Texte | Le numéro de téléphone portable du participant |
| ${participant.1.postalAddress1} | Texte | La première ligne de l'adresse postale du participant (optionnel) |
| ${participant.1.postalAddress2} | Texte | La seconde ligne de l'adresse postale du participant (optionnel) |
| ${participant.1.postalAddress3} | Texte | La troisième ligne de l'adresse postale du participant (optionnel) |
| ${participant.1.postalCity} | Texte | La ville de l'adresse postale du participant (optionnel) |
| ${participant.1.postalCode} | Texte | La code postale du participant (optionnel) |
Types de participants
Il est possible de renseigner des informations provenant de la liste des participants pour un type de participant donné.
Uniquement pour les notifications de type Email ou SMS avec le destinataire configuré sur Autres
Il est recommandé d'utiliser les variables avec le suffixe 'other' uniquement sur les événements dont le déclencheur est un participant par exemple ALL_MANDATORY_DOCUMENT_SUBMITTED_FOR_PARTICIPANT ou DOCUMENT_SUBMITTED_FOR_PARTICIPANT.
| Nom | Type | Description |
|---|---|---|
| ${participantType.IDENTIFIER.email.all} | Texte | Liste des emails de TOUS LES participants pour un type de participant donné, IDENTIFIER étant l'identifiant du type de participant à fournir. |
| ${participantType.IDENTIFIER.email.other} | Texte | Liste des emails de TOUS LES participants pour un type de participant donné SAUF le participant déclencheur s'il est du même type, IDENTIFIER étant l'identifiant du type de participant à fournir. |
| ${participantType.IDENTIFIER.mobilePhone.all} | Texte | Liste des numéros de téléphone mobile de TOUS LES participants pour un type de participant donné, IDENTIFIER étant l'identifiant du type de participant à fournir. |
| ${participantType.IDENTIFIER.mobilePhone.other} | Texte | Liste des numéros de téléphone mobile de TOUS LES participants pour un type de participant donné SAUF le participant déclencheur s'il est du même type, IDENTIFIER étant l'identifiant du type de participant à fournir. |
Personne morale
Ces variables ne peuvent être utilisées uniquement si la personne morale est activée dans le parcours client.
| Nom | Type | Description |
|---|---|---|
| ${legalEntity.identifier} | Texte | L'identifiant de la personne morale (SIRET ou SIREN) |
| ${legalEntity.name} | Texte | Le nom de la personne morale |
Emails
Les variables suivantes pourront être injectées uniquement dans les templates d’email.
| Nom | Type | Description |
|---|---|---|
| ${clientfile.missingDocumentsList} | Texte | Liste à puce des documents manquants de tous les participants |
| ${clientfile.missingDocuments} | Texte | Chaine de caractères des documents manquants, séparés par des virgules de tous les participants |
| ${recipient.missingDocumentsList} | Texte | Liste à puce des documents manquants du participant |
| ${recipient.missingDocuments} | Texte | Chaine de caractères des documents manquants, séparés par des virgules du participant |
| ${creation.message} | Texte | A utiliser uniquement dans les modèles d’emails de création. Commentaire personnalisé saisi par l’opérateur dans la Gestion des dossiers, lorsqu’il crée un dossier |
| ${reopen.message} | Texte | A utiliser uniquement dans les modèles d’emails de réouverture. Commentaire personnalisé saisi par l’opérateur dans la Gestion des dossiers, lorsqu’il ré-ouvre un dossier |
| ${unblock.message} | Texte | A utiliser uniquement dans les modèles d’emails de déblocage. Commentaire personnalisé saisi par l’opérateur dans la Gestion des dossiers, lorsqu’il débloque un dossier. |
| ${clientfile.externalId} | Texte | Information métier : il s’agit de votre identifiant unique du dossier (bon de commande, N° de contrat, …) |
| ${custom.message} | Texte | A utiliser uniquement dans les modèles d’emails de réouverture, de déblocage, d’acceptation et de rejet. Textes prédéfinis insérés par l’opérateur lorsqu’il traite un dossier. |
| ${missing.documents.list} | Texte | Liste à puce des documents manquants de tous les participants Ce champ est déprécié depuis la version Winter 19' |
| ${missing.documents} | Texte | Chaine de caractères des documents manquants, séparés par des virgules de tous les participants Ce champ est déprécié depuis la version Winter 19' |
Champs spéciaux
Les variables suivantes doivent être injectées obligatoirement et uniquement dans des champs précis.
| Nom | Type | Description |
|---|---|---|
| ${otp} | Texte | Code permettant de signer le dossier. Cette variable doit être insérée dans le texte du SMS uniquement |
| ${access.token} | Texte | Token d'accès au parcours client. Cette variable doit être insérée à la fin de l’URL de la page englobante du SignBook |
Formattage des valeurs
Certaines valeurs peuvent être formatées. Pour cela il faut utiliser la syntaxe ${key?format}
Texte
- upper : pour forcer le texte en majuscule (ex : John Doe -> JOHN DOE)
- lower : pour forcer le texte en minuscule (ex : John Doe -> john doe)
Date
Les dates n'utilisent que les jours, mois et années (pas d'heure, ni minutes ...). Le formattage des dates est celui utilisé par Java. Par exemple : "${participant.1.birthDate?dd/MM/yyyy}" deviendra "12/01/1982"
Note : Lors de la configuration des mots clés dans l'interface de configuration des parcours, il est recommandé d'utiliser pour les expressions de type DATE le format ISO8601 suivant : yyyy-MM-dd par exemple ${participant.1.birthDate?yyyy-MM-dd} deviendra "1982-01-12"