Send to Fax Tokens

Send to Fax tokens are used for personalization of content by customers and for limited personalization by users. Personalization values are pulled from the account__v, user_detail__v, and user__sys objects and allow faxes to contain personalized content.

Who can use this feature?

Inserting Send to Fax Tokens as

Reference Tokens

Fax templates support the following reference tokens from the existing Approved Email token library:

Token Description
{{accTitle}} Inserts Account salutation - account__v.salutation__v

{{accFname}}

Inserts Account first name - account__v.first_name_cda__v

{{accLname}}

Inserts Account last name - account__v.last_name_cda__v

{{accCredentials}}

Inserts Account credentials - account__v.credentials__v

{{userEmailAddress}}

Inserts email address of the user - user__sys.email__sys

{{userName}}

 Inserts full name of the user - user__sys.name__v

{{timeZone}}

For iPad users, this token is replaced by the value of the time zone the device is set to. The format is based on the user’s Vault CRM locale.

For Browser users, the token is replaced by the value of the time zone stored in the user__sys record and displays with the format: GMT +/- X hours.

{{ObjectAPIName.FieldAPIName}}

Content creators can use this token to directly reference any field of a supported field type on the following objects:

  • account__v

  • user__sys

  • user_detail__v

The following field types are supported:

  • Currency

  • Date

  • DateTime

  • Formula*

  • Picklist (resolves to the picklist label in the user's language)

  • Email

  • Long Text

  • Number

  • Percent

  • Phone

  • Roll-up*

  • Text

  • Time

  • Yes/No

* Formula and Roll-up field values are not updated automatically on iPad, so a fax may contain an outdated value if the user changed a value used by the field but had not yet synced.

Examples:

  • {{account__v.formatted_name__v}}

  • {{user__sys.office_phone__sys}}

  • {{user_detail__v.custom_field__c}}

If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information.

{{ObjectAPIName.RelationshipName.FieldAPIName}}

Enables retrieving values from object reference fields.

See above for the list of supported objects and field types.

Examples:

  • {{account__v.custom_reference_field__vr.custom_field__c}}

If the referenced field is a Date or a Date/Time type field, creators can additionally specify the displayed format of the date or time. See Formatting Tokens to Display Date and Time for more information.

{{customContent[QUERY]}}

{{customContent[QUERY]:Required}}

Using the token in an email template, data is replaced with the value from one field in one record from any custom object.

The custom content token can be marked as required by adding :Required after the query. Faxes cannot be sent if the required token returns NULL.

User Input Tokens

Fax templates support the following user input tokens from the existing Approved Email token library:

User Input Token Type

 Token Example

Free Text

 {{customText}} {{customText}}

Free Text with Max Length

{{customText(Length)}}

{{customText(255)}}

Free text with Default Text

{{customText(|DefaultText)}}

{{customText(|Providing the order form for our available pharmaceutical products.)}}

Free text with Max Length and Default Text

{{customText(Length|DefaultText)}}

{{customText(255|Providing the order form for our available pharmaceutical products.)}}

Required Free Text

{{customText:Required}}

{{customText:Required}}

Picklist

{{customText[options]}}

{{customText[Hello|Dear|Hi]}}

Picklist with Content Tokens

{{customText[##ContentToken1##|##ContentToken2##]}}

{{customText[##accTitle## ##accFname## ##accLname##, ##accCredentials##|##accTitle## ##accLname##|##accFname##]}}

Additional Tokens for Fax Templates

Fax templates support the following additional tokens unique to Fax.

Token Description
{{documents.FieldAPIName}}

Self-referencing tokens to retrieve document fields. To reference document fields, use the format documents.FieldAPIName

Examples:

  • {{documents.name__v}}

  • {{documents.custom_field__c}}

The following field types are supported:

  • Text

  • Number

  • Date Date

  • Time

  • Yes/No

  • Picklist (resolves to the picklist label in the user's language)

{{documents.RelationshipName.FieldAPIName}}

Retrieves fields on referenced objects on the document.

Supports the same field types available for the {{ObjectAPIName.FieldAPIName}} token.

Examples:

  • {{documents.document_product__vr.name__v}}

  • {{documents.document_custom_field__cr.custom_field__c}}

{{customText[##documents.FieldAPIName##|##documents.RelationshipName.FieldAPIName##]}}

Returns a picklist.

Supports the same field types available for the {{ObjectAPIName.FieldAPIName}} token.

{{recipientFaxNumber}}

Returns the selected fax number used in the fax number selector on the recipient field.

Changing the selected fax number refreshes this value on the preview.

{{totalFaxPages}}

Returns the total number of pages sent in the fax transmission.

This token cannot be rendered when previewing on the iPad, as this value is returned after the fax is generated.

{{transactionID}}

Returns a unique transaction ID specific to each recipient of the fax.

  • Globally unique across all Vault CRM instances for the environment

  • Populated when the user opens the fax template to compose the fax

Format:

Vault ID + '-' + 36 character UUID

Example:

  • Vault ID: 111111

  • UUID: a1b2c3d4-e5f6-7890-1234-567890abcdef

  • Resolved token value: 111111-a1b2c3d4-e5f6-7890-1234-567890abcdef

{{capturedDate}}

Returns the date when the fax was initially captured by the user. Uses server time for online sends and device time for offline sends.

The same date is used in the captured_datetime__v field stamped on the created Sent Fax record.

Creators can additionally specify the displayed format of the date by using the FORMAT parameter.

  • {{currentDateTime(FORMAT)}}

See Formatting Tokens to Display Date and Time for more information.

{{VaultID}}

Returns the ID of the Vault CRM environment from which the fax was sent.

Related Topics

Create and Managing Fax Templates

Sending a Fax