LiveSurvey Invite File Format
Invite files are comma-separated value (CSV) files where each row represents a survey invitation. Each invitation can refer to a member transaction, employee, and manager.
Validation
Staff with an Admin role can validate invite files in the LiveSurvey dashboard, as demonstrated in the clip below.
Format
The invite file must be formatted as follows: * The file must be a comma-delimited file. * The file must contain a header row of column names as the first line to indicate the order of the columns. See below for column names. * The columns can be in any order. * To be uploaded with FTP, the file must have a ".csv" extension to be processed.
| Column Header | Required | Description | Sample | Notes |
|---|---|---|---|---|
| Survey ID | Required for all surveys. | The survey ID that specifies which survey is to be sent to the member. | 35 | The Survey ID can be found in the upper right corner of the survey builder tool. |
| Member Key | Required for all surveys. | The unique identifier for the transaction's associated member. | 105105 | The Member Key can be anything, so long as it is unique. Most commonly it is a member number or email address. |
| Member Name | Required for all surveys. | The full name of the transaction's associated member. | John Smith | |
| Member Email | Required for all surveys. | The primary email address of the transaction's associated member. | jsmith@example.com | |
| Member Mobile Phone | Optional for all surveys. Required if Delivery Method is SMS or EmailAndSMS. | The mobile phone number of the transaction's associated member. | 1234567890 or 123-456-7890 | |
| Member Date of Birth | Optional for all surveys. | The member's date of birth. | 1999-01-24 |
Used for viewing demographics in Scores table |
| Department Key | Required for Transaction Surveys. Optional for Relationship Surveys. | The Active Directory department of the employee who assisted the transaction. | Main Branch | This matches the value from Single-Sign-On. |
| Department Name | Required for Transaction Surveys. Optional for Relationship Surveys. | The name of the department of the employee who assisted the transaction. | Main Branch | This appears in the LiveSurvey dashboard. |
| Employee Key | Required for Transaction Surveys. Optional for Relationship Surveys. | The Active Directory username of the employee who assisted the transaction. | jsmith | This matches the value from Single-Sign-On. |
| Employee Name | Required for Transaction Surveys. Optional for Relationship Surveys. | The full name of the employee who assisted the transaction. | Example Employee | This appears in the LiveSurvey dashboard. |
| Transaction Post Date | Optional for all surveys. | The date and time that the transaction took place. | 2016-01-01T08:30:00 or 2016-01-01T16:30:00-8:00 |
Format: local time yyyy-MM-ddTHH:mm:ss or offset from UTC yyyy-MM-ddTHH:mm:sszzz |
| Transaction Type | Optional for all surveys. | A unique identifier for the type of transaction that took place. | Cash Deposit | |
| Account Number | Optional for all surveys. | The identifying account number on which the transaction primarily took place. | 100200 | |
| Transaction Number | Optional for all surveys. | The identifying transaction number from the core system the transaction. Must be unique for each transaction. | 1000001 | |
| Notify Response | Optional for all surveys. | Notification email is sent to this address when the member submits the associated survey. | employee@example.com | This is typically set to the email address of the associated employee. Multiple recipient addresses can be separated by semicolons in this field. |
| Notify Kudos | Optional for all surveys. | Notification email is sent to this address when the member submits a perfect score for the associated survey. | manager@example.com | This is typically set to the email address of the manager of the associated employee. Multiple recipient addresses can be separated by semicolons in this field. |
| Notify Contact | Optional for all surveys. | Notification email is sent to this address when the member requests to be contacted while taking the survey. | manager@example.com | This is typically set to the email address of the manager of the associated employee. Multiple recipient addresses can be separated by semicolons in this field. |
| Delivery Method | Optional for all surveys. | The survey delivery method. Valid values are "Email", "SMS", "EmailAndSMS" or "Mail". Defaults to "Email" | If "Mail" is specified responses must be manually entered. See below Note on Mail Delivery Method. | |
| Employee Email | Deprecated | Deprecated; use Notify Response instead. | ||
| Manager Email | Deprecated | Deprecated; use Notify Kudos instead. |
Click here to download an example invite file CSV.
Relationship Survey Invite Files
The above table details the file requirements for transaction-based surveys, which we call Transaction surveys. These are continuous ongoing surveys that accumulate results over time. However, not all surveys fit this approach. For a one-time survey of an entire membership (or a segment of one), LiveSurvey offers Relationship surveys. Note that Relationship surveys have a different LiveSurvey dashboard than Transaction surveys, and the Relationship survey dashboard is only viewable by Admins.
For Relationship surveys only the following four columns are required: Survey ID, Member Key, Member Name, and Member Email. All other columns are optional.
Limits
Invite files are generally limited to 120,000 rows and 15 MB in size. Per institution, only one file is processed at a time to ensure the no-repeat-invite policy is guaranteed. Files are processed at a rate of roughly 15,000 rows (survey invites) per hour.
About on Delivery Methods
- Email delivery method- Email is the method by which LiveSurvey sends all survey invites to members by default.
- SMS delivery method – If the institution has purchased this feature, members will be sent survey invites via SMS to their mobile phone
- EmailAndSMS delivery method – If the institution has purchased the SMS invite delivery feature, members will be sent survey invites to both their email address and via SMS to their mobile phone
- Mail delivery method – Used when the institution is running a physical mail survey and they wish to incorporate the results into LiveSurvey.