Overview
The CDCM (Configuration and Data Management Concept) system enables users to manage configurations, baseline types, and associated state models. This documentation provides details on baseline type management, state model behavior, and related functionalities for creating and managing baselines.
...
Key Concepts
Baseline Types
Baseline Types are tags used to define configurations or templates within a space or configuration area (CA).
Properties of Baseline Types:
ID: Unique identifier.
Name: User-defined name.
Key: Unique for use in API, generated by the system.
Description: Description of the baseline type.
URL: Link to internal documentation or related resources.
Permissions:
Creation and modification require
maintain-type-system
permissions at the space or configuration area level.Enabling a baseline type for a CA requires
modify-configuration-area
permissions.
...
Diagram: Baseline Type Association with Configuration Areas
Below is a simplified diagram illustrating how baseline types are associated with configuration areas:
Code Block |
---|
[Space] --> [Baseline Type] --> [Configuration Area]
^ |
| v
[Permissions] [Configurations / Templates] |
...
Examples: Managing Baseline Types
Create a Baseline Type:
Input: Provide a name like "QA Approved."
Result: A baseline type is created and can be associated with configurations.
Enable a Baseline Type:
Input: Select a configuration area.
Result: "QA Approved" is available for configurations within that area.
...
Functionalities
Creating Baselines
Baselines can be created in two ways: Full or Partial.
Full Baseline:
All configuration items (CIs) are included.
Example: A configuration for a software release with all features enabled.
Partial Baseline:
Selected CIs associated with specific baseline types are included.
Example: A configuration for a "Bug Fix Release" with only related changes.
...
Diagram: Baseline Creation Process
Below is a flowchart of the baseline creation process:
Code Block |
---|
[Start] --> [Select Configuration] --> [Choose Baseline Type]
--> (Full) --> [Copy All CIs] --> [New Baseline: Full]
--> (Partial) --> [Select CIs] --> [New Baseline: Partial]
|
...
Closing Baselines
Configurations or items can be transitioned to a Closed Baseline state:
Rules:
All internal and external work products must be in the Closed Baseline state.
Users are informed of irreversible actions before proceeding.
...
Diagram: State Transition to "Closed Baseline"
Code Block |
---|
[Initial State] --> [Validate Conditions] --> [Closed Baseline State]
|
[Fail: Inform User] |
...
Examples: Closing Baselines
Example 1: Full Baseline Closure:
Configuration: "Release 1.0"
Result: All associated work products must meet the Closed Baseline state.
Example 2: Partial Baseline Closure:
Configuration: "Bug Fix 1.0.1"
Result: Only selected work products are validated.
...
Deriving Streams
Streams can be derived from baselines to enable further development or updates:
Full Baseline:
Copies all configuration items.
Partial Baseline:
Copies only selected baseline items.
...
Diagram: Deriving a Stream
Code Block |
---|
[Baseline] --> [Derive Stream] --> [Initial State Stream] |
...
Examples: Deriving Streams
Example 1: Full Baseline Stream:
Baseline: "Release 1.0"
Stream: "Feature Addition for Release 1.1"
Example 2: Partial Baseline Stream:
Baseline: "Bug Fix 1.0.1"
Stream: "Additional Patch for Bug Fix"
...
REST Services
Endpoint Priority | Description |
---|---|
High | Create/Modify Baseline Type, Retrieve Configuration CIs. |
Medium | Retrieve all Baseline Types for a Configuration. |
Low | Add/Remove Baseline Types from Configuration Areas. |
...
State Model Behavior
Behavior Rules
States:
Transitions to Closed Baseline require all prerequisites.
Modifications to associated superstates are restricted after state creation.
Examples:
Work product references cannot be changed in Closed Baseline.
New items cannot be added to a Closed Baseline configuration.
...
Appendices
Glossary
Configuration: A structured collection of items representing a product or system state.
Baseline: A snapshot of a configuration serving as a reference point.
Superstate: A higher-level classification that dictates allowed state transitions.
Known Limitations
Deletion of baseline types is not supported.
Modifications to state model associations are restricted post-creation.