1. Select the survey template in Your work to display the Summary.

2. Click the Upload thumbnail button to display the Upload thumbnail dialog.

3. Click the Select file button to select an image. Here, the image has previously been created by copying part of the questionnaire.

4. Click Open to display the image in the Summary section.

The post Upload Template Thumbnail appeared first on SnapSurveys.

There are 2 approaches to retrieving the survey responses:

• Our recommended approach, which is to use the startingFrom token so you only get the responses that have been submitted or modified since your last call.
• Get all the responses each call and you will be charged for each response for every call.

Use of the API is chargeable. The charge is 0.1 unit each time the API delivers a survey response.  This applies if you use the API to retrieve the same survey response multiple times.

Comparing unit usage

This table compares the number of units that when getting all the responses with getting the responses using the progress token, which is our recommended approach. This comparison shows the results for a survey that receives 100 responses per day, and the organisation gets the responses once per day.

Using the progress token uses far fewer units, reduces network traffic and provide a faster response.

Recommended approach

Using our recommended approach, you can retrieve only the latest responses since the last call was made. This is done by using the startingFrom parameter in the Get Survey Responses call. When you make a call to get the responses, this returns a progress token, which will need to be stored. This is a mark in the data file for where the call got up to. The next time you make the call, pass this progress token in as the startingFrom point, and then only new data is returned.

Step 1: Make the first request for the survey’s responses

When you make the first call to request the survey’s responses, set the startingFrom parameter to 0.

This retrieves all the requested survey responses.

Optional parameter settings will affect the requested survey responses. For example:

• If you include a filter, this will be all the survey responses that match the filter.
• If you set a maximum number of responses, e.g. maxResponses=100, this will be the first 100 responses.
• If you set restricted variables, this will return only the specified variables rather than all the variables in the survey.

