Viewing and changing link validity status in CLM projects

You can view and change link validity information in views and artifact grids that show links to artifacts. You can also include comments about why you chose a status. To see validity summary information, hover over artifact links in the grid view or add the Validity Summary column to artifact views.

Before you begin

  • If your project uses global configurations, you must be a member of the appropriate project area in the Global Configuration Management (GCM) application.
  • Ensure that you are familiar with the concepts and examples described in Link validity.
  • Architecture Management (AM) application:
  • Quality Management (QM) and Requirements Management (RM) applications:
  • RM application only:
  • To view and change the validity status of cross-project and cross-application links, you must work in a global configuration, which resolves links among applications.
    • AM, Design Management (DM), QM, and RM applications: Use the Current Configuration menu on the toolbar.
    • Change and Configuration Management (CCM) source control management (SCM): In the web application, use the Change Configuration Context menu near the upper right of the page when open a CCM stream.

About this task

Where you see link validity information depends on which application that you use:
Note: No validity status icon is shown on external links or on links to other applications that do not support link validity.

When you change the validity status of a link, if the artifacts on either end of the link are in different ELM applications, the status is updated automatically in both applications. For example, if you set the validity status between a test case and a requirement as invalid, this status is visible right away in both applications (you might have to refresh your browser). No additional steps, such as the reconcile operation in the QM application, are required to see the updated status.

If changing the link validity status affects the validity summary for an artifact, the validity summary is updated automatically.

When you set a link validity status in one configuration, the status is refreshed in any other configurations that contain the same two artifacts with that same content and link type between them.The status is refreshed when someone working in the other configuration invokes an operation that refreshes the page (for example, Save).

When you export artifacts from these applications, link validity status is not included in the generated .pdf files or Microsoft Excel spreadsheets.

Reporting on link validity information, such as generating a report that includes only invalid artifact relationships, is limited in this release. For details, see Reporting on link validity status in ELM projects.

Link validity status

Before you begin

  • Save your changes to an artifact before you change the validity status of an associated link.

About this task

The system automatically sets links to Suspect when artifact contents change. If you aren't sure whether the artifact contents meet the intended meaning of the link, you can leave the link status as Suspect and examine it again later. Otherwise, change the link status to Valid or Invalid.
  • Valid (green icons): The contents of the two artifacts satisfy the meaning of the link that connects them. Consider a “validates” link between a test case and a requirement: if the test case does indeed validate the requirement, then the relationship is valid.
  • Invalid (red icons): The contents of the two artifacts do not satisfy the intended meaning of the link that connects them. For example, you know that a test case no longer validates a requirement. Set the status to Invalid, and later, you (or another member of your team) might change the test case (the downstream artifact) to make the link valid.
  • Suspect (gray icons): The system sets links as suspect when they are new or unknown. A person needs to verify whether the contents of both artifacts satisfy the intended meaning of the link. Leave the link as Suspect if you cannot determine this now, and later, do more analysis.
Note: If the system cannot access the linked artifact to get validity status, or if the validity service is not responding, the validity status is Unknown. Sometimes this happens if artifacts have been deleted. To solve the problem, contact your application or project area administrator, or follow the instructions on the page.

Procedure

See the previous section for where link validity information is shown. From one of those locations (except a rich hover preview), click the validity status icon and change its status. You can also add a comment about why you selected the status. For example, if you select Invalid, you might indicate what change is required to make the relationship valid again.

Setting link validity status

Before you begin

Save your changes to an artifact before you change the validity status of an associated link.

About this task

In some applications, to save time, you can change the link validity status of more than one link at a time. For example, you might set multiple links to valid after you adopt a baseline whose links you know are valid, after an import operation.

Procedure

  1. Complete one the following steps depending on the application that you use:
    Application Steps
    AM
    1. In the web client, open or preview an artifact.
    2. In the Links section, hover over the link validity status icon.
    DM
    1. Open the artifact and click the Links tab.
    2. Hover over the link validity status icon.
    QM
    • To set the status for all the requirement links for the selected test case: In the Test Plan > Test Cases view, ensure that the Validates Requirements column is shown. Select the check box in the first column for each artifact; then, in the table header, click Validity Summary Validity Summary.
    • To set multiple links at the same time: In the Test Case > Requirement Links view, select the check box in the first column for each link status to change; then, in the table header, click Link Validity Link Validity.
    Note: You can have the system mark all links as Valid when you approve a test case. Discuss this link validity preference with your application or project administrator.
    RM

    From an artifact grid view, you can change only the status of the link types that are shown in the grid. If you don't see the link whose validity status you want to change, add the corresponding column to the grid view.

    To set all the links for the selected artifact:
    1. Select the check boxes for the artifacts; then, click the pencil Edit.
    2. Click Other Actions > Set Validity Status for x Artifacts.
    Tip: From an artifact grid view, you can set the link validity status by selecting the check box for the artifact; then, click the pencil Edit, then Other Actions > Set Validity Status.

    From a Links sidebar (to change multiple selected links):

    1. Press Ctrl + the links to change.
    2. Right-click one of the links.
    CCM SCM feature
    1. In the web client, open the stream that contains the file on one end of the link whose status you want to change.
    2. Open the file and click the File Links tab.
    3. Hover over the link validity status icon in the Validity column.
  2. Select the status. Optionally, provide a comment about why you selected the status.

Results

The status and comment apply to each link in the Link Validity column for each artifact that you select. When you set a link validity status in one configuration, the status is refreshed in any other configurations that contain the same two artifacts with that same content and link type between them.The status is refreshed when someone working in the other configuration invokes an operation that refreshes the page (for example, Save).

Showing the validity summary (the aggregate link validity status for an artifact)

About this task

This information applies to the QM and RM applications.

The validity summary is a rollup of the status of all the relevant links for an artifact. Hover over an artifact's validity summary to see whether you need to investigate specific relationships further and modify artifacts to achieve or restore the intended meaning of the link.

The validity summary lists the priority ordering of all its links as follows:
  • Invalid : At least one relevant artifact link is invalid, even if other links are suspect or valid.
  • Suspect : At least one relevant artifact link is suspect and should be verified, but there are no invalid or undetermined links.
  • Valid : All the associated artifact links that affect this artifact are valid.
Note: If you see a validity summary status of “Undetermined”, the system doesn't have enough information to determine the status of at least one link. If the problem persists, tell your project area administrator.

To resolve links, use an approach that is appropriate for your situation. You might want to first inspect all the suspect values, to see how many invalid values there are. Or, because invalid links mean someone has verified that a relationship is not semantically consistent, you might want to examine these relationships first, and then address suspect items. Suspect relationships might still be consistent; it’s just that the system has detected changes that you must verify.

For more details and examples, see Link validity.

Procedure

  1. See the preceding list of views where you can see validity summary information. Not all applications provide validity summary information.
  2. From the view, click the icon to add columns to the table, and select Validity Summary.
    • QM application: Click Add or Remove Columns Add or Remove Columns. To change the order of the columns, drag column headings to a new position.
    • RM application: Click Configure Page SettingsConfigure Page Settings > Configure Columns to DisplayConfigure Columns to Display. Use the controls to change the order of the columns in the table.
  3. In the row for an artifact, hover over the icon in the Validity Summary column.
  4. To examine a specific relationship, click its link in the hover preview.
  5. Set the link validity status by completing the steps in the preceding sections.

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