Filters by Entity Fields in Historical Visual Reports
Visual Reports in Targetprocess can process historical records. Two of the available reporting modes support past data records: Cumulative, Burn Up & Down Reports and History Changes & Transitions. Data sources for the reports are based from historical events and modification logs related to Targetprocess entities. Entities of multiple types such as User Stories, Tasks, Bugs, Features, Epics, Projects, Requests, Test Plan Runs are supported. In this article we'll describe how to filter the data source by fields and properties of the entities.
Learn more about how to filter records in the data source by date ranges in the other article: Filters by Date Ranges in Historical Visual Reports.
The Filters described below are set on the Setup tab of the Visual Reports
editor with History mode selected.
The filters in Filter and Date Range / Releases / Iterations / Team Iterations areas are combined together with AND condition.
Filters by Fields available in Modification Records
Modification records in Historical Reports log changes related to multiple fields and properties of the entities. For instance, it is possible to track changes of Effort, Time Spent and Time Remain values, Entity State, Start and End dates, Planned Start and End dates, Modify and Last Comment dates, Business Value (Priority) and Severity, Creator, assigned Project, Team, Release, Sprint (Iteration), Team Iteration, parent Feature and User Story. You can filter the modification records by the values modified in these fields.
Syntax of the filters is quite similar to the one used in Advanced Filters for Views and other Visual Reports.
| Entity | Filter | Result |
| (any type) | ?EndDate is not None | All past modifications that happened during the times when entities were incomplete |
| (any type) | ?EntityState is 'In Progress' | All past modifications that happened during the times when entities were in "In Progress" workflow state |
Filters by previous values
To track how exactly has the value in some particular field been changed refer to PreviousHistoryRecord resource in the filters.
| Entity | Filter | Result |
| (any type) | ?EntityState is 'In Progress' and PreviousHistoryRecord.EntityState is 'Backlog' | Events when state has been changed from a given one to the other specified one |
| (any type) | ?TimeRemain > PreviousHistoryRecord.TimeRemain and PreviousHistoryRecord.TimeRemain > 0 | Events when amount of remaining time increased |
Filters by Present Values of Fields in Entities
Modification records in Historical Reports do not log updates of some of the fields of the entities. The following most common fields are missing in Modification Records:
- Custom Fields
- Nested collections
- Team Workflow States
It is not possible to refer to historical states of custom field values and nested collections in Historical Reports. However it is still possible to use "present moment" values of these fields in the historical reports and refer to these values in the filters as well. Please apply type-specific filters with "Current" keyword for this purpose.
Use "Current" filters anytime when you need to refer to "present moment" assignments of the entities rather than to the "past" ones. Learn the difference:
| Entity | Filter | Result |
| Feature | ?Release is '2.0.4' | All past modifications that happened during the times when selected features were assigned to the release '2.0.4' |
| Feature | ?CurrentFeature.Release is '2.0.4' | All past modifications that happened with the features assigned to the release '2.0.4' now |
The filters below are specific to entity types. In the reports with multiple entity types selected together apply them to the proper entity-specific Filters input areas under Advanced filtering options panel.
Every entity in Targetprocess has its own unique ID number assigned. Syntax for filters by numeric IDs in Historical Reports differs from the one used in Entity Reports. It is caused by the fact that ID in Historical Reports is related to a number of modification history record of an entity rather to the entity itself. Here are the field names you should refer and the syntax you should use in the filters:
| Entities | Filter | Result |
| User Stories | ?CurrentUserStory.ID == 12345 | Modification records of User Story #12345 |
| Tasks | ?CurrentTask.ID == 12345 | Modification records of Task #12345 |
| Bugs | ?CurrentBug.ID == 12345 | Modification records of Bug #12345 |
| Features | ?CurrentFeature.ID == 12345 | Modification records of Feature #12345 |
| Epics | ?CurrentEpic.ID == 12345 | Modification records of Epic #12345 |
| Projects | ?CurrentProject.ID == 12345 | Modification records of Project #12345 |
| Requests | ?CurrentRequest.ID == 12345 | Modification records of Request #12345 |
| Test Plan Runs | ?CurrentTestPlanRun.ID == 12345 | Modification records of Test Plan Run #12345 |
It is possible to use "present moment" values of the fields and properties of entities in the historical reports. You can refer to these values in the filters as well. Please apply type-specific "Current" filters for this purpose. For example:
| Entities | Filter | Result |
| User Stories | ?CurrentUserStory.Tasks.Count > 0 | Past modification records of all the user stories that have tasks at the present moment |
| Bugs | ?CurrentBug.Tags.Where(Name is 'urgent') | Past modification records of all the bugs that are classified as 'urgent' within assigned tag at the present moment |
| User Stories | ?CurrentUserStory.Unit is 'UX&Solutions' | Past modification records of all the user stories that are classified as 'UX&Solutions' within Unit Custom Field at the present moment |
All the Advanced Filters can be combined together within AND, OR logical conditions and brackets.
Hide Deleted Entities
Deleted items are displayed in historical reports by default. To hide them please apply the following entity-specific filters to your source data:
| Entities | Filter | Result |
| User Stories | ?CurrentUserStory.ID is not None | Hide deleted User Stories |
| Tasks | ?CurrentTask.ID is not None | Hide deleted Tasks |
| Bugs | ?CurrentBug.ID is not None | Hide deleted Bugs |
| Features | ?CurrentFeature.ID is not None | Hide deleted Features |
| Epics | ?CurrentEpic.ID is not None | Hide deleted Epics |
| Projects | ?CurrentProject.ID is not None | Hide deleted Projects |
| Requests | ?CurrentRequest.ID is not None | Hide deleted Requests |
| Test Plan Runs | ?CurrentTestPlanRun.ID is not None | Hide deleted Test Plan Runs |
Source Data filters vs UI filters
Using UI filters in form of Entity Name / does not contain text / DELETED is possible but not reliable. In your source data you may have non-deleted entity with DELETED keyword in title. As a result the entity will be unintentionally filtered out together with truly deleted items. Use Source Data entity-specific filters as the best practice.
Filters in Historical Reports by Multiple Entity Types
In the reports with single entity type selected as Data Source you apply all the filters to Filter input area.
In the reports with multiple entity types selected together the primary Filter area supports only fields and properties that exist in modification records of all the selected entity types. When a field you refer to is missing on one of the type-specific modification records an error occurs.
To avoid errors, please apply type-specific filters to the proper type-specific History Filterinput areas under Advanced filtering options panel. Type-specific filters do not affect entities of other types.
