Custom Context Variables Overview

You can create custom context variables for Monetate's personalization engine to use for Automated Personalization experiences. See Engine Context for more information about how these distinct data points are used as well as how to change the context at the account level and at the experience level.

If you're an Engine API client, then you only need to use the monetate:context:CustomVariables event to pass custom context variables and their values to Monetate. For more information about this event, refer to the entry for monetate:context:CustomVariables in the API Models section of the Engine API documentation available in the Monetate platform settings.

If you're a Monetate JavaScript API client, then you must first set up the custom context variable using the Define a Custom Variable modal accessible from the Custom Variables list page in the Monetate platform. See Define a Custom Context Variable for the steps.

You must have the Engine Context — Custom Variables feature enabled for your account to access the Custom Variables list page. Contact your dedicated Customer Success Manager (CSM) to request that the feature be enabled.

After you've defined the variable, you can then pass it and its value using the setCustomVariables method.

Regardless of your Monetate implementation type, you do not need to define a custom variable in the Monetate platform before using it for WHO targets or for dynamic text in Content Builder and a variety of actions.

Custom Variables List Page

To access the Custom Variables list page, click COMPONENTS in the top navigation bar, and then select Custom Variables.

Callout of the Custom Variables option in the COMPONENTS menu

Like many list pages in the Monetate platform, the Custom Variables list page is a table that contains basic information for each custom variable defined in the account.

The Custom Variables list page

The search bar above the table on the left-hand side allows you to search for a word or phrase in the custom variable name and description fields. You can sort the table's contents by variable name in alphabetical or reverse alphabetical order at any time by clicking the NAME header. Sort the contents by creation date in chronological order or reverse chronological order by clicking the CREATION TIME header. Click TYPE to sort the contents by each variable's data type in alphabetical or reverse alphabetical order.

Callout of the NAME header, TYPE header, and CREATION TIME header of the table on the Custom Variables list page

The EXPERIENCE USAGE column shows the number of active and inactive experiences an action is part of or if the action is not used at all.

The count of active and inactive experiences doesn't differentiate between experiences to which a custom context variable was added at the experience level and those experiences that included it because the variable had been added to the Engine Context at the account level.

Callout of the EXPERIENCE USAGE column of the table on the Custom Variables list page

Click DEFINE CUSTOM VARIABLE to create a new custom context variable. See Define a Custom Context Variable for the steps.

Related Articles