Working with report request


After populating the repository on the host with Code Coverage data, you can view this data in a Code Coverage report. A Code Coverage report is created by entering report criteria, applying any desired filters, and then running the report.

To create a report request

  1. On the activity bar, click the DevX Code Coverage icon. 
  2. Click Create Report Request image-2024-12-5_16-14-49.png.
    The Code Coverage Report Request page is displayed. 
  3. On the General tab:

    Field

    Description

    Report request name

    Enter a name for the report.

    Host

    From the host list, select a host.

    Repository

    From the repository list, select a repository or click Find to browse the repository for creating Code Coverage reports.

    Summary level

    Select an option to determine how data in the repository should be summarized:


      • Systems — Displays the summary information about all systems contained in the repository. 
      • Test IDs — Indicates the effectiveness of individual tests within a system and how completely the tests have tested each system. The Test IDs level gives the system name, test ID, and program of all programs in the repository. The load module and user ID are ignored. Each system can have multiple test IDs, and each test ID can have multiple programs. Programs with the same test ID and system name are merged.
      • Users — Indicates how much testing each user has done. It gives the system name, user ID, and program for all programs in the repositories. The load module and test ID are ignored. Programs with the same user ID and system name are merged.
      • Load Modules —Displays code coverage results for all load modules in the repositories. Code coverage results are merged for all programs in load modules with the same name—regardless of the system, test ID, or user ID. This is helpful when the same load module is used by several systems and the user wants to know the code coverage results regardless of the system that ran it.
      • Programs —Displays code coverage results for all programs contained in the repositories. It merges code coverage results for runs of a program that have the same compiled data and time, regardless of the systems, load modules, test IDs, and user IDs from which they were run.

    Combine altered debug sessions with unaltered sessions 

    Select the Combine altered debug sessions with unaltered sessions checkbox to merge debug and non-debug results, or clear it to leave debug and non-debug results as separate entries in the Code Coverage report.

  4. Select the Criteria tab and select one of the following tabs:

    Field 

    Description

    Specify names

    Enter any system, test ID, user ID, load module, and program names to retrieve only the data that matches the criteria. It is not necessary to complete all of the fields. You may use wildcards as a suffixes. Leaving all fields blank retrieves all data.

    Specify a list

    From the Type list, select a type, and then select items from the list showing all items for the selected type present in the selected repository.

  5. On the Filter tab, you can perform the following tasks:

    Purpose

    Action

    Apply existing filters to the report

    In the Search field, enter the filter name and select the filter.

    Create a new filter

    1. Click Add.
    2. In the Add Filter dialog box, specify the following options:

      • In the Type field, select the filter type.
      • In the Scope field, select the scope type.
      • In the Begin mask field, enter the mask details:
        • For a line mask, type the text string to search for in the Begin mask field, the starting column position in the Start field, and the ending column position in the End field.
        • For a block mask, enter the starting text string to search for in the Begin mask field, enter the ending text string in the End mask field, and enter the starting and ending column positions to search.
      • In the Match criteria field, select the matching option to use:
        • Within start/end range — Finds the text string anywhere it occurs between the start and end columns.
        • Exactly at start position — Finds the text string when it starts at the starting column position.
        • Whole word — Optional) Finds the text string of a line mask only when it occurs as a whole word, not when it is embedded within other words. This option only applies to line masks.

    3. Click OK to save the filter.

    Edit a filter

    1. Right-click the added filter in the table and click Edit.
    2. Edit the required field and click OK.

    Remove a filter

    Right-click on the added filter in the table and click Remove.

    Click OK. The newly created filter is added to the list.

  6. Click the Location tab, and select the report location where you want to save the report. By default, the User option is selected.

    Important

    • You can only see the User option in the Location tab if you are not inside any workspace.
    • You can see the User and Workspace options in the Location tab if you are inside any workspace.
    • You can see the User, Workspace, and Workspace Folder options in the Locations tab if have set up multi-root workspaces.

    The Run or Save action should take into consideration the location option specified.

  7. Click Run to view the report or Save to save the report. The Code Coverage Report: <report name> page is displayed when you click Run.

    image-2024-12-5_21-24-49.png

    Click on the program or right-click and select View Annotation Listing to view the annotations data related to the selected program. The ANNOTATIONS tab is displayed with the annotation data. You can filter the annotation data as required. You can also see the color-coded annotation listing in the program.

      • Green color:  Executed status
      • Red color: Unexecuted status
      • Yellow color: Partially executed status

In the annotation listing, you can see the following filter icons if filters are applied.



      • image-2024-12-20_10-42-9.png: Exclude
      • image-2024-12-20_10-43-44.png: Critical
      • image-2024-12-20_10-44-1.png:  Exclude and critical

To edit a report request

  1. Right-click on the report request and click Edit. The Code Coverage Report Request page displays all the report request details you entered while creating the report request.
  2. Edit the fields as required in the General, Creteria, Filters, and Locations tabs.
    In the Locations tab, you can perform the following actions:
    • If you are inside the workspace and have created a report request under workspace settings, you can see an option to move the report request to User settings.
    • If you are not inside any workspace and have created a report request under User settings, you won't see any option to edit the location.
    • If you are inside the multi-root workspace and have created a report request under a specific folder, you can move the request to another multi-root folder or user settings.
  3. Click Save to save your changes.

To duplicate a report request

  1. Right-click on the report request and click Duplicate. A copy of the selected report is created with the name <report request>1.
    The duplicate report request is added to the same location where the original report request was created.

To delete a report request

  1. Right-click on the report request and click Delete. You see a confirmation message to delete the report request.
  2. On the confirmation message click Yes to delete the report request. 


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*