Skip to main content

Decipher Support

All the topics, resources needed for Decipher.


FocusVision Knowledge Base

Attributes for Report Settings

Attributes for Report Settings

 agents - Set Expansion Level for vos/vbrowser Tables

The agents attribute can be set to "normal", "full" or "none" and controls the operating system (vos) and browser version (vbrowser) virtual questions generated automatically in the report. It is required that userAgent be present in the extraVariables attribute for these tables to populate.

By default, agents="normal" is specified and the following data is captured by the vos/vbrowser tables:

vos vbrowser
  • Windows 95
  • Windows 98
  • Windows 8
  • Windows 7
  • Windows Vista
  • Windows 2003
  • Windows XP
  • Windows 2000
  • Microsoft Windows NT 4.0
  • Windows ME
  • iPhone/iPad
  • Mac OS X or older
  • Other Mobile
  • Linux, UNIX
  • Opera
  • MSIE 11
  • MSIE 10.x
  • MSIE 9.x
  • MSIE 8.x
  • MSIE 7.x
  • MSIE 6.x
  • MSIE 5.x or older
  • Chrome
  • Safari
  • Firefox
  • Other Mozilla or Netscape
  • Mobile
  • Text Browser

If agents="full" is specified, the vos/vbrowser tables will expand to include the following items (in addition to the ones listed above):

vos vbrowser
  • Nokia
  • Blackberry
  • DoCoMo
  • Symbian
  • PalmOS
  • Samsung
  • Android
  • Sony Ericsson
  • Windows Mobile
  • Windows CE
  • Symbos
  • MIDP
  • Opera Mobile
  • Nintendo DS
  • Nokia
  • Blackberry
  • DoCoMo
  • Symbian
  • PalmOS
  • Samsung
  • iphone
  • Android
  • Sony Ericsson
  • Windows mobile
  • Windowsce
  • Symbos
  • MIDP
  • Opera mobi
  • Nintendo ds

Set agents="none" if you wish to remove the vos/vbrowser tables.

In compat="120+" surveys, the userAgents attribute is automatically added to all surveys.

 alternatecb - Set to Use Alternative Column Binary Layout

The alternatecb attribute is a boolean value that enables a different output mode for the column binary data format.

Each checkbox input uses its own row rather than multiple punches per row. The column binary text output assigns one row per ASCII character and one card per 80-character line.

 autoAddVariables - Set to Automatically Add New Variables to Layouts

The autoAddVariables attribute is a boolean value that controls whether new variables should be automatically added to data layouts.

If autoAddVariables="1" is specified, then any new variables are automatically inserted following other selected variables from the same question and type. New variables that come from an entirely new question or were not selected in the layout will not automatically be added.

For example, if your existing layout has Q1r1 and Q1r2 selected (checkbox) and you have added Q1r3 to your project after having created the layout, Q1r3 will automatically be inserted after Q1r2. However, a new Q1r3oe would not be inserted since it does not match the type.

 autoRecover - Set to Automatically Recover Partials

The autoRecover attribute is a boolean value that controls automatic data collection for partial respondents. This attribute can be applied to surveys with a compat level of 109+.

If autoRecover="1" is specified, partial respondents will be recovered and added to the dataset approximately every 15 minutes.

A partial respondent is a respondent who has entered the survey but hasn't completed or submitted data in the last 15 minutes.

If a partially recovered respondent completes the survey, the previous partial data entry is updated with the new data.

 blankValue - Specify Replacement Value of Blanks

The blankValue attribute allows you to replace the value for blanks in the dataset.

For example, specifying blankValue="-99.99" will replace all blank (None) values to -99.99.

This attribute is also available on a per question basis.

<radio label="Q1" optional="1" blankValue="NO ANSWER">
  <title>Please choose one...</title>
  <row label="r1">Item 1</row>

 capturePreciseTime - Set to Capture Precision Timing

The capturePreciseTime attribute is a boolean value that allows you to capture the time from when the page is first loaded to the time it's submitted for every page that a respondent sees.

If capturePreciseTime="1" is specified, extra JavaScript will run on each page storing the timing, down to 1 millisecond.