This is an example of a request that retrieves the specified data from all the survey responses by using startingFrom=0. (In the code, you need to replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

curl --location --request GET 'https://<servername>/snaponline/api/surveys/c23a0fd8-6219-4130-a6a7-f312829e56eb/responses?maxResponses=100&restrictedVariables= V16,V45~V47&returnUniqueIds=true&useCodeLabels=true&startingFrom=0' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

Step 2: Receive the response containing the survey’s responses

This is an example of the response to the request for the survey responses. This contains the survey responses in the responses return item, and the progress token in the progress return item.

200 OK with body:

{
    "surveyId": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c",
    "filter": "Q1>1",
    "startingFrom": "0",
    "progress": "#IBCGEGG",
    "upToDate": "false",
    "responses": [
        {
            "status": "new",
            "caseId": "8e4591b0-c1e3-4612-88b4-7b96cd28dd2d",
            "variables": [
                {
                    "id": "V46",
                    "v": "Plane"
                },
                {
                    "id": "V48",
                    "v": "\"Restaurant / Cafe\",\"Gift Shop\",\"Customer Services\""
                },
                {
                    "id": "V52",
                    "s": "NR"
                }
            ]
        },
        {
            "status": "new",
            "caseId": "5458bfcb-97df-4326-879d-4868406761ae",
            "variables": [
                {
                    "id": "V46",
                    "v": "Bike"
                },
                {
                    "id": "V48",
                    "v": "\"Gift Shop\""
                },
                {
                    "id": "V52",
                    "v": "Very busy."
                }
            ]
        }
    ]
}

Step 3: Store the progress token for the next call

In the sample response in Step 2, ‘progress’ represents where you have got to in the data file.

“progress”: “#IBCGEGG”

Store the progress token to use in the next survey response request.

Step 4: Use the progress token in the next request

The progress token from the previous response is then used as the startingFrom value in the next Get Survey Responses request, to retrieve responses that have been submitted or modified since your last call.

This is an example that uses the progress token in the startingFrom parameter.

curl --location --request GET 'https://<servername>/snaponline/api/surveys/c23a0fd8-6219-4130-a6a7-f312829e56eb/responses?maxResponses=100&restrictedVariables= V16,V45~V47&returnUniqueIds=true&useCodeLabels=true&startingFrom=#IBCGEGG' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

Using Max Responses

Max responses is optional and can be used in combination with the progress token. Use the ‘upToDate’ value to decide if you have more responses to get, then use the progress token to get the next group of survey responses. If you know the number of survey responses for each call is never going to exceed the limit of 5000, then you can exclude this parameter.

The post Recommended use of the API progress token appeared first on SnapSurveys.

Create the email question

The first step is to create a short, engaging question in your questionnaire. This is usually the first question, but you may choose any question in the questionnaire.

Some examples can be an emoji style question or a thumbs up or down. Using an image-based question, created using the Show As Buttons feature, provides a visually appealing question that’s easy for the participant to answer.

When the participant responds to the question, the full questionnaire opens for them to complete and submit.

Using single response questions gives the best result, because the questionnaire opens as soon as the participant selects an answer. A map control or slider cannot be used.

Upload Participants

In order to create the email invitation and reminders, you must upload the list of participants.

Create the invitation

You can select the question to show in the email invitation in Snap XMP Online.

1. Open the survey and in the Summary tab, click the Collect link.
2. Select the Participants side menu.
3. Click on the Invitations menu item to view the invitations.
4. Click Edit for an existing invitation or click Add invitation to create a new invitation.
5. Update or create the invitation in the Invitation editor.
6. Position the cursor where you would like to display the question and click Add Question.

4. Select the edition with the question design that you want to use. Then select the language, question and type of survey link.

5. Click Add. This adds an entry in the email body for the question in email.

6. Click Save to save the invitation.

Responding to the Question in email

When the participant answers the question in email they are shown the full questionnaire in their browser. They complete the questionnaire by navigating through the pages and submitting their response.

The post Question in an email invitation appeared first on SnapSurveys.

In Snap XMP, you can also insert an opt out link using Snap XMP Desktop.

When to include an opt-out

A requirement of using the Snap XMP subscription mailing system is to include an opt out link.

You should include an opt-out link in the majority of your email invitations and reminders. Many organisations, including, but not limited to, Gmail, Yahoo and Hotmail, stipulate that you need an opt-out or unsubscribe link in business mailings.

It is good practice to include an opt-out link. You can add the link in the email invitation or reminder using the Invitation editor. With this option, you can customise the appearance and wording of the link. You can also select to automatically include an opt-out link. This is only included if the email content does not contain an opt-out link, preventing multiple opt-out links in your email. When the email is sent the opt-out link is added to the footer of the email.

You may wish to exclude an opt-out link for in-house surveys or forms, where emails are only sent to participants that have emails belonging to your organisation’s domain, such as, an employee survey.

Participant upload requirements

These instructions assume that you have uploaded a list of participants who will receive an email invitation for this survey. If you are not familiar with setting up participants for email invitations, please see these worksheets:

Anonymisation in Surveys – Sending an email that doesn’t identify the participant
Anonymisation in Surveys – Sending an email that includes a unique participant identifier

Adding the Opt Out link

1. In the Collect tab of your survey, select the Participants side menu and then select Invitations.
2. Click Add invitation to create a new email invitation or click Edit to change an existing invitation.

3. In the email editor, place the cursor at the point where you would like the Opt Out link in your invitation.
4. Click Insert tag and select OptOut. This will insert a link with the text {OptOut}.This link will take the participants to a webpage when they opt out.

5. Select or click in this link text and click the hyperlink button to open the Insert hyperlink dialog. You can change the wording for Text and ToolTip.

6. Click Insert to update the link text.

When a participant clicks the Opt Out link in the email invitation they receive, this takes them to the Snap Surveys opt out web page. You can see which participants have opted out in Snap XMP Online. The participant will not receive any more emails for the survey.

Viewing the opt out information

In Snap XMP Online you can view all the participants who have opted out of the survey.

1. In the survey Summary tab, click the Collect link.
2. Once in the Collect tab, select Participants from the side menu and then select Participant list.
3. Click the filter icon on the Opted Out column and select Have opted-out.

4. Click Filter to show all the participants who have opted out.

Auto adding an opt-out link

In the survey invitation settings, there is the option to automatically add an opt-out link at the end of all email invitations where an opt-out has not been provided in the email body. This setting makes sure that you always provide an unsubscribe option for this survey. If you wish to customise the appearance of the opt-out link, you need to manually add the opt-out link in the email body.

1. In the survey Summary tab, click the Collect link.
2. In the Collect tab, select Participants from the side menu.
3. Click the Change Invitation Settings button to open the Invitation settings.
4. Select Automatically add opt-out to add an opt-out link at the end of the email invitation.

The opt-out link is only included if the email body does not contain an opt-out link, preventing multiple opt-out links in your email.

The opt out link will automatically be added to the footer of the email when the email is sent. You will not see it in the email invitation editor.

The post Creating an email invitation with an opt out link appeared first on SnapSurveys.

Responses menu

You can find the Responses menu by following these instructions:

1. In Snap XMP Online, click on the survey in Your Work to select it.
2. In the Summary tab, click the Collect link.
3. Select the Responses menu. This displays the default Responses page where you have the option to export all response data, and to delete all data.

Entering the format and filter

1. In Format, select the format of the exported data. You can download the survey response data in the formats:
   • Excel – csv is a version of the comma separated format that is easily recognised by Excel files.
   • CSV is a comma separated format where the text fields are surrounded by quote characters. 
   • TSV is a tab separated format.
   • Excel – xlsx is an Excel spreadsheet format.
2. In Filter, enter a filter expression to return a subset of the response data that matches the filter. For example, Q1=(1,2) or Q2=”name”.

Choosing the export file options

There are a number of export options available.

Exporting the selected response data

• Click the Export data button.

When the data export is successful, you will see a confirmation message. The export saves the exported data file to the default downloads folder set for the device. The file name consists of the survey name followed by “ – responses” and the file extension chosen for the export. For example, “my survey – responses.csv”.

The post Downloading online response data appeared first on SnapSurveys.

• Asking the owner of the survey, folder or template, to stop your share permissions.
• Stop sharing using your Snap XMP Online account.

These instructions show how you can stop sharing the item from your Snap XMP Online account.

Stop using a shared item

1. Log in to Snap XMP Online to display your work. If you are already using Snap XMP Online, click Home to return to your work.
2. Open the Shared with you folder.
3. Select the shared survey, template or folder that you no longer need to access.
4. Select the Shares tab.

5. Click the Actions menu then select Stop sharing survey with me. The menu may say Stop sharing folder with me or Stop sharing template with me, depending on the shared item selected.

6. This opens a confirmation dialog, containing a summary of the items you will no longer be able to access. Click Stop sharing to stop sharing the shared item. Click Cancel if you do not want to change the sharing access.

If you cannot see the stop sharing menu item then you have access to this survey, template or folder through the parent folder share permissions. You need to select the folder that has the share permission instead. You can find which folder this is by finding your Snap XMP account in the share list and finding the inherited from folder.

The post Stop sharing another user’s work appeared first on SnapSurveys.

1. The first page in Snap XMP Online shows a summary of Your Work. The survey template is available here. Templates are shown with the icon  . Click the icon or template name to show the template Summary.

2. In the Summary, click New Survey.

3. Enter the survey name then click Create survey.

4. This opens the Build tab where you can add questions to your survey.

The post Creating a new survey from a template appeared first on SnapSurveys.

There are two ways to connect Snap XMP response data to Power BI:

• Export the response data file in CSV format to use in Power BI
• Use the Snap XMP API directly in Power BI

Exporting the response data file in CSV format

1. Log into Snap XMP Online and open the survey.
2. In the Summary tab, click Collect to go to the Collect section.
3. In the Collect menu, click Responses. This opens the Responses section where you can manage the survey’s response data that has already been collected.
4. In Export Options, select the CSV export option. Managing response data contains further information on the available export options.

5. Click Export All Data to export all the responses to a CSV file. This saves the file to the Downloads folder set on your device.
6. Once downloaded, open Power BI and select Get Data.
7. In the Get Data dialog, which opens up, select Text/CSV, then select the exported data file and click Open.
8. Once loading is complete, you can view the response data. You can check the data looks the way you want then click Load to load the data into Power BI. There is an option to transform the data before loading, if required.

This option uses a snapshot of the response data at the time you exported the file. To update the data, repeat the process by exporting the file, giving it the same name, then re-loading it into Power BI.

Using the Snap XMP API directly in Power BI

Before using the API, the Snap XMP Online account being used will require an API permit.

• If you are using the Snap Surveys Subscription service Snap Surveys will set up the API permit.
• If you are using an On-Premises service, your organisation will set up the API permit.

Please note that when using the API:

• software development experience may be required.
• there is a unit cost associated with using the API.

Finding the survey GUID

Each survey has a unique identifier, called a GUID. This is used by the API to link to the survey. The survey GUID can be found in Snap XMP Desktop and Snap XMP Online.

Snap XMP Online

Log into Snap XMP Online and open the survey. The survey GUID forms the last section of the URL.

Snap XMP Desktop

• Open Snap XMP Desktop and from the Survey Overview, select and open the survey.
• Click the Tailor | Online Details menu. The Survey field contains the survey GUID.

Getting data using the API

1. Open Power BI and click on the Get data text.

2. Select Web from the list of Common data sources.
3. In the From Web dialog, click Advanced to expand the options.
4. In URL parts, enter the URL that calls the API. For example the URL to return response data is: https://<servername>/snaponline/api/surveys/<surveyGUID>/responses
   • <servername> is the name of the server, such as online1.snapsurveys.com or online2.snapsurveys.com if you are using Snap Surveys Subscription service,
   • <surveyGUID> is the unique GUID for the survey you are using.

5. Next add in login information required by the API. In the HTTP request header parameters add your username, API key (Password) and API version info.
   • Enter X-USERNAME with the Snap XMP Online account email address. Click Add header.
   • Enter X-API-KEY with the user’s API key. Click Add header.
   • Enter X-VERSION as 2.0.

6. Click OK
7. The first time you enter the login information, it will ask what credentials you want to use. Select Anonymous from the left side. (This is not actually anonymous since the login details have been passed through and will be used for authentication.)
8. Select the API level for access. For example, for any API call use “https://<servername>/snaponline/api” replacing <servername> with the name of the server you are using.
9. Click OK.
10. Click Close and Apply to load the data. The API data is one row per variable, so each column has just a list of one aspect of the variable (one column for variable number, one for responses, etc.)

Using the API, means that you can refresh the response data from Power BI and the data is kept up to date. Be aware that there is a unit cost associated with using the API.

You can use the API to return a number of different data sets for your surveys.

Transforming the response data

Once the response data is in Power BI, you can change the data.

We recommend that you duplicate the response data before making changes. This is for safety so that you have your original data to return to, if necessary, and if you are using the API there is a unit charge for re-loading the data.

1. In Power BI, click Transform data. This opens a spreadsheet-style view of the data.

2. Some example transformations are:
   • If the response data uses a header (top) row, this will load as a data row and populate in your chart. You can choose to use the first row to name your column headers or you can remove rows by selecting Remove rows>Remove top rows then enter “1” to remove the top row.
   • Apply a filter by clicking the drop-down next to the column that you want to transform. Select the filter from the options, then click OK.
   • Remove unwanted columns by selecting the column, right-clicking then selecting Remove Columns from the pop-up menu.
3. Click Close and apply to save all the changes.

Using Power BI for charts

There are a variety of visualizations that you can create in Power BI, including charts.

When you have loaded your data set the data source is shown in the Data section. Expand the data source to view the columns.

In the Visualizations section, there are a number of charts that you can select.

Example: Stacked bar chart

To add a chart:

1. In Visualizations, click on the Stacked bar chart icon to add it to the display area.
2. In Data, select or drag a data column, e.g. Location, to add it to the Y axis.
3. Drag the data column to the X axis to view the location counts.

Refreshing data

Using the API, means that you can refresh the response data from Power BI, by clicking Refresh. The data is kept up to date, as there is a connection to it.

For refreshing data obtained from an exported CSV file:

1. In Snap XMP Online, re-download the CSV data export file, keeping the same file name and location. This can be done by overwriting the original file or deleting it ahead of time and replacing it with the new one.
2. In Power BI, click Refresh to load the latest response data.

The next step is to publish.

Publishing data

When you have completed your chart or updated the data, you will need to publish the changes.

1. In Power BI, click Publish.
2. Select a publish location, such as, “My Workspace” and click Select.

Further Power BI help

For further help with Power BI you can access guided learning and videos from the Help menu.

The post Exporting response data to Power BI appeared first on SnapSurveys.

Description

This webinar introduces Snap XMP: Experience Measurement Platform, combining the power of Snap XMP Desktop with upgraded functionality and connects it with the features of Snap XMP Online for online surveys and offline mobile survey interviewing.

The post An Introduction to Snap XMP appeared first on SnapSurveys.

There is also an accompanying analysis webinar that demonstrates how to create the analyses in Snap XMP Online.

Opening the Analyze section

There are two ways of opening the Analyze section.

• In Your work, select the survey to see the Summary tab, then click the Analyze link.

• In the Online Editor, click the Analyze tab near the top of the page.

Creating a new Analysis

1. In the Analyze section, click on the Table & charts side menu option. This displays the list of analyses that are available for the survey in Snap XMP Online and also a New Analysis button used to create a new table, chart, list or word cloud.

2. Click the New Analysis button. This displays the Analysis page, containing the standard fields used to create an analysis.

3. In Analysis type, select the type of analysis, this can be Table, Chart, List or Word cloud. This updates the styles available in the Style file list to those for the selected analysis type.
4. In Style file, select the style used to display the analysis.
5. In Analysis, enter the question or variable. If you need more information about the variables available in the survey, click Variables in the side menu, which shows a list of the variables. Scroll down to the bottom of the list to show the buttons to go to the next or previous pages in the list.
6. In Break, enter the question or variable.
7. In Title, enter the title shown in the analysis display.
8. Click the Apply button to create the analysis. This displays the table, chart, list or word cloud.

9. You can choose to
   • Download an HTML file of the analysis display.
   • Modify the analysis.
   • Save the analysis for future use.
10. Click Save to save your changes. This opens the Save analysis dialog. Enter the analysis name then click Save. The analysis is shown in the list of analyses in the Tables & charts menu.

More options

Advanced options for the analysis are available by clicking the More button.

Options available for all analysis types

Additional options for Tables and Charts

Tables

Tables show the survey data in a tabular form showing the data in rows and columns.

The following example shows a table definition displaying the number of customers who ordered a range of food items.

When you click the Apply button, this displays the table.

Charts

Charts show the survey data in a graphical form.

The following example shows a chart definition displaying the number of customers who ordered a range of food items.

When you click the Apply button, this displays the chart.

Chart style naming convention

There are a number of different chart styles supplied with Snap XMP. When using different chart styles, the style name indicates which show options you need to select.

• If the name contains Counts then select Show counts.
• If the name contains Percents you need to select one of the show percents options.
• If the name contains Transposed then select Transpose.

Please note: In a chart, you should select either counts or percents, but not both.

In the example, the chart style is Horizontal Bar Percent Labelled Transposed. This indicates that one of the show percents options should be selected, in this case Show Analysis percents is used. The Transpose option is also selected.

Lists

Lists are generally used to display comments or free format text responses. The following example shows a list analysis for a question asking for customers’ comments.

When you click the Apply button, this displays the list.

Word Clouds

Word Clouds are used to show important or regularly occurring words in the comments or free format text responses. The more often a word appears in the comments then the larger the word is displayed in the Word Cloud.

The following example shows a word cloud analysis showing words from a question asking for customers’ comments.

When you click the Apply button, this displays the word cloud.

The post Creating Analyses appeared first on SnapSurveys.

Build: 1.0.0.1346

Release Date: 6^th October 2024

Features

• New Single edition starting template
• SOL-4912: Allow nominated question from survey to be embedded into invites
• SOL-5140: Option added to show password on Snap Online log on page
• SOL-5151: Opt out link automatically added to invites if one not present

Fixes

• SOL-5050: Twitter logo updated to X logo
• SOL-5068: Allow Help URL link to be a mailto link
• SOL-5069: Add some help text to the Invitations right hand pane when no invites defined
• SOL-5131: Deleting a seeded variable from the survey causes participant import / connector wizards to hang
• SOL-5152: Participant invites not sent if the survey is processed for mailing before the end of the import
• SOL-5161: Help link incorrect when first log on

Build: 1.0.0.1330

Release Date: 16^th June 2024

Features

• SOL-4320: New Job scheduler service to reduce blocking jobs
• SOL-4904: Participant archive and unarchive jobs added
• SOL-5030: Support POP3 OAUTH using client secret as an alternative to certificate
• SOL-5041: Limit the number of responses that can be exported from Snap XMP Online in one go
• SOL-5113: New ‘scheduled’ survey status added
• SOL-5116: Allow multiple SMTPs to be used for sending invites

Fixes

• JS-154: Prevent multiple AttachIt files for the same question
• SOl-4706: Improve participant/invite UI responsiveness
• SOL-5044: Title on custom domain survey left blank rather than Snap Surveys
• SOL-5052: Return 404/410 for invalid interview links and non running surveys
• SOL-5059: Prevent 2 paper download links being created
• SOL-5064: Improve performance of Desktop Sync streaming
• SOL-5065: Created date set for participant when created via a connector or API call
• SOL-5110: V1 of GetResponses API call now charging units
• SOL-5115: Email alert only includes 1 AttachIt file when multiple added
• SOL-5127: Rephrase reset message on group questionnaire participant
• SOE-345: Better handling for content pasted from Word
• SOE-351: Fix adding options in semantic scale
• SOE-353: Survey fails to load if brackets in style name
• SOE-354: Survey becomes corrupt after deleting grid rows with routing dependencies
• SOE-355: Valid field now working for open ended literals
• SOE-356: Save issues with compound grid and routing
• SOE-358: Questionnaire fails to load in Editor when numbering sections set to numbers 
• SOE-360: Surplus spaces in routing expression not handled
• SD-559: Data export filters via com need to treat case numbers as non-deleted cases

Build: 1.0.0.1320

Release Date: 7^th January 2024

Features

• SD-528: Allow screen outs to explicitly ignore the global target

Fixes

• JS-73: Restart button within SOI does not return the interviewer to the first page
• JS-116: Allow custom CSS to be used during interview
• JS-269: Excluded codes now pushed to the end of the sequence for alpha-ordering only 
• JS-236: Legacy HTML option with masking can stop the interview loading
• JS-253: Rank index displayed on its own line when code label is long
• JS-300: Masking and alpha ordering could result in codes showing more than once
• JS-301: Rating check plus must answer issues
• JS-302: Carousel not displaying correctly when grid question text not showing
• JS-303: Drag rank question with conditional routing does not always display the initial value
• JS-304: Page timer not working when randomise added
• JS-305: Show the error on Drag and drop grids after focus is moved on
• SOE-270: Snmedia read and save added
• SOE-275: Semantic scale label edit improvements
• SOE-312: Rank and Category grid edit improvements
• SOE-316: Image map grid edit improvements
• SOE-338: Grid labels lost when changing grid style
• SOE-343: Group questionnaire edit improvements
• SOE-346: Image resize issues
• SOE-347: Post condition routing can get removed

Build: 1.0.0.1317

Release Date: 12^th November 2023

Features

• SOL-4965: Paper edition published on demand 
• SOL-5025: Excel CSV option added to Export responses and set as default

Fixes

• SOL-5027: Error shown if number of pages in a report greater than 200
• SOL-5028: Rename from ‘Your work \ Surveys’ to ‘Owned by you \ Your work’
• JS-246: Drag & Drop Rank does not limit the number of rows to rank
• JS-294: Quota console error with Next and Back

Build: 1.0.0.1310

Release Date: 8^th October 2023

Features

• SOL-4980: Separate create from save analysis permission
• SOL-5009: Always show Publish button when possible regardless of interviewing state
• JS-258: Prevent going back to an already submitted survey

Fixes

• SOL-4618: Don’t show report label for analysis in solo surveys
• SOL-4706: Database changes to improve performance and throughput
• SOL-4940: Ensure all emails are processed when using batch option
• SOL-4971: Remove X-XSS-Protection header from interviewing and main site (in line with OWASP)
• SOL-4973: Ensure X-Frame options header can be set for main site.
• SOL-4976: Unused referrer header removed to prevent future potential risk of a CSRF attack
• SOL-4987: Return a 400x or 500x error status code when appropriate
• SOL-4988: Track participant being deleted for SOI sync
• SOL-5003: Reset password email content changes to reduce it being treated as spam
• JS-104: Submitting works if error has not been seen yet (submit on all pages)
• JS-231: Must answer inline in a hidden question prevents the Respondent from using Next button
• JS-236: Potential crash during interview with empty code labels
• JS-269: Maintain original position for excluded codes when code order = random
• JS-279: Tab order updated when conditional questions appear
• JS-280: Allow custom scripts to be executed
• JS-284: Inline question within a Not Asked question causes empty page
• JS-287: No longer hide questionnaire when Submit pressed
• JS-288: SOI signature slow to be enabled
• JS-289: Must answer quantity sliders showing as error at start
• SOE-327: Variable references in initial value fields updated correctly when new variable inserted
• SOE-331: Prevent order of language variable being changed
• SOE-337: Stop question text being repeated in open series grids
• SOE-344: Question text lost in multi language survey when routing added
• SOE-345: Paste text only when copying from Word

Build 1.0.0.1297

Release date: 9^th July 2023

Features

• SOL-4888: Ability to create and save analyses via browser
• SOL-4618: Add report label to clickable link for each report
• JS-175: Random question order enhancements

Fixes

• SOL-4947: Report title potentially incorrect when run within Snap XMP Online
• SOL-4948: Handle large amounts of AttachIt data for downloading
• SOL_4953: Error when exporting large amount of CSV data
• SOL-4954: id.name lost on Close using the Legacy interviewer
• SOL-4967: Improve layout of password rules
• JS-132: Reduce flicker when questions transition in due to routing
• JS-235: Reduce size of published output
• JS-272: Set forward ordering to start on random code
• JS-274: Improve accessibility publish
• SOE-257: Improve grid re-arranging
• SOE-314: Fix 10 code semantic scale layout issue
• SOE-330: Allow all characters for hyperlink text
• SOE-333: Handle Greek characters correctly

Build 1.0.0.1289

Release date: 14^th April 2023

Features

• SOL-4742: Merge shared area into main survey tree view

Fixes

• SOL-4283: Redirect to log in page when log in times out on Analyze tab
• SOL-4752: Add option to be able to keep partials for quota/screen out
• SOL-4868: Option to keep partials when quota full hit working with JSI
• SOL-4890: Add username to reset password email text
• SOL-4894: Quota performance improvements when under high load
• SOL-4909/4915: improve performance of New survey dialog and Sync
• SOL-4910: Summary dashboard reports no pdf when not required
• SOL-4914: allow seeding on group survey landing page
• JS-18: variable response properties not working in open series literals
• JS-56: calculated values to show number of dps specified
• JS-73: improve performance of surveys with large amounts of code masking
• JS-208: alignment issues with compound grids when hiding/unhiding parts
• JS-209: inline attachIt option not showing as expected
• JS-246: Drag and drop rank allowed respondent to select more options than designed
• JS-241: alpha ordering not applied to inline questions

Build 1.0.0.1288

Release date: 4^th April 2023

Fixes

• SOL-4921: Anonymous SMTP fails when server supports authentication
• SOL-4928: Remove refs to OPTIMIZE_FOR_SEQUENTIAL_KEY as not supported on less than SQL 2019

Build 1.0.0.1284

Release date: 3rd January 2023

Features

• SOI Quotas now available with this release of SOL
• SOL-4809/4819/4845: Connectors (This is the updatesurvey.asp replacement)
• SOL-4701: Update colors to improve accessibility in the user interface
• SOL-4752: Allow Researcher to optionally keep partials for quota-ed or screen-ed out survey
• SOL-4757: Add ability to configure CSP and X-SSS to main Snap XMP Online site
• SOL-4764: Browser tab for screenout to be labelled Screen out
• SOL-4820: Allow multiple accounts to trust the same browser
• SOL-4838: Allow admin to reset trusted devices for a user
• SOL-4852: Add MFA usage to audit trail
• SOL-4856: Add in Payment Ref to a licence so on import the payment ref can be set AND limit the number of times a link can be used
• SOE-176: Inline spell checker alert (Chrome, Edge)
• SOE-292: Handle Compound Grids added via Snap XMP Desktop

Fixes

• SOL-4488: Validation added to text entry in Admin areas
• SOL-4573: Keep responses when flipping between Standard and Plain versions (w3c)
• SOL-4656: Group questionnaire: second import disables invites on participant where a subject has changed or been added (and possibly deleted)
• SOL-4697: Some characters (e.g. new line) in quota full message cause problems with JSI
• SOL-4765: Fail to process some emails returned to Snap XMP Online
• SOL-4774: Update AttachIt including old JQuery dependency (requires Snap XMP Desktop 12.12)
• SOL-4812: MFA UX issues
• SOL-4813: Print button not working if custom domain and JSI
• SOL-4832: Consistent participant status between legacy and JSI
• SOL-4834: Participant import, delete option can fail when seeding incorrect
• SOL-4837: Remove trusted device list and do not require user to specify one
• SOL-4842: Improve look of MFA code dialog when errors show
• SOL-4853: Maintain JSI zip after each download for next attempt
• SOL-4854: Audit record for closed partials incorrect if > 50 partials being closed
• SOL-4855: Read Email job always reporting 0 emails processed (SOL 1260 onwards only)
• JS-155: Print button not working on single page questionnaires
• JS-208: Spacing issue if ‘Space before’ used with Compound grid and routing
• JS-219: Seeded with hidden language editions can show wrong language
• JS-220: Missing response data in partial when drop down style used
• JS-222: Carousels with large amounts of question text overlap boxes
• JS-224: Masking in plain text version causes codes to not show
• JS-226: Text box loses focus (requires double click)
• SOE-132: Variable reference lost when new question added
• SOE-237: Variable reference potentially causing corrupt survey on save
• SOE-279: Survey fails to save due to routing

Build 1.0.0.1260

Release date: 20^th October 2022

Features

• JS-186: Inline questions
• SOL-4722: Multi Factor Authentication added
• SOL-4722: Password complexity setup via admin UI
• SOL-4756: Support for POP3/IMAP Office 365 Exchange Online OAUTH certificate-based authentication
• API: GetSurveyList and GetSurvey have a new property called ResponsesLastChanged that contains the timestamp showing when the responses were last changed.

Fixes

• SOL-4550: Share context not used for determining code list in filter/context
• SOL-4590: Optional for questionnaire SNIF is stored in the database
• SOL-4616: Pending activation list is limited to showing 10 accounts
• SOL-4634: Some characters can cause problem with export of data to Excel
• SOL-4664: Identify survey in bounce back email
• SOL-4724: Admin edit of account can lose some account data
• SOL-4746: SMTP 500 errors don’t need to be tried again
• SOL-4750: Switching to text only version turns partials off
• SOL-4770: Double quotes in filter expression fails
• SOL-4771: IMAP connection not secure
• SOL-4772: SNIF extraction on demand for Online Editor
• SOL-4780: Stop Admin browsing affecting user’s ‘Recent list’
• SOL-4785: Webpage on submit causes pop up if custom domain
• SOL-4787: Dashboard Summary report doesn’t work for a shared user
• JS-131: ‘use steps’ option for sliders respected
• JS-152: Carousel grid not always showing code labels
• JS-166: Compound grids
• JS-176: Preserve random order of codes on Save
• JS-182: Initial value shows up as answered twice in partial
• JS-185: Carousel grid changes for right to left languages
• JS-189: Updated version of jQuery
• JS-197: Multi choice drag and drop grid fixes
• SOE-142: Preview of drop downs fixes
• SOE-242: Preview of Data picker fixes
• SOE-293: Preview option removed from Editor

Build 1.0.0.1205

Release date: 16^th May 2022

Features

• SOL-4347: reCAPTCHA can be added to reset the password and account creation pages. Configuration is required in machinespecific.config (FMSMVC)

Fixes

• SOL-4729: Stop storing the ‘Data’ in the Responses table if the source is Snap XMP Desktop
• SOL-4738: Invites stopped incorrectly on a survey when too many concurrent connections
• SOL-4379: SMTP connections not always disposed of as soon as can be
• SOL-4740: Close partials job can block other jobs when large numbers of partials to close
• JS-8: Rating check with routing on grid doesn’t allow the grid questions to be answered. (This requires the latest Interviewer and Snap XMP Desktop updates for complete release)
• JS-49: Resume partial to start on page in error (if necessary)

Build 1.0.0.1171

Release date: 7^th February 2022

Features

• SOE-254: Support for Sliders added
• SOL-4565: Support for multi response context values
• SOL-4618: Report title shown as tool tip
• SOL-4677: Support for new (beta) interviewer in Qwizards online

Fixes

• JS-22: No read only calculated source can show as 0
• JS-138: Fix for multi line AttachIt question
• JS-143: Customisation possible of error message for Valid property
• JS-144: Auto answer on masked question set incorrectly
• JS-145: Too many decimal places sometimes displayed on derived variable
• JS-146: Error in calculation following variable with Max responses property set
• JS-151: Initial value set to an exclusive code could be removed when using Back button
• JS-153: Grids in Safari browser sometimes failed to display
• SOL-4315: Email alerts with AttachIt attachments now handled correctly
• SOL-4526: Error shown to user when no valid licence on cloning
• SOL-4550: Share context not applied for determining code list for filters/contexts 
• SOL-4568: Reset participant invite status after email address corrected
• SOL-4588: Revise ordering of seeding screen on Participant import
• SOL-4596: RGB colours converted to RGBA on save in email invite
• SOL-4622: Adding or editing a subject on a Group questionnaire within Snap XMP Online would break seeding for the first subject
• SOL-4623: Web page on submit seeding not handled correctly
• SOL-4666: Improve performance of email reader and enhance error logging
• SOL-4684: Change wording of invite schedule when invites are disabled
• SOL-4685: Better display of survey status messages on mobile devices
• SOL-4690: Fix for Restart button not working
• SOL-4698: Mailing status added to top line
• SOL-4710: Partials not working as expected for Group questionnaire

Build 1.0.0.1104

Release date: 4^th October 2021

Features

• SOL-4389: API v1 (permission based so needs to be enabled for each account)
• SOL-4542: New button added to allow userAdmin to generate a reset Password link manually
• SOL-4553: Separate licence defaults for when Admin creates account
• SOL-4585: Option to update survey licences when template licence updated
• SOL-4608: Quotas
• SOL-4648: Include created time in Participant export
• JS-94: Image map accessibility enhancements JS-108: Slider bar accessibility enhancements

Fixes

• SOL-4072: Set default session timeout to be 59 mins
• SOL-4331: Handle surveys with only paper editions
• SOL-4491: More helpful error message when creating an account that’s been deleted or purged
• SOL-4492: Social media links added to Collect page
• SOL-4494: QR code to use custom URL
• SOL-4538: Stop using iFrame unless its custom domain
• SOL-4539: Set custom URL token to original value if you clear it
• SOL-4545: Survey name can contain invalid characters when you clone a survey
• SOL-4549: Make choosing worksheet number more obvious in Participant upload dialog
• SOL-4555: Use account’s Full name when no Email from name set for invitations
• SOL-4558: Participant import performance improvements
• SOL-4575: Add option to disable checks in mailer for certificate revocation
• SOL-4577: Handle id.name variable rename
• SOL-4579: Sort order added for Group questionnaire list as seen by Participant
• SOL-4601: Trim leading and trailing spaces from ‘subject’ for group questionnaires
• SOL-4612: Logged in survey completion rate incorrect
• SOL-4617: Participants cannot be added via UI
• SOL-4629: More validation required on email address when sharing (plus trim spaces)
• SOL-4654: Crash adding a new participant to an invite only survey
• SOE-145: Drop downs now working in Editor preview
• SOE-165: Code ordering now working on Editor preview 
• SOE-208: More…dialog can get cut off
• SOE-222: Placeholder text would sometimes remain in Firefox
• SOE_225: Footnote in wrong position when masking is on
• SOE-246: Grid of open ended quantity questions incorrect size
• JS-20: Closing the attachIt dialog would show an error in IE11 
• JS-20: Native data pickers in SOI
• JS-39/SOE-216: Alpha ordering with mask and other question problem
• JS_90: Footnote appears in wrong place when mask also applied to the variable
• JS-91: Routing not working when variable in error state
• JS-92: Start date/time incorrect
• JS-95: Wrong format for dates in initial/seeded values
• JS-113: Error message not visible when question overflows viewport
• JS-119: Long initial values could cause crash
• JS-120: Build preview does not reload on browser refresh
• JS-124: Grid of notes would crash
• JS-123: Cater for seeding/ restoring values when initial value

Build 1.0.0.1065

Release date: 21st June 2021

Features

• Survey response profile graphs added
• SOL-4562: Delete mode added to Upload Participants 
• SOE-122: Rating check feature added to Online Editor
• JSI-32:Support for partials

Fixes

• SOL-4558: Participant import re-write adjustments – batch up within SQL to improve performance / only allow 1 update from Desktop at a time
• SOL-4560: Warn user the schedule will be cleared if they manually stop a survey
• SOL-4578: Error shown when survey with custom login page paused
• SOL-4591: Allow participant reminder to have an interval set to 0
• SOL-4598: Participant wizard can time out when uploading a large spreadsheet
• SOL-4550: Share context not used for determining code list in filters/contexts in Analyze
• SOL-4555: use account’s Full name when no Email from name set for invitations
• SOL-4559: Participant overview ‘started’ and ‘completion rates’ inaccurate for group survey
• SOL-4554: Group Questionnaires don’t work when there is an apostrophe in the subject
• SOL-4534: Adding a / or : in Subject line of an email results in error
• SOE-217: Mutually exclusive option doesn’t show
• SOE-224:  Editor preview doesn’t show initial values
• SOE-229: Grid questions have code exclude lists set up on 2nd, 3rd etc row
• SOE-234: grid attributes text overlaps content
• SOE-235: Page breaks not handled correctly in Editor preview
• SOE-169: Auto renumber option not respected in Editor
• JS-8: Added option to unselect option for Rating Check
• JS-31: Support for Restart button in SOI
• JS-45: Prevent double submit from occurring
• JS-109: Support for Close button in SOI
• JS-20: data pickers not working
• JS-38: Handling for read only variables
• JS-107: Id.completed not set on submit
• JS-83: All paradata handling

Build 1.0.0.999

Release date: 7^th December 2020

Features

• SOL-4479: Allow surveys created from Survey templates to be sync’d between Snap XMP Desktop and Snap XMP Online
• SOL-4506: Customisable options available when exporting data from Snap XMP Online

Fixes

• SOL-4331: Handle surveys with only paper editions
• SOL-4420: Entering HTML in text fields can crash dialog or page
• SOL-4470: Build tab tooltip restyled to make it easier to read and not overlap
• SOL-4507: Filter issue when Survey set to US date format
• SOL-4510: Handle email bounce backs
• SOL-4511: Filter Participant by status displays empty list
• SOL-4520: Survey mailing stopped on failure to send 1 invite
• SOE-123: Text substitution not working in Editor Preview
• SOE-189: Add a footnote to a Single and it disappears after a reload
• SOE-205: Open ended questions only accept 1 character in Build | Preview 
• SOE-209: Setting the Initial value for a literal can throw up an error or cause the survey to not save
• SOE-221: Hard to set a semantic scale to have 10 codes
• JS-96: Footnotes on grids fixed

The post Subscription Snap XMP Online release notes appeared first on SnapSurveys.

Viewing the Response Profile

To view the Response Profile:

1. Select the survey from Your work. This shows the Summary tab, by default.
2. Select the Response Profile tab to view the response profiles of the participants and completed responses.

The Response Profile shows two profile sections:

• Profile of participants showing the current status for all participants, with the proportion of survey responses that are not started, started or completed.
• Profile of completed responses showing the profile of completed survey responses, with graphs of the date, day of the week and hour of the day that the responses were completed, and when invitations or reminders were sent.

Profile of participants

This section is only available for surveys that use participants. This section shows the current status for all participants. The graph shows the percentage of survey responses for each status: not started, started or completed.

The scale shows approximate percentage. Place the mouse cursor to hover over the graph to see the exact percentage of participants at each stage.

You can click the participant completion status labels to add or remove the participants with that status. The label has a line through it when the graph does not show that data.

Profile of completed responses

This section is available for all surveys. This section shows the profile of completed responses received and invites and reminders sent.

There are three graphs showing the number of completed responses received or invitations sent over the selected date ranges for:

• the date
• the day of the week
• the hour of the day

For each graph, click the labels for the completed responses received, or the invites and reminders sent, to show or hide the appropriate data. The label has a line through it when the graph does not show that data.

Selecting the date ranges

When you enter a date range, this shows the survey response profile for the selected range. You can drill-down to see the responses over specific dates especially over busy periods.

1. In the Show drop-down, select the date range. You can select from This month, Last month, Choose dates, All time, Last 7 days, Last 30 days.

2. If you select, Choose dates
   • In From, enter a start date, either by entering directly in the text box or by clicking the calendar icon and selecting the date.
   • In To, enter an end date, either by entering directly in the text box or by clicking the calendar icon and selecting the date. The end date must be on or after the start date.

3. Click the Refresh button. This updates the data in all the graphs in the completed responses profile.

The response profiles use the time zone of the survey.

Completed Responses profile graph by date

This graph shows the number of responses that the respondents completed on a specific date over the selected date range. It also shows the number of invitations and reminders sent on a specific date over the selected date range. The date range shown on the horizontal axis is that selected in the Show drop-down.

Completed Responses profile graph by day of the week

This graph shows the number of responses that the respondents completed on each day of the week over the selected date range. It also shows the number of invitations and reminders sent on each day of the week over the selected date range.

Completed Responses profile graph by hour of the day

This graph shows the number of responses that the respondents completed for each hour of the day over the selected date range. It also shows the number of invitations and reminders sent for each hour of the day over the selected date range.

The post Response profile appeared first on SnapSurveys.

When a respondent submits a response to the source survey, that information can be used to create, edit, or delete participants in the destination survey.

This associated information can include details such as logins, email addresses, or other seeded data.

There are three requirements for Connectors:

1. The source survey, which is the initial survey.
2. The destination survey, which is the follow-on survey.
3. The participant definition spreadsheet containing the required participant data fields.

Defining participant data before using Connectors

Connectors are set up in the destination survey.

Prior to using Connectors, you need to upload the participant definition spreadsheet in the destination survey. The format of the spreadsheet needs to match the participant and seeding data expected from the source survey in order to create participants in the destination survey.

This data needs to include a unique identifier for the participant, which may be a login id or email address. The data requires an email address if you wish to send invitations to the participants.

The data may also contain information from the source survey available to seed the invitations or the destination questionnaire.

The spreadsheet needs to contain at least one row of data, but this can be dummy data and you can remove it later.

Importing the participant spreadsheet

1. Log in to Snap XMP Online.
2. In Your Work, select the destination survey.
3. Select the Collect tab and select Participants from the side menu.

4. The Connectors section becomes available after you upload a participant file. Select Participant List and click Upload Participants to load the list of participants. Further information on all the options is available at: Uploading participants from a spreadsheet
5. When the file has been successfully loaded, the Connectors section is enabled. Two options are available: Add Connector and Validate All Connectors

Creating a Connector

Before adding a Connector, make sure that the destination survey is selected, and that the participant definition file has been uploaded.

1. Select the Collect tab then select Participants from the side menu.
2. Select Connectors and click Add Connector. This opens the Participant connector dialog.
3. Enter the Connector name.
4. There are 3 operations to choose from: Add participant, Edit participant, Delete Participant. This is the action that is taken when the source survey is completed, using the information from the survey response. Select the operation required. Click Next.

5. Select the source survey. You can select a survey from your own surveys in Your Work or from surveys that are shared with you. Click Next.

6. In the next page, you can select whether to send email invitations, assign a login and set up seeding. Click Next.
7. If the option to seed email invitations is selected, the next page lets you set up seeding for the email invitation. Click Next.
8. If the option to seed the questionnaire is selected, the next page lets you set up seeding for the questionnaire. Click Next.
9. The next page contains a summary of all the options chosen for the Connector. Click Create to create the Connector.
10. Once created, list of Connectors shows the new Connector.

Seeding the questionnaire

The questionnaire seeding maps a variable in the source survey to a variable in the destination survey. When you map a single-choice or multi-choice question, the connector uses the code index, which is the order of the code. It does not use the code label to cater for multi-language surveys.

When mapping a single-choice or multi-choice question from the source survey to one from the destination survey, the code order needs to match. If this is not the case, you need to create a derived variable in either survey to match the order that you need.

Enable or disable a Connector

Initially, the default status of the Connector shows as disabled. You must enable the Connector before you can use it.

1. In the list of Connectors, click Enable on the Connector row.
2. Click Enable when you are asked to confirm.
3. Click Finish when the confirmation message displays.
4. The status of the Connector displays a green tick in the list of Connectors. A Disable button is now available to allow you to disable the Connector.

If you want to disable the connector, repeat the instructions, clicking the Disable button. The Connector row displays a red cross.

Editing a Connector

You can edit the operation and the seeding in the Connector. This also uses the Participant connector dialog.

1. Find the Connector that you want to edit in the list of Connectors. Click the Edit button. This opens the Participant connector dialog containing the details of the selected Connector.

2. There are 3 operations to choose from: Add participant, Edit participant, Delete Participant. This is the action that is taken when the source survey is completed, using the information from the survey response. Select the operation required. Click Next.
3. The Connectors view displays the selected source survey. You cannot change the source survey. (If you require a different source survey you will need to create a new Connector.) Click Next.
4. In the next page, you can view the survey options. You can change the source survey variable used for the email and login information. Click Next.
5. If the option to seed email invitations is selected, the next page lets you change the source survey variable for seeding in the email invitation. You cannot add new seeding. Click Next.
6. If the option to seed the questionnaire is selected, the next page lets you change the source survey variable for seeding in the questionnaire. You cannot add new seeding. Click Next.
7. The next page contains a summary of all the options you have set up for the Connector. Click Update to update the Connector.

Deleting a Connector

When the Connector is no longer required, you have the option to delete it.

1. Find the Connector that you want to delete in the list of Connectors.
2. Click the Delete button.

3. This displays a message asking you to confirm the delete action. Click Delete to delete the Connector. This removes the Connector from the list of connectors.

Validation

In the Connectors section, there is the ability to validate an individual connector or validate all connectors.

• To validate an individual connector, click the Validate button on the Connector row in the list of connectors.
• To validate all connectors, click the Validate All Connectors button at the top of the Connectors section.

A message displays showing whether the connectors are valid. Click OK to close the message.

Clear Errors

When you enable the Connector, the connector row may show errors because the connector is unable to create the participant from the response data of the source survey. The errors show in the list of Connectors, on the row of the Connector with the error.

1. Find the Connector in the list of Connectors.
2. Click the Clear Errors button.

3. This displays a message asking you to confirm the clear errors action. Click Clear to clear the errors for the Connector.
4. The Errors column shows no errors and the error count shows 0 in the connector row.

Please note: A participant will not be created when there is a blank email address or login, but this will not be shown as an error.

The post Connectors appeared first on SnapSurveys.

Multi-factor authentication is a security measure for online software. In addition to your username and password, this requires you to authenticate your login by providing additional information that proves your identity. This is usually provided by a code generated in an email or in an authenticator app. This makes your account more secure as it requires multiple pieces of information to log on with.

Multi-factor authentication is often abbreviated to MFA and is used in the rest of this article.

Configure MFA

You configure the MFA in Snap XMP Online.

1. To set up MFA on your account log in to Snap XMP Online.
2. Select Your account in the side menu.
3. Select Security.

4. In the Security tab, click the Configure MFA button.

5. There are 3 options available: None, Email or Authenticator app. You can choose either Email or an Authenticator app to receive the 6-digit verification code. Examples of authenticator apps are Microsoft Authenticator or Google Authenticator. Select None to turn off MFA.

6. Click Next.
7. The next action depends on the option selected.
   • None – the MFA settings are cleared. Additional information will not be requested when you log in.
   • Email – an email will be sent to the email address associated with the logged in account with the 6-digit code. Enter the code and click OK.
   • Authenticator app – follow the instructions on the dialog to set this up. Enter the 6-digit code and click OK.
8. When the multi-factor authentication is set up you will be prompted for the code when you next log in.

Log in using MFA

Snap XMP Online

1. When you next log in, enter your username and password as usual and click Log in.
2. Snap XMP Online prompts you for a code. Enter the 6-digit code from email or the authenticator app.

3. If you wish to set your current device as a trusted device, select Remember browser. You will not need to enter the code each time you log in using the same browser on your device. If you use a different device or browser, you will need to enter the code.
4. Click Submit to log in to Snap XMP Online.

Snap XMP Desktop

Once you have set up MFA in Snap XMP Online, the next time you use Snap XMP Desktop you will need to enter a code. Make sure you are using Snap XMP Desktop 12.11 or later for MFA support.

1. Open Snap XMP Desktop.
2. The message ‘Could not validate account’ appears. Click OK to remove the message.
3. Enter the password for the user account shown.
4. Snap XMP Desktop prompts you for a code. Enter the 6-digit code from email or the authenticator app.

5. If you wish to set your current device as a trusted device, select Trust this device. You will not need to enter the code each time you log in on the same device. If you use a different device or browser, you will need to enter the code.
6. Click OK to log in to Snap XMP Online.

Change the type of MFA

You change the MFA settings in Snap XMP Online.

1. Log in to Snap XMP Online.
2. Select Your account in the side menu.
3. Select Security.

4. In the Security tab, click the Configure MFA button.

5. You can choose either Email or an Authenticator app to receive the 6-digit verification code. Examples of authenticator apps are Microsoft Authenticator or Google Authenticator.
6. Click Next.
7. The next action depends on the option selected.
   • Email – an email will be sent to the email address associated with the logged in account with the 6-digit code. Enter the code and click OK.
   • Authenticator app – follow the instructions on the dialog to set this up. Enter the 6-digit code and click OK.
8. When you next log in, enter the 6-digit code when prompted.

Clear the MFA settings

You can clear the MFA settings in Snap XMP Online, when you no longer require multi-factor authentication.

1. Log in to Snap XMP Online.
2. Select Your account in the side menu.
3. Select Security.

4. In the Security tab, click the Configure MFA button.

5. There are 3 options available: None, Email or Authenticator app. Select None to clear the MFA settings.
6. Click Next which clears the MFA settings. When you log in, you do not need to enter any additional information.

The post Multi-factor authentication (MFA) appeared first on SnapSurveys.

• Windows Server 2012 or later running IIS, matching Microsoft’s minimum requirements, plus an additional 2GB memory
• SQL Server 2012 or later, matching Microsoft’s minimum requirements

Further resources will be determined by load levels and usage profiles

These installation instructions have been written for Window server 2019. You will need to refer to the system documentation if installing on a different version of Windows server

This document assumes that your server is configured, secured and functioning properly using a server certificate for SSL

You will require server administrator skills and rights

You will need a Snap XMP Desktop installation code during the Snap XMP Online installation process. This is required to run the software used by Snap XMP Online. This must be the only copy of Snap XMP Desktop on the server. If you have a networked copy of Snap XMP Desktop the networked copy must be run on a separate server.

Snap XMP Online requires the use of a mail server for certain functionality. The mail server should be running on a separate server to reduce congestion.

Installation steps

IIS installation

Check if IIS has already been installed and if not, install it

Configure the server using ‘Add roles and features’ to have the following components to ensure the software installs and runs correctly:

Add Windows Authentication

Add the ASP.NET 4.7 role under the Application Development section

Include the features that are required for ASP.NET 4.7

Add the HTTP activation for WCF services and the Message Queuing (MSMQ) Activation (including the features required)

Create databases in SQL Server

Snap XMP Online requires 5 separate databases to store the data.

NB: The collation must be Latin1_General_CI_AS. This needs to be set when the databases are created.

The naming convention allows for a prefix of your own choosing followed by the following names:

• prefix_CustomURL
• prefix_SOL
• prefix_SOLMailing
• prefix_SOLResources
• prefix_SOLShares

The prefix along with user credentials for an account that has permission to create tables in these databases will be required when running the installer. We recommend you create a new user and set the new user to be the database owner.

Run the installer

The Snap XMP Online setup.exe will install the following components:

• Snap XMP Online
• Snap XMP Desktop
• Snap Pool12
• Win2pdf (a pdf printer driver to enable reports to be generated)
• AttachIt

Run setup.exe from your download:

Install all the pre-requisites and reboot as required.

Select where you would like the Snap XMP Online software to be installed and the folder you would like to use to store the survey data.

When prompted select the SQL server and specify the user credentials and prefix chosen for the databases:

Press the Next button. The Snap XMP Desktop installer will start.

Enter the installation code when asked to do so.

You do not need to

• install the sample surveys
• have the SPSS add-on
• include the shortcuts

The win2pdf installer will automatically start. Follow the prompts to install.

The SnapPool12 installer will automatically start. Follow the prompts to install.

Check the information dialog at the end for errors:

Restart server

Once the installer has finished restart the server to update the security permissions set up during the install.

Configuring Snap XMP Online

Log in as sysadmin

Open the Snap XMP Online site in a browser: https://localhost/SnapOnline

NB – access needs to be over https://

Log into the sysadmin account. The default password is sysadmin.

Change the sysadmin password

Select Your account from the accordion and then select the Change password option:

Password complexity rules

The password complexity rules can be configured in the User interface:

Configure the site

Most of the configuration is set up for optimum working of Snap XMP Online and so will not need to be adjusted. However, the following configuration is necessary:

AttachIt

Select Configuration in the accordion and select the AttachIt topic:

Set the ‘External service path’ to your sites public domain

Generate a new random GUID and copy the GUID into the ‘DownloadToken’ setting in AttachIt’s web.config (C:\inetpub\wwwroot\AttachIt)

Main site URLs

Select Configuration in the accordion and select the ‘Common settings’ topic:

You will need to configure the following with your site domain:

• Base URL for the interviewer application
• Base URL for the JavaScript interviewer
• External URL for Snap XMP Online

Content security policy for the interviewer site:

Select Configuration in the accordion and select the ‘Content security policy’ topic:

You will need to configure the following with your site domain:

• Custom url domain

Custom URL site

Select Configuration in the accordion and select the ‘Custom URL’ topic:

You will need to configure the following with your site domain:

• Service URL path

Custom URL template

You will need to edit the config file C:\SnapOnline\WebContent\ShortUrl\config\MachineSpecific.config and change the setting:

<setting name=”UrlTemplate” serializeAs=”String”>

<value>http://localhost/s/{0}</value>

</setting>

And replace “http://localhost” with your site domain. This is the base URL for surveys that respondents will use.

Email responses and invites

Snap XMP Online can be configured to send and receive emails. Snap XMP Online uses the SMTP server to send emails regarding administration tasks such as password reset and invitations to participants as well as email alerts configured on a survey by survey basis. The incoming mail server can be set up to use POP3/IMAP basic authentication or Office 365 Exchange Online OAUTH certificate based authentication – details can be entered in the Inbox accounts page.

Snap XMP Online can be configured to process an inbox to handle replies to invitations including bounced emails.

After an SMTP mailer has been configured you will need to enable to the job which is periodically called to send the invitations. Select Job scheduler in the accordion and Edit the ‘Send invitations’ job:

Adding ReCAPTCHA to password reset and account register pages

It is possible to add Google’s reCAPTCHA v2 to the password reset and account registration pages. To use reCAPTCHA, you will need to sign up for an API key pair for your site and then edit the MachineSpecific.config file entering your own keys:

C:\SnapOnline\WebContent\FMSMVC\config\MachineSpecific.config

<add key=”RecaptchaSiteKey” value=””/>

<add key=”RecaptchaSecretKey” value=””/>

See https://developers.google.com/recaptcha for more details

Enabling the API

To allow programmatic access to the data held within Snap XMP Online apply the following configuration:

Access to survey information and response data is controlled by ‘Enable RESTful API’ and access to participant information (to add, update and delete) is controlled by ‘Enable Participants’

To add and delete participants via the API the PUT and DELETE HTTP verbs need to be enabled in IIS

Initialising the system

To create surveys in the Snap XMP Online editor you need to have a starting template. Snap XMP Online can be configured to share the contents of a global folder so that any starting templates you upload to this folder will be available to all accounts.

Create an account to hold the global folder

Select User admin in the accordion and select the ‘Create new user’ option:

Fill in the details, setting the Permissions to be ‘Researcher’ and select the ‘Create user’ button at the bottom of the page:

Upload a starting template into the account

Select the account and use the ‘Upload template’ option to upload a zip file containing a Questionnaire template and an optional image (with the same name as the template). A blank starting template can be found in the ‘Questionnaire templates’ folder alongside the Snap XMP Online installer setup.exe. Clear the ‘Create default licence’ option before selecting the file:

Once the template has uploaded you can log into the account to set up the global folder:

Select the ‘New folder’ option and create a folder:

Move the template into the folder by dragging the item in the accordion:

Select the folder in the accordion and make a note of the (folder) ID on the URL

Log out of the account to return to the Admin area. Select Configuration in the accordion and select the ‘Licensing-system’ topic. Copy the folder ID into the ‘Global Resources Folder id’:

Follow the steps above to upload all custom Questionnaire templates for your system.

Creating new user accounts

Each account on the system has a permit (which details what the account is able to to) and a licence (how much the account can do). Permits are defined by Permission groups and allocated when the user is created and can be changed at any time. Some default Permission groups are created during the installation process eg Researcher (the permit for users who need to create surveys), Analysis (the permit for users who just need to view reports and analyses) and Interviewer (the permit for users who use the mobile interviewing app (Snap Offline Interviewer) to conduct face to face or kiosk based surveys). The Permissions groups can be adjusted to allow or disallow functionality. On saving a change any account using that Permission group will be affected immediately.

When creating an account you will allocate a Permit and can specify licence limits. The limits that can be applied are:

Survey limit (maximum number of surveys that can be created/uploaded),

Number of units (responses and attachIt file size make up units and can be ‘charged’ according to ‘Charging rates’ which can be configured via the accordion.)

Number of days for licence (how long the licence lasts for once activated)

Snap XMP Online has been written with the intention that the ‘User name’ is the same as the email address. For example: when the reset password option is used the form asks for an email address. Strictly speaking it is requesting the user name field and will use the email address field to send the email. All user names must be unique, however the same email address can be used on multiple accounts. This allows admin accounts to be created with a unique user name but use the email address of an existing account.

Multi Factor Authentication (MFA)

It is possible to allow users to set MFA up on their account. A User Admin needs to enable this feature which will then allow the user to set up MFA choosing either email or an Authenticator app as an additional factor:

Alternatively, MFA can be enabled for all accounts by editing machinespecific.config:

C:\SnapOnline\WebContent\FMSMvc\Config\machinespecific.config

<add key =”MakeMFAAvailable” value=”True”/>

Authenticator App

To allow users to choose an Authenticator app for MFA you will need to configure the following:

C:\SnapOnline\WebContent\FMSMvc\Config\machinespecific.config and set:

<add key=”GAuthPrivateKey” value=”xxxxxxxx”/>

<add key=”GAuthEnable” value=”True”/>

Set GAuthPrivateKey to an 8 (or more) character alphanumeric value which is used to generate a unique key

If a user has a problem logging in after setting up MFA a User Admin is able to clear the MFA settings reverting the user back to basic authentication:

Allowing API access for the account

API access is controlled by a permission. To add that permission to an account you either need to edit the existing Permission group or create a new one to allocate to the account.

If you want to edit an existing one, log in as a SysAdmin account and select the Permission group:

Enable the ‘Manage integrations’ option:

If you want to create a new Permission group (eg Researcher with API) then select the ‘Create new group’ option at the top of the Permissions page, set it to have the same options as Researcher and then add the Manage integrations option. You would use this method if you want to limit which accounts can be accessed via the API. The account that you want to use for the API will need to have a permit that has this permission – so either Researcher if you have modified that or the new one you created.

To change the permit, select the user via an admin account and then select the ‘View user licences’ option:

You can then change the permit used by that account:

Note: The permit on a resource (e.g. survey) is dependent on the permit that the resource owner has and in the case of sharing it is also dependent on the permit the shared to account has as well as the permit applied on the share itself. So if you use 1 account via the API and want access to surveys that belong to a different account but have been shared to the API account then both accounts need to have API permission as well as the share.

The post On-Premises Snap XMP Online installation guide appeared first on SnapSurveys.

Endpoint

Get details of the specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request GET 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Responses

The response structure is determined by the participant feature configuration of the survey. This is shown in the participant import wizard of Snap Online.

If the configuration has “Allow Snap Online to track respondents” ticked it is a logged on survey and a “loginSection” will be included. If the configuration has “Send email invites / reminders” ticked then an “invitationSection” will be included.

The “invitationSection” will always include an “inviteSeeding” section even if there isn’t any seeding.

The “loginSection” will always have a “questionnaireSeeding” section even if there isn’t any seeding.

If the configuration has “Group Questionnaire” ticked then there will be one or more subjects inside the “loginSection” section and each “subjectName” property will be a non empty string.

If the configuration does not have “Group Questionnaire” ticked then there will be exactly one subject inside the “loginSection” section and the “subjectName” property will be an empty string.

200 OK with body (invite only participant with some invite seeding):

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {
            "forenames": "A",
            "surname": "A"
        }
    },    
    "enabled": true
}

