Creating export specifications
Create an export specification from the Export specifications screen. Start by choosing type of export to create (survey records or report result), naming it and saving the specification. After saving the specification, you can provide the definition for the rest of the properties.
If you need to export survey records as they change or are updated, consider using Omni Exporter instead.
Before creating an export specification
To create an export specification you first need to determine if the report will be pushed (delivered automatically per schedule) or downloaded manually by a User viewing a report. Then, you need to determine the details for specification based delivery method, export file format, and other criteria.
| Criteria | Pushed export | Downloaded export |
|---|---|---|
| Delivery method | Email or FTP per schedule. | User manually chooses to download export results; role-based |
| Data type | Records or Analytics. | Records or Analytics |
| Export format | Excel, delimited text file, SPSS, custom text; Only one per specification. | Excel, delimited text file, SPSS, custom text; User may select the format when configured |
| Data set | Specified fields or as defined in the Analytics report. | Specified fields or as defined in the Analytics report. |
| Filter criteria |
Episode conditions for fast filters (preferably indexed fields); Condition filters for non-indexed fields; Conditions can be all (AND) or just one (OR) . | Records match what is currently shown in the report per the report filter;Analytics match filter specified in the AA2 report. |
| Data formatting | Format the exported data;Options based on the export format type. | Format the exported data;Options based on the export format type |
| Encryption and compression | As required by the Company. | As required by the Company. |
| Delivery method options | Depending on the chosen method, including where to deliver the export and any security settings associated with the method, such as email address or FTP target. | — |
Survey records automatically delivered (pushed) to an external system
- Choose New Survey Export on the Export specifications screen.
- Provide the values for these required properties:
- Name
- Priority
- Export via — Choose Email or one of the FTP deliver methods.
- Filename
- Save the specification.
- Define these additional required properties:
- Data type — Choose Record-level (Surveys)
- Export format
- Fields to export
- Schedules
- For email delivery types, provide the Email specific options: To and From addresses, From Name, and message subject.
- For FTP types, provide the FTP/SFTP specific options:
- Define any optional properties.
- Save the specification.
- (Optional) Define one more episode conditions to filter the results:
- Select the Export specification and then choose New Episode Condition.
- Provide the filter Name, and define the filter condition.
- When using multiple filters, any combination of Episode and Survey conditions, set the Episode Conditions option appropriate for the desired result: unchecked for ALL conditions must be met; checked for any condition must be met.
- Save the episode condition.
The export should now be sent per the Schedule.
Report download
Downloads the records shown on the associated standard report, per the report's current filter condition. This feature is not available for Custom Reports (also known as AA2s).
- Choose New Response Filter Export on the Export specifications screen
- Name the specification, and save it.
- Provide the values for these required properties:
- Priority
- Export via — Choose the report-type this specification applies to.
- Export format
- Filename
- Available for roles — Determines which Roles see this export option. The report must have the same roles assigned to it.
- Fields to export
- Define any optional properties
- Save the specification.
The download option should now be available on the associated report.
Analytics report pushed to external system
The analytics report is already "filtered", so no filters need be defined in the export specification.
- Choose New Survey Export on the Export specifications screen.
- Provide the values for these required properties:
- Name
- Priority
- Export via — Choose Email or one of the FTP deliver methods.
- Filename
- Save the specification.
- Define these additional required properties:
- Data type — Choose Aggregate (Analytics report)
- Export format
- Analytics Report — Name of the Custom reports to export.
- Schedules
- For email delivery types, provide the Email specific options: To and From addresses, From Name, and message subject.
- For FTP types, provide the FTP/SFTP specific options:
- Define any optional properties.
- Save the specification.
The export should now be sent per the Schedule.
