Considerations for enabling configuration management

Before you enable configuration management capabilities for a project area, you should understand how this affects it and its links to artifacts in other project areas. After you enable these capabilities, you cannot disable them.

Read a guidance article for links to videos, considerations, and other resources to help you decide if using configuration management tools is right for your team.

Important:
Before your team can use configuration management capabilities, read this topic and the following article about considerations before enabling configuration management. After you read the article, you can obtain an activation key:
  • For pilot environments, generate an activation key at https://jazz.net/products/clm/cm/get-key.
    Note: The configuration management capabilities of the RM, QM, and Global Configuration Management applications are added services for IBM® Engineering Lifecycle Management Base SaaS and IBM Engineering Lifecycle Management Extended SaaS customer environments and should only be enabled by the SaaS provider. The source-control management (SCM) feature in CCM is included in Cloud offerings at no additional cost.
  • For production environments, discuss your plans with your IBM Client representative or contact IBM Support.
Starting in version 6.0.1, only integrations with the following products support versioned artifacts:
  • IBM Engineering Requirements Management DOORS® Next (DOORS Next)
  • IBM Engineering Test Management (ETM)
  • IBM Engineering Systems Design Rhapsody® - Model Manager (RMM)
  • IBM Engineering Workflow Management (EWM)

    External integrations to EWM work items continue to work as expected, because work items are not versioned.

After you understand the behaviors and limitations that are associated with enabling configuration management, and you have an activation key, you can activate configuration management for the Requirements Management (RM) and Quality Management (QM) applications. Then, you can enable the configuration management capabilities in RM and QM project areas and AM project areas. There is no way to reverse the action after you enable a project area. Back up existing repositories before you enable configuration management capabilities. If you restore from a backup, you will lose any changes that were made in all project areas managed by that server.

All ELM applications

If you plan to use ELM products in global configurations with other products, the considerations in this topic apply. If you use these products stand-alone (without linking to other applications), the information on this page does not apply.
  • If you need to keep some applications at a version earlier than 6.0, defer enabling configuration management until they all can be upgraded.
  • All ELM applications must be at the same version 6 level.
  • For linked QM or RM project areas, if you cannot enable configuration management for all of them, do not enable any of them: Project areas that are enabled for configurations cannot be associated with those that are not. For example, if your RM project area links to a QM project area, or even to another RM project area, you cannot enable one and not the other. Links between the projects become uneditable, and links to any artifacts in the enabled project will only resolve to the default configuration. This behavior does not apply if you link from RM or QM project areas to either RMM or EWM. You must make the decision holistically for related project areas. Project areas that are not associated are not affected, and do not have to be enabled.
    Note: In EWM and RMM, no additional steps are required to activate configuration management.

    Ensure that you have considered all project area relationships, because there could be cascading links (for example, RM Project Area A links to RM Project Area B, which links to QM Project Area C).

  • Back links are removed and links across project areas are managed by the Link Index Provider. In project areas that are not enabled for configurations, links across project areas are managed by each application storing a copy of the link to the other's artifact. This process is called back linking. When you enable configuration management, only one application stores a link to the other's artifact, and that link goes only in one direction. Most links are managed by the Link Index Provider. If RM or QM artifacts have links to artifacts in other applications, and then you enable configuration management, to see the links across project areas you must set the current configuration to a global configuration that contains the corresponding local configurations. For details about linking, see Links across project areas after enabling configuration management. To learn more about global configurations, see Workflow for global configurations.
  • If you rely on synchronization or OSLC integrations to relate data in ELM project areas to data in tools that do not support the OASIS OSLC Configuration Management specification, defer enabling configuration management for those project areas until those integrations are supported.
  • Links to tools outside of ELM are inconsistent until those integrations are updated to be compatible with configuration-enabled projects. This includes IBM tools, tools from other vendors, and custom OSLC integrations, such as those created by using the SDK from the Eclipse Lyo project.

RM (DOORS Next)

