|
| 1 | +--- |
| 2 | +title: Custom Enums |
| 3 | +description: Learn about custom enums in Openlane and how they can be used to extend and customize your compliance program |
| 4 | +sidebar_position: 1 |
| 5 | +--- |
| 6 | + |
| 7 | +# Custom Enums |
| 8 | + |
| 9 | +Custom Enums allow organizations to define structured dropdown values that shape how compliance data is categorized across Openlane. |
| 10 | + |
| 11 | +Located in Organization Settings → Custom Data → Custom Enums, this feature lets you tailor key object types such as environments, scopes, control kinds, risk categories, and more — without changing your core workflows. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +## What Are Custom Enums? |
| 16 | + |
| 17 | +A Custom Enum is a predefined list of selectable values used throughout the platform to classify objects consistently. |
| 18 | + |
| 19 | +Unlike free-form fields, enums: |
| 20 | +- Ensure standardized categorization |
| 21 | +- Reduce inconsistent data entry |
| 22 | +- Enable filtering and reporting |
| 23 | +- Maintain audit-ready structure |
| 24 | + |
| 25 | +Each enum value can include: |
| 26 | + |
| 27 | +- Name |
| 28 | +- Description (optional) |
| 29 | +- Color |
| 30 | + |
| 31 | +## Global vs. Object-Specific Enums |
| 32 | + |
| 33 | +Some enums are global and can be used across multiple object types (e.g., Environments), while others are specific to certain objects (e.g., Control Kinds for controls). When creating custom enums, be mindful of where they will be applied to ensure they fit the intended use case. |
| 34 | + |
| 35 | +## System-Managed Enums |
| 36 | + |
| 37 | +In addition to organization-created enums, some categories include System-Managed Enums. These are common, standardized values provided by Openlane to help organizations get started quickly and align with widely used terminology. |
| 38 | + |
| 39 | +Key Characteristics |
| 40 | + |
| 41 | +1. Provided by Openlane |
| 42 | +1. Cannot be deleted |
| 43 | +1. Can be used like any other enum value |
| 44 | +1. Are not editable, but can be supplemented with custom values |
| 45 | +1. Designed to support common compliance patterns |
| 46 | + |
| 47 | +System-managed enums ensure consistency across organizations while still allowing flexibility through additional custom values. |
| 48 | + |
| 49 | +For example: |
| 50 | + |
| 51 | +- Default task kinds |
| 52 | +- Standard risk categories |
| 53 | +- Common document types for Trust Centers |
| 54 | + |
| 55 | +You are free to use system-managed values, ignore them, or supplement them with your own organization-specific enums. |
| 56 | + |
| 57 | +## How to Create a Custom Enum Value |
| 58 | + |
| 59 | +1. Navigate to Organization Settings → Custom Data → Custom Enums |
| 60 | +1. Select the enum category (e.g., Environments) |
| 61 | +1. Click Create Enum and provide the following details: |
| 62 | + - **Name**: The name of the enum value (e.g., "Production", "High Risk", etc) |
| 63 | + - **Description**: Optional additional context about the value |
| 64 | + - **Color**: Choose a color to visually distinguish this value in dropdowns and reports |
| 65 | +1. Click Save to create the new enum value |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +The new value will immediately become available in dropdowns across the platform. |
| 70 | + |
| 71 | +## How Custom Enums Differ from Custom Tags |
| 72 | + |
| 73 | +| Custom Tags | Custom Enums | |
| 74 | +| ----------------------------------- | ----------------------------------- | |
| 75 | +| Flexible, multi-select labels | Structured dropdown categories | |
| 76 | +| Used for lightweight classification | Used for core object structure | |
| 77 | +| Free-form and optional | Controlled, standardized values | |
| 78 | +| Great for filtering | Critical for reporting + governance | |
0 commit comments