Skip to main content

OML Profiles

Manage OML Profiles​

The OML Profiles section in Admin Settings allows administrators to manage OML profiles that define the vocabulary for specific concerns or domains. Each profile version is displayed as an individual card with its metadata and lifecycle status.

❗️info

This section provides an overview of existing profiles and enables import/export operations. For detailed information about profile concepts and structure, see Profiles.

Viewing OML Profiles​

The profiles overview displays all available profile versions as cards, showing:

  • Icon: Visual identifier from the profile specifications
  • Name: Display name of the profile
  • Description: Human-readable description
  • Version number: Semantic version (e.g., 1.0.0)
  • Status: Current lifecycle state (Draft, Published, or Deprecated)
  • Tags: Categorization tags for filtering and organization

Filtering OML Profiles​

Use status filters to control which profiles are displayed:

  • Draft (default: enabled): Profiles under development
  • Published (default: enabled): Released profiles available for use in baselines
  • Deprecated (default: disabled): Profiles no longer recommended

Adding a New OML Profile​

To add a new OML profile:

  1. Click the Add OML profile button
  2. In the sidebar that opens, upload a YAML file containing the OML profile definition
  3. Click Add to upload (or Cancel to abort)

Validation​

When adding an OML profile, the system validates:

  • File format: Must be a valid YAML file
  • Profile structure: The YAML must conform to the OML profile schema
  • Required fields: All mandatory profile attributes must be present

If validation fails, appropriate error messages are displayed.

❗️info

All newly added OML profiles start in Draft status.

Managing Profile Lifecycle​

Each OML profile card provides an overflow menu with the following operations:

Upload New File​

Icon: Upload Availability: Only when status is Draft

Allows you to replace the OML profile file with an updated version. Opens the same upload dialog as adding a new OML profile. Use this to iterate on a OML profile before publishing it.

Download File​

Icon: Download Availability: Always available

Downloads the profile YAML file to your local machine. Useful for:

  • Creating backups
  • Sharing OML profiles with other teams
  • Using as templates for new OML profiles
  • Version control and collaboration

Set Status to Published​

Icon: Rocket Availability: When status is Draft or Deprecated

Publishes the OML profile, making it available for use in project baselines.

Once published, an OML profile becomes immutable and cannot be modified or deleted.

⚠warning

Published OML profiles cannot be reverted to Draft status.

Set Status to Deprecated​

Icon: Archive Availability: When status is Draft or Published

Marks the OML profile as deprecated, indicating it's no longer recommended for new baselines. Deprecated OML profiles:

  • Remain available for existing baselines that reference them
  • Are hidden by default in the OML profile overview (unless the Deprecated filter is enabled)
  • Can be re-published if needed

Best Practices​

  • Version incrementally: Create new versions with semantic versioning rather than modifying published OML profiles
  • Document clearly: Use descriptive names, descriptions, and tags
  • Deprecate gracefully: When superseding an OML profile, deprecate the old version rather than deleting it
  • Coordinate with baselines: Publish OML profiles before publishing baselines that reference them
  • Backup regularly: Download OML profile files periodically for disaster recovery
  • Follow naming conventions: Use consistent ID patterns (e.g., domain-profile, c4-profile)

Profile Lifecycle States​

StatusDescriptionCan ModifyCan DeleteAvailable for Baselines
DraftUnder developmentYesYesNo (testing only)
PublishedReleased for useNoNoYes
DeprecatedNo longer recommendedNoNoYes (existing baselines)