You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

A filter represents a set of run configurations that enable custom views of the data stored in DTP (see DTP Concepts). Filters show a subset of data that is associated with projects in the database. Many DTP REST API services require the filter ID to be specified when calling an endpoint.

 In this section:

Creating a Filter

A filter is automatically created when a new project is added to DTP, but you can create additional filters to facilitate custom views of the data associated with the project.

  1. Choose Report Center Settings from the settings (gear icon) menu.
  2. Choose Filters from the Administration menu and click Create Filter.
  3. Enter a name for the filter and choose a project from the Associated Project menu.
  4. Click Create to add the filter.

    You can still change the filter settings when the Create Filter dialog closes.
     

    Changes are saved automatically.

Automation Association of New Data

This setting affects how run configurations are added to the filter.

  • Choose None to disable the automatic association of data.
  • Choose Associated Projects to automatically associate data from the associated project with the filter. 
  • Choose All Projects to automatically associate data from all projects with the filter.

Example

Suppose you have a filter called "My Filter" with Associated Project set to "Cromwell" and your CI/CD pipeline runs C/C++test Static Analysis then sends the XML report to DTP:

  • Run 1: for Project named "Cromwell"
  • Run 2: for Project named "Drones"

If Automatic Association of New Data is set to Associated Project:

  • Run Configuration for run 1 will be automatically added to this filter. The results of run 1 will be associated with this filter.

If Automatic Association of New Data is set to All Projects:

  • Run Configuration for run 1 will be automatically added to this filter. The results of run 1 will be associated with this filter.
  • Run Configuration for run 2 will be automatically added to this filter. The results of run 2 will be associated with this filter.

Choosing All Projects will associate all incoming data from every project with this filter, which can clutter the filter with unrelated or unexpected data. You can prevent this situation by turning off users' ability to choose All Projects. To do this, set <auto-add-new-run-configurations-allow-all> to false in PSTRootConfig.xml:

    <filter-settings>
        <auto-add-new-run-configurations-allow-all>false</auto-add-new-run-configurations-allow-all>
    </filter-settings>

Configuring Filter Settings

After creating the filter, you can configure additional settings in the Filters Settings page. See the following sections for details about additional project configuration:

Editing Filters

  1. Choose Report Center Settings from the settings (gear icon) menu.
  2. Click on a filter name to view its settings. You can begin typing in the search bar to quickly locate your filter.
  3. Make changes (see Adding Run Configurations to Filters for filter configuration options) fit and click Save.

Deleting Filters

  1. Choose Report Center Settings from the settings (gear icon) menu.
  2. You can begin typing in the search bar to quickly locate the filter you want to delete. 
  3. Click the trash icon and confirm that you want to delete the filter when prompted.

Duplicating Filters

  1. Choose Report Center Settings from the settings (gear icon) menu.
  2. You can begin typing in the search bar to quickly locate the filter you want to duplicate. 
  3. Click duplicate icon and enter a name for the copied filter. 
  4. Click Create and make any adjustments when the dialog closes.


  • No labels