HomeGuidesRecipesAPI
HomeGuidesAPILog In

Constant Values

When sending emails to users (usually the assignee of a Workflow task), SmartIQ replaces a number of pre-defined values with corresponding information which it might otherwise be difficult or tedious for the designer to obtain. A non-exhaustive list follows:

Value

Replaced with

[Comments]
[Comment]

User comments on workflow submit

[ProjectName]

Published name of project

[StateName]

Name of workflow state

[AssigneeFullName]

Full name of assigned user

[AssigneeFirstName]

First name of assigned user

[AssigneeSurname]

Surname of assigned user

[RequesterFullName]

Full name of requester

[RequesterFirstName]

First name of requester

[RequesterSurname]

Surname of requester

[SenderFullName]

Full name of sender

[SenderFirstName]

First name of sender

[SenderSurname]

Surname of sender

[ReceiverFullName]

Full name of receiver

[ReceiverFirstName]

First name of receiver

[ReceiverSurname]

Surname of receiver

[AccessCode]

Temporary user access code for the assigned temporary user

[DocumentLink]

URL to a zip file containing the documents which were generated by the submission

[ProjectLink]

HTML hyperlink to the in progress workflow.

Note:

  • Parts of the link can be adjusted, refer to [ProjectLink].
  • Where possible, the project link will attempt to link directly to the point of the form in context. For example, if the email is a notification about a comment on a particular page, the link will take you straight there.

[ProjectUrl]

Similar to project link but returns the raw URL only. Usually so that it can be rendered in a paricular way by the designer.

[WorkflowId]

Unique identifier of the workflow task

[Choice]

Refer to Email Approval for details.

[QuestionText]

Where the notification is in the context of a question, for example, a comment notification, the question text of the item in context will be rendered.

[ProjectLink]

Parts of the resulting Project Link can be overridden with:
LinkUrl=
LinkText=
StateName=
ProjectName=
ProduceUrl=

These are passed as a pipe-separated list of key-values:
[ProjectLink|LinkUrl=https://google.com|LinkText=This is a link to google]
The above example will result in a link like:
<a href="https://google.com">This is a link to google</a>

If a ProduceUrl is supplied, other values will be appended to it to construct the URL as if the supplied value were the Produce URL of the system.

The positions of the placeholders in the formatted link are as follows.

If LinkText is not supplied:
<a href="LinkUrl">ProjectName - StateName</a>

If LinkText is supplied and is not empty:
<a href="LinkUrl">LinkText</a>

If LinkText is supplied as empty:
LinkUrl