200 OK with body (log on and invite participant – group questionnaire):

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {
            "forenames": "A",
            "surname": "A"
        }
    },
    "loginSection": {
        "login": "A",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v53": "L1",
                    "v48": "2;3",
                    "v50": "A",
                    "v51": "A",
                    "v46": "4"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}

Response Definitions

HTTP Status Codes

200 OK

404 Not Found

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Participant appeared first on SnapSurveys.

Endpoint

Get the details of latest participants of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

Sample Request

curl --location --request GET 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants?startingFrom=0&maxParticipants=2' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

{
    "surveyId": "20dbe888-ec99-4895-b094-e34084f9408f",
    "startingFrom": "0",
    "progress": "#ECDEHDIHBB",
    "upToDate": false,
    "participants": [
        {
            "enabled": true,
            "invitationSection": {
                "optedOut": false,
                "sendInvitations": true,
                "emailAddress": "a@example.com"
            },
            "loginSection": {
                "login": "A",
                "password": null,
                "interviewer": null,
                "status": "NotStarted"
            }
        },
        {
            "enabled": true,
            "invitationSection": {
                "optedOut": false,
                "sendInvitations": true,
                "emailAddress": "b@example.com"
            },
            "loginSection": {
                "login": "B",
                "password": null,
                "interviewer": null,
                "status": "NotStarted"
            }
        }
    ]
}

Response Definitions

HTTP Status Codes

200 OK

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Participant List appeared first on SnapSurveys.

Endpoint

Delete the specific subject identified by the subjectName path variable from the specific participant identified by the participantUniqueId path variable of the specific survey identified by the suurveyId path variable.

Note: You cannot delete the subject of a non-group questionnaire. On a group questionnaire you cannot delete a subject if there would be no subjects remaining.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request DELETE 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A/subjects/L5' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

No response

Response Definitions

No  response definition

HTTP Status Codes

200 OK

400 Bad Request

• If trying to delete a subject from non-group questionnaire.
• If trying to delete last remaining subject from a group questionnaire.

404 Not Found

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject

The post Delete Participant Subject appeared first on SnapSurveys.

Endpoint

Update the existing specific subject identified by the subjectName path variable of the specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None.

Request body data

Requires request body of JSON object e.g.:

{
    "subjectName": "Chester Zoo2",
    "questionnaireSeeding": {
        "v46": "D",
        "v45": "David"
    },
    "status": "NotStarted"
}

Note. The subjectName property must be the same as the subjectName path variable. It is not possible to rename a subject with this call. In the case of a non-group questionnaire the subjectName path variable should be null.

In the example above we are changing two of the seeding values for the subject. The status property is ignored if included. This means that you can take the output of a get subject call, modify the seeding and pass it in the add subject call without having to remove the status property.

Sample Request

curl --location --request PUT 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A/subjects/L5' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subjectName": "L5",
    "questionnaireSeeding": {
        "v48": "2;3",
        "v50": "A",
        "v53": "L5",
        "v51": "A",
        "v46": "6"
    },
    "status": "NotStarted"
}'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

{
    "subjectName": "L5",
    "questionnaireSeeding": {
        "v48": "2;3",
        "v50": "A",
        "v53": "L5",
        "v51": "A",
        "v46": "6"
    },
    "status": "NotStarted"
}

Response Definitions

HTTP Status Codes

200 OK

404 Not Found with:

{
    "message": "Participant not found."
}

400 Bad Request with:

{
    "message": "Subject name must match subject details."
}

"message": "Survey is not a group questionnaire. Cannot add subjects."
"message": "Participant does not have this subject."
"message": "Could not update subject."
"message": " Participant invite seeding does not have a '<invite key>' seeding property."
"message": " Survey variable '<questionnaire item>' does not contain code value '<code value>'."
"message": "Participant questionnaire seeding does not have a '<questionnaire item>' seeding property."
"message": "Survey does not have a '<questionnaire item>' variable."
"message": "Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed."
"message": "Survey variable '<questionnaire item>' cannot contain duplicate code values."

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Delete Participant Subject

The post Update Participant Subject appeared first on SnapSurveys.

Endpoint

Add the new subject of the specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Request body data

Requires request body of JSON object e.g.:

{
    "subjectName": "Chester Zoo2",
    "questionnaireSeeding": {
        "v46": "D",
        "v45": "David"
    },
    "status": "NotStarted"
}

Note. For a group questionnaire the subjectName must be a non-empty string. It is not possible to add a subject to a non-group questionnaire as there is only one subject with a subjectName of empty string. In the example above we are setting two of the seeding values for the subject. The status property is ignored if included. This means that you can take the output of a get subject call, modify the seeding and pass it in the add subject call without having to remove the status property.

Sample Request

curl --location --request POST 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A/subjects' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subjectName": "L5",
    "questionnaireSeeding": {
        "v53": "L5",
        "v48": "2;3",
        "v50": "A",
        "v51": "A",
        "v46": "4"
    },
    "status": "NotStarted"
}'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

{
    "subjectName": "L5",
    "questionnaireSeeding": {
        "v48": "2;3",
        "v50": "A",
        "v53": "L5",
        "v51": "A",
        "v46": "4"
    },
    "status": "NotStarted"
}

Response Definitions

HTTP Status Codes

200 OK

404 Not Found with:

{
    "message": "Participant not found."
}

400 Bad Request with:

{
    "message": "Must provide a subject."
}

"message": "Survey is not a group questionnaire. Cannot add subjects."
"message": "Participant questionnaire seeding does not have a '<questionnaire seeding>' seeding property."
"message": "Participant already has that subject."
"message": "Could not add subject."
"message": " Participant invite seeding does not have a '<invite key>' seeding property."
"message": " Survey variable '<questionnaire item>' does not contain code value '<code value>'."
"message": "Participant questionnaire seeding does not have a '<questionnaire item>' seeding property."
"message": "Survey does not have a '<questionnaire item>' variable."
"message": "Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed."
"message": "Survey variable '<questionnaire item>' cannot contain duplicate code values."

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Add Participant Subject appeared first on SnapSurveys.

Endpoint

