Step 1. Choosing data

Edit online

Procedure

  1. Open Report Builder.

    Go to https://server_name:port/rs. On the Reports page, click Build report. If the page doesn't open, contact your application administrator.

  2. Choose a report type.
    • Click the Edit icon to select the LQE data source as per what you want to report on: a specific configuration or all configurations. If only one data source is defined, it is selected by default. To decide what data source to choose, read this topic.
    • Select Current Data (table or graph) to report on the latest information about artifacts in and across projects.
  3. Limit the scope.

    Choose the projects to report on, and click Continue. If you don't select any projects, the report includes all projects that you can access.

    The list shows the projects that you can access in the data source that you selected. If your projects are not in the list, see the administrator who created the data sources for Report Builder.
    • For Lifecycle Query Engine, only projects that are not enabled for configurations are listed. If you select List all projects when reporting on configurations themselves, configuration-enabled projects are included in the list. To limit the configuration results, select specific projects.
    • For Lifecycle Query Engine scoped by a configuration, only configuration-enabled projects are listed. When you run the report, you must choose a configuration.

    Some artifact types are project-specific. Go to step 4 to select the artifact type, then return here, and select List only the projects that contain the artifact for your report.

  4. Choose an artifact.

    Select an artifact or specific types, and click Continue. You might have to expand some artifacts to make a choice; if you don't expand the artifact, and select it, all of its types are included in the results.

    If you select an artifact type that is project-specific, you can return to the Limit the scope section, and select List only the projects that contain the artifact for your report.

    Tip: To report on requirements from specific modules, click Requirement, and select the types. You specify the requirement collections or modules later.
  5. Trace relationships and add artifacts.
    Explore how your artifacts are linked to other artifacts from the same, or from other lifecycle tools. Click Add a relationship. For each artifact type, you see all the existing relationships. Pick one, and click OK.
    Note: Some custom link types are not shown in the list of existing relationships: for example, custom link types from artifacts that do not own the link. To know more, contact your administrator, or see Getting started with reporting by using Lifecycle Query Engine data sources on Jazz.net.
    You can select multiple relationships between two artifacts of the same type, as shown in the following example:
    Multiple traceability links between two work items.
    Example: To show that a requirement is validated by a test case, click Add a relationship, and under QM Test Case, select the Validated by relationship. To also list the work items that are associated with the test cases, click Add a relationship > Related Work Item, and then click OK. To specify what type of related work item to add, select Work Item, and click OK. In the Set conditions section, you can further define the relationships.
    Traceability links that associate requirements, their related test cases, and work items associated with those test cases.
    Tip: When you name and share your report, include the traceability link names so that team members can find your report easily.
    To trace multiple relationships from one artifact, or to add source artifacts, select the Enable multiple paths or add other source artifacts checkbox.
    Tracing multiple relationships and adding source artifacts
    • From one artifact, you can trace multiple relationships to other artifacts, and show all the results in the same report. Choose how to for combine the results:
      Merge
      The results are shown in the same rows.
      Append
      The report shows the results for each traceability relationship. All the source artifacts are in the same column.
      Append in new columns
      To count the source artifact relationships separately, append the results in different columns.
      A dialog box shows options for combining the data from multiple traceability relationships.
    • Click Add an artifact, and select an artifact type.
    For each relationship that you trace, you can set conditions. For step-by-step instructions on how to build this type of report, read the Tutorial.
    Example: You can trace how features are linked to work items, test cases, and child requirements. You see all the relationships in a single table.

    To trace release-specific relationships between work items and versioned artifacts, select the Exclude work item relationships with incompatible releases checkbox.

    If you choose to select this option, Report Builder includes the work item relationships only if one or both of the following statements are true:
    • Relationships are not associated with any IBM® Engineering Workflow Management (Engineering Workflow Management) releases.
    • The relationships are associated with at least one Engineering Workflow Management release that is linked directly to the global configuration, or through a recursive release predecessor of the global configuration that is used to run the report.

    If you choose not to select this option, Report Builder might include relationships that do not apply to the configuration that is selected for the report, and such mismatches might not be shown in IBM Engineering Requirements Management DOORS® Next or IBM Engineering Test Management , application. You can control whether to see such mismatches in the specific application by setting the Exclude work item relationships with incompatible releases advanced server property.

    You can also select this option to exclude the work item relationships for incompatible releases and make Report Builder consistent with the incoming links from work items to requirements in DOORS Next, and test artifacts in Engineering Test Management provided the corresponding application has the Exclude work item relationships with incompatible releases advanced server property enabled. This property is set to true by default, but you can configure it. For more information, see Enabling filtering of work item relationships with incompatible releases.

    Tracing release-specific relationships between work items and versioned artifacts

    To remove the last relationship from the right of an artifact, click Back. To remove an artifact or relationship, and all the items to the right, click the X on the item name.

    Tip: You can change the name of an artifact in the traceability box by double-clicking its name and typing the new one. For example, if you want your report to refer to related defects instead of change requests, double-click the Change Requests box in the traceability diagram, and type Defects. Changing the name in the traceability diagram makes it clearer to your team members, especially if your report uses custom artifact types or custom links.

    After you build the artifact relationships, click Continue.

  6. Set the conditions.

    To further refine the content of your report, specify conditions. You can set conditions for any attribute of the artifact type that you selected, and any attribute of the related artifact types in your traceability paths. By setting conditions, you can further identify relationships among artifacts. For example, to show that a requirement is validated by a test case, select the Validated by relationship under QM Test Case. Then, set a condition to focus only on approved test cases. For the artifact type QM Test Case, choose the attribute State, and set the value to Approved.

    You can set a condition to return data only for specific components. You must select an application-specific artifact type (such as QM Test Case, or System Requirement). These artifact types contain a Component attribute that you can choose, and then select the component to report on. The Component attribute is not available if you select a global artifact type (typically the expandable top-level artifact type in the Choose an artifact section) or types from projects that aren't enabled for configurations.
    Tip: If you add the Component attribute as a column but do not add a condition for it, when you run your report you can select a component to filter the results that you see.
    1. Click Add condition.
    2. From the list, select an artifact type.
    3. Choose the attribute that you want to specify a condition for, and select the values to return the artifacts you want.
    4. To keep the window open for adding other conditions, click Add. Otherwise, click Add and Close.
    5. Optional: Change the lock to control whether people can or must supply a value for the condition when they run the report.
    • To edit a condition, click the pencil Edit icon.
    • To create logical groups of conditions, select the conditions and click Group.
    • To create nested groups of conditions, use the grouping options or drag conditions to existing groups.
    • To exclude data from a report by grouping conditions, use the Not all match (AND NOT) or None match (OR NOT) options.
    • To reorder conditions, drag them into position.
    • To remove conditions, select them, and click Remove.
    Note: If your condition uses an is not statement, the report shows only artifacts that have different values from the one you specified. If no value is selected for that attribute (the value is unassigned), the artifact is not included in the report.

    To include artifacts with different values from the specified one, and also artifacts with unassigned values, create two conditions and group them by using Some match (OR).

    Example:
    Example of grouped conditions
    If you group the conditions, you get the expected results, but the report takes longer to run.
    Sometimes several projects use the same custom attribute, and although the attribute has the same name across the projects, its ID is different in each project. To report on this attribute, add a condition for each project. Then, to consolidate them in your report, group the attributes by using an OR condition.
    Example: Each project that you report on has a risk status attribute, and it means the same to each project. Select this attribute for all the projects; then, group the attributes, and add an OR condition between them. To show the results in one column, instead of one column for each project, see the Show the report as a table section.
    Tip: To report on requirements in specific modules, from the attributes list, select the requirement or requirement type, and choose the Collection or Module attribute; then, choose the collections or modules, and click Save.

    After you create your conditions, click Continue.