Custom fields in Feature Experimentation

  • Updated
  • Optimizely Feature Experimentation

Custom fields add required or optional metadata to flags, going beyond standard properties like name, key, and description. When you require collaborators to enter these fields during flag creation or editing, you add structure and accountability to your workflow.

Use custom fields to do the following:

  • Capture domain-specific details such as Jira links, page names, or categories.
  • Improve reporting and tracking across projects.
  • Filter, sort, and group flags for quick access and better discoverability.

Custom fields make it easier to manage experiments and flags at scale.

Benefits of custom fields

Custom fields provide the following benefits for managing and scaling experimentation programs:

  • Organization and clarity – Categorize experiments and flags for easier management and improved discoverability through enhanced filtering.
  • Improved insights – Use custom fields in dashboards and reports to analyze impact across multiple dimensions.
  • Scalability and efficiency – Provide structured tagging to reduce duplicate experiments and minimize configuration errors in large organizations.
  • Enhanced collaboration – Promote a unified approach to experimentation across teams and simplify experiment reviews with consistent metadata.

Create custom fields

  1. Go to Settings > Fields.

    screenshot of the Settings > Fields page listing custom fields
  2. Click Create Custom Field.
  3. Enter a Name for the custom field and, optionally, a Description.
  4. Select the Make this field required checkbox to require collaborators to enter a value when they create a flag through the Feature Experimentation UI or the Create feature flags REST API.

    The Entities drop-down list shows that the custom field applies at the Flags level. For details on configuring custom fields, see Manage flags

  5. Select the Type of custom field. The type controls what collaborators can enter or select when they fill in the field on a flag.
    • Label – A predefined list of values. Select Allow multi-select to permit multiple selections.
    • Text – Free-form text. Set a Character Limit to restrict the number of characters allowed.
    • Numerical – A number within a range you define. Set the range, specify decimal places, and choose whether to format thousands with a comma separator.
    • Link – Any URL.
    • Boolean – A true or false selection.
  6. Click Create Custom Field to save the field.

    Screenshot of the Create Custom Field dialog with Name, Description, and Type fields

Edit custom fields

Go to Settings > Fields.

The Fields page lists all custom fields. Use the search bar to find a field by name or key. Filter by Type or Status using the drop-down lists.

Click More (...) > Edit for the field you want to edit.

Screenshot of the Fields page showing the More menu with Edit and Archive options

Make the necessary changes and click Save.

You can only edit the Name and Description of a custom field.

Archive custom fields

Archive a custom field to remove it from the list of custom fields.

Optimizely Feature Experimentation retains your custom field data so you can unarchive it later.

  1. Go to Settings > Fields.
  2. Click More (...) for the field.
  3. Click Archive.

Unarchive custom fields

To unarchive a field, complete the following steps:

  1. Go to Settings > Fields.
  2. Select Archived for the Status.
  3. Click More (...) for the field.
  4. Click Unarchive

    Screenshot of the Fields page showing the More menu with the Unarchive option

Custom fields on the Flags Dashboard

To display the custom fields you created in the previous step, on the Custom Flags Dashboard complete the following steps:

  1. Go to Flags.
  2. Click Show/Hide Columns

    Screenshot of the Flags page with Show/Hide columns highlighted
  3. Click the Column tab.
  4. Select your custom fields.
  5. Click Close or anywhere outside the Table Options section to save your selection.

Feature Experimentation displays the custom fields you select in a column.

Flags page with the Page column highlighted

After they are displayed, you can use custom field columns to filter and sort flags on the dashboard. For details on setting custom field values, see Update custom fields. For details on what Feature Experimentation displays on the Flags Dashboard, see Custom Flags Dashboard.