Get the details of the specific subject identified by the subjectName path variable of the specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request GET 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A/subjects/L1' \
--header 'X-USERNAME: {USERBNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

{
    "subjectName": "L1",
    "questionnaireSeeding": {
        "v53": "L1",
        "v48": "2;3",
        "v50": "A",
        "v51": "A",
        "v46": "4"
    },
    "status": "NotStarted"
}

Response Definitions

HTTP Status Codes

200 OK

404 Not Found

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Participant Subject appeared first on SnapSurveys.

Endpoint

Get the details of the subjects of the specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request GET 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/A/subjects' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

[
    {
        "subjectName": "L1",
        "questionnaireSeeding": {
            "v53": "L1",
            "v48": "2;3",
            "v50": "A",
            "v51": "A",
            "v46": "4"
        },
        "status": "NotStarted"
    }
]

Response Definitions

HTTP Status Codes

200 OK

404 Not Found

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Participants Subjects appeared first on SnapSurveys.

Endpoint

Delete the existing participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request DELETE 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/E' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

No response

Response Definitions

No response definition

HTTP Status Codes

200 OK

404 Not Found

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Delete Participant appeared first on SnapSurveys.

Endpoint

Update the existing specific participant identified by the participantUniqueId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Request body data

Requires request body of JSON object e.g.:

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "sborg4@titan.local",
        "inviteSeeding": {
            "surname": "D",
            "forenames": "David"
        }
    },
    "loginSection": {
        "login": "A4",
        "password": null,
        "interviewer": "",
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "Alton Towers",
                "questionnaireSeeding": {
                    "v45": "David",
                    "v46": "D"
                },
                "status": "NotStarted"
            },
            {
                "subjectName": "Chester Zoo",
                "questionnaireSeeding": {
                    "v45": "David",
                    "v46": "D"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}

Note. The above example is updating a participant in a survey where the participant feature requires that the participant be invited and that the participant has to provide credentials to view the questionnaire. Therefore, you must specify both the invitationSection section and the logonSection section in the call. The example is also for a group questionnaire and it will create two subjects for the participant. In a non-group questionnaire you must provide one subject and the subjectName property should be an empty string.

For an invite only survey do not include a loginSection section. For a logged on only survey do not include an invitationSection section.

The status properties are read-only so will be ignored if specified.

If the survey allows interviewers for SOI then you specify the interviewer in the interviewer property. The interviewer must be the email address of a user that has SOI access to the survey. If you don’t want to specify an interviewer set it to an empty string. If the survey does not allow interviewers set it to null.

Sample Request

curl --location --request PUT 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants/E' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {}
    },
    "loginSection": {
        "login": "E",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v48": "2;3",
                    "v50": "A",
                    "v53": "L1",
                    "v51": "A",
                    "v46": "6"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Note. The status field is read-only. If you send it into the request body as in the sample request above it will be ignored

Sample Response

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {}
    },
    "loginSection": {
        "login": "E",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v48": "2;3",
                    "v50": "A",
                    "v53": "L1",
                    "v51": "A",
                    "v46": "6"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}

Response Definitions

HTTP Status Codes

200 OK

404 Not Found with:

{
    "message": "Participant not found."
}

400 Bad Request – various including:

{
    "message": "Participants require a login section."
}

"message": "You must provide a login name."
"message": "Participants require an invitation section."
"message": "Participants should not have an invitation section."
"message": "Participants should not have a login section."
"message": "The unique participant id provided in the URL must be the same as in the request body."
"message": "Not allowed to add, update or delete an interviewer."
"message": "Must provide an interviewer property and value cannot be null."
"message": "Interviewer does not have access to the survey."
"message": Participants for this survey must have one subject."
"message": "Participants for this survey must only have one subject and the subject name must be an empty string."
"message": "Participants for this survey must have at least one subject."
"message": "Subject name cannot be blank for a group questionnaire."
"message": "Participant cannot be opted out and have send invitations enabled at the same time."
"message": "The unique participant id provided in the URL must be the same as in the request body."
"message": "You must provide a valid email address."
"message": "If an email address is provided, it must be valid."
"message": "Participant with this login name does not exist."
"message": "Participant with this login name already exists."
"message": "Participants for this survey must have unique subjects."
"message": "Participant to update does not exist."
"message": "Participant subjects do not match."
"message": "Participant with this email address does not exist."
"message": " Survey does not support participants."
"message": " Participants cannot be added, updated or deleted whilst an import is scheduled or running."
"message": " Participant invite seeding does not have a '<invite item>' seeding property."
"message": " Participant questionnaire seeding does not have a '<questionnaire item>}' seeding property."
"message": " Survey does not have a '<questionnaire item>' variable."
"message": " Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed."
"message": " Survey variable '<questionnaire item>' cannot contain duplicate code values."
"message": " Survey variable '<questionnaire item>' does not contain code value '<code value>'."

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Update Participant appeared first on SnapSurveys.

Endpoint

Add a new participant to the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Request body data

Requires request body of JSON object e.g.:

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {
            "forenames": "A",
            "surname": "A"
        }
    },
    "loginSection": {
        "login": "A",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v53": "L1",
                    "v48": "2;3",
                    "v50": "A",
                    "v51": "A",
                    "v46": "4"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}

Note. The above example is creating a participant in a survey where the participant feature requires that the participant be invited and that the participant has to provide credentials to view the questionnaire. Therefore, you must specify both the invitationSection section and the loginSection section in the call. The example is also for a group questionnaire and it will create two subjects for the participant. In a non-group questionnaire, you must provide one subject and the subjectName property should be an empty string.

For an invite only survey do not include a loginSection section. For a logged on only survey do not include an invitationSection section.

The status properties are read-only so will be ignored if specified.

If the survey allows interviewers for SOI then you specify the interviewer in the interviewer property. The interviewer must be the email address of a user that has SOI access to the survey. If you don’t want to specify an interviewer set it to an empty string. If the survey does not allow interviewers set it to null.

Sample Request

curl --location --request POST 'https:// <servername>/snaponline/api/surveys/20dbe888-ec99-4895-b094-e34084f9408f/participants' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {
            "forenames": "E",
            "surname": "E"
        }
    },
    "loginSection": {
        "login": "E",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v53": "L1",
                    "v48": "2;3",
                    "v50": "A",
                    "v51": "A",
                    "v46": "4"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Note. The status field is read-only. If you send it into the request body as in the sample request above it will be ignored.

Sample Response

{
    "invitationSection": {
        "optedOut": false,
        "sendInvitations": true,
        "emailAddress": "a@example.com",
        "invitationSeeding": {}
    },
    "loginSection": {
        "login": "E",
        "password": null,
        "interviewer": null,
        "status": "NotStarted",
        "subjects": [
            {
                "subjectName": "L1",
                "questionnaireSeeding": {
                    "v48": "2;3",
                    "v50": "A",
                    "v53": "L1",
                    "v51": "A",
                    "v46": "4"
                },
                "status": "NotStarted"
            }
        ]
    },
    "enabled": true
}

Response Definitions

HTTP Status Codes

201 Created

The response headers will include a Location key where the value is the URL to call to get the participant.

400 Bad Request – various including:

{
    "message": "Participants require a login section."
}

"message": "You must provide a login name."
"message": "Participants require an invitation section."
"message": "Participants should not have an invitation section."
"message": "Participants should not have a login section."
"message": "The unique participant id provided in the URL must be the same as in the request body."
"message": "Not allowed to add, update or delete an interviewer."
"message": "Must provide an interviewer property and value cannot be null."
"message": "Interviewer does not have access to the survey."
"message": Participants for this survey must have one subject."
"message": "Participants for this survey must only have one subject and the subject name must be an empty string."
"message": "Participants for this survey must have at least one subject."
"message": "Subject name cannot be blank for a group questionnaire."
"message": "Participant cannot be opted out and have send invitations enabled at the same time."
"message": "The unique participant id provided in the URL must be the same as in the request body."
"message": "You must provide a valid email address."
"message": "If an email address is provided, it must be valid."
"message": "Another participant already has this login name."
"message": "Participants for this survey must have unique subjects."
"message": "Participant to update does not exist."
"message": "Participant subjects do not match."
"message": "Another participant already has this email address."
"message": " Survey does not support participants."
"message": " Participants cannot be added, updated or deleted whilst an import is scheduled or running."
"message": " Participant invite seeding does not have a '<invite item>' seeding property."
"message": " Participant questionnaire seeding does not have a '<questionnaire item>}' seeding property."
"message": " Survey does not have a '<questionnaire item>' variable."
"message": " Survey variable '<questionnaire item>' is single choice. Multiple values are not allowed."
"message": " Survey variable '<questionnaire item>' cannot contain duplicate code values."
"message": " Survey variable '<questionnaire item>' does not contain code value '<code value>'."

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Add Participant appeared first on SnapSurveys.

If you provide a query parameter that does not exist, you will get a 400 Bad Request response and the return body will state “Invalid query string parameters” in the message property followed by the parameters that don’t exist in the parameters property. E.g.

{
    "message": "Invalid query string parameters",
    "parameters": [
       "sortorder"
    ]
}

If the parameters provided exist but are not valid you will receive a message such as:

{
    "message": "The request is invalid.",
    "modelState": {
        "includeCodes": [
            "The value 'yes' is not valid for Boolean."
        ]
    }
}

The post API Validation appeared first on SnapSurveys.

It describes the best practices for setting up users and folders where sharing is used to collaborate on working with the organization’s surveys.

In addition to this document there is an accompanying video Working with folders that will help you create, use and share folders in Snap XMP.

Setting up the accounts

We recommend that there is a hierarchical set up where there are two types of account within an organization:

• Master User Account. This is a researcher account that is used as a nominated account to create folders which are then used to share the surveys with other individual researcher accounts. This could be a role or group-based account, for example surveyadmin@organization.com, so that it can be passed onto another person in the organization or used by multiple holders at the same time. This account should only contain folders and surveys that they are shared with the organization’s user accounts.

• User Account. This is all other individual researcher accounts.

The organization should have one account that is identified as a nominated Master User Account. This can be a role or group-based account, so that if the account holder leaves the account can easily be used by another person in the organization. Each user in the organization has an individual User Account. Folders are set up in the Master User Account and individual User Accounts are given shared access with permissions to folders appropriate to them.

There are two ways of setting up sharing for collaborating on surveys:

• All users have access to all surveys
• Users are restricted to surveys that are relevant to them

All users have access to all surveys

In an organization where all users work on the same surveys, then the Master User Account holder can share the surveys created in their Your Work folder to each of the other users.

These users can then create and access surveys via their Shared with you folder. The user accounts should only create or work on surveys within this Shared with you folder. Surveys created in their own areas will not be shared and therefore it is advised against.

The shared folders can also be viewed in Snap XMP Desktop.

The diagram below shows the sharing relationship between the Master User Account and the User Accounts where all users are given access to all surveys.

Users are restricted to relevant surveys

If there is a requirement to segment work so that only some users have access to certain surveys, then the Master User Account holder can create specific folders in their Your Work folder and shares those with the relevant users. So, for example, if two departments work independently from one another, but they want to share access within their own department, then the Master User Account holder creates a folder for Department A, and shares that with all members of Department A.

The shared folders can also be viewed in Snap XMP Desktop.

Similarly, they create a folder for Department B, and they share that with members of Department B.

In this way, all units consumed by the User Accounts of the organization will be recorded against the Master User Account, and the activity logs recorded for each survey will show who (which User Account holder) has done what and when they did it.

The diagram below shows the sharing relationship between the Master User Account and the individual researcher accounts when users are restricted to surveys relevant to them.

If required, User Accounts can share their surveys or folders with any other User Accounts in the normal way and have permissions to add, delete, edit in their folders and any folders that have been shared with them. Any User Account with the ability to manage the shares will be able to add, delete, edit the shares.

Summary

The following are properties of the Master User Account.

• Nominated account for setting up all the working folders of the organization
• Working folders (and sub folders) are set up in the Your Work folder of this account
• Working folders, in the Your Work folder, are shared with full permissions to Individual Researcher accounts
• The entire Your work folder can also be shared if necessary
• Has access to the Audit log for each survey owned or shared with them

The following are properties of the User Account (with Manage shares permissions given)

• Has folders and surveys shared with them that are available from the Shared with you folder
• Can create sub folders and surveys in the folders shared with them
• Can create folders and surveys in their Your Work folder
• Can share any folder or survey including the Your Work folder
• Has access to the Audit log for each survey owned or shared with them

Guidance to follow when someone leaves the organization

When a user leaves an organization, if shares have been set up in the suggested ways described in this guide and does not have any of their own work in their account, then the User Account becomes dormant and all the surveys they have been working on will be under the control of the Master User Account holder.

If the leaving user has work in their own account, then before they leave, they should share their work with the Master User Account holder who can then reshare it to other user accounts in the organization.

In the case where a user leaves with work in their own account, that is not shared with the Master User Account, then a person with authority from the organization needs to contact the Helpdesk and request that the account is assigned to a new email address. To demonstrate that the person contacting the Helpdesk has suitable authority, they will be required to run through a number of security questions. When the support team have verified that the contact is a genuine person with authority, they will inform the person of authority that they will initiate a password reset to generate a link, which they will be sent, so they can reset the password and log into the account. The person of authority can then decide how they wish to share the folders and surveys of this old account.

When they share the folders and surveys the Manage shares option should be set to Yes. The researcher that has been shared the folders and surveys of the old account now has full access to these resources. They can clone a survey (through Desktop mode) if they want to have a copy of the survey in their Your work folder (or sub folder), bearing in mind that the URL will be different. If the original survey is deleted, they can then reuse the original URL on the cloned survey. Once all the folders and surveys of the old researcher account have been shared there is no requirement to log into this account again, however, it will remain active until such times as the organization requires it to be deleted.

Snap XMP Online user account leaving process

1. If a user leaving the organization has been working in the suggested ways described in this guide and does not have any of their own work in their account, then the Master User Account holder shares the leaver’s work to other User Accounts as appropriate.
2. If the user leaving has work in their own account, they should share their work with the Master User Account holder so it can be shared to other users.
3. If the user has left the organization and did not share their work with the Master User Account holder, then a person of authority will need to contact Support to request a change of password in order to access the account. This requires verification that the contact is a genuine person with authority.
4. Admins of Snap XMP Online initiate the Password reset process to generate a link
5. The reset password link is sent to the person of authority in the organization so they can reset the password and access the account.
6. Admins set up the new researcher account if required.
7. The person of authority who reset the password determines how the account should be transferred and how to share the folders and surveys with the other researchers, ensuring Manage shares is set to Yes.
8. On request from a person of authority in the organization, the old researcher account is deleted. Alternatively, this is done by a Snap XMP Online admin if the organization closes their account in full.

The post Sharing between users and teams of an organization appeared first on SnapSurveys.

To find more information on viewing the standard reports online, see Viewing the reports.

Viewing the Summary Dashboard report

The standard reports are in the Reports side menu in the Analyze section.

1. Click on Summary Dashboard in the Reports menu to generate the analysis from your survey responses. You can run reports on your survey data while interviewing is taking place as well as after interviewing has closed.

2. The default web browser for your device displays the report.

3. You can click the button to maximise the report to view it in full screen. Click it again to go back to the standard view.
4. Hovering over the icon displays the filter or context information that has been applied to the current report.

Updating your report with the latest survey data

Usually you will want to work with the latest survey results as your survey runs.

1. In the Analyze tab, select the Summary Dashboard report.
2. Click on the Update button to update the report with the latest survey data

3. You can see the the generated time for the response data.
4. The Update button refreshes the data when new responses are available, when the filter or context applied changes, or when the time elapsed since the report is over an hour ago.

Downloading the report and images

You can download a report as an HTML file and then import into other applications to further analyze the survey responses.

1. In the Analyze tab, select the Summary Dashboard report.
2. Click on the Download button to download the HTML report and the image files for each analysis in a ZIP file.

3. The download is in the Downloads folder (or other location determined by your device and browser settings) as a ZIP file.

Printing your report

You can print any of your reports using the following instructions.

1. In the Analyze tab, select the Summary Dashboard report.
2. Right-click on the report to show the pop-up menu. Click on Print.
3. Enter the print information required and click Print to print the report.

The post Viewing the Summary Dashboard report appeared first on SnapSurveys.

• External filters and contexts. These are defined from the Analyses or Reports windows in Snap XMP Desktop. Once defined, you can apply the filter or context to reports and analyses in both Snap XMP Desktop and Snap XMP Online. They form part of the survey which means you can use them every time the survey is open.
• Custom filters and contexts. These are set up in Snap XMP Online using a filter expression. You can use the variables section to check the variables and questions used in the questionnaire to help create the expression. These are temporary filters and contexts that are available while the survey is open but are removed when the survey is closed.

Using an external filter or context

Any analyses or reports that include external filters or contexts can use these to view a subset of the response data. To apply a filter to an analysis, use the following instructions:

1. In Snap XMP Online, select the survey from Your work.
2. In the Summary tab, click the Analyze link. The reports and analyses are available here.

3. Select the report or analysis from the Reports or Tables and Charts menus.
4. To apply a filter to the selected report or analysis, select Filter & context in the side menu.
5. Click Add variable    to add a filter rule.
6. In the Select a variable list, select a variable to use as the filter then click Next.
7. Select the answers to use in the filter and click OK.

8. Click Apply changes to update the analysis of your response data for the selected filter.

Further information on the full process of setting up and using external filters is available at Setting up filters for Snap Online analysis.

Set a custom filter or context

As well as using externally defined filters and contexts, you can create a custom filter or context. These are temporary and only available while you are using the survey in Snap XMP Online.

1. In Snap XMP Online, select the survey from Your work.
2. In the Summary tab, click the Analyze link to see the list of reports and analyses.
3. Select the report or analysis from the Reports or Tables and Charts menus.
4. To apply a filter to the selected report or analysis, select Filter & context in the side menu.
5. Click Set custom  to add a custom filter or context rule.
6. Enter the filter expression and click OK.

7. Click Apply changes to update the analysis of your response data for the selected filter.

Viewing variable details

Click on the Variables menu to view the variables available in the survey. This helps to identify the variable details of the questions, derived variables and paradata, which you can use to build the custom filter expression.

The post Applying filters and contexts appeared first on SnapSurveys.

1. In Snap XMP Online, open the survey and go to the Analyze section.
2. Click on the Tables & charts menu on the left to show the list of available analyses. These can be tables, charts, lists, word clouds and maps.

3. Click on an analysis name to generate the analysis from the data responses. You can run analyses on the responses while interviewing is taking place as well as after interviewing has closed.

Downloading the analysis to a PDF file

You can download an analysis to a PDF file that can be imported into other applications to further analyze the survey responses.

1. In the Analyze tab, click the Tables & charts menu on the left to show the list of available analyses.
2. Click on an analysis name to generate the analysis from the data responses.
3. Click on the Download button to generate a PDF file.
4. The download is found in the Downloads folder or another location as determined by your device or your web browser settings.

The post Viewing the analyses appeared first on SnapSurveys.

Snap XMP Online provides four standard reports with each survey. (Surveys created prior to Snap XMP Desktop build 12.10 contain three standard reports)

• Questionnaire report generates a top-line summary report showing the counts or percentages of responses in the questionnaire layout
• Summary report generates a chart, table or list for every question
• Summary Tables report tabulates responses to all questions
• Summary Dashboard report generates an HTML summary report with images of each chart, table or list for each question and displayed in a double column format. (This report is available for surveys created using Snap XMP Desktop build 12.10 and after.)

Bespoke reports

In addition to the standard reports the survey may have additional bespoke reports that have been created in Snap XMP Desktop.

In the Report Details window, you can use the Available field and set the conditions when the report is available in Snap XMP Online. By default, the Available field is blank and the report is available in Snap XMP Online.

You can enter a condition in the Available field to determine when the report is available. You can enter ‘No’ to make the report unavailable in Snap XMP Online. Note: If all reports, including standard reports are unavailable then the Reports menu will not be available.

Viewing the PDF reports

The majority of reports are PDFs in the Adobe Acrobat document application. This includes the Questionnaire, Summary and Summary Tables standard reports.

You can view the reports in the Reports side menu in the Analyze section.

1. Click on a report name in the Reports menu to generate the analysis from your survey responses. You can run reports on your survey data while interviewing is taking place as well as after interviewing has closed.

2. The report displays in the Adobe Acrobat document application.

3. The features available through this add-on are
   • Rotate clockwise
   • Download
   • Print via print preview options
   • Fit to page or width
   • Zoom in and Zoom out
4. You can click the button to maximise the report to view it in full screen. Click it again to go back to the standard view.
5. Hovering over the icon displays the filter or context information applied to the current report.

Updating your report with the latest survey data

Usually you will want to work with the latest survey results as your survey runs.

1. Navigate to the Analyze tab.
2. Select the report required.
3. Click on the Update button to update the report with the latest survey data

4. You can see how long ago the report data was generated.
5. When you receive new responses, click the Update button to refresh the data. You can also update the data when the applied filter or context applied changes, or when the data is over an hour old.

Downloading your analysis report to a PDF file

The report downloads as a PDF file which you can be import into other applications to further analyze the survey responses.

1. Navigate to the Analyze tab.
2. Select the report required.
3. Click on the Download button to generate a PDF file.

3. The download is in the Downloads folder or another location as determined by you or your web browser.
4. You can also use the Adobe Acrobat download feature.

Printing the PDF report

You can print any of your reports using the following instructions.

1. Navigate to the Analyze tab.
2. Select the report required in the Reports menu.
3. Click on the Print icon in the toolbar at the top of the report. The icon may vary depending on your browser.

4. Enter the print information required and click Print to print the report.

Viewing the HTML reports

The Summary Dashboard report displays as an HTML report in a web browser viewer.

The reports are in the Reports side menu in the Analyze section.

1. Click on Summary Dashboard in the Reports menu to generate the analysis from your survey responses. You can run reports on your survey data while interviewing is taking place as well as after interviewing has closed.

2. The report displays in the default web browser for the device being used.

3. You can click the button to maximise the report to view it in full screen. Click it again to go back to the standard view.
4. Hovering over the icon displays the filter or context information that has been applied to the current report.

Updating your report with the latest survey data

Usually you will want to work with the latest survey results as your survey runs.

1. In the Analyze tab, select the Summary Dashboard report.
2. Click on the Update button to update the report with the latest survey data

3. You can see how long ago the report data was generated.
4. When you receive new responses, click the Update button to refresh the data. You can also update the data when the applied filter or context applied changes, or when the data is over an hour old.

Downloading the HTML report and images

The report downloads as an HTML file that you can be import into other applications to further analyze the survey responses.

1. In the Analyze tab, select the Summary Dashboard report.
2. Click on the Download button to download the HTML report and the image files for each analysis in a ZIP file.

3. The download is found in the Downloads folder (or other location determined by your device and browser settings) as a ZIP file.

Printing the HTML report

You can print any of your reports using the following instructions.

1. In the Analyze tab, select the Summary Dashboard report.
2. Right-click on the report to show the pop-up menu. Click on Print.
3. Enter the print information required and click Print to print the report.

The post Viewing the reports appeared first on SnapSurveys.

In this section, you can

• export all the response data or a filtered subset of the response data
• delete all response data
• manage partial responses
• use Find and erase to erase specific response data as part of the GDPR data regulations

You can find the Responses menu by following these instructions:

1. In Snap XMP Online, click on the survey in Your Work to select it.
2. In the Summary tab, click the Collect link.
3. Select the Responses menu.

Delete all response data

1. When you select the Responses menu, the default page shows Responses in the list of options. In this page you have the option to delete all response data.

2. Click Delete all data. A warning message displays asking you to confirm that you want to delete all the survey response data.
3. Click OK to confirm that you want to delete all the response data. This action is permanent, and you cannot retrieve the response data later.

View and submit partial responses

You can include partial responses in your survey’s response data by submitting all partial responses. This option will only be available if you have the correct permissions to view and submit the partial responses.

You will need to consider at what stage of the interview process to submit the partials. If you wait until interviewing closes to submit all the partial responses, this gives the opportunity for a respondent to return to complete the survey.

1. In the Responses menu, click the Partials option and this will display all the partial responses that are available.

2. The Partial responses overview shows any partial responses. You can use the navigation icons to move through the responses and view the data. You will need the correct permissions to view the partial responses.

3. When you are ready to submit the partial responses, click the Submit Partials button. You will need the correct permissions to submit the partial responses.

4. You will see a message telling you that the partial are being submitted.

5. When you navigate to the Participants List in the Participants  menu, any participants with a status of Partial or Saved are now shown as Submitted.

6. The partial responses are cleared from the Partial responses list.

You can find further information on running a survey with partial responses at Managing partial responses.

Find and erase responses

You can also permanently remove individual data responses stored for a participant in Snap XMP Online. This can be used when a respondent requests that their response data is removed from the survey as part of the GDPR data regulations.

1. In the Responses menu, click the Find and erase option.
2. In the adjacent box type the filter condition that identifies the respondent.
3. Click on the Find matching responses button.

4. The filtered data to be removed will appear in a list below. Click on the Erase button to permanently remove the data.

The post Managing response data appeared first on SnapSurveys.

The variables can be viewed in the Collect section in Snap XMP Online with the following instructions:

1. In Your work, select the survey that you are sharing.
2. Click the Collect tab. This shows the Overview section
3. Click Variables on the side menu. This shows a list of the variables for the survey. The list includes the system paradata variables.

4. The variable details contain the name, label, type, response type and codes as described in the following table

5. In the Codes column, click on the numbered link to show a list of the available codes for that variable.

The post Viewing the questionnaire variables appeared first on SnapSurveys.

This worksheet describes how to insert an image into an HTML email invitation and then link it to a website. It assumes that you have already set up the survey and it is available in Snap XMP Online. If the image is already on the internet, you can insert a link to the image.

Step 1: Create an email invitation

The invitations are the templates used to create the emails inviting participants to complete the questionnaire. They can be viewed and edited in the Invitations section of the Participants menu. Invitations can only be created once the participant details have been uploaded.

1. In Snap XMP Online, open the questionnaire and navigate to the Collect section.
2. Select the Participants side menu. The Overview is selected by default.
3. Click on the Invitations menu item to view the invitations.

4. The Invitations are displayed in the overview area.
5. Click the Add Invitation button. This displays the Add invitation dialog where you can create your invitation or reminder. The image can be added to the email from this dialog.

Step 2: Inserting the image in the email

You can insert any image that is already on the Internet via its URL.

1. Create or find the graphic that you want to use in your email. Check that it is a suitable size and resolution for an email. The supported image formats are png, gif or jpg format.
2. When editing the email message in Snap XMP Online click in the email at the place where the graphic will go and then click the insert image button   on the toolbar. This opens the Insert image dialog.

3. Enter the URL of the image in the Web address box.
4. Enter the text that describes the image in the Alternate text field. This will be displayed if the image is not downloaded in the email.
5. Leave the Width and Height boxes blank.
6. Click Insert to insert your image.
7. Leave the Add invitation dialog open to insert the link.

Step 3: Adding a link to your image

You can create a link so that your participant can click on the image and easily go to a given website.

1. In the Add invitation dialog select the image that you wish to add the link to.
2. Click the link button  . This opens the Insert hyperlink dialog.

3. Enter the URL that you wish to link to as the address.
4. In Text, enter the text you would like to describe the hyperlink.
5. Enter the ToolTip text that will appear when the respondent hovers over the image.
6. Click Insert to create the hyperlink.
7. Click Save in the Add invitation dialog to save the email invitation. The new invitation is shown in the list of invitations.

Step 4: Test the email

Before you send the email invitations to your participants you can check the format of the invitations by using the test functionality.

1. Click the Test button.

2. This displays the Test invitation dialog. You will need to enter an email address that you have access to so that you can view the email and check that the format and seeding are correct.

3. Click Send test email. This will send a test email invitation to the test email address.
4. When the email arrives check that the format is as you expected. The email will substitute one of the participants in your list to test the invitation seeding is correct.

Further Information

• Uploading participants from a spreadsheet.
• Creating invitations using the email editor.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Adding a linked image to an email invitation appeared first on SnapSurveys.

This tutorial shows how to seed the username of a participant into a logged in/tracked survey, so you can send the URL to a participant outside of the mailing system built into Snap XMP Online.

Tracking participants using a URL

What you need

You will need a spreadsheet or database that contains the participant information. For participants to log in to your survey you need to upload a unique username for each participant. This can be their email address. You can also add additional fields, which are optional, that seed into the survey to personalise it.

Here is an example of an Excel spreadsheet with participant data.

This data file contains

• unique username used for participant logins
• two columns that contain seed data, Q1 First name and Q2 Training course. These are used to personalise the survey.

Uploading the participants

1. Once you have created your survey and it is on Snap XMP Online you can upload the database of participants. Open Snap XMP Online on your browser, click on the related survey and from the survey’s Summary click on the Collect link.

2. Select the Participants side menu to view the participants and invitations. The Overview is selected by default.
3. Click on the Participant list menu item to view the participants.

4. Click on Upload Participants to open the Upload Participants Wizard.
5. The wizard guides you through the process of uploading the participants to your survey. You can find further information about using the wizard at Uploading participants from a spreadsheet.

Creating the URL to send to the participants

1. Once you have uploaded your participant list then you need to export the list to a CSV file. This generates a unique identifier for each participant, also referred to as a GUID. Now you have uploaded the participants there is now the option to Export. Click on Export and then select Export to CSV.

2. When you open the CSV file you will see it has generated the Participant ID number, this is the number you need to use at the end of your survey link relating to each participant.

3. The link is made up of the Interview URL for the published survey following by “?PID=” then the Participant ID. This example uses the Participant ID for lesley and the link for this participant will look something like below:

https://online1.snapsurveys.com/s/9raksp?PID=8e4576f8-9e5c-43f2-b8ac-0c7eb1dd045e

Reserved keywords

There are two reserved keywords in Snap XMP, which means they cannot be used as variable names:

• pID (used for participant ID)
• rID (used for response ID)

The reserved keywords are not case sensitive. If someone were to create a survey and have these as named variables then manual seeding of the url will not work because Snap XMP Online is already using them.

The post Seeding the login details via the URL for a tracked survey appeared first on SnapSurveys.

When you share the survey with an analyst or researcher in Snap XMP Online, you can also set the context for that user. The report or analysis available to the shared user is tailored according to the context.

The survey needs to include a single-response variable that can be used as the context. For example, this could be a location or a job function.

The reports or analyses are created using information that changes according to the context, that is filtered according to the context or both. In Snap XMP Online, you can share the survey with another user with any context or filter values set on the survey.

Step 1: Create context-sensitive reports and analyses in your survey

You need to put context-sensitive information in your reports and analyses. If you want to set up the report in your own version of Crocodile Rock Cafe survey, the instructions are given below.

This section describes briefly how to change the Crocodile Rock Cafe survey provided with Snap XMP to create the context sensitive report. It consists of the following stages

• 1: Set up a derived variable to compare all data to the current context data
• 2: Create a bar chart comparing the amount spent in the specified location with the amount spent elsewhere using the comparison variable
• 3: Create a comments list filtered on context
• 4: Create your report including the comparison bar chart and filtered comment list

Set up a derived variable to compare all data to the current context data

1. Click    to open the Variables window.
2. Open Q0 and change its Name to Location to make it more obvious what it is. This is the context variable.
3. Click   on the Variables window toolbar to add a new variable.
4. Specify the Variable details:
   • Name: CComparison
   • Label: Compare context to all
   • Type: Derived (the variable will derive its data from Location, the existing location question).
   • Response: Multiple
5. Double click in the first code label and click the Insert button. Select Variable Field from the menu.

6. Select Location as the Variable, and Context as the Aspect. This will give the selected location as the code label. Click OK to return to the variable definition.

7. Press Tab to move to the Values column. Enter Location=Location@context. The code used will be the code that equals the location specified by the context.
8. Press Tab to move to the next Label field and enter Other sites. Then enter NOT(Location=Location@context) as the Value. This code will be used when the response does not equal the location specified by context.
9. Press [Tab] to move to the next Label field and enter All sites. Then enter True as the Value.

10. Click  to save the variable.

Create a bar chart comparing one restaurant to the others using the comparison variable

1. Click Analysis Chart   to display the Analysis Definition dialog for a chart.
2. Select the chart style Bar Counts from the drop-down list.
3. Type CComparison (your derived variable) into the Analysis field.
4. Check the Transpose box.
5. Select Means & Significances from the Calculate list and enter Q5 (the amount spent) as the variable to use.

6. Select the Notes/Titles tab and click in the Title field.

7. Enter the title of your chart, using the Insert button to open the Variable field dialog and insert the Name aspect of Q5. Click OK and repeat to insert the Context aspect of Location in the title.

8. Clear the Chart Axis titles.
9. Select the Base/Labels tab.
10. Clear the Reports Include options for Description and Notes if set.
11. Click Apply to update the chart while keeping the analysis definition displayed.

12. There will be no data for the title and subject as no context has been set.
13. Click Save  to save your chart.

Add a comments list filtered on context

1. Click  to create a list. The picture below shows a list consisting of the variable (Q9) with comments plus the displayed location.
   Apply a filter of Q9 ok and Location=Location@context to filter the comments according to the current location. Q9 ok tests that an answer has been supplied to Q9 to strip out empty comments. Location=Location@context filters the comments according to the selected location.

2. Select the Base/Labels tab and clear the Reports Include options for Description and Notes if set.
3. Click OK to create the new list. It will have no content as no context has been set.
4. Click Save  to save your list.

Create your report including the comparison bar chart and filtered comment list

1. Click   on the Snap XMP Desktop toolbar to open the reports window.
2. Click   to create a new report and give it a label describing it.
3. Click   on the report dialog and select Information to add a piece of text to your report.
4. Enter the title for your report in the text pane. Leave the Title field blank.
5. Click OK to add the Information instruction to the report.
6. Click   on the report dialog and select Execute.
7. Click  on the Execute dialog and select the comparison chart (AN14) from the list.
8. Click OK to add the Execute instruction to the report.
9. Click  on the report dialog and select Information to add text after the comparison chart.
10. Enter some text describing the comments list. Use Insert to insert the Context Aspect of the Location variable to insert the label of the current location.
11. Type AN18 empty in the N/A field. This tests if there is currently any data in the comments list (analysis AN18). If there is no data, the report will not include the instruction.
12. Click OK to add the Information instruction to the report.
13. Click  and select Execute from the drop-down menu.
14. Select the comments list (AN18) from the list of analyses.
15. Click OK to add the Execute instruction to the report.

16. Click Save   to save your report.

Step 2: Sharing the survey with a context

Other Snap XMP Online users are given permission to share a survey through the Shares tab in Snap XMP Online.

1. Log in to Snap XMP Online to show Your work. If you are already using Snap XMP Online, click Home to return to Your work, where the Summary tab displays by default.
2. Select the survey to share, then select the Shares tab, which lists the users who have shared access to the survey.

4. Click the Add user button to enter the details of the user you want to share the survey with. The user must have a Snap XMP Online account.

5. In the Add user dialog enter the user’s email address that they use to access their Snap XMP Online account.
6. Next set the Permissions for the user. Further information on the permissions is available at Sharing overview.
7. Type the required context in the Context field (Location=1 in this example). Note that the context will not be checked here. It is only checked when it is used, and it is only used when the client logs in and looks at the analyses or reports.
8. Set Enabled to Yes for the user to have access to the shared survey or survey template.
9. Set Manage shares to No if you do not want the user to share the survey with other account holders or set to Yes if you want the user to be able to share the survey with other Snap XMP Online account users.
10. When you have entered the user details, click Save to add the user. The user has access to the shared item. The Shares list includes the new user.
11. Select the Show contexts/filters to view the context and filter columns.

12. The shared icon shows that the survey or survey template is shared.

Step 3: Testing the context

1. Log into Snap XMP Online using the shared user’s login details.
2. Select the survey with the filter value you have just set up.
3. In the Summary tab, click the Analyze link
4. Click Reports or Tables & charts in the side menu then select a report or analysis.

5. Confirm that the results show the context as you would expect. If you have made an error when applying the context, you will now see a message. Look at any other results to confirm that the context applies to all of them.
6. Click Log out.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Tailored reports and analyses in shared surveys appeared first on SnapSurveys.

If you use shared accounts on Snap XMP Online, you can set up a filter for each survey which will be applied to the shared user’s view of all the analyses in that survey.

The survey must include a question that identifies the appropriate data for the filter. For example, this can be a question that provides a department, college, business, or location. You can then set up filters on the shared account which will provide access to view only the relevant data.

Step 1: Finding the variable details

The list of the survey’s variable details is available in both Snap XMP Online and Snap XMP Desktop. You will need the variable details to create the filter expression.

In Snap XMP Online

1. Log into Snap XMP Online.
2. In Your work, select the survey that you are sharing.
3. Click the Collect tab. This shows the Overview section
4. Click Variables on the side menu. This shows a list of the variables for the survey. The list includes the system paradata variables.

5. In the Codes column, click on the numbered link to show a list of the available codes for that variable.

In Snap XMP Desktop

1. On the Snap XMP Desktop toolbar, click Variables to open the Variables window.
2. Click   on the Variable window toolbar to display the Print Variable Details dialog.

3. Select All to print the definitions of all the variables in your survey. Select Specify selection to filter on selected variables then enter the names of the variables, separated by commas, in the list, e.g. Q2, Q3.
4. In Style, select Details (single column) or Details (double column) to print the details of the variable. The report layout can be a single column or double column format, depending on the selection.
5. Click Setup followed by Printer Setup. Select the printer or to print to a file. Click OK twice to return to the Print Variable Details dialog.
6. Click Print. This generates a report showing the codes for the selected variables. This is available as a reference when defining your filter.

Step 2: Sharing the survey and adding a filter

Other Snap XMP Online users are given permission to share a survey through the Shares tab in of Snap XMP Online.

1. Log in to Snap XMP Online and the first page shown is Your work. If you are already logged into Snap XMP Online, click Home to return to Your work. The Summary tab shows by default.
2. Select the survey that you want to share.
3. Select the Shares tab. This lists the users who you have shared the survey with.

4. Click the Add user button to enter the details of the user you want to share the survey with. The user must have a Snap XMP Online account.

5. In the Add user dialog enter the user’s email address that they use to access their Snap XMP Online account.
6. Next set the Permissions for the user. Further information on the permissions is available at Sharing overview.
7. Type the required filter in the Filter field (Q2=2 in this example). Note, that the filter is not checked at this point. It is only checked when it is used, and it is only used when the client logs in and looks at analyses.
8. Set Enabled to Yes for the user to have access to the shared survey or survey template.
9. Set Manage shares to No if you do not want the user to share the survey with other account holders or set to Yes if you want the user to be able to share the survey with other Snap XMP Online account users.
10. When you have entered the user details, click Save to add the user. The user has access to the shared item. The Shares list displays the new user.

11. The survey or survey template now shows with the shared icon 

Step 3: Testing the filter

1. Log into Snap XMP Online using the shared user’s login details.
2. Select the survey with the filter value you have just set up.
3. In the Summary tab, click the Analyze link
4. Click Reports or Tables & charts in the side menu then select a report or analysis.

5. Confirm that the filtered results are as you expect. If you have made an error when applying the filter, you will now see a message. Look at any other results to confirm that the filter applies to all of them.
6. Click Log out.

If there is a topic you would like a worksheet on, email to snapideas@snapsurveys.com

The post Filtering the analyses for shared users appeared first on SnapSurveys.

Please note that from Monday 5th December 2022 usage of the API becomes chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is delivered by the API multiple times. The survey responses are delivered using the Get Survey Responses endpoint.

List of API endpoints in v2.0

The post API Reference appeared first on SnapSurveys.

Endpoint

Get information for the authenticated user.

Parameters

Path parameters

None

Query string parameters

None



Sample Request

curl --location --request GET 'http://<servername>/snaponline/api/account' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}'\
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

