mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
ab24264df9
<!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> This is a demo that uses [Floe](https://www.floe.dev/) to review the `how-to` directory using the `spelling-and-grammar` rule. You can read more about the tool here: https://www.floe.dev/docs
33 lines
2.2 KiB
Markdown
33 lines
2.2 KiB
Markdown
---
|
|
title: How to define custom context fields
|
|
---
|
|
|
|
:::info Availability
|
|
|
|
|
|
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](../reference/unleash-context.md#custom-context-fields). You can use custom context fields for [strategy constraints](../reference/strategy-constraints.md) and for [custom stickiness calculations](../reference/stickiness.md#custom-stickiness). If there are [standard Unleash Context fields](../reference/unleash-context.md#structure) 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 {#step-1-navigate-to-context-fields}
|
|
|
|
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.
|
|
|
|
|
|
|
|
3. On the context fields page, click the "add new context field" button.
|
|
|
|
|
|
|
|
## Step 2: Define the new context field {#step-2-define-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](../reference/unleash-context.md#custom-context-fields) 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.
|
|
|
|
|