Advanced export options
These options customize Data Export formats and filter specifications.
-
File content customizes the content of the data and column headings in the export file.
-
File format customizes the export format. The options available are specific to the chosen format.
-
Advanced filters defines how multiple filters behave together, and provide a more complex filter method.
-
String templates defines the content of the String Template export format.
File content
Custom formatting of the exported data.
- Column headers
-
The value to export for column headings (field names). This option identifies the Fields property that contains the value to use.
Column header format
Field property
Name
(default) Name of the field.
Name in survey
For Survey fields (Q-Field), use the question prompt (Short name). Otherwise, for all others, use Name of the field.
Note: SPSS export format truncates the output to 120 characters (UTF bytes).Client identifier
Client identifier property; if empty, use Keyname property instead.
Export label
Export label property; if empty, use Keyname property instead.
Note: The String template Export-format, can override this setting to use either the Name or Keyname properties. - Export values
-
How to export Alternative field values.
A field based on an Alternative value is an enumeration where the field's value is one of a set of elements predefined by the field's alternative set (Alt Set). Each element has a Sequence Number, an In report label or "name", and an optional Numeric value. For example, a "Contact Type" field might have three alternative values, like this:
Seq NumVal In report ---- ------- ----------- 0 100 In person 1 140 Phone call 2 165 Web siteWhen a field is assigned one of these elements, all three properties are available for export. Additionally:
-
Sequence number never changes and is the safest value to export. This value is useful for profile questions. However, this option requires the export recipient know what the values mean.
-
Numeric value is optional, can be any number, and can change. This value is useful for ratings questions and for performing statistical calculations.
-
In report must have a value, and it can be changed. This value is useful for presentation.
Note: When a survey question is based on an Alt Set and the customer does not make a selection, or if the customer chooses "N/A", the field value is empty.When the field is a system field (A-Field) this option determines how to export values as follows:
Option
Export
Sequence number
(safest) Use Sequence number.
Numeric
Use Numeric Value. If the field is empty, export as as null.
Note: Using null is hard to distinguish between skipped questions and those where "N/A" was chosen.Name
Use In report.
Numeric or name
(recommended) Use Numeric value. If the field is empty, use In report instead.
Numeric or sequence number
Use Numeric Value. If the field is empty, use Sequence Number instead.
Export value
Use Numeric Value if the datatype can be exported as a numeric value (Alt Set, Export value is numeric is true); otherwise, export as text.
-
- Date values in export formatting
- Java date formatting pattern for the
$DATE$variable. Common patterns include:yyyy-MM-dd (default) MM/dd/yyyy yyyMMddSee Date and time formatting for details about the patterns.
- Time values in export formatting
- Java date formatting pattern for the
$DATETIME$variable. Common patterns include:yyyy-MM-dd HH:mm:ss (default) yyyy_MM_dd_HH_mm_ss yyyy.MM.dd HH:mm:ss Z MM/dd/yyyy HHmmssSee Date and time formatting for details about the patterns.
File format options
File formatting options depend on the selected Export format. This is the complete list of options available for all formats.
- Date time values in filename formatting
- Java date formatting pattern for the
$DATETIME$variable. Common patterns include:yyyy-MM-dd HH:mm:ss (default) yyyy_MM_dd_HH_mm_ss yyyy.MM.dd HH:mm:ss Z MM/dd/yyyy HHmmssSee Date and time formatting for details about the patterns.
- File encoding
- Character set of the exported text-based content. The most common set is UTF. Choosing None defaults to UTF.
- File compression
-
File compression method to use when compressing the file. An appropriate extension is automatically appended to the filename. The options are:
-
Gzip
-
Bzip2
-
Zip
Important: Do not use compression on encrypted files because they are already compressed.Restriction: File compression for aggregate-field exports (Analysis Reports) is not supported for any compression format. Compression is only applied to record-level (Surveys) export types. -
- File encryption key
-
Public encryption key provided by the company for encrypting the data. A key is a long string of text in Pretty Good Privacy (PGP) format. The export will always be encrypted when there is text in this field.
Restriction: Generally encrypted files should have a .pgp filename extension, like myFile.pgp. However, the export process always appends a final extension that matches the type of export, such as .csv or .xslx. There is no way make .pgp the final extension. For example, exporting a CSV file named myFile.pgp results in final filename of myFile.pgp.csv.Note: This is not the same as a password, and is different from the key required by the SFTP delivery method.
Advanced filters
These options further refine the selection of records to export.
- Do not send empty exports
- Whether or not to deliver the export when it has no survey records or the aggregate report is empty. When an empty export happens, an email is sent to the Failure email report to address, regardless of the state of this property.
- Survey condition
-
Identifies survey records to export based on a simple comparison.
Important: This filter is very slow because it is applied after the other Exporter constraints have retrieved a set of records to export. Whenever possible, use the Filters instead, because they are applied in the database before retrieving records.Use a ‘<field><operator><value>’ syntax, like:
e_mail = "ry.cooder@example.com" - Filtering condition
-
How to combine episode filter results.
-
(default) Records must match ALL filters (AND condition).
-
Records must match ONE filter (OR condition)
Warning: When using a custom timeperiod as a filter condition, the filtering condition will always be AND, regardless of this setting. This can result in exceptionally long export queries that eventually timeout without completing. -
- Export end time field
-
Field used to check the upper bound of the selected time period. Use None (default) to use the Time field selection for both bounds of the time period.
- Exclude partially completed invite (personalized) surveys
- Select this option to excludes partially completed feed-based surveys.
- Exclude partially complete anonymous surveys
- Select this option to exclude partially completed anonymous surveys.
String template options
See String templates for details.