{
 "username": "jbloggs@snapsurveys.com", 
 "fullname": "Joe Bloggs",
 "emailAddress": "jbloggs@snapsurveys.com"
}

Response Definitions

HTTP Status Codes

• 200 OK

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get User Info appeared first on SnapSurveys.

You can

• use our recommended approach, which is to use the startingFrom token so you only get the responses that have been submitted or modified since your last call.
• get all the responses each call and will be charged for each response for every call.

Please note that from Monday 5th December 2022 usage of the API becomes chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the same survey response is delivered by the API multiple times. The survey responses are delivered using the Get Survey Responses endpoint.

Changes from v1.0

• A ‘filter’ property has been added.
• The ‘variableId’ property has been renamed ‘id’.
• The ‘value’ property has been renamed ‘v’.
• The ‘status’ property has been renamed ‘s’.
• Additional validation: invalid filter or startingFrom parameter now leads to a 400 response code rather than 500.

Endpoint

Get the responses of the specific survey identified with the surveyId path variable

Parameters

Path parameters

Query string parameters

Note: There are two ways to identify the V number required in the restrictedVariables parameter:

1. Postman: Make the Get Survey Variables call and examine the result.

2. Snap Desktop: Tick the UniqueIDs checkbox in the Variable Tailoring dialog. A new Id column will then be visible in the Variables screen.

Sample Request

curl --location --request GET 'https://<servername>/snaponline/api/surveys/c23a0fd8-6219-4130-a6a7-f312829e56eb/responses?maxResponses=100&restrictedVariables= 
V16,V45~V47&returnCaseIds=true&useCodeLabels=true&startingFrom=0' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

{
    "surveyId": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c",
    "filter": "Q1>1",
    "startingFrom": "0",
    "progress": "#IBCGEGG",
    "upToDate": "false",
    "responses": [
        {
            "status": "new",
            "caseId": "8e4591b0-c1e3-4612-88b4-7b96cd28dd2d",
            "variables": [
                {
                    "id": "V46",
                    "v": "Plane"
                },
                {
                    "id": "V48",
                    "v": "\"Restaurant / Cafe\",\"Gift Shop\",\"Customer Services\""
                },
                {
                    "id": "V52",
                    "s": "NR"
                }
            ]
        },
        {
            "status": "new",
            "caseId": "5458bfcb-97df-4326-879d-4868406761ae",
            "variables": [
                {
                    "id": "V46",
                    "v": "Bike"
                },
                {
                    "id": "V48",
                    "v": "\"Gift Shop\""
                },
                {
                    "id": "V52",
                    "v": "Very busy."
                }
            ]
        }
    ]
}

Follow on Sample Request using the progress response item

In the sample response above, ‘progress’ represents where you have got to in the data file. This token is then used as the startingFrom value in the next /Responses request, to retrieve responses that have been submitted or modified since your last call.

“progress”: “#IBCGEGG”,

Use this token as the startingFrom parameter in order to retrieve responses that have been submitted or modified since your last call.

Sample Request example using the progress token

curl --location --request GET 'https://<servername>/snaponline/api/surveys/c23a0fd8-6219-4130-a6a7-f312829e56eb/responses?maxResponses=100&restrictedVariables= 
V16,V45~V47&returnCaseIds=true&useCodeLabels=true&startingFrom=#IBCGEGG' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0' \
--data-raw ''

Response Definitions

HTTP Status Codes

• 200 OK
• 400 Bad Request
  • If maxResponses parameter is not between 1 and 5000.
  • If restrictedVariables parameter is invalid or a variable does not exist.
  • If startingFrom parameter is invalid.
  • If the filter parameter is invalid.
• 500
  • If something else went wrong while trying to extract the responses from the survey

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Survey Responses appeared first on SnapSurveys.

Changes from v1.0

• The response now shows the ‘surveyId’ property at the top and has the variable inside a ‘variable’ property.
• The ‘id’ property has been removed from the response.

Endpoint

Get the details of the specific variable identified by the variableId path variable of the specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request GET 'http://localhost/snaponline/api/surveys/e819df57-0a01-4592-a7aa-8918dbe54e00/variables/V46' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

{
    "surveyId": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c",
    "variable": {
        "order": 15,
        "variableId": "V48",
        "label": "Which facilities did you visit?",
        "name": "Q2",
        "questionText": "Which facilities did you visit?",
        "variableTypeId": 6,
        "responseTypeId": 2,
        "variableType": "Question",
        "responseType": "Multiple",
        "codeCount": 3,
        "codes": [
            {
                "codeIndex": 1,
                "codeValue": 1,
                "codeLabel": "Restaurant / Cafe"
            },
            {
                "codeIndex": 2,
                "codeValue": 2,
                "codeLabel": "Gift Shop"
            },
            {
                "codeIndex": 3,
                "codeValue": 3,
                "codeLabel": "Customer Services"
            }
        ]
    }
}

Response Definitions

HTTP Status Codes

• 200 OK
• 404 Not Found – if survey variable does not exist.

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variables
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Survey Variable appeared first on SnapSurveys.

Changes from v1.0

• A new ‘includeCodes’ query parameter has been added. If the ‘includeCodes’ query parameter is omitted, or if it is set to true, then the response body will include a list of codes for the variable. Each code will contain a ‘codeIndex’, ‘codeValue’ and ‘codeLabel’ property.
• The response now shows the ‘surveyId’ property at the top and has the variables inside a ‘variable’ property.
• The ‘id’ property has been removed from the response.

Endpoint

Gets the details for a specific survey ID.

Parameters

Path parameters

Query string parameters

Sample Request

curl --location --request GET 'http://<servername>/snaponline/api/surveys/e819df57-0a01-4592-a7aa-8918dbe54e00/variables' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body (when ‘includeCodes’ is false):

{
    "surveyId": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c",
    "variables": [        
        {
            "order": 14,
            "variableId": "V46",
            "label": "What was the main form of transport used to get to the at...",
            "name": "Q1",
            "questionText": "What was the main form of transport used to get to the attraction?",
            "variableTypeId": 6,
            "responseTypeId": 1,
            "variableType": "Question",
            "responseType": "Single",
            "codeCount": 7
        },
        {
            "order": 15,
            "variableId": "V48",
            "label": "Which facilities did you visit?",
            "name": "Q2",
            "questionText": "Which facilities did you visit?",
            "variableTypeId": 6,
            "responseTypeId": 2,
            "variableType": "Question",
            "responseType": "Multiple",
            "codeCount": 3
        },
        {
            "order": 16,
            "variableId": "V52",
            "label": "Please tell us if there were any issues, otherwise leave ...",
            "name": "Q3",
            "questionText": "Please tell us if there were any issues, otherwise leave blank.",
            "variableTypeId": 6,
            "responseTypeId": 4,
            "variableType": "Question",
            "responseType": "Literal",
            "codeCount": 0
        }
    ]
}

200 OK with body (when ‘includeCodes’ is true):