The following considerations apply to configuration-enabled projects:
  • You can migrate baselines from earlier versions of DOORS Next. Starting in version 6.0, if you start your project without configuration management enabled but enable it later, you can use the baselines that you created.
  • Projects stop their data feeds to the data warehouse, and their data is archived there. All configuration-specific data is stored in the lifecycle index and is accessed by using the Lifecycle Query Engine (LQE) application. See the Reporting section for details.
  • You can create, display, and delete these link types from AM project areas: Derives Architecture Element, Refined by Architecture Element, Traced by Architecture Element, and Satisfied by Architecture Element.
  • There are two ways to use change sets:
    • Simple scenario, using automatic change sets: The RM application provides automatic change sets that are created by the system when a change to an artifact or link is saved. You can make changes to links across applications and to RM artifacts, and the system creates and delivers the change set in one atomic action. You can deliver a potentially large set of these changes to another stream, but this is a complex operation in version 6 releases.
    • Complex reuse scenario, using named change sets: Create explicit, named change sets to easily group related changes and deliver changes across streams. For some organizations, this practice is required as part of the development process. If your organization is using global configurations, when you create a change set, it is automatically added to your personal stream. You can then edit links to artifacts in other RM, QM, or AM repositories.
      You must make manual edits to resolve conflicting change sets. This includes any two change sets that change a module structure (add, remove, or reorder the artifacts in a module). The following actions minimize conflicts:
      • Use many small change sets and deliver them quickly.
      • Make changes in a separate stream, then deliver all changes at once to the original stream.
      • Assign one person to make edits to each module.
    For more information about change sets, see Managing changes to artifacts.
  • Suspect link traceability is replaced with link validity status on links between artifacts. To see this information, enable the option to show link validity status. To understand how link validity helps to achieve consistency across artifacts and links as artifacts change, see this topic.
  • If you click a link stored elsewhere (for example, on a wiki page), this link does not specify the configuration context. The RM application shows the artifact at the other end of the link in the default configuration. If the default configuration does not include that artifact, an error is shown indicating that the artifact was not found.
  • You cannot add ELM links within a rich-text artifact because the resolution mechanism uses back links, which are not used after you enable configuration management. If a project already has such links when configuration is enabled, they won't work. To remove the links, use the Links side bar of the artifact or the remove link option in the rich text editor.
  • The Requirements Tracing widget does not show results.
  • You cannot create ELM Link Type filters to show artifacts that are linked to other applications.
  • You cannot create a link to a work item from a baseline. You can create this link from a stream. To create a link between a work item and a baseline, create the link from the CCM application. For more information about link management and link ownership, see Links across project areas after enabling configuration management.
  • Links between IBM Engineering Requirements Management DOORS (DOORS) version 9 objects and objects in the RM or QM applications do not work as expected because DOORS does not support configurations. Instead of linking, use ReqIF to transfer requirements into specific streams or link to work items, which are not versioned.
  • You must re-create any artifact templates that refer to deleted artifacts or collections.
For more information about these behaviors, see the DOORS Next release notes for this release on Jazz.net.

In project areas that are not enabled for configurations, you should understand the following information about the default configuration:
  • It is the stream that the New project wizard creates by default, and it is the only stream in a project.
  • If the project was migrated from a previous release, the current contents of the project are in this stream.
  • In this release, it is the only configuration where suspect links work properly.
  • The data warehouse contains information only from the default configuration.
  • The default configuration is used in all cases to resolve an incoming link that does not contain configuration information, such as links from a QM project area that is not configuration-enabled, or Hewlett-Packard Quality Center Synchronizer.

QM (ETM)

The following considerations apply to configuration-enabled projects:
  • Use TRS v2.0 as a data source to create the linked lifecycle data index.
  • Projects stop their data feeds to the data warehouse, and their data is archived there. All configuration-specific data is stored in the lifecycle index and is accessed by using the Lifecycle Query Engine (LQE) application. See the Reporting section for details.
  • Fewer dashboard widgets are supported, and ETM dashboard gadgets based on BIRT are not available. To work around this problem, you can create custom widgets with Report Builder or create custom HTML widgets with links to IBM Engineering Lifecycle Optimization - Engineering Insights (ENI) views. Update settings of your dashboard widgets that need to refer to specific configurations.
  • Filtering on development item and development plan links is not supported.
  • You cannot create snapshots to capture artifact versions. Take baselines instead. Baselines capture the current version of all the artifacts that can be versioned in a project area. To understand which artifacts can be versioned, see "Versioned artifacts in configurations" in this help topic.
  • You can still read snapshots that were created before you enabled the project area for configurations. In the snapshot:
    • OSLC links to RM artifacts are shown
    • OSLC links to CCM items are not shown
  • You cannot create a link to a work item from a baseline. You can create this link from a stream. To create a link between a work item and a baseline, create the link from the CCM application.

