System spreadsheets are globally-accessible resources, and are administered from the Home dashboard.
Accessing System spreadsheets
To access the System Spreadsheets Administration, expand the Resources button group, and click the Sheets button.
This launches the System Spreadsheets applet. The default view displays all existing system spreadsheets.
Tip: Use the search box at the top of the list to locate a specific sheet.
These spreadsheets can be sorted by Name, Description, Version, Created, and Author.
- Name refers to the actual name or ID of the spreadsheet.
- Description is a user-defined description of the spreadsheet defined when the spreadsheet was created.
- Version refers to the iteration of the spreadsheet (e.g., version 1, version 2, etc.).
- Created is the date on which the file was uploaded.
- Author is the user that uploaded or created the spreadsheet.
View individual versions or compare multiple versions of a spreadsheet in the Version History window. You can also upload new versions, view each version, download existing versions, or designate a version as the "primary" version in this window.
Note; Not all users will have the ability to add system sheets (the New button might not be available). If the New button is not displayed, the user will be limited to the following Actions - View, History, Download.
Formatting and creating spreadsheets
Any spreadsheet or text editing software can be used to create a spreadsheet, provided that it is formatted such that the first row defines columns, and the first column defines the row ID. The first column must be labeled ‘id’. The second column can be labeled arbitrarily, but if the sheet is to be used as a survey data source, then it is highly recommended to label it as 'text'. The default text for a sheet reference is defined by the 'text' column. Omitting it means that no default text will show when the list is referenced, and text
decorators must be used to define the data column to use as text.
It is essential that these standards are observed. Although the system may load your spreadsheet, it may disregard data which is improperly formatted and does not follow these conventions. As such, it is a good idea after creating your spreadsheet to use the View button to look at the spreadsheet's contents, so you may ensure it has been loaded as expected.
The system accepts three file formats: Microsoft Office XLS or XLSX Excel files, Open Document ODS spreadsheets, and CSV files (comma separated value). Be sure your document is saved in one of these formats before attempting to create a new spreadsheet.
Formatting examples
Given the formatting restrictions mentioned in the previous paragraph, a properly formatted XLS or ODS file looks something like this.
id |
text |
STATE |
CITY |
CBSA |
COUNTY |
---|---|---|---|---|---|
97001 |
97001 |
OR |
ANTELOPE |
17180 |
WASCO |
97002 |
97002 |
OR |
AURORA |
41420 |
MARION |
97004 |
97004 |
OR |
BEAVERCREEK |
38900 |
CLACKAMAS |
97005 |
97005 |
OR |
BEAVERTON |
38900 |
WASHINGTON |
97006 |
97006 |
OR |
BEAVERTON |
38900 |
WASHINGTON |
97007 |
97007 |
OR |
BEAVERTON |
38900 |
WASHINGTON |
97008 |
97008 |
OR |
BEAVERTON |
38900 |
WASHINGTON |
97009 |
97009 |
OR |
BORING |
38900 |
CLACKAMAS |
97010 |
97010 |
OR |
BRIDAL VEIL |
38900 |
MULTNOMAH |
97011 |
97011 |
OR |
BRIGHTWOOD |
38900 |
CLACKAMAS |
97013 |
97013 |
OR |
CANBY |
38900 |
CLACKAMAS |
Notes on case sensitivity
- The 'id' column must always be labeled as such in lower case. Failure to do so will cause the spreadsheet to add its own id column, potentially causing confusion.
- The 'text' column should also be lowercase, particularly if that column is to be used by a survey question widget.
- All other columns can contain mixed case, CAPS, etc., but then must be referenced verbatim.
Adding spreadsheets to IntelliSurvey
After creating a properly formatted sheet, it can be uploaded. Begin by clicking the New button.
Note: Currently, only Superusers and System Administrators have permission to add or edit a system spreadsheet. To add/upload or edit survey spreadsheets, one must have the survey role of Survey Creator or higher (Team Leader, Superuser, System Administrator).
For more information on adding survey spreadsheets to an existing survey, see Managing survey spreadsheets with the Spreadsheets applet.
The system prompts for the following information:
- Name (ID) is the static reference used to call the spreadsheet in survey code. Names should not include any spaces or special characters.
- Description is a short description of the contents of the spreadsheet. The description appears only within the Browse Sheets applet and is used to help search and sort spreadsheets.
Note: Because the name is the programmatic reference to the sheet, the sheet must be uniquely named. Lists within the survey source cannot share the ID.
When the name and description are completed, click the Browse button to display the file open dialog box and select the locally-created document. When the file is selected, click the Next button. The system will load and parse the document and create the spreadsheet. If there are any errors, adjust the document, being sure to follow the formatting guidelines above.
The sheet is now ready to be used in a survey.
Comments
0 comments
Please sign in to leave a comment.