{
    "surveyId": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c",
    "variables": [        
        {
            "order": 14,
            "variableId": "V46",
            "label": "What was the main form of transport used to get to the at...",
            "name": "Q1",
            "questionText": "What was the main form of transport used to get to the attraction?",
            "variableTypeId": 6,
            "responseTypeId": 1,
            "variableType": "Question",
            "responseType": "Single",
            "codeCount": 7,
            "codes": [
                {
                    "codeIndex": 1,
                    "codeValue": 3,
                    "codeLabel": "Walk"
                },
                {
                    "codeIndex": 2,
                    "codeValue": 5,
                    "codeLabel": "Bike"
                },
                {
                    "codeIndex": 3,
                    "codeValue": 8,
                    "codeLabel": "Motorbike"
                },
                {
                    "codeIndex": 4,
                    "codeValue": 4,
                    "codeLabel": "Car"
                },
                {
                    "codeIndex": 5,
                    "codeValue": 6,
                    "codeLabel": "Bus"
                },
                {
                    "codeIndex": 6,
                    "codeValue": 9,
                    "codeLabel": "Train"
                },
                {
                    "codeIndex": 7,
                    "codeValue": 10,
                    "codeLabel": "Plane"
                }
            ]
        },
        {
            "order": 15,
            "variableId": "V48",
            "label": "Which facilities did you visit?",
            "name": "Q2",
            "questionText": "Which facilities did you visit?",
            "variableTypeId": 6,
            "responseTypeId": 2,
            "variableType": "Question",
            "responseType": "Multiple",
            "codeCount": 3,
            "codes": [
                {
                    "codeIndex": 1,
                    "codeValue": 1,
                    "codeLabel": "Restaurant / Cafe"
                },
                {
                    "codeIndex": 2,
                    "codeValue": 2,
                    "codeLabel": "Gift Shop"
                },
                {
                    "codeIndex": 3,
                    "codeValue": 3,
                    "codeLabel": "Customer Services"
                }
            ]
        },
        {
            "order": 16,
            "variableId": "V52",
            "label": "Please tell us if there were any issues, otherwise leave ...",
            "name": "Q3",
            "questionText": "Please tell us if there were any issues, otherwise leave blank.",
            "variableTypeId": 6,
            "responseTypeId": 4,
            "variableType": "Question",
            "responseType": "Literal",
            "codeCount": 0,
            "codes": []
        }
    ]
}

Response Definitions

HTTP Status Codes

• 200 OK

Other API calls

• Get Survey List
• Get Survey
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Survey Variables appeared first on SnapSurveys.

Changes from v1.0

• The ‘displayName’ property is now called ‘name’.
• The ‘questionnaireTitle’ property is now called ‘title’.
• An ‘ownerId’ property has been added. This gives the owner’s id (GUID)
• An ‘ownerName’ property has been added. This is the owner’s user name.
• A ‘path’ property has been added. This is the path up to the survey as an array. E.g. A survey called ‘Survey001’ in folder ‘New Surveys’ in the user’s account will show as “Your work”, New Surveys” and the name will be ‘Survey001’.
• The interviewingState property has a different set of possible values. In v1 they were: “NotStarted”, “Live”, “Paused” and “Stopped”. In v2 they are: “NotStarted”, “Started”, “Paused”, “Stopped”, “TooManyRespondents” and “Unknown”.

Endpoint

Gets the details of a specific survey identified by the surveyId path variable.

Parameters

Path parameters

Query string parameters

None

Sample Request

curl --location --request GET 'http://<servername>/snaponline/api/surveys/e819df57-0a01-4592-a7aa-8918dbe54e00' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

{
        "id": "6834a5f1-46e5-4b12-9e0c-a38a3d9be12c", 
        "ownerId": "644f58a7-8526-4901-af7d-20969e5c68e4", 
        "ownerName": "sb4@titan.local", 
        "name": "APIv2 Example Survey", 
        "path": [ 
            "Your work", 
            "APIv2"
        ], 
        "title": "APIv2 Example Survey", 
        "url": "https:// <servername>/snaponline/Home/Index/6834a5f1-46e5-4b12-9e0ca38a3d9be12c", 
        "interviewUrl": "https:// <servername>/interview/6834a5f1-46e5-4b12-9e0ca38a3d9be12c", 
        "interviewPreviewUrl": "https:// <servername>/interview/6834a5f1-46e5-4b12-
9e0c-a38a3d9be12c?preview=true", 
        "isPublished": true, 
        "interviewingState": "Live", 
        "numberOfResponses": 4, 
        "numberOfPartials": 0, 
        "responsesLastChanged": "2022-06-09T13:40:25.7"
}

Response Definitions

HTTP Status Codes

• 200 OK

Other API calls

• Get Survey List
• Get Survey Variables
• Get Survey Variable
• Get Survey Responses
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Survey appeared first on SnapSurveys.

Changes from v1.0

• Response JSON is now in name property order.
• The ‘displayName’ property is now called ‘name’.
• The ‘questionnaireTitle’ property is now called ‘title’.
• An ‘ownerId’ property has been added. This gives the owner’s id (GUID).
• An ‘ownerName’ property has been added. This is the owner’s username.
• A ‘path’ property has been added. This is the path up to the survey as an array. E.g. A survey called ‘Survey001’ in folder ‘New Surveys’ in the user’s account will show as “Your work”, New Surveys” and the name will be ‘Survey001’.
• The interviewingState property has a different set of possible values. In v1 they were: “NotStarted”, “Live”, “Paused” and “Stopped”. In v2 they are: “NotStarted”, “Started”, “Paused”, “Stopped”, “TooManyRespondents” and “Unknown”.

Endpoint

Get a list of surveys that are accessible by the user.

Parameters

Path parameters

None

Query string parameters

None

Sample Request

curl --location --request GET 'http://<servername>/snaponline/api/surveys' \
--header 'X-USERNAME: {USERNAME}' \
--header 'X-API-KEY: {APIKEY}' \
--header 'X-VERSION: 2.0'

(In the above code, replace {APIKEY} with your actual API key and {USERNAME} with your actual username.)

Sample Response

200 OK with body:

[
    {
        "id": "2c4be70c-fe6d-4883-9fd3-629943bec836",
        "ownerId": "644f58a7-8526-4901-af7d-20969e5c68e4", 
        "ownerName": "sb4@titan.local", 
        "name": "APIv2 Example Survey", 
        "path": [ 
            "Your work", 
            "APIv2"
        ], 
        "title": "APIv2 Example Survey", 
        "url": "https:// <servername>/snaponline/Home/Index/6834a5f1-46e5-4b12-9e0c-a38a3d9be12c", 
        "interviewUrl": "https:// <servername>/interview/6834a5f1-46e5-4b12-9e0ca38a3d9be12c", 
        "interviewPreviewUrl": "https:// <servername>/interview/6834a5f1-46e5-4b12-9e0c-a38a3d9be12c?preview=true", 
        "isPublished": true, 
        "interviewingState": "Live", 
        "numberOfResponses": 4, 
        "numberOfPartials": 0
    },
    {
        "id": "de8e8ca3-b7e7-4810-93e6-84c65da7e7aa",
        "ownerId": "644f58a7-8526-4901-af7d-20969e5c68e4", 
        "ownerName": "sb4@titan.local", 
        "name": "Test 1", 
        "path": [ 
            "Your work"
        ], 
        "title": "", 
        "url": "https:// <servername>/snaponline/Home/Index/faae664a-0287-459b83f8-782cafae8622", pg. 18 issue 2.3
        "interviewUrl": "https:// <servername>/interview/faae664a-0287-459b-83f8-782cafae8622", 
        "interviewPreviewUrl": "https:// <servername>/interview/faae664a-0287-459b83f8-782cafae8622?preview=true", 
        "isPublished": false, 
        "interviewingState": "NotStarted", 
        "numberOfResponses": 0, 
        "numberOfPartials": 0, 
        "responsesLastChanged": "2022-06-09T13:40:25.7"
    }
]

Response Definitions

HTTP Status Codes

• 200 OK

Other API calls

• Get Survey
• Get Survey Variables
• Get Survey Variable
• Get User Info
• Get Participant List
• Get Participant
• Add Participant
• Update Participant
• Delete Participant
• Get Participants Subjects
• Get Participant Subject
• Add Participant Subject
• Update Participant Subject
• Delete Participant Subject

The post Get Survey List appeared first on SnapSurveys.

The post Recommendation appeared first on SnapSurveys.

The post HTTP Status Codes appeared first on SnapSurveys.

Versioning is achieved by use of request and response headers.

If you don’t specify a version in your request, then you will be using the v1.0 version of the API.

The following response header tells you which versions are available:

• api-supported-versions

The value is a comma-separated list of versions.

To use a new version you have to supply the following header parameter in the request:

• X-VERSION

Set the value to the version that you require.

You should check to see whether use of the new version is advised and what changes (if any) you
need to make to your code in order to use a new version.

Note. At some point it may become necessary to deprecate a version. We will strive to avoid this but sometimes it is unavoidable. We will give you plenty of notice.

Breaking changes

A breaking change is a change that may require you to make changes to your integration. The following are examples of changes we consider to be breaking changes:

• Removal of a parameter, request field or response field
• Addition of a required parameter or request field without default values
• Changes to the intended functionality of an endpoint
• Introduction of additional validation

A non-breaking change is a change that should not require you to make changes to your integration. In most cases, we will communicate non-breaking changes after they have been released.

Please ensure that your application is designed to be able to handle the following types of non-breaking
changes:

• Addition of new endpoints
• Addition of new methods to existing endpoints
• Addition of new fields in the following scenarios:
  • New fields in responses
  • New optional request fields or parameters
  • New required request fields that have default values
• Addition of a new value returned for an existing text field
• Changes to the order of fields returned within a response
• Addition of an optional request header
• Removal of redundant request header
• Changes to the length of data returned within a field
• Changes to the overall response size
• Changes to error messages. We do not recommend parsing error messages to perform business logic. Instead, you should only rely on HTTP response codes and error codes.
• Fixes to HTTP response codes and error codes from incorrect code to correct code

The post Versioning appeared first on SnapSurveys.

You should ensure that you don’t attempt to make more than one call per second or more than ten calls per minute. One way to achieve this is to perform a “sleep” in between calls.

We reserve the right to change the throttling limits at any time.

Current throttling metrics are returned in the following response headers:

Ideally, when a 429 status code is received your code should automatically change its “sleep” behaviour based on these metrics. Alternatively, you may decide to wait say 15 seconds between calls which should satisfy all future per second and per minute requirements.

The post Handling Throttling appeared first on SnapSurveys.

• X-USERNAME containing the Snap XMP Online email address for the user
• X-API-KEY containing the API key for the user

Creating the key

To create the key for the user’s account do the following:

1. Log onto Snap XMP Online.
2. Go to the Your account section.

3. Click on the Integrations link.

4. Click the Generate key button.

5. Click the Copy to clipboard button.

Your API key is now in the clipboard and you can paste this into your API calls.

Failure to include the X-USERNAME and X-API-KEY header parameters, or an incorrect X-API-KEY or use of a revoked API token will result in a 401 – Unauthorised response code, from all API calls.

Note: You should never reveal your API key to anyone or add it to code that is publicly accessible – this includes code in JavaScript files that is easily viewed using the Developer tools in a web browser.

Failure to secure your API key could result in your data being accessible by someone else.

If you think your API key has become known, then you should revoke your key (with the Revoke now button on the Integrations page) or replace the key (with the Replace key button which will make the previous key no longer usable). You will then have to change your client code to use the new key.

The post Security appeared first on SnapSurveys.

Note that if you give anyone else API access to your account you will be giving them access to all of your surveys and all of your survey responses and (depending on the share permissions) access to all surveys and survey responses shared to you by others. Do not give anyone API access if this will be a problem for you.

The API is a RESTful API (Representational State Transfer). It utilises the HTTP transport mechanism and is stateless. Data submitted in the body of a request and data returned in the body of the response is in the JSON format. The API only supports the JSON representation at present. We may allow other representations such as XML in future versions.

Each call made to the API is stateless and as such each call must include the authorisation information. The return from each call consists of a standard HTTP response which consists of a HTTP response code, response body and response headers.

Please note that from Monday 5th December 2022 usage of the API becomes chargeable. The charge is that 0.1 unit will be consumed each time a survey response is delivered by the API.  This applies if the API delivers the same survey response multiple times. Use the Get Survey Responses endpoint to deliver the survey responses.

The post Introduction appeared first on SnapSurveys.

If conditions for single and multiple response questions

The conditions used for routing must return true or false.

These conditions are mainly for use in single or multiple response questions.

If conditions for any question

These conditions are for use with any type of question.

Examples of If conditions

These examples show possible conditions applied to single or multiple response questions

The post Routing rule expressions appeared first on SnapSurveys.

Deleting a survey in Snap XMP Online

1. After logging into Snap XMP Online, the first page shown is Your work.
2. Select the survey you want to delete. Deleting an online surveys in Snap XMP Online also deletes the survey in Snap XMP Desktop due to the synchronization between the products in Snap XMP.

3. There are four states of a survey. This is shown on the Summary tab for the survey.
   • Not started where the survey has not yet been published
   • Interviewing in progress/Started where the survey has been published and interviewing has started
   • Paused where the survey has been published, interviewing has started and is now paused
   • Closed/Stopped where the survey has been published, interviewing has taken place and is now closed.
4. Check the state of the survey on the Summary tab. If the status is Interviewing in progress or Paused then you should stop interviewing prior to deleting the survey.
   • Click the Collect link in the Summary tab.
   • In the Collect tab, click Stop Interviewing.
   • Click OK to confirm that you want to stop interviewing
5. Click Summary in the Snap XMP Online toolbar to return to Your work and display the summary page of the selected survey.

6. Click on the survey action menu and select Delete survey. This displays a confirmation dialog.

7. Click Delete to delete the survey from Snap XMP Online. Deleting an online surveys in Snap XMP Online also deletes the survey in Snap XMP Desktop due to the synchronization between the products in Snap XMP.

Deleting a survey in Snap XMP Desktop

1. On the Snap toolbar, click Survey Overview to display the Survey Overview window.
2. Select the survey you wish to delete. Deleting an online surveys in Snap XMP Online also deletes the survey in Snap XMP Desktop due to the synchronization between the products in Snap XMP.
3. On the Survey Overview toolbar, click Delete survey to delete the survey and/or the data. When deleting a survey, you can:
   • delete all variables, reports and weights (.mdf file)
   • delete the survey data, if available (.rdf file)
   • delete the temporary back up files (.mdo/.rdo file)
4. Select the components of the survey that you wish to delete and click Delete.

5. Click Yes to confirm your selection on the warning message.

6. Once the deletion is successful, you should also delete any archives of the survey.

If there is a topic you would like a tutorial on, please email snapideas@snapsurveys.com.

The post Deleting a survey in Snap XMP appeared first on SnapSurveys.

• the participants’ submitted response data
• the participant details used for the email invitations and survey login information

Removing submitted responses held within the survey

Removing in Snap XMP Desktop

1. In Snap XMP Desktop, open the Survey Overview window .
2. Select the online or offline survey that you need to amend, and open by pressing Enter. If it is an offline survey that is not displayed, use Browse to find the folder containing it.

3. For an online survey, the responses synchronize when the survey is opened. If required, you can synchronize your survey responses by clicking Synchronize Responses on the main Snap Toolbar.
4. Open the Data Entry window .
5. Find the responses associated with the participant. Use Filter Cases to help you find any responses from the participant.

6. Use the delete icon to clear the response data for that case (the record will show as a deleted case).
7. For offline surveys you may have archive files; you can update them by overwriting the archived data. In the Survey Overview window, select the survey and click Archive Survey .

.

8. A generated file name with the .adf extension is defaulted. If required, change the location and file name to match the archived file you wish to overwrite, by clicking Browse.
9. Check the Include Raw Data box to include the case data in your archive.
10. Click OK to archive the survey. If the survey has previously been archived to that location, you will be asked if you want to overwrite the existing file. Click Yes.
11. A confirmation message is displayed when the archived is completed. Click OK.

Note: To fully remove the participant’s data, all previously created archive files, cloned surveys, or other copies of the survey data that specifically identify the individual also need to be removed. This includes re-running any reports containing information that can identify the individual participant.

Removing in Snap XMP Online

You can also permanently remove the data responses stored for an individual participant in Snap XMP Online.

1. In Snap XMP Online, select the survey that is linked to the participants’ file.
2. In the Summary tab, click the Collect link.
3. Click the Responses option in the side menu panel
4. Click Find and erase.
5. In the adjacent box type the filter condition that identifies the participant then click on the Find matching responses button.

6. The filtered data to be removed will appear in a list below. Click on the Erase button to permanently remove the data.

Removing a participant’s details from the mailing and logins list

In a survey that uses a list of participants to provide email invitations and/or logins, you may need to update the participants’ information. The participants’ details for a survey are initially uploaded from a database or file in Snap XMP Desktop or Snap XMP Online. The details should be first updated in the source database or file. The following instructions show how to upload to Snap XMP Desktop or Snap XMP Online again.

Removing in Snap XMP Desktop

1. Open your database of participants and remove the relevant participant(s).
2. In Snap XMP Desktop, open the survey that is linked to the database of participants.
3. Choose File | Database links, select the relevant database link and click Run.

4. In the Run Database Link dialog, select Replace all participants in the Participants and Seeding list. This replaces the existing participants with the updated list, removing any participants that were removed from the database.

5. Click OK to update the participants’ email invitation and login information.

Removing in Snap XMP Online

1. Open your Excel, CSV or TSV file and make the relevant amendments.
2. In Snap XMP Online, select the survey that is linked to the participants’ file.
3. In the Summary tab, click the Collect link.

4. Select Participants in the side menu and then select the Participant list. This shows a list of all the participants for the survey.

5. Click Upload Participants, select the updated participant file and click Next.
6. There are three options. Select Replace all participants. This replaces the existing participants with the updated list, removing any participants that were removed from the list.

7. Click Next to proceed through the Upload Participants wizard. Click Upload to update the participants’ email invitation and login information.

You can also locate and select the participant in the Participant list then click Delete to remove the individual participant. If you choose this method, you must remember to update the Excel, CSV or TSV file containing your participants as well.

If there is a topic you would like a worksheet on, email to snapideas@snapsurveys.com

The post Removing an individual’s information held in Snap XMP appeared first on SnapSurveys.

Participants choose whether to give consent by answering a specific question at the beginning of the survey.  If they choose not to provide consent they are prevented from completing the survey.

Provide potential participants with the relevant information

You need to ensure that the consent that you obtain from participants is ‘informed’, meaning that participants have been given ‘fair processing information’ and have been informed of all aspects of the survey project that are relevant to their decision to participate. This is commonly done by providing potential participants with a privacy or information notice. You can present this information by including it in the instruction question type field at the start of your survey. You have the option of providing this information in a layered format by providing a summary of the essential information in the instruction question type field, followed by a link to your full privacy policy or notice for more detailed information. Snap Surveys provides a link to the Snap Surveys’ Privacy Policy; available at https://www.snapsurveys.com/survey-software/privacy-policy-uk/. This provides information as to how we act as your data processor.

Worksheet example

In this worksheet example, the question and text are an example of simple wording that may be used as part of the process of gaining consent to the collection of the survey response data and processing it for the purposes of the survey itself. You can set the question and the explanation to include whatever information you as data controller consider appropriate for your survey, the type of data that you propose to collect, and the uses that you propose to make of the survey response data.

For example, where special categories of personal data will be collected (e.g. gender and ethnicity data) and explicit consent is required, you may wish to include specific wording to make it clear that the participant is willing to provide such information. If you plan to use the response data for other purposes beyond the survey itself, you may also set multiple consent questions, to separately obtain consent for each of them.

Create a Multi Choice consent question

1. In Your work, open your survey.
2. In the Summary tab, click on the Build link. This opens the Online Designer where you can build and edit your questionnaire.
3. Click in the first question then double click the Multi Choice option to insert the consent question. You may also use drag and drop or Ctrl + Enter.
4. In the area marked Enter Multi Choice question text, enter your consent request text.

5. Double click the Page Break option in the side menu. This inserts a page break before the consent question and also between the consent question and any following question. You may also use drag and drop.

Set the question as a mandatory response

1. Select the consent question and select the Validation & Masking option in the side menu.
2. Select the Mandatory checkbox to make the question mandatory.

3. Click Save .

Test the survey

1. In the Online Designer, click Preview. The preview opens a new browser window displaying the questionnaire as it would look if it after it has been published. Use this previewed survey to test that your consent question behaves accordingly
2. In the published version it will look like this.

3. Check that the consent question appears on a page by itself. The respondent must answer the question before they can complete the rest of the survey.

Keep a record of consent

1. In Snap XMP Online, select the survey and in the Summary tab click the Collect link.
2. Select the Responses option in the side menu.
3. Select the Responses in the list of options.

4. You can export the survey response data by clicking the format, Excel, CSV or TSV, that you want to download.

If there is a topic you would like a worksheet on, email to snapideas@snapsurveys.com

The post Including a consent question appeared first on SnapSurveys.

• the participants’ submitted response data
• the participant details used for the email invitations and survey login information

Amending submitted responses held within the survey

Amending the response data is done in Snap XMP Desktop. The following steps outline the process.

1. In Snap XMP Desktop, open the Survey Overview window .
2. Select the online or offline survey that you need to amend, and open by pressing Enter. If it is an offline survey that is not displayed, use Browse to find the folder containing it.

3. For an online survey, the responses synchronize when the survey is opened. If required, you can synchronize your survey responses by clicking Synchronize Responses on the main Snap Toolbar.
4. Open the Data Entry window .
5. Find the responses and amend the data as necessary. Use Filter Cases to help you find any responses from the participant.

6. Save the changes .
7. For offline surveys you may have archive files; you can update them by overwriting the archived data. In the Survey Overview window, select the survey and click Archive Survey .

8. A generated file name with the .adf extension is defaulted. If required, change the location and file name to match the archived file you wish to overwrite, by clicking Browse.
9. Check the Include Raw Data box to include the case data in your archive.
10. Click OK to archive the survey. If the survey has previously been archived to that location, you will be asked if you want to overwrite the existing file. Click Yes.
11. A confirmation message is displayed when the archived is completed. Click OK.

Note: To fully amend the data, all previously created archive files, cloned surveys, or other copies of the survey data that specifically identify the individual also need to be amended. This includes re-running any reports containing information that can identify the individual participant.

Amending a participant’s details from the mailing and logins list

In a survey that uses a list of participants to provide email invitations and/or logins, you may need to update the participants’ information. The participants’ details for a survey are initially uploaded from a database or file in Snap XMP Desktop or Snap XMP Online. The details should be first updated in the source database or file. The following instructions show how to upload to Snap XMP Desktop or Snap XMP Online again.

Amending in Snap XMP Desktop

