Custom parameters

Digital is a dynamic environment that includes features such as custom parameters to enrich the survey feedback. A custom parameter is a reference to information on your website or mobile app, and collects data exposed on the front-end of the site about the customer's identification and attributes such as their purchases or behavior. Use custom parameters to:

  • collect data when a survey is submitted

  • trigger invitations to provide feedback according to specific data

Custom parameters are often used with a dataLayer object that has been added by a web developer, or a tool such as Google Tag Manager or Adobe Analytics.

By default, all Custom parameters are automatically set up as text q-fields in Medallia Experience Cloud. Custom parameters can be shared across forms but not across properties. Custom parameters can be added to dashboards, but are not assigned by default.

Document audience and usage

This document assumes that you have an understanding of basic JavaScript programming concepts and variable storage, browsers and cookies, and the structure of URLs. This document is not an instructional or general guide to programming or browser technology. Examples provided are specific to the most commonly requested solutions. This document provides guidance on how to add or change custom parameters. Consult your Medallia expert for specific requirements.

See the following topics for details on custom parameters:

Data collection examples

A custom parameter collects information from a website or mobile app and adds it to the feedback collected. For example, if a webpage displays the username for a logged-in user, a custom parameter could store this information instead of asking the user to provide that information during survey submission. This is useful when a webpage includes data that can provide more information about a user or add to the context and information about the customer's experience at the time of survey submission.

For an online shopping page, when a customer leaves feedback, use custom parameters to understand any or all of the following items:

  • Did the user place anything in the cart?

  • What is the value of the cart?

  • How many items are in the cart?

  • Is the customer logged in?

  • Is the customer a specific type of customer, such as bronze, silver, gold, or platinum?

  • Is there a specific campaign ID or transaction information?

If a custom parameter is attached to a survey, the feedback item contains a new section and a new field when the feedback is received. The custom parameter does not add a field to the survey.

The following lists some examples of how custom parameters can be used in different industries:

  • eCommerce/retail - Cart value, loyalty, products viewed or purchased

  • Insurance - Member type, group number

  • Travel hospitality - Confirmation code, loyalty ID

Trigger examples

In a similar way that a custom parameter can provide additional information when a survey is submitted, a custom parameter can also be used to define when a survey is triggered. For example, on a webpage that exposes information related to specific types of customers (such as bronze, silver, gold, or platinum), set up a custom parameter to capture this information. This custom parameter can then be used for targeting.

Custom parameter types

Custom parameters can collect data from the following origins:

  • JavaScript variable, for example declared in a script. A JavaScript variable in a dataLayer is preferred and cannot be in an array. See Website dataLayer.

  • Cookie, for example created using Google Tag Manager or Adobe Analytics.

  • URL parameters, for example after the "?" character in example.com/?search=heatedBlanket&color=Blue are two parameters - search and color.

The JavaScript variable or cookie must be exposed or accessible by Digital. Usually your web team provide the specific information about how your origin is configured.

The following is an example of a JavaScript variable created by Adobe Analytics:

  • s_obj - Default variable containing the Adobe Analytics data and eVars (e.g., s_obj.eVar1).

Some JavaScript variables are built in to the browser. These can be useful for configuring various trigger rules.

Variable nameDescription
document.location.hostDomain portion of a URL (e.g., www.company.com).
document.location.hrefFull URL (e.g., https://company.com/path1/path2).
document.location.pathnamePath portion of a URL (e.g., /path1/path2).
document.referrerURL of the document that loaded the current document.

Reusing custom parameters

For every data point created in Digital there is a corresponding field in the Medallia Experience Cloud reporting module. This is true for survey components as well as custom parameters. Reusing a custom parameter means the same reporting field mapping can be used across all properties in the account. Use the self-service reusable custom parameter fields to:

  • Determine if the custom parameter is mapped to an existing reporting field or create a new reporting field.
  • Administrators can configure a new or existing custom parameter to be reused in other properties within the account. See Adding custom parameters.

Note the following important features of reusing custom parameters:

  • All Digital custom parameters are defined in reporting fields as Q-Fields of type "Text".
  • It is not possible to map two custom parameters within the same property to the same report field as it could cause data inconsistencies.
  • It is only possible to use self-service mapping to fields that have been created in Digital. To map custom parameters to fields that were previously created in the Admin suite please contact your Medallia Digital Expert.