Create Variables to Pass Data as URL Parameters

Create Variables to Pass Data as URL Parameters

Overview

Create variables as text, email, number, date or choice to pass data as URL parameters in your survey.

How to create variables to pass data as URL parameter fields:

  1. Select the survey and go to Builder > Settings > Variables.
                        
  1. Click Create Variable.
  2. Select source as URL Parameters. Click Next.
            
  1. Enter the details for the following fields:
    1. Variable Name: Enter the name of the variable. Variable names can’t contain spaces. Use only letters (A–Z, a–z), numbers (0–9), periods (.), underscores (_), and hyphens (-).
    2. Label: Enter a description for the variable. This variable label will be used throughout the survey to reference the variable.
    3. Type: Select the data format of the variables.
  2. Click Save.

 How to add a new variable to the URL parameter fields:

  1. Select the survey and go to Builder > Settings > Variables.
  2. Click the Edit icon next to URL Parameters.
            `
  1. Select source as URL Parameters. Click Next.
  2. Click Add Variable.
            
  1. Enter the details for the following fields:
    1. Variable Name: Enter the name of the variable. Variable names can’t contain spaces. Use only letters (A–Z, a–z), numbers (0–9), periods (.), underscores (_), and hyphens (-).
    2. Label: Enter a description for the variable. This variable label will be used throughout the survey to reference the variable.
    3. Type: Select the data format of the variables.
                        
  1. Click Save.

How to edit variable configuration for URL Parameter fields:

Add, delete or modify the variables to update the configuration when the data you pass changes. Rename the variable names, modify the labels as per latest requirements, mark variables as ePHI, or encrypt answers to mask information sent via URL.
  1. Select the survey and go to Builder > Settings > Variables. 
  2. Click on the Edit icon () next to the URL Parameters.
            
  1. Modify the variable names or labels as required. You can also encrypt variables or mark as Health Information.
            
  1. Click Save.

How to remove variables from URL parameter fields:

Modify URL Parameter configuration at any point to reflect the latest list of data that is being passed to the survey via URL parameters. You can add or remove variables from URL configuration to enable information transfer to the survey.
Select the survey and go to Builder > Settings > Variables. This displays the created URL Parameters variable configuration.
  1. Click on the Edit icon () next to the URL Parameters.
            
  1. Click the More options icon () next to the variable to be deleted, and click Delete.
            
  1. Click Save.
Notes
Note:
To modify the variable type, delete the variable and create a new one. 

How to delete variable configuration for URL Parameter fields

Delete variable configuration for URL Parameters when you no longer need it. Deleting this configuration will also permanently delete all its associated variables.
  1. Select the survey and go to Builder > Settings > Variables.
  2. Click on the Delete icon () next to the URL Parameters. Once confirmed click Delete.
Warning
All associated data in existing responses will be deleted. The deleted data cannot be restored.


Notes
Notes:
  1. The mapped variables will no longer be available in your survey.
  2. All associated data in existing responses will be deleted.
  3. Deleted data cannot be restored.