1. Open your database of participants and make the relevant amendments. (If you have uploaded multiple database files to your survey already, you can create a new database with just the necessary participants’ details, clone the existing database link and select the new file.)
2. In Snap XMP Desktop, open the survey that is linked to the database of participants.
3. Choose File | Database links, select the relevant database link and click Run.

4. In the Run Database Link dialog, select Update Participants in the Participants and Seeding list.

5. Click OK to update the participants’ email invitation and login information.

Amending in Snap XMP Online

1. Open your Excel, CSV or TSV file and make the relevant amendments.
2. In Snap XMP Online, select the survey that is linked to the participants’ file.
3. In the Summary tab, click the Collect link.

4. Select Participants in the side menu and then select the Participant list. This shows a list of all the participants for the survey.

5. Click Upload Participants, select the updated participant file and click Next.
6. There are three options. Select Update Participants to update with the changes made to the participant file.

7. Click Next to proceed through the Upload Participants wizard. Click Upload to update the participants’ email invitation and login information.

If there is a topic you would like a worksheet on, email to snapideas@snapsurveys.com

The post Amending an individual’s information held in Snap XMP appeared first on SnapSurveys.

• running anonymous surveys with no personal data submitted to Snap XMP Online
• running surveys that identify if a participant has responded but not linking them to their response
• removing identifiers from the data after collection so that further processing is on anonymised data only

If you want your survey to remain anonymous:

• Don’t ask participants for personally identifiable data including email address, name, postal address and phone numbers.
• Don’t add a database of participants to your survey in Snap XMP Desktop or Snap XMP Online.

To deploy your survey you can:

• Put the link and/or QR code for the survey in places where your participants will have access to it, for example your website, intranet or on posters
• Print a paper version and leave it in relevant places

Finding the link and QR code for the survey

1. Log in to Snap XMP Online and the first page shown is a summary of Your Work.
2. Click on your survey to show the Summary then click the Collect link.

3. You will need to publish the survey, if it is not already published. Click the Publish current version button to publish your survey then click OK to confirm.

4. When you have published your survey the Overview shows the Interview URL and QR code

If you want to deploy a survey where you contact a participant in your database you have three options:

• Circulate the link to your survey using your own email system – in this case, no personal data is uploaded to Snap XMP Online
• Follow our worksheet Anonymisation in Surveys – Sending an email that doesn’t identify the participant
• Follow our worksheet Anonymisation in Surveys – Sending an email that includes a unique participant identifier

Finally, if you want to anonymise your survey after carrying it out, you can remove personal data from the data file. For further information please see Anonymising data after carrying out your survey .

