Displaying Metadata in Survey and Messages

From skylightwiki

This page applies to Version 1.1 (May 2008)

There is a syntax that can be used when you write survey text to automatically include a value of metadata or other system information into a body of text.

The basic syntax is: {{sourceofdata:datavalue}} . Below are some examples.

Review description. Please review this description against the application.

Contents 1 Reserved characters 2 Application Metadata 3 Survey Metadata 4 Respondent Pool Metadata 5 Respondent

Reserved characters

These characters can not be used in metadata keywords: : { } (eg, colon and braces)

The system converts capital letters in keys to lower case to prevent case-related confusion.

Application Metadata

For system defined metadata keys:

• {{app:title}}
• {{app:version}}
• {{app:majorversion}}
• {{app:minorversion}}
• {{app:buildnumber}}
• {{app:username}}

There are no user defined metadata keys at this level

Survey Metadata

For system defined metadata keys:

• {{survey:title}}
• {{survey:desc}}
• {{survey:author}}
• {{survey:start}}
• {{survey:stop}}

For user defined metadata keys:

• {{survey:keyname}} (e.g., keyname is a user defined key)

Respondent Pool Metadata

For system metadata keys:

• {{pool:title}}
• {{pool:start}}
• {{pool:stop}}
• {{pool:deliverymode}}
• {{pool:keyname}} (e.g., keyname is a user defined key)

Example of using author-defined metadata in a survey:
"You are receiving this survey because you are completing {{pool:prefix}} {{pool:coursenumber}} taught by {{pool:instructorname}}."

Note: If user defined keyname collides with system defined keyname, the two values will be concatenated and pipe delimited

Respondent

There are no system defined metadata keys at this level

For user defined metadata keys:

• {{respondent:keyname}}