Pular para o conteúdo principal

FV Decipher Support

Todos os tópicos, recursos necessários para FV Decipher.

Base de Conhecimento da FocusVision

Attributes for Project Settings

1:  Attributes for Project Settings

1.1:  alt - Set the Project's Alternative Name

The alt attribute controls your project's alternative report name. This is where you can set your project's main name that will appear in the Research Hub and survey editor. In contrast to the name attribute, which is visible to respondents in the survey's tab (e.g. "Shoe Survey"), the alt can be used to assign a full name (e.g. "2014 Adidas Shoe Survey").

1.2:  builderCompatible - Enable Survey Editor Access

The builderCompatible attribute enables use of the survey editor to edit the survey. If builderCompatible="0" is specified, the survey can only be edited from the command-line or using the XML editor.

1.3:  compat - Set the Survey Compatibility Level

The compat attribute controls what level of compatibility the survey is set to. When starting a new project from the Research HUb, surveys are set to the highest compat level. With each new compat, newer features are added and some old features may be removed.

If the compat attribute is not specified, surveys are assumed to be compat="0".

1.4:  encryptData - Encrypts All Open Fields and Partial Data

The encryptData attribute controls whether open end fields and partial data is encrypted.  Set encryptData="1" to encrypt all the persistent and partial data (saved in state.db) prior to launching. The default is: encryptData="0".   

Note that this setting cannot be enabled or disabled once a survey has gone live.  Additionally, this setting requres that server encryption be enabled.

Note that a survey with encrypted data cannot be moved to another survey path.

1.5:  extraVariables - Set Additional Variables to Capture

The extraVariables attribute is a comma-separated list of strings that should be made acceptable variables in the survey. These variables and their values will be stored in the data and can be used across the entire survey.

Use this attribute to declare new variables relative to your project and/or samples sources. For example, you may add ID or respid to capture these values from the URL (e.g. /selfserve/9d3/proj1234?respid=RESP144).

When creating a new project from the Research Hub, the variables source, record, ipAddress, decLang, list, userAgent are automatically added to the extraVariables attribute.

Here is a list of built-in variables you can specify that are automatically populated with additional information:

  • ipAddress - respondent's starting IP address will be captured
  • record - assigns each respondent an ascending index (record) number
  • url - the full URL of the initial request will be saved
  • session - the respondent's session cookie will be saved
  • userAgent - the respondent's last "User-Agent" header will be captured and two virtual questions, vos and vbrowser, will be created (automatically added to compat="120+" surveys)
  • flashDetected - auto-detects if Flash 9+ is present on the machine (flashDetected's value will be 1 if detected after the first page of the survey)

1.6:  fullService - Enable Staff-Only Access

The fullService attribute controls access to the survey using the survey editor. If fullService="1" is specified, then only Decipher staff members can edit the survey. All other users will not have access to the project.

This is different than the builderCompatible attribute, which still allows edit access using the XML editor.

1.7:  lang - Set the Project's Main Language

The lang attribute sets the survey's default language. Specifying lang="french" will update the language from English to French, updating the error messages, button texts, and other applicable system language resources.

If you need to add additional languages, see the otherLanguages attribute.

1.8:  name - Set the Project's Name

The name attribute controls the name of your project that is visible in both the report and respondent view. The name provided here will appear in the respondents' browser window as the page's title. For example, specifying name="Shoe Survey" has the following effect:

Unique project names are usually assigned using the alt attribute.

1.9:  otherLanguages - Set Other Available Languages

The otherLanguages attribute is a comma-separated list of other languages to present your survey in.

For example, if otherLanguages="german,french" is specified, then you can use the <languages> element or setLanguage() function to dynamically alter the language for each respondent (e.g. setLanguage('german')). Learn more.

1.10:  projectType - Set the Project's Type

The projectType attribute controls the type of project. When using the Research Hub to create a new project, "What type of project is this?" is the first question that you must answer and sets this attribute according to your response. A project can be any one of the following: "beacon", "email", "info", "spss", or "offline".

When changing the  projectType, there may be up to a five minute delay for the change to be seen in the portal.

1.11:  refcheck - Enable Code Checking

The refcheck attribute applies to surveys with a compat level less than 15. This attribute can be set to "yes" or "no". By default, refcheck="yes" is specified and Python code is checked to verify that references to other questions make sense. This includes code within a cond attribute and if statements inside <exec> and <validate> elements.

For example, the following error will be shown if conditions reference a question that exist on the same page:

Error: Data reference to QUESTION which does not have data yet

1.12:  unmacro - Enable Survey to be Saved/Edited in the Survey Editor

The unmacro attribute applies to surveys with macros present. When unmacro="0" is specified, the survey cannot be opened using the survey editor or XML editor. If unmacro="1" is specified and macros exist within the survey, opening the survey in the survey editor will unravel these macros.

1.13:  unusedLanguages - Set an Available Language as Unused

The unusedLangauges attribute is used to set an available language as unused so that the SST requirement for completes in all languages can be ignored.

For example, if your survey was originally fielded in Spanish as the main language but will no longer set or use any Spanish references, then you can specify unusedLanguages="spanish" so that you can successfully bypass the requirement for a specific number of SST completes in all languages when trying to set the survey live.

<survey
    name="Survey"
    lang="spanish"
    otherLanguages="english, chinese"
    unusedLanguages="spanish"
    ...>

Just like otherLanguages, the unusedLanguages attribute can accept a comma-separated list of valid languages to ignore. All unused languages will remain visible in the data and reports, but will not be available for testing or updating translations via the survey editor.

1.14:  version - The Number of Live Edits/Remerges

Do not modify this attribute's value.

The version attribute is a read-only attribute that starts at 1 and increments each time a live survey is edited through the survey editor or remerged from the command-line.

This attribute is used to help flag respondents who view an updated survey (i.e. changed since it was initially set live) by appending a special marker to their existing set of markers.

When the survey's version is greater than 1, meaning it has received a live edit or has been remerged, then all respondents that view the updated survey will receive a marker in the form of YYYYMMDD_HH:MM_v# (e.g. 20140912_14:22_v3). This marker is a combination of two values: the remerged attribute and the version attribute.

A file named previous.datamap.txt will be written to the project directory containing the survey's previous datamap, before the most recent changes were put in place.

1.15:  remerged - The Timestamp of the Most Recent Live Edit/Remerge

Do not modify this attribute's value.

The remerged attribute is a read-only attribute that reflects the date of the most recent live edit and/or remerge. When a survey receives a live edit through the survey editor or is remerged from the command-line, this attribute will be set to the timestamp of this moment in the form of YYYYMMDD_HH:MM (e.g. 20140912_14:22).

This attribute is used to help flag respondents who view an updated survey (i.e. changed since it was initially set live) by appending a special marker to their existing set of markers.

When the survey's version is greater than 1, meaning it has received a live edit or has been remerged, then all respondents that view the updated survey will receive a marker in the form of YYYYMMDD_HH:MM_v# (e.g. 20140912_14:22_v3). This marker is a combination of two values: the remerged attribute and the version attribute.

A file named previous.datamap.txt will be written to the project directory containing the survey's previous datamap, before the most recent changes were put in place.