When you use Snap XMP Online to collect survey responses, it will not collect the participant’s IP address in conjunction with the survey response. As explained in our Privacy Policy (https://www.snapsurveys.com/survey-software/privacy-policy-uk/ ) Snap Surveys separately records participant IP addresses and other technical information in its backend logs, which it deletes after no longer than 6 months. This technical information is not linked to survey response data and is not shared with customers.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Making surveys anonymous appeared first on SnapSurveys.

Finding the participant

1. Login to Snap XMP Online and the home page shows Your Work.
2. In Your Work, navigate to your survey.
3. In the survey Summary tab, click the Collect link.
4. Once in the Collect tab, select Participants from the side menu and then select Participant list.
5. Use the filter to search for the participant by Email address or Login.

Changing the Enabled and Send invites status

1. To change the Enabled and Send invites status, click Edit.

2. In the Edit participant dialog, clear the Enabled and Send invitations checkboxes. Click Save to save your settings

3. A disabled status for Enabled indicates that the participant cannot access the survey. A disabled status for Send Invites indicates that the participant will no longer receive email invitations or reminders. A participant can be given access to the survey and have email invitations and reminders reinstated at any time by repeating the process with Enabled and Send invites selected instead.

If there is a topic you would like a worksheet on, email to snapideas@snapsurveys.com

The post Stopping a participant from accessing the survey appeared first on SnapSurveys.

This can be applied

• permanently, for example where a participant has objected to receiving further emails
• temporarily, for example where a participant wishes to restrict the processing of their personal data, until such a restriction is lifted

Find the participant

1. Login to Snap XMP Online and the home page shows Your Work.
2. In Your Work, navigate to your survey.
3. In the survey Summary tab, click the Collect link.
4. Once in the Collect tab, select Participants from the side menu and then select Participant list.
5. Use the filter to search for the participant by Login or Email address.

Change the Send invites status

1. To change the Send invites status, click Edit.

2. In the Edit participant dialog, clear the Send invitations checkbox and click Save to save your settings

3. A disabled status for Send Invites indicates that the participant will no longer receive email invitations or reminders. However, the participant will still be able to access the survey. To prevent a participant from accessing the survey, please see [link to ‘Stop a participant from accessing the survey’ worksheet’]. A participant can have email invitations and reminders reinstated at any time by repeating the steps, selecting the Send invites checkbox instead.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Preventing further survey invitations appeared first on SnapSurveys.

You may need participants to log in to ensure that they only complete a questionnaire once, or to enable Snap XMP Online to keep track of the responses. To set up a login page, you must have a known list of participants and they must each have a unique ID that they use to log in. In Snap XMP Online, you must set this up in the participants file.

To make life simple for participants and help to increase your response rate, the email invitations can contain a link to the survey that, when clicked, automatically logs the participant into the survey.

Tracking the participant using a unique identifier in Snap XMP Online

What you need

• A unique email address for each participant. You can also add additional fields to personalise your email invite or to provide login details.

Uploading the participants

1. Open your survey in Snap XMP Online and from the survey’s Summary click on the Collect link.
2. Select the Participants side menu to view the participants and invitations. The Participants Overview is selected by default.
3. Click on the Participant list menu item to view the participants.

4. Click on Upload Participants to open the Upload Participants Wizard.

5. On the first page, click Select file to add the file with the participants’ data. The accepted formats are CSV and XLSX. Click Next.

6. Select the survey options for sending email invitations and using logins.
   • Select Send email invites/reminders to be able to send email invitations and reminders.
   • In Email address field, select the spreadsheet column that contains the email address for the participants. This field is mandatory and Snap XMP Online attempts to match the most likely column.
   • Select Seed data into invites/reminders if you wish to seed participant data into the invitations and reminders.
   • Select Allow Snap Online to track your participants for questionnaire seeding. This allows you to track your participant when they have responded.
   • In the Login field, select the spreadsheet column that contains the login for the participants. This field is mandatory and Snap XMP Online attempts to match the most likely column.

7. Click Next. The overview summarizes the chosen settings for you to review.
8. Click Upload to upload the participants to the survey. The results are displayed when the upload is complete. Click Finish to close the wizard.

Creating the email invitation

1. Click on the Invitations menu item to view the email invitations and reminders.
2. Click Add Invitation to create an email invitation in the Email Editor.

3. Add a heading in Subject.
4. Type the email message in the message area.
   • Click Insert tag to add a SurveyLinkAuto link. This provides a link for the participant to access the survey and must be included in the email message.
   • You should also include a link enabling your participants to opt out of the survey. Click Insert tag and select the OptOut link.
   • The link text can be customised by clicking Insert hyperlink .
5. The list of participants can be managed in Snap XMP Online.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Anonymisation in Surveys – Sending an email that includes a unique participant identifier appeared first on SnapSurveys.

Sending an anonymous survey invitation

What you need

• A unique email address for each participant.

Uploading the participants

1. Open your survey in Snap XMP Online and from the survey’s Summary click on the Collect link.
2. Select the Participants side menu to view the participants and invitations. The Participants Overview shows by default.
3. Click on the Participant list menu item to view the participants.

4. Click on Upload Participants to open the Upload Participants Wizard.

5. On the first page, click Select file to add the file with the participants’ data. The accepted formats are CSV and XLSX. Click Next.

6. Select the survey options for sending email invitations.
   • Select Send email invites/reminders to be able to send email invitations and reminders.
   • In Email address field, select the spreadsheet column that contains the email address for the participants. This field is mandatory and Snap XMP Online attempts to match the most likely column.
   • Do not select Seed data into invites/reminders as the seeded data could identify the participant.

7. Click Next. The overview summarizes the chosen settings for you to review.
8. Click Upload to upload the participants to the survey. The results are displayed when the upload is complete. Click Finish to close the wizard.

Creating the email invitation

1. Click on the Invitations menu item to view the email invitations and reminders.
2. Click Add Invitation to create an email invitation in the Email Editor.

3. Add a heading in Subject.
4. Type the email message in the message area.
5. Click Insert tag to add a SurveyLink link. You need to include this link in the email message. This provides a link for the participant to access the survey.
6. You should also include a link enabling your participants to opt out of the survey. Click Insert tag and select the OptOut link.
7. The link text can be customised by clicking Insert hyperlink .
8. Click Save to save the email.
9. You can manage the list of participants in Snap XMP Online.

If there is a topic you would like a tutorial on, email to snapideas@snapsurveys.com

The post Anonymisation in Surveys – Sending an email that doesn’t identify the participant appeared first on SnapSurveys.

This tutorial describes how to set up the participants data then upload the participants using Snap XMP Online and create email invitations and reminders using Snap XMP Online that enable the participants to access the survey directly from the SMS message.

There is also a video demonstrating how to send SMS invitations that can be found at SMS Invitations from Snap Surveys on Vimeo.

Email to SMS service pre-requisite

To provide SMS survey invitations you will need a custom email address, provided by Snap Surveys, that is associated with your Snap XMP Online account. Please contact our sales team about enabling this feature on your account. This email address will be used for sending all future invitations from your Snap XMP Online account and is used by your chosen SMS provider to authenticate your messages as they are sent.

Prior to sending SMS survey invitations you need an account with an SMS messaging service provider. This is a service provided by a third party that sends bulk SMS messages from your organisation, for purposes such as invitations, reminders and alerts. Your organisation may already have an existing account with an SMS messaging service provider. If this is not the case, you need to sign up for an account with an SMS message service provider. Snap Surveys does not provide recommendations for any service providers. However, the provider that you decide to use must provide an Email to SMS service to be able to send SMS survey invitations.

Step 1: Create an Email to SMS service account

Make sure that you have an account set up with a SMS messaging service provider and a custom email address provided by Snap Surveys. Once an account is set up, register the Snap XMP Online custom email address as a valid sending address within the SMS messaging service account. Please refer to your SMS messaging service provider’s documentation for further details on how to set up the Email to SMS service.

Step 2: Create and publish the survey

In Snap XMP Desktop, create the survey making sure that you include mobile editions as the participants are likely to access the survey directly from the SMS message on their smart phones.

Publish the survey in Snap XMP Desktop at Publishing the online editions or Snap XMP Online at Publishing your survey.

Step 3: Set up the participant data file

The data file containing the participant details must contain the unique participant email address required by the SMS messaging service. This email address is usually configured in the format

International mobile phone number of the participant @ SMS service provider domain name

For example 447712345678@smsprovider.com where 447712345678 is a participant’s UK mobile phone number in international format and smsprovider.com is the domain of the SMS service provider.

Check that this is the required format in the documentation provided by your SMS messaging service provider.

An example Excel spreadsheet is shown below, containing login information (ID); SMS email (Email) and first name (Name).

The data file may also contain other login and seeding information.

Step 4: Upload the participants in Snap XMP Online

In Snap XMP Online, you can upload participants to the survey prior to sending out invitations.

1. Open your survey in Snap XMP Online and in the survey’s Summary click the Collect link.

2. Select the Participants side menu to view the participants and invitations. The Participants Overview is selected by default

3. Click on the Participant list menu item to view the participants.
4. Click on Upload Participants to open the Upload Participants Wizard, which guides you through the steps to add the participants to your survey.
5. On the first page, click Select file to add the file with the participants’ data. The accepted formats are CSV and XLSX.

6. Click Next. The next page shows the survey options for sending email invitations and logging into the questionnaire. In this tutorial, email invitations are sent (converted to SMS format by the SMS messaging service provider) and the participants are going to log into the survey automatically. The email invitations are going to contain the participant’s name. For this the following survey options are selected:
   • Select Send email invites/reminders to be able to send emails.
   • In the Email address field, select the spreadsheet column that contains the email address for the participants. This field is required and this defaults to match the most likely column. In this tutorial, it is set to email to match the spreadsheet column.
   • Select the Seed data into invites/reminders checkbox so that the invitations can contain the participant’s name.
   • Select Allow Snap Online to track your respondents, which requires the participants to log in.
   • In the Login field, select id to match the spreadsheet column

7. Click Next and complete the invitation seeding. Select the field name and click Add to make the name information available when you create the invitations and reminders.

8. Click Next to show the overview page then click Upload to upload the participants to the survey. The results are displayed when the upload is complete. Click Finish.

Questionnaire seeding is also available when adding participants, but is not shown in this tutorial. Further details on how to set these options can be found at Uploading participants from a spreadsheet.

Step 5: Create plain text invitations in Snap XMP Online

The invitations must be created as plain text emails because the SMS messages cannot contain HTML.

1. Click on the Invitations menu item to view the invitations.

2. Click the Add plain text invitation button to display the invitation email editor where you can compose the email you wish to send to your participants.
   • In the Title field, enter the name that describes the invitation or reminder.
   • In the Subject field, enter the email subject that the participants will see. There are two tags available in Insert tag into subject. These are Survey Title and Username.
   • Enter the SMS message text, by overtyping [Add your text here], in the email message field. Click Insert tag into body and select name to add the name field in your email message greeting.
   • You must include the survey link in the message for participants to access the survey from the SMS message. In Insert tag into body, click SurveyLinkAuto to add a link that automatically logs the participant in and shows the survey. If you want the participant to enter the log in details then use SurveyLink.

3. When you have completed the SMS invitation click Save to save your changes.

When creating the SMS invitation, consider the length of the message. A standard text message length is 160 characters. The link in the message is replaced with the full web address of the survey which you need to include in the message length. Multiple messages will increase the cost of sending the invitations to participants.

Step 6: Test the invitation

Before you send the email invitations to your participants you can check the format of the invitations by using the test functionality.

1. In the Invitations section, click the Test button.

2. This displays the Test invitation dialog. Enter an email address that is available for testing.

3. Click Send test email. A test email invitation is sent to the test email address.
4. When the email arrives check that the format is as you expected. The email will substitute one of the participants in your list to test the invitation seeding is correct. Check that the survey link opens the survey.
5. Once the invitations are ready to send you can start interviewing. Further details on starting interviewing can be found at Collecting your survey data.

To test that the SMS message is delivered, you will need to upload a database containing your own email address i.e. 447712345678@smsprovider.com (where 07712345678 is your UK mobile phone number).

To manage the load on our email relays, as well as the subsequent load as respondents complete their survey, we limit the speed at which emails are sent, this is primarily to make sure that each respondent has a good experience and fast response times, to encourage them to finish the survey. As per the technical specifications on our website (https://www.snapsurveys.com/survey-software/technical-specifications/) , please consider how long it will take for your emails to be sent.

Finally, please consider the number of characters in your survey URL as multiple SMS messages will incur greater costs from your SMS provider.

The post Sending SMS invitations appeared first on SnapSurveys.

Adding a plain text invitation

1. Open your survey in Snap XMP Online and in the survey’s Summary click the Collect link.

2. Select the Participants side menu to view the participants and invitations. The Participants Overview shows by default
3. Click on the Invitations menu item to view the invitations.

4. Click the Add plain text invitation button to display the invitation email editor where you can compose the email you wish to send to your participants.
   • In the Title field, enter the name that describes the invitation or reminder.
   • In a reminder, set the Days to wait before sending to the number of days to wait since the sent time of the previous invitation or reminder.
   • In the Subject field, enter the email subject that the participants will see. There are two tags available in Insert tag into subject. These are Survey Title and Username.
   • Enter the email message text, by overtyping [Add your text here], in the email message field.
   • Any invitation seeding is available in the Insert tag into body list. Click Insert tag into body and select the seeded field into the email message at the cursor position. In the example shown, name is a seeded field that inserts the participant’s name in the email message. Tags are shown inside braces or curly brackets, for example {name}.
   • You must include the survey link in the message for participants to access the survey from the email message. In Insert tag into body, click SurveyLinkAuto to add a link that automatically logs the participant in and opens the survey. If you want the participant to enter their log in details then use SurveyLink.

5. When you have completed the plain text email invitation click Save to save your changes.
6. The list of invitations now contains the new invitation.

The post Creating plain text invitations appeared first on SnapSurveys.

You can share work with other people who have a Snap XMP Online account. 

Auditing changes made by shared users

Shared users of a survey who are added with the Researcher permission have access to make changes to the shared survey, such as, editing the questionnaire in the Snap XMP Online Designer, publishing the questionnaire and starting interviewing.

Auditing information about the activity on the survey is available in the survey’s Audit log and Version history. These are available by selecting the required survey in Your Work then clicking on the Audit log or Version history tab.

The survey’s Audit log shows the changes made to the survey including the timestamp, the name of the user making the change and the type of activity.

The survey’s Version history shows an entry for each version of the questionnaire created. The information includes the timestamp, the name of the user who created the version and any publishing details.

Auditing changes made to shared users

The shared users of a survey or folder can be viewed and edited in the Shares tab. These are available by selecting the required survey or folder or Your Work then clicking on the Shares tab.

When you create a shared user there is an option to give this user permission to manage the shared users of the survey. Shared users who have this permission can add, edit or remove shared users of the survey. You can keep track of the shared users who have access to the survey or folder in the Shares tab, where you can see both who created and who last modified the shared user as well as when these changes happened.

In the example, the owner of the survey is chris@example.org. The owner has created a shared user, sam@example.org, who is a Researcher and can share the survey. The user sam@example.org has also created another shared user, jane@example.org, who is an analyst and cannot share the survey.

The post Auditing shared surveys appeared first on SnapSurveys.

What is synchronized?

When changes are made to a survey, the data that is synchronized includes the

• Questionnaire when it is created in Snap XMP Online
• Publishing details
• Interviewing details
• Response data

When is it synchronized?

Synchronizing the surveys takes place in Snap XMP Online when you

• Load or reload your online survey, folder or Your work
• Save an online survey’s questionnaire

Synchronizing the surveys takes place in Snap XMP Desktop when you

• Open the online surveys in the Survey Overview window.
• Upload an online survey
• Download an online survey
• Click the Synchronize button
• Save an online survey’s questionnaire

Upload a Survey from Snap XMP Desktop

When you have made changes to a survey you can upload the survey to make sure it is available in Snap XMP Online.

1. In the Survey Overview window select to view the online surveys.
2. Select the survey that you have updated and would like to upload.
3. Click the Upload Survey button.

4. View the updated survey in Snap XMP Online.

Download a survey to Snap XMP Desktop

Before you start making changes to a survey in Snap XMP Desktop you can make sure you have the latest version of the survey by downloading it.

1. In the Survey Overview window select to view the online surveys.
2. Before you download you can check the status of your surveys by clicking the Refresh button to see which surveys are Out of date.

3. Select the survey you would like to download.
4. Click the Download Survey button.

5. After the survey is downloaded it is shown as Up to date. Open the survey to see the latest version.

Synchronize in Snap XMP Desktop

The Synchronize button on the main menu is available for online surveys only. This button synchronizes the online surveys.

The Synchronize button icon alters when changes are detected.

• is displayed when no changes are detected.
• is displayed when changes are detected.

1. Click on the Synchronize button or use the File/Synchronize menu option to synchronize your work.
2. A status bar is displayed while Snap XMP Desktop is synchronizing. The Synchronize button detects changes when
   • Changes are made to an open online survey in Snap XMP Desktop.
   • Any variable property, analysis, reports and analysis variables associated with an online survey are updated.
   • New responses are found for an open online survey.

Synchronize Your work in Snap XMP Online

There are two ways to update the surveys in Snap XMP Online.

1. Click on Your work to refresh the Your work side menu and Summary.

2. Click on the folder name to refresh the folder Summary.

3. Click on the Build, Collect or Analyze tab of your survey to reload the survey with the latest questionnaire and responses.

Synchronizing Publishing, Interviewing and Collecting

Online surveys are available in both Snap XMP Online and Snap XMP Desktop.

Online surveys are automatically synchronized between the two applications when a survey is

• Published
• Interviewing started
• Collecting responses

The information is available to view and edit in Snap XMP Desktop and Snap XMP Online, regardless of the application used to publish, start the interviewing process or collect responses.

The responses that are collected through interviewing can be viewed in Snap XMP Online or Snap XMP Desktop. The responses can come from online, mobile, kiosk and paper sources. As these responses arrive they are saved with the other cases. The case data is available to analyze in both Snap XMP Online and Snap XMP Desktop.

The post Synchronizing online surveys appeared first on SnapSurveys.

1. In Snap XMP Desktop, open the Survey Overview window.
2. Click to view the Online Surveys.
3. Select the survey that will be the basis of your survey template.

4. Select File|Save as Template to display the New Online Template dialog. A default survey template name and folder are entered in the dialog. You can change these before saving. In our example the name is “Conference survey template” and the location is “Demo Folder”.

5. Click OK to save the survey template.

6. The survey template is now available for use in Snap XMP Online.

Upload Template Thumbnail in Snap XMP Online

In the Summary section of a survey template, you have the option to upload a thumbnail image. This can help users identify the survey template when they are creating a new survey.

1. Select the survey template in Your work to display the Summary.

2. Click the Upload thumbnail button to display the Upload thumbnail dialog.

3. Click the Select file button to select an image. Here, the image has previously been created by copying part of the questionnaire.

4. Click Open to display the image in the Summary section.

The post Creating a survey template for use in Snap XMP Online appeared first on SnapSurveys.

In Snap XMP – you can share results with key associates online and in real time. This quick-sharing of data provides a more inclusive experience.

You also have control over which analyses and reports are available, how they are presented, and what permissions are granted.

How it works

To share results with analysts and stakeholders you will need to assign them permissions to the survey or folder. This means that each person you want to be an analyst must have their own Snap XMP Online account.

If they already have an account in Snap XMP Online, you can use the Shares feature to give them either Analyst or Analyst plus data download permissions to a survey or folder.

If they do not already have an account created in Snap XMP Online, you can give them a copy of the following links in order for them to create an account with the associated permissions. There are 2 account types you can give them to create, which are Analyst  or Analyst plus data download. Be sure to give them the appropriate country’s link (UK or US).

Link to create analyst accounts on the United Kingdom server

Use these links if your organisation is using the UK Server.

UK Analyst account

UK Analyst + data download account

Link to create analyst accounts on the United States server

Use these links if your organisation is using the US Server.

US Analyst account

US Analyst + data download account

The post Setting up new Snap XMP Online accounts for analysts appeared first on SnapSurveys.

1. Ensure that firewalls or proxy servers are not blocking Snap XMP from making HTTPS calls to the domain e.g. online1.snapsurveys.com
2. Add *.snapsurveys.com to the proxy server settings, this should allow the synchronisation calls through. The service uses port 443.

The post Security settings for synchronization appeared first on SnapSurveys.

Build: 1.0.0.1344

Release Date: 5^th September 2024

Features

• SOL-4320: New Job scheduler service to reduce blocking jobs
• SOL-4611: New job added to delete inactivated pending accounts
• SOL-4904: Participant archive and unarchive jobs added
• SOL-5030: Support POP3 OAUTH using client secret as an alternative to certificate
• SOL-5041: Limit the number of responses that can be exported from Snap XMP Online in one go
• SOL-5113: New ‘scheduled’ survey status added
• SOL-5116: Allow multiple SMTPs to be used for sending invites
• SOL-5133: Rebuild db index job migrated to new Scheduler
• JS-295: New ID.page functionality during interview
• JS-296: New Tab control functionality during interview

Fixes

• SOL-4632: QuestionnaireSnifRevisions table in Resources DB no longer required
• SOL-4706:  Improve participant/invite UI responsiveness
• SOL-4781: Updated Kendo and JQuery libraries
• SOL-4827: Incorrect warning about partial being deleted when editing a participant removed
• SOL-5035: Concurrent web interview limits redrawn issues
• SOL-5044: Title on custom domain survey left blank rather than Snap Surveys
• SOL-5052: Return 404/410 for invalid interview links and non running surveys
• SOL-5059: Prevent 2 paper download links being created
• SOL-5064: Improve performance of Desktop Sync streaming
• SOL-5065: Created date set for participant when created via a connector or API call
• SOL-5110: V1 of GetResponses API call now charging units
• SOL-5115: Email alert only includes 1 AttachIt file when multiple added
• SOL-5123 – POP3/IMAP passwords cannot contain certain characters eg <>
• SOL-5127: Rephrase reset message on group questionnaire participant
• SOL-5137: DB index improvements
• SOL-5142: Extra warning added to Save pages
• SOE-345: Better handling for content pasted from Word
• SOE-351: Fix adding options in semantic scale
• SOE-353: Survey fails to load if brackets in style name
• SOE-354: Survey becomes corrupt after deleting grid rows with routing dependencies
• SOE-355: Valid field now working for open ended literals
• SOE-356: Save issues with compound grid and routing
• SOE-358: Questionnaire fails to load in Editor when numbering sections set to numbers
• SOE-360: Surplus spaces in routing expression not handled
• JS-73: Speed improvements when loading of large surveys
• JS-152: Better centring of code labels on mobile devices with carousel grids
• JS-154: Prevent multiple AttachIt files for the same question
• JS-280: Allow custom scripts in the header to be executed
• JS-299: Configuration issues with Randomise displayed in Desktop preview
• JS-307: Implement Timer in multi-language questionnaires
• JS-315: Fix text substitution from variable hidden on another page
• JS-317: Alphabetical ordering with columns broken when excluding the last code(s)
• JS-318: Map control alignment incorrect
• JS-320: Inconsistent execution of routing affecting Next page contents
• JS-321: Masking not working when number of codes is different
• JS-331: Native date picker showing wrong date format in error message
• JS-336: Hide blank entry for drop-down plus must answer plus value
• JS-337: Show slider set with initial value
• JS-338: Refresh image maps with calculated value
• JS-339: Allow time to be entered with “.” separator
• JS-341: Carousel would not show code labels if defined in the Next parts
• JS-345: Error saving a partial on an empty page
• JS-347: Allow initial value to be set to specific codes of another variable

Build: 1.0.0.1321

Release Date: 15^th January 2024

Features

• SD-528: Allow screen outs to explicitly ignore the global target
• SOL-4965: Paper edition published on demand 
• SOL-5025: Excel CSV option added to Export responses

Fixes

• JS-73: Restart button within SOI does not return the interviewer to the first page
• JS-116: Allow custom CSS to be used during interview
• JS-269: Excluded codes now pushed to the end of the sequence for alpha-ordering only 
• JS-236: Legacy HTML option with masking can stop the interview loading
• JS-246: Drag & Drop Rank does not limit the number of rows to rank
• JS-253: Rank index displayed on its own line when code label is long
• JS-294: Quota console error with Next and Back
• JS-300: Masking and alpha ordering could result in codes showing more than once
• JS-301: Rating check plus must answer issues
• JS-302: Carousel not displaying correctly when grid question text not showing
• JS-303: Drag rank question with conditional routing does not always display the initial value
• JS-304: Page timer not working when randomise added
• JS-305: Show the error on Drag and drop grids after focus is moved on
• SOE-270: Snmedia read and save added
• SOE-275: Semantic scale label edit improvements
• SOE-312: Rank and Category grid edit improvements
• SOE-316: Image map grid edit improvements
• SOE-338: Grid labels lost when changing grid style
• SOE-343: Group questionnaire edit improvements
• SOE-346: Image resize issues
• SOE-347: Post condition routing can get removed
• SOL-5027: Error shown if number of pages in a report greater than 200
• SOL-5028: Rename from ‘Your work \ Surveys’ to ‘Owned by you \ Your work’

Build: 1.0.0.1313

Release Date: 17^th October 2023

Features

• SOL-4980: Separate create from save analysis permission (Admins can set Edit and create analyses / save modified analyses permissions as required)
• SOL-5009 Always show Publish button when possible regardless of interviewing state
• JS-258: Prevent going back to an already submitted survey
• SD-485 / JS-200: New ribbon for compound grids with option to set relative widths
• SD-505: Native time picker allows seconds
• SD-507: Allow variables to be excluded from randomisation blocks (to keep titles at the top)
• SD-514: Responsive images: automatically resize when the window is resized

Fixes

• SOL-4618: Don’t show report label for analysis in solo surveys
• SOL-4706: Database changes to improve performance and throughput
• SOL-4940: Ensure all emails are processed when using batch option
• SOL-4971: Remove X-XSS-Protection header from interviewing and main site as recommended by OWASP
• SOL-4973: Ensure X-Frame options header can be set for main site. (Admins can set via Configuration | Content security policy) 
• SOL-4975: Session cookie invalidated after log out
• SOL-4976: Unused referrer header removed to prevent future potential risk of a CSRF attack
• SOL-4987: Return a 400x or 500x error status code when appropriate
• SOL-4988: Track participant being deleted for SOI sync   
• SOL-5003: Reset password email content changes to reduce it being treated as spam
• JS-104: Submitting works if error has not been seen yet (submit on all pages)
• JS-231: Must answer inline in a hidden question prevents the Respondent from using Next button
• JS-236: Potential crash during interview with empty code labels
• JS-269: Maintain original position for excluded codes when code order = random
• JS-279: Tab order updated when conditional questions appear
• JS-280: Allow custom scripts to be executed
• JS-284: Inline question within a Not Asked question causes empty page
• JS-287: No longer hide questionnaire when Submit pressed
• JS-288: SOI signature slow to be enabled
• JS-289: Must answer quantity sliders showing as error at start
• SOE-327: Variable references in initial value fields updated correctly when new variable inserted
• SOE-331: Prevent order of language variable being changed
• SOE-337: Stop question text being repeated in open series grids
• SOE-344: Question text lost in multi language survey when routing added
• SOE-345: Paste text only when copying from Word
• SD-510: Prevent crash with quotas containing a weight
• SD-511: Fix Done and Cancel buttons on data import (for when quotas are present)
• SD-512: Recompile group variables based on a range of variables when new variables present in the range
• SD-516: Variables with an initial value cannot be used in a db import
• SD-517: Rim weights not rebuilding correctly

Build 1.0.0.1301

Release date: 24^th August 2023

Features

• SOL-4888: Ability to create and save analyses via browser
• SOL-4618: Add report label to clickable link for each report
• JS-175: Random question order enhancements

Fixes

• SOL-4947: Report title potentially incorrect when run within Snap XMP Online
• SOL-4948: Handle large amounts of AttachIt data for downloading
• SOL_4953: Error when exporting large amount of CSV data
• SOL-4954: id.name lost on Close using the Legacy interviewer
• SOL-4967: Improve layout of password rules
• JS-132: Reduce flicker when questions transition in due to routing
• JS-235: Reduce size of published output
• JS-272: Set forward ordering to start on random code
• JS-274: Improve accessibility publish
• SOE-257: Improve grid re-arranging
• SOE-314: Fix 10 code semantic scale layout issue
• SOE-330: Allow all characters for hyperlink text
• SOE-333: Handle Greek characters correctly

Build 1.0.0.1292

Release date: 2nd June 2023

Features

• SOL-4742: Merge shared area into main survey tree view

Fixes

• SOL-4283: Redirect to log in page when log in times out on Analyze tab
• SOL-4752: Add option to be able to keep partials for quota/screen out
• SOL-4868: Option to keep partials when quota full hit working with JSI
• SOL-4887: Password Reset link generated by Admin does not work
• SOL-4890: Add username to reset password email text
• SOL-4894: Quota performance improvements when under high load
• SOL-4909/4915: improve performance of New survey dialog and Sync
• SOL-4910: Summary dashboard reports no pdf when not required
• SOL-4914: allow seeding on group survey landing page
• JS-18: variable response properties not working in open series literals
• JS-56: calculated values to show number of dps specified
• JS-73: improve performance of surveys with large amounts of code masking
• JS-208: alignment issues with compound grids when hiding/unhiding parts
• JS-209: inline attachIt option not showing as expected
• JS-246: Drag and drop rank allowed respondent to select more options than designed
• JS-241: alpha ordering not applied to inline questions

Build 1.0.0.1288

Release date: 4^th April 2023

Fixes

• SOL-4921: Anonymous SMTP fails when server supports authentication
• SOL-4928: Remove refs to OPTIMIZE_FOR_SEQUENTIAL_KEY as not supported on less than SQL 2019

Build 1.0.0.1284

Release date: 3rd January 2023

Features

• SOI Quotas now available with this release of SOL
• SOL-4809/4819/4845: Connectors (This is the updatesurvey.asp replacement)
• SOL-4701 – Update colors to improve accessibility in the user interface
• SOL-4752 – Allow Researcher to optionally keep partials for quota-ed or screen-ed out survey
• SOL-4757 – Add ability to configure CSP and X-SSS to main Snap XMP Online site
• SOL-4764 – Browser tab for screenout to be labelled Screen out
• SOL-4820 – Allow multiple accounts to trust the same browser
• SOL-4838 – Allow admin to reset trusted devices for a user
• SOL-4852 – Add MFA usage to audit trail
• SOL-4856 – Add in Payment Ref to a licence so on import the payment ref can be set AND limit the number of times a link can be used
• SOE-176 – Inline spell checker alert (Chrome, Edge)
• SOE-292 – Handle Compound Grids added via Snap XMP Desktop

Fixes

• SOL-4488 – Validation added to text entry in Admin areas
• SOL-4573 – Keep responses when flipping between Standard and Plain versions (w3c)
• SOL-4656 – Group questionnaire: second import disables invites on participant where a subject has changed or been added (and possibly deleted)
• SOL-4697 – Some characters (e.g. new line) in quota full message cause problems with JSI
• SOL-4765 – Fail to process some emails returned to Snap XMP Online
• SOL-4774 – Update AttachIt including old JQuery dependency (requires Snap XMP Desktop 12.12)
• SOL-4812 – MFA UX issues
• SOL-4813 – Print button not working if custom domain and JSI
• SOL-4832 – Consistent participant status between legacy and JSI
• SOL-4834 – Participant import, delete option can fail when seeding incorrect
• SOL-4837 – Remove trusted device list and do not require user to specify one
• SOL-4842 – Improve look of MFA code dialog when errors show
• SOL-4853 – Maintain JSI zip after each download for next attempt
• SOL-4854 – Audit record for closed partials incorrect if > 50 partials being closed
• SOL-4855 – Read Email job always reporting 0 emails processed (SOL 1260 onwards only)
• JS-155 – Print button not working on single page questionnaires
• JS-208 – Spacing issue if ‘Space before’ used with Compound grid and routing
• JS-219 – Seeded with hidden language editions can show wrong language
• JS-220 – Missing response data in partial when drop down style used
• JS-222 – Carousels with large amounts of question text overlap boxes
• JS-224 – Masking in plain text version causes codes to not show
• JS-226 – Text box loses focus (requires double click)
• SOE-132 – Variable reference lost when new question added
• SOE-237 – Variable reference potentially causing corrupt survey on save
• SOE-279 – Survey fails to save due to routing

Build 1.0.0.1260

Release date: 20^th October 2022

Features

• JS-186: Inline questions
• SOL-4722: Multi Factor Authentication added
• SOL-4722: Password complexity setup via admin UI
• SOL-4756: Support for POP3/IMAP Office 365 Exchange Online OAUTH certificate-based authentication
• API: GetSurveyList and GetSurvey have a new property called ResponsesLastChanged that contains the timestamp showing when the responses were last changed.

Fixes

• SOL-4550: Share context not used for determining code list in filter/context
• SOL-4590: Optional for questionnaire SNIF is stored in the database
• SOL-4616: Pending activation list is limited to showing 10 accounts
• SOL-4634: Some characters can cause problem with export of data to Excel
• SOL-4664: Identify survey in bounce back email
• SOL-4724: Admin edit of account can lose some account data
• SOL-4746: SMTP 500 errors don’t need to be tried again
• SOL-4750: Switching to text only version turns partials off
• SOL-4770: Double quotes in filter expression fails
• SOL-4771: IMAP connection not secure
• SOL-4772: SNIF extraction on demand for Online Editor
• SOL-4780: Stop Admin browsing affecting user’s ‘Recent list’
• SOL-4785: Webpage on submit causes pop up if custom domain
• SOL-4787: Dashboard Summary report doesn’t work for a shared user
• JS-131: ‘use steps’ option for sliders respected
• JS-152: Carousel grid not always showing code labels
• JS-166: Compound grids
• JS-176: Preserve random order of codes on Save
• JS-182: Initial value shows up as answered twice in partial
• JS-185: Carousel grid changes for right to left languages
• JS-189: Updated version of jQuery
• JS-197: Multi choice drag and drop grid fixes
• SOE-142: Preview of drop downs fixes
• SOE-242: Preview of Data picker fixes
• SOE-293: Preview option removed from Editor

Build 1.0.0.1205

Release date: 16^th May 2022

Features

• SOL-4347: reCAPTCHA can be added to reset the password and account creation pages. Configuration is required in machinespecific.config (FMSMVC)

Fixes

• SOL-4729: Stop storing the ‘Data’ in the Responses table if the source is Snap XMPDesktop
• SOL-4738: Invites stopped incorrectly on a survey when too many concurrent connections
• SOL-4379: SMTP connections not always disposed of as soon as can be
• SOL-4740: Close partials job can block other jobs when large numbers of partials to close
• JS-8: Rating check with routing on grid doesn’t allow the grid questions to be answered. (This requires the latest Interviewer and Snap XMP Desktop updates for complete release)
• JS-49: Resume partial to start on page in error (if necessary)

Build 1.0.0.1171

Release date: 7^th February 2022

Features

• SOE-254: Support for Sliders added
• SOL-4565: Support for multi response context values
• SOL-4618: Report title shown as tool tip
• SOL-4677: Support for new (beta) interviewer in Qwizards online

Fixes

• JS-22: No read only calculated source can show as 0
• JS-138: Fix for multi line AttachIt question
• JS-143: Customisation possible of error message for Valid property
• JS-144: Auto answer on masked question set incorrectly
• JS-145: Too many decimal places sometimes displayed on derived variable
• JS-146: Error in calculation following variable with Max responses property set
• JS-151: Initial value set to an exclusive code could be removed when using Back button
• JS-153: Grids in Safari browser sometimes failed to display
• SOL-4315: Email alerts with AttachIt attachments now handled correctly
• SOL-4526: Error shown to user when no valid licence on cloning
• SOL-4550: Share context not applied for determining code list for filters/contexts 
• SOL-4568: Reset participant invite status after email address corrected
• SOL-4588: Revise ordering of seeding screen on Participant import
• SOL-4596: RGB colours converted to RGBA on save in email invite
• SOL-4622: Adding or editing a subject on a Group questionnaire within Snap XMP Online would break seeding for the first subject
• SOL-4623: Web page on submit seeding not handled correctly
• SOL-4666: Improve performance of email reader and enhance error logging
• SOL-4684: Change wording of invite schedule when invites are disabled
• SOL-4685: Better display of survey status messages on mobile devices
• SOL-4690: Fix for Restart button not working
• SOL-4698: Mailing status added to top line
• SOL-4710: Partials not working as expected for Group questionnaire

Build 1.0.0.1104

Release date: 4^th October 2021

Features

• SOL-4389: API v1 (permission based so needs to be enabled for each account)
• SOL-4542: New button added to allow userAdmin to generate a reset Password link manually
• SOL-4553: Separate licence defaults for when Admin creates account
• SOL-4585: Option to update survey licences when template licence updated
• SOL-4608: Quotas
• SOL-4648: Include created time in Participant export
• JS-94: Image map accessibility enhancements JS-108: Slider bar accessibility enhancements

Fixes

• SOL-4072: Set default session timeout to be 59 mins
• SOL-4331: Handle surveys with only paper editions
• SOL-4491: More helpful error message when creating an account that’s been deleted or purged
• SOL-4492: Social media links added to Collect page
• SOL-4494: QR code to use custom URL
• SOL-4538: Stop using iFrame unless its custom domain
• SOL-4539: Set custom URL token to original value if you clear it
• SOL-4545: Survey name can contain invalid characters when you clone a survey
• SOL-4549: Make choosing worksheet number more obvious in Participant upload dialog
• SOL-4555: Use account’s Full name when no Email from name set for invitations
• SOL-4558: Participant import performance improvements
• SOL-4575: Add option to disable checks in mailer for certificate revocation
• SOL-4577: Handle id.name variable rename
• SOL-4579: Sort order added for Group questionnaire list as seen by Participant
• SOL-4601: Trim leading and trailing spaces from ‘subject’ for group questionnaires
• SOL-4612: Logged in survey completion rate incorrect
• SOL-4617: Participants cannot be added via UI
• SOL-4629: More validation required on email address when sharing (plus trim spaces)
• SOL-4654: Crash adding a new participant to an invite only survey
• SOE-145: Drop downs now working in Editor preview
• SOE-165: Code ordering now working on Editor preview 
• SOE-208: More…dialog cut off
• SOE-222: Placeholder text would sometimes remain in Firefox
• SOE_225: Footnote in wrong position when masking is on
• SOE-246: Grid of open ended quantity questions incorrect size
• JS-20: Closing the attachIt dialog would show an error in IE11 
• JS-20: Native data pickers in SOI
• JS-39/SOE-216: Alpha ordering with mask and other question problem
• JS_90: Footnote appears in wrong place when mask also applied to the variable
• JS-91: Routing not working when variable in error state
• JS-92: Start date/time incorrect
• JS-95: Wrong format for dates in initial/seeded values
• JS-113: Error message not visible when question overflows viewport
• JS-119: Long initial values could cause crash
• JS-120: Build preview does not reload on browser refresh
• JS-124: Grid of notes would crash
• JS-123: Cater for seeding/ restoring values when initial value

Build 1.0.0.1065

Release date: 21st June 2021

Features

• Survey response profile graphs added
• SOL-4562: Delete mode added to Upload Participants 
• SOE-122: Rating check feature added to Online Editor
• JSI-32:Support for partials

Fixes

• SOL-4558: Participant import re-write adjustments – batch up within SQL to improve performance / only allow 1 update from Desktop at a time
• SOL-4560: Warn user the schedule will be cleared if they manually stop a survey
• SOL-4578: Error shown when survey with custom login page paused
• SOL-4591: Allow participant reminder to have an interval set to 0
• SOL-4598: Participant wizard can time out when uploading a large spreadsheet
• SOL-4550: Share context not used for determining code list in filters/contexts in Analyze
• SOL-4555: use account’s Full name when no Email from name set for invitations
• SOL-4559: Participant overview ‘started’ and ‘completion rates’ inaccurate for group survey
• SOL-4554: Group Questionnaires don’t work when there is an apostrophe in the subject
• SOL-4534: Adding a / or : in Subject line of an email results in error
• SOE-217: Mutually exclusive option doesn’t show
• SOE-224:  Editor preview doesn’t show initial values
• SOE-229: Grid questions have code exclude lists set up on 2nd, 3rd etc row
• SOE-234: grid attributes text overlaps content
• SOE-235: Page breaks not handled correctly in Editor preview
• SOE-169: Auto renumber option not respected in Editor
• JS-8: Added option to unselect option for Rating Check
• JS-31: Support for Restart button in SOI
• JS-45: Prevent double submit from occurring
• JS-109: Support for Close button in SOI
• JS-20: data pickers not working
• JS-38: Handling for read only variables
• JS-107: Id.completed not set on submit
• JS-83: All paradata handling

Build 1.0.0.999

Release date: 7^th December 2020

Features

• SOL-4479: Allow surveys created from Survey templates to be sync’d between Snap XMP Desktop and Snap XMP Online
• SOL-4506: Customisable options available when exporting data from Snap XMP Online

Fixes

• SOL-4331: Handle surveys with only paper editions
• SOL-4420: Entering HTML in text fields can crash dialog or page
• SOL-4470: Build tab tooltip restyled to make it easier to read and not overlap
• SOL-4507: Filter issue when Survey set to US date format
• SOL-4510: Handle email bounce backs
• SOL-4511: Filter Participant by status displays empty list
• SOL-4520: Survey mailing stopped on failure to send 1 invite
• SOE-123: Text substitution not working in Editor Preview
• SOE-189: Add a footnote to a Single and it disappears after a reload
• SOE-205: Open ended questions only accept 1 character in Build | Preview 
• SOE-209: Setting the Initial value for a literal can throw up an error or cause the survey to not save
• SOE-221: Hard to set a semantic scale to have 10 codes
• JS-96: Footnotes on grids fixed

The post On-Premises Snap XMP Online release notes appeared first on SnapSurveys.

Shares can also be added directly to the subfolders, surveys and survey templates. The sharing set at the subfolder, survey or survey template level takes priority over the parent folder level security.

When you remove access at subfolder, survey or survey template level then the folder level sharing is used again. If you intend to remove access for a shared user then check that the inherited sharing from the parent folder level will not still give access.

Example – adding and removing sharing at survey level

1. Log in to Snap XMP Online and Your work is the first page shown. If you are already logged into Snap XMP Online, click Home to return to Your work.
2. Select the folder you want to share and create a share as described in How to share a folder.
3. The new user is displayed in the Shares list for the folder.

4. In the Shares tab, the Permissions column shows you where the share is set. As the following example shows the survey share is inherited from the folder called Conference surveys.

.

5. Select a survey that is in the parent folder and create a share as described in How to share a survey or template. Here a share for the same user has been created but with the Permission set to Interviewer. The selection box is shown on the left hand side as the shared user was created at the survey level. These permissions override those set at the folder level and in this example, the user can access this survey as an Interviewer.

6. Select the user and click Remove. This removes the sharing at the survey level and reinstates the inherited sharing from the parent folder.