Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add guidance for survey link fields

Many Decipher surveys need values in the test link, for example the participant source, the language, or a respondent ID. The Research Manager (RM) or Project Manager (PM) enters these values in the Survey link configuration when they share the survey with their client. Add a short explanation to each field, so that they know what to enter.

Before you begin

  • The project must be connected to Forsta Decipher. Refer to Connect Metaforms to Decipher.

  • survey.xml must have at least one successful sync with Decipher. The fields come from the last successful sync. Changes in the editor that you did not sync do not show.

  • You must have permission to edit the survey in Programming.

Add guidance to the fields

  1. Open the project and select Programming from the left sidebar.

  2. Select Test survey link, then select Sample source field guidance.

  3. Select a sample source from the list on the left.

  4. For each field, type what the field is for and what value to enter. You can type up to 240 characters of plain text.

  5. Select Save changes.

The Test survey link menu in Programming, with Open test survey and Sample source field guidance

For example, for a field named RID, you can type: Enter the respondent ID from the panel provider. Use a new ID for each test.

Good to know

  • Guidance is saved for each field in each sample source. If two sample sources have a field with the same name, add guidance to each one.

  • Only fields inside a sample source can have guidance. Global variables cannot.

  • To change guidance, open the editor again, change the text, and select Save changes. To remove it, delete the text and save.

  • After a new sync, the guidance stays on fields that keep the same sample source and the same name. Add new guidance to fields that you add or rename.

What the RM or PM sees

In Overview > Client Access > Survey link configuration, an information icon shows next to each field that has guidance. When the RM or PM puts the pointer on the icon, they see your text. Fields without guidance have no icon. The guidance is not added to the survey link.

The guidance for the identifier field shows when the pointer is on its information icon

For the RM and PM steps, refer to Setting up client access in Design - Collaboration or Review - Collaboration.

If the fields do not show

Message
What to do

Decipher integration required

Connect the project to Forsta Decipher.

Sync survey.xml first

Sync survey.xml with Decipher, then open the editor again.

No sample-source fields found

Add variables to a sample source in survey.xml, then sync it.

Last updated

Was this helpful?