You can access the timing details using any of the following functions:

  • preciseTimeSpent()
  • preciseTimeSpent(pageno)
  • preciseTimeSpent(
  • preciseTimeSpent(uuid)
  • preciseTimeSpent(uuid, pageno)

For example:

<text label="Q1" title="What is your email address?"/>

<html label="Q1_Timing" where="survey">
  <p>You took ${preciseTimeSpent(} seconds to answer that question.</p>

The following mutator function is also available to store the precise time for each page:

<float label="pagetime" onLoad="preciseTimePerPage()" title="."/>

Changes to the layout of the survey may alter the capturePreciseTime and preciseTimeSpent values, because each respondent might hold a different page view. 

 cbUseFwidth - Set to Use Fixed Width for Column Binary Files

The cbUseFwidth attribute is a boolean value that forces column binary files to use the fixed-width set in the variables.xls file (which defaults to 64) rather than always using 9.

 checkboxBlankIfZero - Set to Use Blank Instead of 0 for Checkboxes

The checkboxBlankIfZero attribute is a boolean value that allows you to control the value for <checkbox> elements.

If checkboxBlankIfZero="1" is specified, all 0 (None) data will be forced to a blank in the data files.

 dashboard - Specify Variables to Include in Field Report

The dashboard attribute enables you to display additional variables in the field report.

This attribute accepts a space separated list of question variables with an appropriate row/column label (e.g. Q1.r1). For example, given the following two questions:

<radio label="Q1">
  <title>Radio Question (Select One:)</title>
  <row label="r1">Row 1</row>
  <row label="r2">Row 2</row>
  <row label="r3">Row 3</row>
  <row label="r4">Row 4</row>

<checkbox label="Q2" atleast="1">
  <title>Checkbox Question (Select all that apply:)</title>
  <row label="r1">1</row>
  <row label="r2">2</row>
  <row label="r3">3</row>
  <row label="r4">4</row>

If we specify dashboard="Q1.r1 Q1.r2 Q2.r2" inside the <survey> element, we'll get the following result in the Completions tab of the field report:


 dashboardInclude - Specify Data File to Include in Field Report

The dashboardInclude attribute allows you to specify a tab-delimited file other than include.dat to include into the field report.

This is used sometimes to reference a different tab-delimited file for the report and the field report.

 dashboardIncludeKey - Specify Key to Use for Field Report Data File

The dashboardIncludeKey attribute allows you to specify a variable other than source to index the included file by for the field report.

 fixedWidth - Set the Size of Fixed-Width Fields

The fixedWidth attribute controls the way fixed-width files show open-ended data.

By default, fixedWidth="lax" is specified and all open-ended data is included in the download files with their field widths set to their defaults.

If fixedWidth="tight" is specified, then only numeric open-ended data will be included and the field width will be determined by the verify, range or size attributes specified at the question level (e.g. verify="range(0, 999)" sets the field width to 3, size="10" sets the field width to 10).

 flatKey - Set the Key for Flat Form Data

The flatKey attribute is emitted for the OE Data (Flat Form) data file type. Specify a comma-separated list of variables (e.g. flatType="item1,item2,item3,..." or flatType="PID") and the data will be outputted according to the key(s) specified.

 flatShowEmpty - Set to Show Empty Lines in Flat Form

The flatShowEmpty attribute is a boolean value that controls the OE Data (Flat Form) data file type to show empty lines.

If flatShownEmpty="1" is specified, empty lines will be shown in the downloaded data file.

 forceDataCharset - Set the Downloaded Data Character Set

The forceDataCharset attribute allows you to convert data downloads contained within zip files from their default character set (typically UTF-8) to a new character set.

This attribute is used in very rare cases and you may find the available character sets here.

 fwoe - Specify OE Data to Include in Fixed-Width Files

The fwoe attribute can be set to "text", "textarea", "other" or "" (blank) and controls which open-ended data appears in the data.

If fwoe="text,textarea,other" is specified, then non-numeric text, textarea and other data is emitted.

If fwoe="" is specified, then none of the non-numeric open-ended data will be shown.

 geoip - Set to Generate GeoIP Variables

The geoip attribute controls the virtual questions that are added to the survey related to respondent GeoIP information.

If geoip="all" is specified, all GeoIP-related information relative to country name, city, region and metro code will be added.

Learn more: How to Implement the Digital Fingerprinting System

 imagePrefix - Specify a Prefix for "Uploaded Files" Downloads

The imagePrefix attribute controls the variable prepended to the "Uploaded Files" in the data downloads menu.

By default, the respondent's record is prepended. You may specify, for example, imagePrefix="source" to use the source variable instead.

 indexed - Specify Variables to Index Data By

The indexed attribute can be used to index survey data based on an extra variable. This is often used in association with the loadRecord function to load data from a source survey.

 minimumSegment - Set Minimum Population Size for Segments

The minimumSegment attribute enables you to disable segments that don't meet a certain number of population. If minimumSegment="10" is specified, then segments below that population will appear as blanks in the reports. This is required to obey certain UK market research regulations.

Learn more: Restricting Values in Reports, Exports & Dashboards for Low Sample

multixt - Sets the Number of Cores to Distribute Crosstabs Processing

The multixt attribute allows crosstabs to run on multiple CPUs at once but at a low priority.  This results in a speedup in extremely large data files (100,000+ or more respondents) but will decrease performance otherwise.  This does not speed up e.g. virtual question generation but solely backend processing.  If multixt="4" is specified, crosstabs processing is distributed across four CPUs. The default is multixt="0".

 namingScheme - Specify Variable Naming Format

The namingScheme attribute can be used to adjust the data labels for your questions. If namingScheme="cruft cruft" is specified, the system will use an older way of generating labels in the report. If namingScheme="TEST TEST" is specified, you'll see the question labels for each variable have changed to "TEST" instead of the normal "Q1".

The default value, namingScheme="%L%R%C%H %L%R%C%Hoe", uses the lables you provided in the survey.xml to generate the labels appropriately.

  • %L is replaced with the label of the question (which must be set)
  • %R is replaced with the row label
  • %C is replaced with the col label
  • %H is replaced with the choice label

There are two parts to the naming scheme: the first part (before the space) is for normal questions and the second part (after the space) is for open ended questions.

Instead of %R you can use %r which will be the 1-based index of the row. This means that even if you named your rows "r0", "r1", "r4", you would see "r1", "r2", "r5" instead.

 precision - Set the Number of Digits to Display After Decimal

The precision attribute controls the number of digits to display after the decimal points for fixed-width data files.

By default, tab-delimited files display 6 significant digits both before and after the decimal point and weights are shown with 8 significant digits.

 saveRandomOrder - Save the order of shuffled elements

The saveRandomOrder attribute is a boolean value that controls whether the order of shuffled elements is saved when a respondent exits the survey.

If saveRandomOrder="0" is specified, the order for shuffled elements is not saved. This setting may optimize the time it takes to save because the random order can be considerable large and slow to save. Note that the "Random Order" file located in the "Tracking Files" section of the data downloads will be blank.

 spssSimpleCheckbox - Set to Show Simple Labels in SPSS

The spssSimpleCheckbox attribute is a boolean value that changes the value labels for checkboxes in the SPSS script data downloads.

For example, instead of displaying Q1 1 'The text' 0 'NO TO: The text', it will be shown as Q1 1 'Selected' 0 'Not Selected'.

 sql - Set to Use SQL Database

The sql attribute is a boolean value mostly used for panel surveys. If sql="1" is specified, the data will be stored inside a SQL database.

 sqlRefreshTime - Set the SQL Database Refresh Time

The sqlRefreshTime attribute is an integer value that allows you to override the default time it takes for new records to appear in the report after having been added to the SQL database.

The default is 3600 seconds (1 hour) and can be set lower for small surveys. For panel surveys, however, this time should be kept at 1 hour to avoid lengthy delays.

 sqlTarget - Set the SQL Database File Path

The sqlTarget attribute can be set to the path where the SQL database should be stored.

For example, if sqlTarget="selfserve/9d3" is specified, then the database will reside in the main client directory specified.

 trackCheckbox - Set to Show Blanks for Unseen Checkbox Cells

Use the trackVars attribute described below instead. trackCheckbox is obsolete.

If trackCheckbox="1" is specified, then a hidden question is generated, _tcx, with one row per checkbox row and column in the survey. When a respondent completes the survey, each cell in that question is set to TRUE if the corresponding cell was hidden due to a False condition. When downloading data, this information is used to turn checkbox variables that would be otherwise 0 to blank (None) values.

 trackVars - Set to Show Blanks for Unseen Checkbox Cells

The trackVars attribute can be set to "none", "checkbox" or "term". 

If trackVars="checkbox" is specified, then each checkbox input will be individually tracked to show if the cell was shown to the respondent or hidden due to a False condition. This will enable a reporting Percentage Base option that lets you configure the base to show the exact number of respondents who actually saw the checkbox option rather than those who answered the question (e.g. "Total Shown Variable").

The trackVars="checkbox" option tracks what rows and columns were seen in checkbox question by re-checking the conditions at the end of the survey, when respondent's data is about to be saved. In order to generate the correct values you must ensure that the conditions have the same value at the end of the survey as at the beginning. For example, if you base the visibility of a row based on a persistent variable (i.e. set by using <exec>p.showRows = ['r1', 'r3,' r5'] and checked by e.g. rowCond="row.label in p.showRows") , that persistent variable must remain unchanged throughout the survey.

In contrast to trackCheckbox="1", with trackVars="checkbox" you can import and export this data. Variables that are not shown to the respondent appear as blanks (None) instead of 0s. Tabimporting data with a blank value will set this "not shown to respondent" flag.

If you use hmerge with trackVars="checkbox" specified, the downloaded data will be coded to 0/1 instead of blank/1. Note that the _tcx data value will default to 1 if a respondent answered a question before the trackVars attribute was added.


Learn more: Setting an Answer Option Base to Total Shown for Multi-Select Questions

If trackVars="term" is specified, then a marker will be added to each terminated respondent tracking which terminate condition they met. The percentages for all terminate points will be tracked in the Terminates tab of the Field Report.


You can specify trackVars="checkbox,term".

 weights - Specify Weights for Data Weighting

The weights attribute allows you to provide weights for individual questions.

 zeroPad - Set to Enable Leading Zeroes for Fixed-Width Files

The zeroPad attribute controls the leading zeroes in fixed-width files.

If zeroPad="1" is specified, then leading zeroes will be displayed in fixed-width files (e.g. a variable with a fixed-width of 3 with the value of "1" will look like "001").

What's Next?

More information about all of the <survey> element's attributes are provided in the documents below:

  • Was this article helpful?