The app config widget enables Survey Programmers (SPs) to define global parameters for a survey. Generally speaking, it is placed at the beginning of a survey's source, but additional app config widgets can be applied later in the code to modify the defaults established in the initial definition.
For more detailed information on how to apply these tags, please see the In depth section below.
Tip! Think about set defaults as the ability to define tags or turn components on and off within the survey. It impacts the survey's Survey Programming Language (SPL) and rendered content. In contrast, think about app config as the high level survey configuration and meta data.
Commonly used tags
| Tag | Description |
|---|---|
allowreadsfrom |
Allows access to a survey data set programmatically from a different survey or access to other respondents' answers within the same survey. |
autoredirect |
Enables the use of the auto-redirection system for panel vendor redirects and is followed by a local or system sheet reference, e.g., |
autotranslate |
Enables the automated translation of open-ended survey fields using machine translations. |
charset |
Sets the text encoding system to be used. |
|
(alias |
For use with click balance quotas; behaves similarly to apply if, but is included with the app config widget. Specifies a condition for which, if "true" for a given respondent, then they should be included in a click balance quota's group for which they qualify.
|
|
(alias |
Specifies the quota base (condition) applied to the click balance quotas, overriding the default values. |
defer term |
Specifies the label at which respondents are sent to term pages. |
editcompletes |
Allows editing of records with Complete statuses. |
feedback |
Enables/disables per-page respondent feedback. |
hide_language_picker |
Specifies to hide the language picker on survey pages. |
inactivelockout |
Controls the re-entry of respondents who have become "Inactive." |
inactivetimeout |
Sets the period of time that must elapse for an unresponsive In-progress (P) respondent to become an Inactive (N) respondent. |
infopage |
Enables/disables the Survey Info applet in the Survey Navigation menu. |
max_cap_message |
Specifies a message (other than the default) to display to respondents when a survey's max capacity is exceeded. |
pagenotfound |
Specifies the question or page which a respondent who lands on a non-existent page will be routed. |
panel_sheet |
Specifies which spreadsheet to pull panel IDs and information from and is followed by a local or system sheet reference, e.g., panelsheet : survey_id.sheet_id. |
poweredby |
Changes the "Powered by IntelliSurvey" footer message/link. |
poweredby_url |
Changes the URL for the "Powered by" footer link. |
progressbar |
Specifies whether or not the survey will display a progress bar to the respondent so they can see roughly how far they are in the survey. |
require_js |
Toggles Javascript requirement on and off; if 'true' the survey will show an error message if Javascript is disabled. |
restartonpage |
Specifies the page upon which inactive respondents will continue if they return to a survey. |
singlepage |
Allows the original page of a survey to persist while dynamically replacing some of the content. A page refresh actually never occurs, thus letting the respondent complete the survey on a single browser page. |
startonpage |
Indicates the page upon which respondents will start the survey when they first enter. |
storedatafrom |
Stores data from a different survey application. |
storedatato |
Stores data in a different survey application. |
title |
Specifies the page title for every page of the survey. |
totalcap |
Specifies whether or not to include a total cap quota in the Quota Manager. Defaults to 'y' in r8.1+ and is no longer needed to be physically present in the survey source code. |
use panels |
Specifies a list of which panel numbers should be used in the survey. The SP must have a system sheet 'system_panels', or a local sheet which lists all panel numbers that Is a system default as of r8.0+ and is no longer needed to be physically present in the survey source code unless changes need to be made to the panel redirects. |
In depth
alllowreadsfrom
The get_answer method has the ability to import data from other records and/or surveys. This might be useful in situations where respondents are re-contacted to take a second survey, while the first survey is still fielding. Using get_answer, response information from the first survey can be used to manipulate data in the second survey. The allowreadsfrom tag is required on the appconfig widget when data is being referenced from a different record, even if it is in the same survey.
Input: Survey ID(s) of the survey(s) to read from
If omitted: Survey code can only reference the unique respondent ID within that survey record and survey ID; in other words, get_answer will only be able to reference answers within the survey, not from other records or surveys.
autoredirect
Auto redirect is a multi-part system comprised of a sheet which contains all panels and their respective redirects, automatically generated variables, a source code tag which establishes the relationship between the survey and the sheet, and a URL parameter appended to the survey run URL to specify the record's corresponding panel.
Input: Name of the spreadsheet to read from that contains the redirects
If omitted: The respondent will not redirect based on their final status unless the redirect is manually specified in the survey source code.
autotranslate
When translated surveys are fielded, they naturally collect open-ended responses in languages other than the primary language that the survey is programmed in. To leverage machine translations to automatically translate such responses, use the autotranslate tag.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: Automated machine translations are disabled.
charset
The text encoding that the survey will use. Any standard encoding system can be used.
Input: A text string identifying the system
If omitted: Will default to UTF-8.
defer term
Used for deferred termination. This specifies the page at which terminated respondents are routed to the termination message/redirect. Can be written as deferterm.
Input: Question label, group, or page label
If omitted: Respondents will be routed to the termination message/redirect immediately after submitting a response which fulfills termif criteria.
editcompletes
Controls whether or not records with finished statuses (e.g., "Complete", "Terminate", etc.) are allowed to edit responses to questions.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: Defaults to "yes" in QA stage, and "no" in Live stage.
feedback
The feedback tag permits the survey feedback box to be hidden if so desired.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: Respondent feedback box shows.
hide_language_picker
This tag can override, e.g., "turn off," showing the Language Picker menu in the bottom of the survey screen.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: Languages checked as "selectable" in the Translations applet will appear in the language picker throughout the survey.
inactivelockout
This prevents respondents who have gone inactive from re-entering the survey. If inactivelockout is turned "on" and the time condition has been met, a lockout message is displayed to the respondent if they attempt to re-enter the survey.
Input: Accepts 'y' (yes) and 'n' (no) input or numeric; if using numeric inputs, specify units (seconds, minutes, hours, or days). There is no max/limit to the amount of time specified for a respondent to be locked out.
All of the following variations are accepted:
inactive lockout: 500 seconds inactive lockout: 30m inactivelockout: 60minutes inactivelockout: 1h inactivelockout: 4 hours inactivelockout: 3 days
If omitted: Inactive respondents are allowed to re-enter.
inactivetimeout
This allows you to define the amount of elapsed time a respondent with no survey activity is re-statused from "In progress" to "Inactive."
Input: A number of seconds, minutes, hours, or days. Like inactivelockout, there is no limit to the specified time interval.
The units should be specified along with the number. You may insert a blank space as a separator between the time value and the time qualifier: 24 h is the same as 24h. You may also use the full words minutes, hours, or days instead of the abbreviations: 24 hours is the same as 24h. All of the following variations are accepted:
inactive timeout: 500 seconds inactive timeout: 30m inactivetimeout: 60minutes inactivetimeout: 1h inactivetimeout: 4 hours inactivetimeout: 3 days
If omitted: Respondents will become inactive after 30 minutes.
Example usage:
app config inactive lockout: y inactive timeout: 2m # This sets a stricter than usual rule that will render respondents inactive after 2 minutes, and they'll be locked out.
infopage
Placing info page: n in the source code removes the Survey Info applet from the menu.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: The Survey Info applet is visible to all.
pagenotfound
This tags allows you to define where respondents who see a "404 page not found" error message are routed.
Input: A page form number or page label. Respondents who are routed or navigate to a non-existent location will be redirected to the page specified by this tag.
If omitted: Respondents are routed to the first page of the survey.
poweredby
Every survey includes a footer with a text link: "Powered by IntelliSurvey." This tag overrides that text with a custom value.
Input: Text string
If omitted: Default text.
poweredby_url
The "Powered by IntelliSurvey" link points to intellisurvey.com by default. To instead make that text (or custom text as specified by poweredby) point to a custom URL, use this tag.
Input: URL
If omitted: Link target is www.intellisurvey.com.
require_js
Toggles whether or not JavaScript is required on the respondent's computer in order for them to take the survey. If this is enabled, and a user does not have JavaScript, they are presented with the message: "JavaScript is required for this survey, but seems to be disabled in your browser. Please enable JavaScript and then refresh this page to continue."
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: JavaScript will be required.
restartonpage
Indicates the page upon which inactive respondents who return to the survey will restart.
Input: Page number or page label
If omitted: Will start on the page where they left off.
singlepage
The singlepage tag allows the original page of a survey to persist while dynamically replacing some of the content. A page refresh actually never occurs, thus letting the respondent complete the survey on a single browser page. This creates a faster respondent experience and prevents respondents' survey browser back button from affecting survey navigation.
Input: Accepts 'y' (yes) and 'n' (no) (defaults to 'n'), or accepts 'fade', 'scroll', or 'show' (singlepage: y is the equivalent of 'show' 0 msec). The 'fade' and 'scroll' inputs can also accept a number of msec for their transitions (e.g., 'fade 500'). Not specifying a value with 'fade' is the equivalent of 'fade 100'....
If omitted: Survey creates discrete HTML pages for each survey page.
startonpage
Indicates the page upon which respondents will start the survey when they first enter.
Input: Page form number or page label respondents will start on
If omitted: Respondents will start on the first page.
storedatafrom
Allows other surveys to store data within this survey where this tag is placed.
Input: Survey ID(s) of the surveys that will store data within this survey
If omitted: No data from other surveys will be stored within this survey.
storedatato
Indicates the survey ID where data can be stored from this survey where this tag is placed (e.g., where the data will be hosted).
Input: Survey ID of the survey that will store data from this survey
If omitted: No data will be stored from this survey in another survey.
title
The page title. This is the text that will appear in the template's title. This stays static for the entire survey, unless redefined in another appconfig later.
Input: Text string
If omitted: No page title text appears.
totcap
The system quota Total Cap is one way to control the total number of respondents who are allowed to complete a survey. When it is used, once a specified number of respondents have completed the survey, no new responses are allowed.
Note that totcap defaults to 'y' in r8.1+ and is no longer required to be in the source code unless setting to 'n'.
Input: Accepts 'y' (yes) and 'n' (no)
If omitted: No system total quota will appear in the Quota Manager.
use panels
The use panels tag, used along with the auto redirect and panelsheet tags, allows the Survey Creator to specify a list of which panel numbers should be used on the survey. This tag can also be applied later in the survey to change which panel numbers should be used for a specific question or set of questions.
The Survey Creator must have a system sheet 'system_panels' or a local survey sheet which lists all panel numbers that use panels will call to and place it after the auto redirect and panelsheet tags.
When use panels is specified, a list called panel_list and a quota named $panel_quota are generated, with the values equaling the text string entered in use panels.
Starting with r8.0, the use panels tag has been moved to the background as a system default. It is no longer in the survey source code and must be manually added back in, along with the necessary auto redirect and panelsheet tags.
Input: Integer values
If omitted: Survey will use all panel numbers associated with the survey.
Example usage:
definesheet: surveyid.panelsheetname app config auto redirect: surveyid.panelsheetname panelsheet: surveyid.panelsheetname use_panels: 2,100,991 #use_panels: auto
Comments
0 comments
Please sign in to leave a comment.