Version Notice: This article covers features in our r9/IS Pro platform. If you're looking for information on this topic related to r8, see Reporting Record Selector and Reporting Field Selector.
The Report Builder allows you to determine which respondent records and survey fields (questions or variables) to include in Frequency and Response reports. There are several options available for filtering records and selecting fields you can use to create a report that is focused on the specific data you are interested in.
Report Builder overview
The Report Builder is found the Frequency and Response report applets. Other reporting applets such as Crosstabs and Charts use a modified version of this tool.
The Records & Filters section determines which respondent records are included in the report, while the Fields section allows you to select which questions and variables (or "fields") to include. Once the desired records and fields are selected, click Apply to run the report.
Individual filters can be reset as needed, or you can click Clear Report to remove all previously selected filters and start over.
Selecting records
The Records & Filters section (a.k.a., Record Selector) consists of a Respondent Filter dropdown menu and a set of checkbox filters: Data Cut, IDs, and Date/Time. These settings can be applied in any combination. The filters are cumulative, meaning that records must satisfy all of the selected filters to be included in the report.
Respondent Filter dropdown menu
Click the Respondent Filter dropdown menu to choose from a selection of common respondent statuses, or use the default option, Completed respondents. Click the checkbox next to each record type you wish to include, or select All Records to include all respondent types.
The number in the blue bubble is the number of records that will be included in the report based on the selected Records & Filters settings. This number updates automatically as you adjust the various filter settings.
Data Cuts
The Data Cut filter allows you to create and apply data cuts. Data cuts are filters that allow users to define the scope of respondents to be included in a report.
The dropdown menu contains all data cuts that have been created for that particular survey. You may also type in this menu to filter the data cut list. Two data cuts are included by default: All records and All completed records.
The text field below the dropdown menu allows you to type in a logical expression, similar to writing a condition in our survey programming language (SPL). After entering an expression, the expression can be saved as a data cut for future use.
Expression Builder
Users can also create a new data cut using the Expression Builder by clicking the wrench icon. The Expression Builder allows you to select any fields, operators, and response options necessary to create the logical statements for the desired data cut. If need be, multiple fields may be combined, and the logic statements can be edited in the Expression Output text box.
If a more complex logic statement is required to construct the filter condition, click the wrench icon at the bottom of the modal. This will bring you to the Data Cuts applet where you can use a modified version of the Expression Builder to create a more complex data cut filter.
IDs
The IDs filter provides a text box where you may input or paste in a list of respondent IDs, one per line. Only the IDs in this list will be included in the report.
Date/Time
The Date/Time filter allows you to filter records based on timestamps. There are four dropdown menus. In the upper row, choose a reference timestamp on the left, and a time frame on the right. In the lower row, select a date and (optionally) a specific time of day.
The menus in the second row will change depending on the timeframe selected in the upper right. For example, if Between is selected, an additional row is shown to allow for selecting a start time and end time.
The options in the upper left menu refer to the following fields in the survey data:
| Date/Time option | Survey field referenced |
| Respondent Start | resp_start_ts |
| Respondent End | resp_last_ts |
| Record Creation | create_ts |
| Record Last Update | last_ts |
Saving IDs and Date/Time filters
The Gear menu icon in the IDs and Date/Time filter sections allows you to save an ID list or date/time filter for future use, apply a previously saved filter to the current report, or rename or delete a previously saved filter. These filters are saved as data cuts and may also be selected in the Select data cut dropdown menu.
Selecting fields
The Fields section (a.k.a., Field Selector) allows you to choose which questions and variables to include, and whether to run the report from a Draft or Published set of the survey. First, use the Question Set menu to select a Published Version or Draft Version. If the most recent survey version has been published, the Question Set will automatically use the published version, and the menu will be disabled.
Next, select the survey fields to include in the report. For Response reports, the record ID field trans_id is always included.
Click the Select Fields dropdown menu and choose from the following options. When selecting fields By Chapter or Individually, the reporting field tree is used to navigate the chapters and fields in the survey.
| Option | Description |
| Survey Fields |
All questions and variables within the Survey fields chapter. This does not include items in the Record data or System fields chapters. |
| Survey Fields and Record Data | All questions and variables within the Record data, Survey fields, and Appendix chapters. |
| By Chapter |
Select one or more chapters via a dropdown list. |
| By Field Type |
All questions and variables organized by their type. This includes most chapters — Managers Only and specific sub-chapters of System fields are excluded.
|
| Individually | Select questions or variables individually via a dropdown list. |
Comments
0 comments
Please sign in to leave a comment.