Custom parameter based labels

Use custom parameters in survey component labels and descriptions

Custom parameters can be used to provide labels for survey form components, sometimes described as piping in a value. Unlike using custom parameters to collect additional data, this functionality uses the custom parameter as a value to populate the label and description.

For example, a BRAND_PARAM custom parameter could represent the location where a transaction took place. Use the custom parameter to populate a text field element's label with "This feedback is related to the ##BRAND_PARAM## store", where ##BRAND_PARAM## is replaced by the value of the custom parameter. The label shown on the survey retrieves this value from the custom parameter, such as "This feedback is related to the East London store".

Example of a survey form element label using a custom parameter based label.

Because there is the potential for the custom parameter to not provide a value, a default fallback label should also be configured. This label is displayed if the custom parameter does not return a value. Following the above example, the default fallback label could be "This feedback is related to my recent transaction".

Enabling custom parameter based labels

By default this functionality is not enabled. To enable it for a survey form:

  1. Open the survey form in the editor and navigate to Form settings. On the Advanced settings tab open the Custom parameters section.

    Form settings with the enable custom parameters in form display option set.
  2. Set the Enable custom parameters in form display option and save the changes.

Configure the custom parameter value

Before you can configure this feature, create a custom parameter that passes in the value. Usually this would be a text value, but it could also be a number. See setting up custom parameters.

For a survey form that has this feature enabled, in the survey editor, select the form element that should have a custom label or description. On the left side of the window there are additional options to customize the label and description.

Layer 112345
  1. Use custom parameters values toggles the feature on and off for this survey form element.
  2. Label defines the fallback text that is displayed for this element if the custom parameter is not defined or captured.
  3. Label with Custom Parameter values defines the text that is displayed for this element if the custom parameter is captured.
  4. Description defines the fallback text that is displayed for this element if the custom parameter is not defined or captured.
  5. Description with Custom Parameter values defines the text that is displayed for this element if the custom parameter is captured.

To use the custom parameter, click the plus sign in either Label with Custom Parameter values or Description with Custom Parameter values. The drop-down menu shows the custom parameters that have been assigned to this survey.

Example of the custom parameters that have been assigned to this survey.

Choose a custom parameter and its name is inserted into the value, surrounded by two hash (#) characters. For example ##BRAND_PARAM##. If the survey has a lot of assigned custom parameters, the list of custom parameters can be searched.

Alternatively, type the parameter name directly into the value including the surrounding hash characters. The value is verified and an error is shown if the custom parameter is not recognized or the syntax is not correct.

FAQs

Can you pipe-in custom parameters into TEXT elements in Digital surveys? No, this functionality only applies to labels and descriptions.

Why is my custom parameter not visible in the drop-down menu? The custom parameter must be assigned to the survey form before it can be used. See Enabling custom parameter based labels.

Can a piped-in custom parameter be transformed somehow? No there is no way to transform the custom parameter.