Step 1. Selecting Data

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 Edit to select the data source. 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 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.
    Note: If you are reporting on IBM® Engineering Requirements Management DOORS® , select the DOORS Database - Engineering Requirements Management DOORS Next Project.

    Whatever data can be seen by the DOORS user, which is set in the Data Collection Component resource group for DOORS , is the data that gets seen by all users in Report Builder. The project DOORS Database - Engineering Requirements Management DOORS Next Project that gets created in the data warehouse is fully public and any IBM Jazz® Team Server user can see all the data in any Report Builder reports, since there is no correlation between JTS users and DOORS users.

    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 Data warehouse, only projects that are not enabled for configurations are listed.
    • For Lifecycle Query Engine, only projects that are not enabled for configurations are listed.
    • For Lifecycle Query Engine scoped by configurations, only configuration-enabled projects are listed.

    Some artifact types are project-specific. Go to the step 4 to select the artifact type, then return here, and select List only the project areas 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.
    Example: To show that a requirement is validated by a test case, select the Validated by Test Case 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. In the Set conditions section, you can further define the selected relationships. The example uses a data warehouse data source.
    Traceability links that associate requirements, their related test cases, and work items associated with those test cases.

    When you are reporting on top-level artifact types such as Work Item or Requirement in LQE reports, you can now use custom attributes from child artifact types in the report. Hence, if same custom attribute is added to multiple artifact types and you want to write a report on it, you no more need to create a separate traceability path for each type of artifact you want to report on. To trace multiple relationships from one artifact, or to add source artifacts, select the checkbox. For details on how to create traceability reports, read Tips for working with Report Builder traceability reports.

    • Click Add a relationship, and choose how to 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.
      Note: In Lifecycle Query Engine report, you can mix Append and Merge traceability paths in a single report. Merge paths take precedence and are evaluated first, and then the results are appended together. However, in Data warehouse report, you cannot mix Append and Merge traceability paths in a single report.
      Append in new columns
      To count the source artifact relationships separately, append the results in different columns.
      A dialog window shows options for combining the data from multiple traceability relationships.

      For more information, watch the following video:

    • 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.
    If you use Data Warehouse, you can trace relationships to iterations, releases, or timelines from the following artifact types: work item work item history, test case execution record, test case result, and test plan.
    Example: Show all open work items that are assigned to an iteration that is completed.
    1. Select Work Item in step 4.
    2. Click Add a relationship > Iteration, and then click OK.
      Traceability links that associate work items with iterations.
    3. Set Conditions in step 6.
      • To show only open work items, set the status group category for the work item to is not Closed, then click Add.
      • To focus only on work items that are assigned to an iteration that is completed, set the iteration end date to before today. Click Add and close.

    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 for 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 conditions.

    To further refine the content of your report, set conditions. You can set conditions for any attribute of the artifact type that you selected, and any attribute of the related artifact type 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 Related Test Case relationship. Then, set a condition to focus only on approved test cases. For the artifact type Test Case, choose the attribute State, and set the value to Approved.

    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 Edit icon.
    • To create logical groups of conditions, select the conditions and click Group.
    • To create nested groups of conditions, use the grouping buttons 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.
      • Not all match (AND NOT) is the negation of an AND group.
    For example, if a group has three conditions that are named A, B and C, the AND NOT operation is "NOT (A AND B AND C)."
      • None match (OR NOT) is the negation of an OR group. That is, if a group has three conditions that are named A, B and C, the OR NOT operation is "NOT (A OR B OR C)."
      Group of negated conditions using AND NOT or OR NOT
    • To reorder conditions, drag them into position.
    • To remove conditions, select them, and click Remove.
    LQE note: If your condition uses an is not statement, your report might show different results than an equivalent data warehouse report. If you use the is not operator for a specific attribute value, the report shows only artifacts with different values from the specified one. 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 one you specified, and also artifacts with unassigned values, create two conditions and group them with Some match (OR).

    Example: 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.

    Note: When you filter the Requirement ID that uses single or double digits instead of the full ID, the results display all the entries with the mentioned digits. For example, if you filter by the digit 1, all the entries with the Requirement IDs as 1, 21, 103, 912 displays in the filtered results list.
    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 set your conditions, click Continue.