Feature flag settings

4 minute read

Each feature flag in a specific environment has its own setting options. You can provide a description, define variations for string or numerical values which cannot be predetermined, set the stickiness property, add labels for organization, and clone or hide a flag.

Because flag settings are specific to each environment, a flag in the production environment can have a different label from the same flag in your test environment.

To modify flag settings:

  1. From the CloudBees Feature Management Home page, select Flags in environments, and then select an environment.

  2. Select a flag, and then select the Settings tab.

    The flag settings tab
    Figure 1. The flag Settings tab
    All feature flags settings are environment-specific.

Feature flag settings include:

  • Feature flag description, to include any information on this flag in this environment.

  • Feature flag variations (only for number or string-based flags)

  • Feature flag label

  • Feature flag stickiness property

  • Clone feature flag to an environment

  • Hide or unhide feature flag

When editing the settings, your modifications are saved automatically.

Defining feature flag variations

For string or number flags, you can add or remove variations from the feature flag setting tab.

To define feature flag variations:

  1. From the CloudBees Feature Management Home page, in the left pane, select the environment.

  2. Select a flag, and then select the Settings tab.

  3. Select Variations > Edit.

  4. Delete Variation by selecting the garbage icon.

  5. Select + Add another variation to add another possible value.

You can only remove variants that are not actively being used in the Configuration screen.

When setting the configuration for a number or string flag, you can configure predefined variations or free text as targeting values. Variations are useful when you have string or numerical values which cannot be predetermined, such as a timeout value or URL. Set it to off in order to use free text within the targeting screen.

Working with labels

Labels help you categorize and mark feature flags, and can assist you in organizing different stakeholders, different deployment types, or any external marking of feature flags. For example, you can label a flag with the name of a specific CloudBees Feature Management team that manages the flag.

To learn how you can filter for a specific label, refer to Filtering flags. You can add any number of labels to a feature flag.

To create a label:

  1. From the CloudBees Feature Management Home page, in the left pane, select App Settings > Labels.

  2. Select Add new label.

  3. Enter a name and an optional description.

  4. Select Create Label.

Your label is available to be added to feature flags.

To add a label to a feature flag:

  1. From the CloudBees Feature Management Home page, in the left pane, select the environment.

  2. Select a flag, and then select the Settings tab.

  3. Select the label from the options, or enter a new name.

Your label is added to the flag.

You can remove a label from a flag by selecting the "X" next to the label name.

Working with the stickiness property

The Stickiness Property determines the property that is the basis for stickiness behavior for a particular feature flag.

The default value for the Stickiness Property is distinct_id, which is a UUID generated by the end device, or a randomly generated number in the server side SDK. The distinct_id is stored on the local storage of the device.

The Stickiness Property is used by CloudBees Feature Management to determine what value a user should get when splitting values. For more information, refer to How split by percentage works.

For example, if you select userId as the Stickiness Property, the userId has consistent behavior on all devices. Alternatively, if you select account_id as the Stickiness Property, all users in the same account experience consistent behavior.

Modifying the stickiness property

To update the default (distinct_id) Stickiness Property:

  1. From the CloudBees Feature Management Home page, in the left pane, select the environment.

  2. Select a flag, and then select the Settings tab.

  3. Select Edit to the right of Stickiness Property.

  4. Select a Stickiness Property from the options.

  5. Select Update property.

The Stickiness Property is updated for your flag.

If a user deletes the application, a new distinct_id is generated when a new application is created.

Cloning a flag configuration

Cloning a flag configuration overrides the destination flag configuration.

Cloning a flag configuration copies a feature flag’s rules, targeting state, and hidden/visible state to override the flag configuration in another environment. Cloning enables you to efficiently set up a flag configuration in a different environment.

You need to have Full access permission to the destination environment to clone a flag configuration.

A flag configuration can only be cloned to the flag of the same name in the destination environment. Cloning a flag configuration does not create a new flag.

To clone a flag configuration to another environment:

  1. From the CloudBees Feature Management Home page, select Flags in environments, and then select an environment.

  2. Select the three vertical dots to the right of the flag you want to clone, and then select Clone to environment.

    Cloning from the environment
    Figure 2. Cloning a flag configuration from the environment
    Alternatively, select Settings and review the flag configuration, and then select Clone to environment.
    Cloning from settings
    Figure 3. Cloning a flag configuration from the flag Settings tab
  3. Select the destination environment.

  4. Select Override flag.

The flag configuration is cloned, and opens on Audience in the destination environment. The destination environment configuration is overridden.

Hiding and unhiding a feature flag

Each feature flag can be either in a visible or hidden mode. Hidden feature flags are flags you cannot or will not remove from the code, but do not want displayed in the environment flag list.

  • Hiding a feature flag does not affect the feature flag aside from listing it on the hidden feature flags tab.

  • When a feature flag is hidden, you can unhide it from the feature flag Settings tab.