Baselining

Overview

The CDCM 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:

[Space] --> [Baseline Type] --> [Configuration Area]
    ^               |
    |               v
[Permissions]  [Configurations / Templates]

Examples: Managing Baseline Types

1. Create a Baseline Type:

   • Input: Provide a name like "QA Approved."

   • Result: A baseline type is created and can be associated with configurations.

2. Enable a Baseline Type:

   • Input: Select a configuration area.

   • Result: "QA Approved" is available for configurations within that area.

Step-by-Step Guide

1. Creating a New Baseline

Prerequisites

• Permissions:

  • To create or modify a baseline, you must have the maintain-type-system permission in the space or configuration area.

  • To enable a baseline type for a configuration area, you need modify-configuration-area permission.

Workflow

1. Access the Configuration:

   • Navigate to the Configuration Management interface.

   • Select the desired configuration you want to baseline.

2. Select Baseline Type:

   • Go to the Baseline Types tab.

   • Choose an existing baseline type or create a new one:

     • Option 1: Create a new type by clicking Add Baseline Type and providing a name (e.g., QA Approved).

     • Option 2: Select an existing type from the sorted and filterable list.

3. Create the Baseline:

   • Choose the scope of the baseline:

     • Full Baseline: Select all configuration items (CIs) in the configuration.

     • Partial Baseline: Choose specific CIs associated with the selected baseline type.

   • Confirm and save the new baseline.

Diagram: Baseline Creation Process

[Configuration] --> [Baseline Types Tab] --> [Select Type] --> [Full or Partial?]
        --> (Full) --> [Create Baseline: All CIs]
        --> (Partial) --> [Select CIs] --> [Create Baseline: Partial CIs]

2. Viewing Existing Baselines

Steps:

1. Open the Baseline Types tab in the configuration area.

2. Use the filter or sort functionality to locate the baseline type of interest.

3. Review associated CIs, descriptions, and metadata.

Example:

• Scenario: You created a baseline for a software release tagged Release 1.0.

• Action: Filter for baseline types labeled Release and view the associated CIs.

3. Managing Baseline Types

Add or Remove Baseline Types

• Add:

  • Navigate to the Baseline Types tab.

  • Click Add Baseline Type and define its name and key.

• Remove:

  • Select the baseline type and click Remove. Baseline types that are actively associated with unit types cannot be removed.

4. Closing a Baseline

When to Use:

• Close a baseline when the configuration is finalized and no further changes are allowed.

Steps:

1. Open the configuration.

2. Ensure all CIs are in a state that supports closing (e.g., QA Approved or Production Ready).

3. Set the configuration’s state to Closed Baseline.

4. Confirm the action:

   • The system will validate all CIs.

   • If prerequisites are unmet, the system will inform you and cancel the action.

Diagram: Closing a Baseline

[Configuration] --> [Validate CIs] --> [Close Baseline State]
        |
   [Fail: Inform User]Code kopieren

Example:

• Scenario: A Closed Baseline is required for an audit.

• Action: Transition all CIs to Closed Baseline, ensuring no modifications are possible.

5. Deriving a Stream from a Baseline

When to Use:

• Create a development or feature stream from an existing baseline.

Steps:

1. Select a baseline (e.g., Release 1.0).

2. Click Derive Stream.

3. Choose whether to:

   • Include all CIs (Full Stream).

   • Include only specific baseline items (Partial Stream).

4. Confirm to create a new configuration in the Initial state.

Example:

• Scenario: Derive a stream from Release 1.0 for a Bug Fix 1.0.1.

• Result: A partial stream containing only the required fixes.

Examples of Usage

1. Full Baseline Example

• Scenario: Prepare a snapshot for a major release.

• Steps:

  1. Open configuration Project X.

  2. Add a new baseline type Major Release.

  3. Create a full baseline, including all 100 CIs.

• Outcome: A baseline named Project X – Release 1.0 is created.

2. Partial Baseline Example

• Scenario: Snapshot a subset of features for a minor release.

• Steps:

  1. Open configuration Project Y.

  2. Use the baseline type Bug Fixes Only.

  3. Select 20 specific CIs and create the partial baseline.

• Outcome: A baseline named Project Y – Patch 1.0.1 is created.

REST Services

State Model Behavior

Behavior Rules

• States:

  • Transitions to Closed Baseline require all prerequisites.

  • Modifications to associated superstates are restricted after state creation.

• Examples:

  1. Work product references cannot be changed in Closed Baseline.

  2. 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.