Default piping/field mapping symbols

A quick reference PDF version of this guide has been made available.

Field mapping symbols can be used in various areas of Blue to bring in (pipe) data from the Blue database, such as Blue task emails, questionnaires, report blocks, welcome messages, and error messages. Alternatively, any field in any datasource can be piped by creating a user defined field mapping symbol. Learn more from this article: Create custom field mapping symbols.

Using piping symbols and field mapping variables provides customized information and purpose to the task emails and may increase response rates by providing a more relevant experience for the users. For more information on advanced field mapping symbols, see Advanced field mapping symbols.

THINGS TO KNOW ABOUT FIELD MAPPING SYMBOLS

Field mapping symbols need to be enclosed in square brackets ([]).
An S, C or R and G can precede the dollar sign to indicate the value should come from the subject, secondary subject, rater, or group respectively.
A G can only be used in Group by reports.
The plus (+) symbol is used to designate a field mapping symbol that's part of a Relationship datasource.
Relationship datasource field mapping symbols must be prefixed with a C or R and the plus (+) symbol.
If there is an error or if there is no data available, the symbol will be ignored.
Each mapping symbol begins with a dollar sign ($).
Mapping symbols must be composed of all uppercase letters and numbers.
Mapping symbols are not supported in Rollover reports.

NOTE

For all field mapping symbols, if the "Display Error List" option is enabled (in Projects - Questionnaire - Options), the field mapping symbols will not be piped in properly in question titles.

General messaging

These field mapping symbols can be used in any email or task message that will be seen by a rater or other task owner. This includes invitation emails, reminder emails, thank you emails, task introductions, other in task messaging, etc.

Rater first name - [R$FN]

Rater last name - [R$LN]

Primary subject first name - [S$FN]

Primary subject last name - [S$LN]

Primary subject name - [S$NAME]

Secondary subject first name - [C$FN]

Secondary subject last name - [C$LN]

Secondary subject name - [C$NAME]

Email messaging

Symbols that can be used in the automated emails that are sent to task owners.

Personalized link to a survey(s) or report(s) - $LINK

Task list with all tasks - $TASK_LIST_ALL

Task list with all active tasks - $TASK_LIST_ACTIVE

First task expiration date - $TASK_ENDDATE

Personalized survey or report link - $($Link$)$

Title of project - $PROJECT

Datasource name - $DATASOURCE

Opt out of all evaluations - $OPTOUTBLUE

Opt out of project - $OPTOUT

Link to task list - $($text$)$

Link to certificate - [$CERTIFICATE]

Custom link to certificate - [$CERTIFICATE($Text of the certificate link$)CERTIFICATE$]

Project task messaging

Field mapping symbols that can be used in the task messages. For example, the thank you page, or welcome message.

Count of group members - $GROUPCOUNT

Name of group - $GROUPNAME

Hyperlink - $L($http://web.com$$text$)L$

Logout link - $LOGOUT[text]

Subject name - $SUBJECT

Secondary subject user role - [$ROLETYPE]

Report messaging

Field mapping symbols that are used in the report messaging.

Report title - $REPORT

Report blocks

Field mapping symbols that can be piped into report blocks.

Question title - [QTitle]

Reliability Assessment report block

Field mapping symbols that are used to pipe in values for the Reliability Assessment report block.

RA block field mapping

Invited count - [RA$AudienceCount$]

Response count - [RA$ResponseCount$]

Reliability assessment conclusion (text) - [RA$ReliabilityCaption$]

Reliability assessment conclusion (value) - [RA$ReliabilityValue$]

Minimum required respondent count for a level - [RA$<level>Number$]

Caption for level - [RA$<level>Caption$]

Threshold value for a level - [RA$<level>Value$]

Course name - [$CANVASCOURSENAME$]

Project name - [$PROJECTNAME$]

Primary subject name - [$PRIMARYSUBJECTNAME$]

Secondary subject name - [$SECONDARYSUBJECTNAME$]

More complex built-in piping symbols and HTML formatting may also be implemented in email messages and some areas of the application. Learn more about Advanced field mapping symbols.

Use a response from another project

InBuild and manage a questionnaire

Use responses from an earlier question

InBuild and manage a questionnaire

Set default values for field mapping symbols in reports

InBuild and manage report content

Create custom field mapping symbols

InSystem wide settings for projects and reports

Manage users that have opted out

InRecord management