Variables
Variables allow inserting information from the client file into certain texts. Depending on the context, not all variables are
necessarily valued. For example, some variables like ${signbook.frontUrl} are not valued in SMS notifications where the message
size is limited. The consequence is that the variable will not be replaced by its value but by an empty string. This is not an
anomaly, it is the expected behavior. To know if a variable can be used in a given context, it is recommended to use the center
application. If auto-completion does not suggest the desired variable in a given context, it means it is not supported.
Variables are in ${xxx} format. For example:
Hello ${participant.1.firstName}
Customer file
| Name | Type | Description |
|---|---|---|
| ${today} | Date | The current date |
| ${company.name} | Text | The name of the company |
| ${clientfile.id} | Text | The file ID (generated by Trust and Sign, example: 10203) |
| ${clientfile.uuid} | Text | The internal unique identifier of the file (generated by Trust and Sign, example: a1e22fdd-5479-49e2-a828-b9a765b370bf) |
| ${clientfile.externalId} | Text | The external identifier of the folder (provided at creation) |
| ${externalInfo.xxx} | Text | The value of an external information provided at creation (xxx = identifier of the external information) |
| ${expiration.delay} | Text | Number of days remaining before the recipient's file expires |
| ${contract.url} | Text | URL to download the recipient's contract |
| ${signbook.url} | Text | URL to SignBook iframe |
| ${signbook.frontUrl} | Text | URL to the SignBook wrapper page |
| ${clientfile.url} | Text | URL to the folder page in Center |
| ${terms.url} | Text | URL to Trusted Third Party TOS (Docusign only) |
Participants
Participant information can be inserted with the prefix "participant.{id}", where id is the participant's index starting at 1, corresponding to the participant's turn in the workflow.
| Name | Type | Description |
|---|---|---|
| ${participant.1.accessToken} | Text | The participant's access token |
| ${participant.1.firstName} | Text | The first name of the participant |
| ${participant.1.lastName} | Text | Participant's last name |
| ${participant.1.birthName} | Text | Participant's birth name (optional) |
| ${participant.1.email} | Text | Participant's email address |
| ${participant.1.birthDate} | Date | The participant's date of birth (optional) |
| ${participant.1.birthPlace} | Text | The participant's city of birth (optional) |
| ${participant.1.iban} | Text | The participant's IBAN (optional) |
| ${participant.1.phone} | Text | The participant's landline telephone number (optional) |
| ${participant.1.mobilePhone} | Text | Participant's mobile phone number (optional) |
| ${participant.1.postalAddress1} | Text | The first line of the participant's postal address (optional) |
| ${participant.1.postalAddress2} | Text | The second line of the participant's postal address (optional) |
| ${participant.1.postalAddress3} | Text | The third line of the participant's postal address (optional) |
| ${participant.1.postalCity} | Text | The city of the participant's postal address (optional) |
| ${participant.1.postalCode} | Text | The participant's postal code (optional) |
Participant type
It is possible to provide information from the participant list for a given participant type.
Only for notifications of type Email or SMS with the recipient set to Others.
It is recommended to use the variables with the suffix 'other' only on events where the trigger is a participant, for example ALL_MANDATORY_DOCUMENT_SUBMITTED_FOR_PARTICIPANT or DOCUMENT_SUBMITTED_FOR_PARTICIPANT.
| Name | Type | Description |
|---|---|---|
| ${participantType.IDENTIFIER.email.all} | Text | List of emails of ALL participants for a given participant type, where IDENTIFIER is the identifier of the participant type to be provided. |
| ${participantType.IDENTIFIER.emails.other} | Text | List of emails of ALL participants for a given participant type EXCEPT the initiating participant when he/she is of the same type, where IDENTIFIER is the identifier of the participant type to be provided. |
| ${participantType.IDENTIFIER.mobilePhone.all} | Text | List of mobile phone numbers of ALL participants for a given participant type, where IDENTIFIER is the identifier of the participant type to be provided. |
| ${participantType.IDENTIFIER.mobilePhones.other} | Text | List of mobile phone numbers of ALL participants for a given participant type EXCEPT the initiating participant when he/she is of the same type, where IDENTIFIER is the identifier of the participant type to be provided. |
Legal person
These variables can only be used if the legal entity is activated in the customer journey.
| Name | Type | Description |
|---|---|---|
| ${legalEntity.identifier} | Text | The identifier of the legal entity (SIRET or SIREN) |
| ${legalEntity.name} | Text | The name of the legal entity |
Emails
The following variables can be injected only into email templates.
| Name | Type | Description |
|---|---|---|
| ${clientfile.missingDocumentsList} | Text | Bulleted list of missing documents from all participants |
| ${clientfile.missingDocuments} | Text | Comma-separated string of missing documents from all participants |
| ${recipient.missingDocumentsList} | Text | Bulleted list of participant's missing documents |
| ${recipient.missingDocuments} | Text | Comma-separated string of missing documents from the participant |
| ${creation.message} | Text | This is only used in the creation email templates. Custom comment entered by the operator in Folder Management when creating a folder. |
| ${reopen.message} | Text | This is only used in the reopen email templates. Custom comment entered by the operator in Folder Management when re-opening a folder. |
| ${unblock.message} | Text | This is a custom comment entered by the operator in Folder Management when re-opening a folder. Custom comment entered by the operator in Case Management when unlocking a case. |
| ${clientfile.externalId} | Text | This is your unique identifier for the file (purchase order, contract number, etc.). |
| ${custom.message} | Text | Only to be used in the reopening, release, acceptance and rejection email templates. Predefined texts inserted by the operator when processing a file. |
| ${missing.documents.list} | Text | This field has been deprecated since version Winter 19' Bulleted list of missing documents from all participants |
| ${missing.documents} | Text | This field has been deprecated since version Winter 19' Comma separated string of missing documents from all participants |
Special fields
The following variables must be injected mandatory and only into specific fields.
| Name | Type | Description |
|---|---|---|
| ${otp} | Text | This variable must be inserted in the text of the SMS only. This variable must be inserted in the text of the SMS only. |
| ${access.token} | Text | This variable must be inserted in the text of the SMS only. This variable must be inserted at the end of the URL of the SignBook wrapper page. |
Formatting values
Some values can be formatted. To do this, use the syntax ${key?format}
Text
- upper : to force the text in upper case (ex : John Doe -> JOHN DOE)
- lower : to force the text in lower case (ex : John Doe -> john doe)
**Date
Dates use only days, months and years (no hours, minutes ...). The date formatting is the one used by Java. For example: "${participant.1.birthDate?dd/MM/yyyy}" will become "12/01/1982"
Note: When configuring keywords in the course configuration interface, it is recommended that the following ISO8601 format be used for DATE expressions: yyyy-MM-dd e.g. ${participant.1.birthDate?yyyy-MM-dd} will become "1982-01-12"