Feature Flags

Feature Flags

DXP 7.4 U69+/GA69+

Some features in Liferay are hidden behind feature flags. Using feature flags, you have control over new functionality introduced into your Liferay instance. New and experimental features can be adopted and validated more effectively with feature flags.

To access and manage feature flags, open the Global Menu (Global Menu) and navigate to Control PanelInstance Settings. Click Feature Flags under Platform. There are three types of feature flags available:

  1. Beta feature flags

  2. Release feature flags

  3. Dev feature flags

You can use feature flags to control the visibility of features.

The documentation for a beta feature includes a badge to set it apart:

The documentation for a beta feature includes a badge.

Beta Feature Flags

Beta features are functional features or capabilities undergoing business validation. These are experimental and require careful consideration before usage. Beta features may be deprecated after a limited time period or converted into a release feature. You can give feedback on beta features through Liferay’s Community Slack.

To enable a beta feature,

  1. Open the Global Menu (Global Menu) and navigate to Control PanelInstance Settings.

  2. Click Feature Flags under Platform, then click Beta.

  3. All beta features appear. Toggle to enable or disable a feature.

You can also use the search bar to find beta features, sort them using the Sort (Sort) button, or filter them based on their status.

You can search, sort, or filter beta features.

Release Feature Flags

Release features are fully functional, but remain hidden behind a flag for a limited time. The flag allows you to control the visibility of a new feature and enable it when ready.

To enable a release feature,

  1. Open the Global Menu (Global Menu) and navigate to Control PanelInstance Settings.

  2. Click Feature Flags under Platform, then click Release.

  3. All release features are listed. Toggle to enable or disable a feature.

You can also use the search bar to find release features, sort them using the Sort (Sort) button, or filter them based on their status. The flag for release features is removed after a period of time, so monitor the release notes for your Liferay update.

You can search, sort, or filter release features.

Dev Feature Flags

Dev feature flags are for features and capabilities in active development, and you must not enable them in production. Only enable dev features for testing.

To enable a theoretical dev feature flag with the code XXX-000000 using a portal property, add this to portal-ext.properties:

feature.flag.XXX-000000=true

To enable a theoretical dev feature flag with the code XXX-000000 using an environment variable, add this to your configuration:

LIFERAY_FEATURE_PERIOD_FLAG_PERIOD__UPPERCASEX__UPPERCASEX__UPPERCASEX__MINUS__NUMBER0__NUMBER0__NUMBER0__NUMBER0__NUMBER0__NUMBER0_=true
warning

Never use dev features in production. Instabilities in Liferay are expected side effects of enabling dev feature flags.