Dev guideAPI Reference
Dev guideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Manage flags and rules

Information on how to manage flags and rules in Optimizely Feature Experimentation.

The Flags dashboard gives you a view of what is happening to a flag and what rules are implemented for the flag.

🚧

Important

You see different user interfaces (UI) for flags and rules depending on your access.

Beta participants will experience the latest design, while others will continue with the current interface.

Flags

Archive flag

You can archive a flag to remove it from the list of flags. Archiving a flag also removes it from the datafile. See Manage flags section for information.

Optimizely Feature Experimentation keeps your flag and rule data so you can unarchive the flag later.

To archive a flag,

  1. Go to Flags.

  2. Click More options for the flag.

  3. Select Archive from the drop-down list.

    Click Actions > Archive.

Unarchive flag

To unarchive a flag:

  1. Go to to Flags.

  2. Click the Archived filter menu and select Yes.

  3. Click More options for the flag.

  4. Select Unarchive from the drop-down list.

    Filter by archived > more > unarchive

Beta

πŸ‘

Beta

Flag lifecycle management is in beta.

Rulesets can be in one of the following states:

  • Draft – Flag recently created and never enabled.
  • Running – Flag is enabled and running "On" in the selected environment.
  • Paused – Flag was previously turned on and now paused with any rules within not running or delivered to new users.

Start flag

  1. Go to Flags > select your flag with a paused ruleset.

  2. Select your environment.

  3. Click Run on the Ruleset.

    click run on the paused ruleset

Pause flag

  1. Go to Flags > select your flag with a running ruleset.

  2. Select your environment.

  3. Click Pause on the Ruleset.

    click pause on the running ruleset

Current interface

Turn a flag on or off

Toggling a flag on or off enables or disables all rules for the environment:

Toggle a flag on or off

Toggle a flag on or off


Rules

A rule contains the experiment and targeting logic within a flag. Rules describe what variation the flag should deliver to a given user. A ruleset is the collection of rules associated with a flag.

πŸ“˜

Note

You are limited to 100 rules per environment.

Duplicate rule across environments

To duplicate a rule across an environment, select Add Rule, click Copy rules from, and select which environment you want to copy the rules from.

copy rule from another environment

πŸ“˜

Note

Collaborators outside of your organization cannot create multiple experiments per flag. For information, see collaborators.

Manage flag rules

You can add, remove, or update your flag's rules anytime. But, it is advised to turn your flag off before making changes.

❗️

Warning

You should not change your experiment while it is running. For information, see Why you should not change a running experiment.

The following are configurable for rules:

  • Name
  • Description
  • Audiences
  • Traffic ramp percentage
  • Metrics
  • Traffic distribution mode
  • Variations
  • Exclusion groups

After you create a rule, you cannot change its key.

🚧

Important

Be careful when you are changing experiment parameters

DO NOT change your rule unless you are making the corresponding changes in your code. No traffic is sent to that experiment or variation if you use a key not referenced in your code.

To edit a flag rule:

  1. Click the rule name to open it.
  2. Change your rule parameters as desired.
  3. Click Save.

Changing your rules will update your project's datafile within a few seconds. Depending on how often you retrieve datafile updates, it may take some time before your experiments are updated in production.

If you want your rules to update in real-time, use webhooks to receive datafile updates.

❗

Warning

Changing traffic allocation or group assignment for a running experiment will impact user bucketing, causing users to be bucketed in or unbucketed from this experiment.

For information, refer to How bucketing works.

Beta

πŸ‘

Beta

Flag lifecycle management is in beta.

Rules can be in one of the following states:

  • Draft – Rule recently created and never enabled.
  • Ready to Run – Rule is enabled and ready to be delivered, but the associated ruleset is in Draft or Paused state and yet to be "On".
  • Running – Rule is enabled and running "On" in the selected environment.
  • Paused – Rule was previously running "On" but now was turned β€˜Off’ and paused.
  • Concluded – The experiment or targeted delivery has concluded, and no further action is necessary beyond reporting progress and delivering a winning variation.

Start a rule

Go to Flags > select your flag. Select the environment.

From the Ruleset:

  1. Click More options on the rule.
  2. Select Run.

From the rule details:

  1. Click on the rule.
  2. Click Run.

Stop a rule

Go to Flags > select your flag. Select the environment.

From the Ruleset:

  1. Click More options on the rule.
  2. Select Pause.

From the rule details:

  1. Click on the rule.
  2. Click More options.
  3. Click Pause.

Conclude rule

Go to Flags > select your flag. Select the environment.

From the Ruleset:

  1. Click More options on the rule.

  2. Select Conclude.

  3. On the Conclude page, select an option for the Results Outcome.

  4. (Optional) Add a brief conclusion about what you learned about the experiment.

  5. (Optional) Toggle Conclude and deploy on.

  6. Click Conclude.

From the rule details:

  1. Click on the rule.
  2. Click Conclude.
  3. Follow steps 3-6 from the previous From the Ruleset section.

If you toggled Conclude and deploy:

  1. Select which variation to direct traffic to from the Variation drop-down list.
  2. (Optional) Change the Traffic allocation percentage.
  3. Click Deploy.

Current interface

Reorder, copy, or delete rules

In the rules list, click More options on a rule to move it, create a copy of it in the current environment, or delete it. You can also drag and drop rules to rearrange them.

Move rules

πŸ“˜

Note

To duplicate experiment rules, you must not be on a free rollouts account.

Pause a rule

If you want to enable or disable individual rules within an environment, you can play or pause them:

Pause or play a rule

Pause or play a rule