Feature Flags
Overview
Feature flags allow you to enable or disable new features in Fynapse.
How Do Feature Flags Work?
When a new feature is released, it is by default disabled in the vNext and vCurrent environments. This allows you to decide when you want to start testing how the feature will affect your existing configuration and business logic.
If, after consulting with the release documentation to assess the impact on your configuration, you want to start testing the new feature, you can enable it using the feature flag.
The feature flag has to be enabled in each environment separately to enable the feature.
When Does a New Feature Stop Being Elective?
You will be able to enable and disable a new feature for a period of 4 weeks, starting from the day the feature was released.
Feature Flags Screen
You can view the list of feature flags available in Fynapse by going to the Feature Flags screen, available in the Configuration section. Here you can also enable and disable available feature flags and view the audit log of who and when enabled or disabled a feature flag.
If there are no feature flags currently available in Fynapse, the screen will be empty.
Audit Log
You can check who and when enabled or disabled a feature flag, or when it was permanently enabled by going to the audit log.
Go to Configuration > Feature Flags and click the Related button from the expanded list and select Audit log.
The Audit log grid comprises the following information:
- Flag name - name of the flag the state of which was changed
- Username - name of the user who changed the state of the feature flag
- Changed on - timestamp of when the state of the flag was changed
- Logs - depicts the current state of a feature flag:
- DEFAULT OFF - the feature flag is by default disabled, this is the initial state of each new feature flag
- DEFAULT ON - the feature flag is by default enabled, this occurs when a feature flag reaches maturity
- ON - the feature flag has been enabled
- OFF - the feature flag has been disabled
Tutorials
How to Enable a Feature Flag?
- Go to Configuration > Feature Flags.
- Click the Edit button.
- Select the feature flag you want to enable and check the checkbox.
- Click Save to enable the feature flag, or Cancel to discard your changes.
It may take a moment before a feature is available after enabling the feature flag. However, if it remains unavailable after a while, please refresh the screen or log out and log in again to Fynapse.
How to Disable a Feature Flag?
- Go to Configuration > Feature Flags.
- Click the Edit button.
- Select the feature flag you want to disable and check the checkbox.
- Click Save to disable the feature flag, or Cancel to discard your changes.
How to Enable/Disable Feature Flags in Configuration Data JSON File?
By default, all new features are disabled. They can be enabled either on the Feature Flags screen or in the Configuration Data JSON file.
Feature flags have unique names. In order to learn the names of the feature flags available in Fynapse, download the Configuration Data JSON file. In the featureFlags section of the file, the names will be listed.
-
To enable a feature flag, add it to your Configuration Data JSON file.
featureFlag1Nameis an example and not the name of an actual feature flag. -
Then go to Configuration > Bulk Operations > Configuration Data.
-
In the Upload configuration section, drag and drop the file or click the Select files button and select the file from the location on your computer.
-
Click the Upload button.
It may take a moment before a feature becomes available after enabling the feature flag. If it remains unavailable, refresh the screen or log out and log back in to Fynapse.