Skip to main content

How to define custom context fields


Before Unleash 4.16, custom context fields were only available to Unleash Pro and Enterprise users. From 4.16 onwards, they're available to everyone. They were introduced in Unleash 3.2.28.

This guide shows you how to create custom context field for the Unleash Context. You can use custom context fields for strategy constraints and for custom stickiness calculations. If there are standard Unleash Context fields missing from the context fields page, you can use the same steps to add them too.

Step 1: Navigate to the context field creation form

In the Unleash Admin UI, navigate to the context fields page:

  1. Click the "Configure" button in the top menu to open the configuration dropdown menu.

  2. Click the "Context fields" menu item.

    A visual representation of the tutorial steps described in the preceding paragraph, showing the interaction points in the admin UI in order.

  3. On the context fields page, click the "add new context field" button.

    The "context fields" page with the "add new context field" button highlighted.

Step 2: Define the new context field

Define the custom context field by filling out the form. You must at least give the field a unique name. Everything else is optional. Refer to the custom context field reference guide for a full overview of the parameters and their functions and requirements.

When you are satisfied with the context field's values, use the "create" button to submit the form and save the context field.

A "create context field" form. It contains data for a custom context field called "region". Its description is "allows you to constrain on specific regions" and its legal values are "Africa", "Asia", "Europe", and "North America". Its custom stickiness value is not shown.