Enabling link validity in projects in the AM, DM, QM, and RM applications

For each Architecture Management (AM), Design Management (DM), Quality Management (QM), and Requirements Management (RM) project area that is enabled for configurations, you can choose to show or hide the link validity status of links and the validity summary of artifacts. Show this information to help determine which artifacts and relationships you need to examine and update when changes are made. Hide this information to reduce the clutter on the page when you know that your team does not need it. In a distributed environment, additional setup is required.

Before you begin

  • All in IBM® Engineering Lifecycle Management (ELM) applications must be the same version (6.0.1 or later).
  • Ensure that you are familiar with the concepts and examples described in Link validity.
  • AM application:
  • DM application:
  • RM and QM applications:
    • A Jazz Administrator must activate configuration management.
    • A project area administrator must enable configuration management for the project areas whose links you want show validity status for.
    • You must set the advanced server property for link validity to true.

      RM application: The Link Validity enabled advanced server property must be set to true in both the RM Client Component and RM Core Component sections. By default, the property is set to true in both locations.

      QM application:
      • You must have permission to save project area properties.
      • The Link Validity advanced server property must be set to true, which is its default value.
Note:

In the Change and Configuration Management (CCM) application, no additional steps are required to enable configuration management or show validity status. Link validity status information is shown only in the web client and is shown by default on links between source control management (SCM) files and artifacts that support validity status. The CCM application does not support validity summary information.

About this task

Link validity shows the status of links between artifacts and indicates whether the content of the artifacts meet the intended meaning of the link between them.

For details and examples that explain link validity status and validity summary information, see Link validity.

By default, the Show link validity option is disabled, and you can change it at any time. For example, when work begins at the start of a release or milestone, the link validity status might not be as important to consider, so you might enable it later in the release.

Procedure

  1. Distributed environments only: For each product node, complete the following steps. For a topology overview, see the related Deployment wiki article.
    1. Log in to the Jazz Team Server Home page as a user with administrative privileges: https://server_name:port/jts/admin
    2. Below the banner, click Server, and then click Advanced Properties.
    3. Search for the Shared Validity provider URL property and assign it this value: https://parent_node_server:port/jts/validity

      Assign this value only for product nodes: do not assign it for the parent node in the topology.

    4. Click Save.
    The following image shows a distributed topology. In this example, you complete steps 1.a to 1.d for the Product Line 1 and Product Line 2 servers.Shows a federated topology consisting of one parent or federated node and two product nodes.
  2. Complete the steps for the application you are enabling. In a distributed environment, for each product node, complete this step for each application that supports link validity.
    Application Steps
    Architecture Management (AM)
    1. From the Administration menu Administration menu, select Manage This Project Area.
    2. Click Architecture Management.
    3. To show or hide link validity status, select or clear the Show link validity check box.
    4. Click Save.
    Design Management (DM)
    1. From the Administration menu Administration menu, select Manage This Project Area.
    2. Click Design Domain.
    3. To show or hide link validity status, select or clear the Show link validity check box.
    4. Click Save.
    Quality Management (QM)
    1. From the Administration menu Administration menu, select Manage Project Properties.
    2. In the Properties section, click Link Validity.
    3. To show or hide link validity status, select or clear the Show link validity check box.
    4. Click Save.
    5. (Optional) When a test case is approved, mark all links as Valid: When you select this option, the system automatically marks each link to corresponding requirements as Valid after a team member approves a test case. This option saves team members time when they work with large numbers of test cases because they do not need to manually validate each test case-to-requirement link.
    6. Configure the functional user for each RM and DM project area that the QM project area links to:
      1. On the Administration menu Administration menu, click Manage Application > Friends (Outbound).
      2. Copy the consumer keys for the RM (/rm) and DM (/dm) entries in the Jazz Team Server Friends table.
      3. Go to the Jazz Team Server administration page at https://host-name:9443/jts/admin; then, click Manage Server > Consumers (Inbound).
      4. In the Authorized Keys section, for each consumer key that you copied, click the Edit Consumer icon Pencil icon, and in the Functional User ID field, assign the functional user for that application (such as rm_user or dm_user); then, click Finish.
      5. Grant permission for team members to set link validity. For details, see Modifying role-based permissions.
    Requirements Management (RM) You must enable link validity for each component in a project area whose links team members show and set validity status for.
    1. From the Administration menu Administration menu, select Manage Component Properties.
    2. To show or hide link validity status, on the Link Validity tab, select or clear the Show link validity check box.
    3. Click Save.
    4. Grant permission for team members to set link validity. For details, see Modifying role-based permissions.

Results

After you enable the Show link validity option, link validity information is shown where links to artifacts are shown. For details, see Viewing and changing link validity status in CLM projects.

Link validity status information is collected by the Lifecycle Query Engine (LQE) data source whether you show or hide this information.

What to do next

In the LQE application, grant access to link validity data so team members can report on link validity information.

For team members to create Report Builder reports that include RM and QM application link validity information, you must grant them access to link validity data. For details, see the related topic.


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