CCM (EWM)

  • Use TRS v2.0 as a data source to create the linked lifecycle data index. This feed provides additional access control for work items based on team areas.
  • To navigate links to versioned artifacts, you must use the web client, the EWM client for Microsoft Visual Studio IDE, or the 6.0 (or greater) version of the EWM client for Eclipse IDE.
  • To create links to versioned artifacts, you must use the web client, the 6.0 (or greater) version of the EWM client for Eclipse IDE, or the 6.0 (or later) version of the EWM client for Microsoft Visual Studio IDE.
  • In general, linking EWM plans to versioned artifacts is not supported. It is possible to create a link from a versioned artifact to a plan; however, when you navigate the link from within the plan, EWM uses the default configuration for the target project area. The default configuration might not be the same configuration from which the link to the plan was created.
  • In a work item that has links to versioned artifacts, if you change the value of the release (deliverable attribute type) field, the links are not updated until you save the work item.
  • Links to versioned artifacts are not supported in the following views:
    • History tab of the work item editor
    • My Activities / My Subscriptions tab in the Quick Planner
    • Dashboard viewlets that show change events
    • Feeds (EWM client for Eclipse IDE and EWM client for Microsoft Visual Studio IDE)
    • Links tab of a plan
  • You can link work items to versioned artifacts only if the configurations that contain those versioned artifacts belong to global configurations.
  • To specify the mapping of OSLC link types to attributes, and to associate releases with global configurations, you must use the web client.
  • While working in ETM or DOORS Next, you cannot create a link from a baseline to a work item. The workaround is to create the link from within the work item.
  • In the EWM client for Eclipse IDE, you can perform a bulk edit of work items to change the target link of versioned artifacts. If the selected work items belong to different releases and have different associated global configurations, EWM uses the target artifact versions that belong to the global configuration associated with the first work item in the selected collection.
  • In the web client plan editor, you can perform a bulk edit of work items to change the target link of versioned artifacts. If the selected work items belong to different releases and have different associated global configurations, EWM uses the target artifact versions that belong to the global configuration associated with the work item from which the context menu was activated.
  • ELM includes a set of predefined lifecycle work item queries, which retrieve work items based on their links to artifacts in other applications, such as RM and QM. See Using lifecycle queries for the complete list of these queries. For work items that are linked to versioned RM and QM artifacts that do not belong to default configurations, the lifecycle query results might not be accurate.
  • Data warehouse reporting is not supported for links to versioned artifacts.

For details about configuring a project area so that you can link work items to specific versions of artifacts in other applications such as QM and RM, see Enabling linking of work items to versioned artifacts.

GCM application

In the following points, a global configuration provider is the GCM application that your deployment uses.
  • An ELM deployment can have one global configuration provider only. However, you can configure a global configuration provider to accept contributions from another global configuration provider. For details, see Enabling GCM servers to contribute configurations to other GCM servers.
  • You can create reports with information about global configurations by using ENI and Report Builder. When you build your report, select the Lifecycle Query Engine scoped by a configuration data source.

Reporting

Consider these limitations when reporting on data in configurations. For details and other considerations, see Getting started with reporting by using Lifecycle Query Engine data sources on Jazz.net.
  • Enabling configuration management in RM and QM project areas stops their feeds to the ELM data warehouse and archives their data there. EWM does populate the data warehouse, but that data does not include configuration-related information.
  • All configuration-specific data is stored in the lifecycle index and is accessed by using the Lifecycle Query Engine (LQE) application. The Report Builder and ENI can report from the lifecycle index by using an "LQE scoped by a configuration" data source.
    Note: The name of the data source for reporting on versioned artifacts in configurations varies, but the meaning is the same:
    • If you create the LQE data sources in Report Builder version 6.0.3, it's called LQE scoped by a configuration.
    • If you upgrade to version 6.0.3, it's called LQE using Configurations
  • You can now report on some historical trends and metrics by using the LQE data sources.
  • Link types and attributes for DOORS Next are duplicated. In the Traceability links section, hover over the question mark Question mark inside a square speech balloon to identify the project the attribute is from. You must set a condition for each attribute with the same name; then, group them and add an OR relationship between them. To show them in one column when you run the report, in the Format section, give them the same column name.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki