Profiles Deprecation

Prev Next

Starting with Platform 6, Profiles are deprecated. Platform 6 introduces a simplified configuration model based on environment variables and a platform.properties configuration file, replacing the legacy properties.json file and reducing the need for Profiles. For full details on the new configuration model, see Configuration Enhancements.

What Changed

In previous Platform releases, configuration was split between a properties.json file and a Profile stored in MongoDB. In Platform 6, configuration is consolidated into environment variables or a platform.properties file, and Profiles are no longer required.

The following Profile-related functionality has been deprecated:

  • The switchActiveProfile API is no longer available.
  • Switching the active profile through the Admin Essentials UI is no longer supported. Attempting to do so will return an error.
  • The "Applications", "Adapters", and "Indexing" tabs previously found on the Profiles page have been moved to the new Status page in Admin Essentials. The Profiles page now only contains profile property configuration.

What Still Works

Profiles can still be created and used for configurations that may change while the server is running. As of Platform 6, the only stateful property that requires a Profile is prebuiltProps.

When conflicting configuration values exist, Platform 6 resolves them in the following priority order:

  1. Environment Variable
  2. Configuration File
  3. Profile
  4. Default Value

For more information, see Platform Environment Variables and Configuration Enhancements.

Impact

Most users will not need to take any action. If your workflows and configuration do not depend on Profiles, no changes are required.

If you need to use a Profile — for example, to configure prebuiltProps for importing new Pre-Builts — you must set the active profile in your configuration file rather than through the UI:

  1. Add or uncomment the profile_id property in your platform.properties (or legacy iap.properties) file and set it to the name of your profile.
  2. Restart the Platform server for the change to take effect.

For step-by-step instructions, see Use Pre-Builts in Platform 6.

Updated Footer