Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrjo committed Nov 28, 2018
1 parent a31eb58 commit a9195bb
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 45 deletions.
48 changes: 3 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,7 @@
# Custom Grid with deep export
# Allowed Values Audit

![](screenshot.png)

Note that as with other custom lists, the filter is only applied at the root level.

Additionally, items can be filtered by an ancestor portfolio item. (e.g. filter Features that are ultimately children of the higher level Theme).
If placed on a page that also has a [pi-ancestor-filter-broadcaster](https://github.com/RallyTechServices/pi-ancestor-filter-broadcaster),
and filter by ancestor portfolio item is enabled, it will listen to the broadcaster for the selected ancestor or project scope.

Several export options are provided and change depending on the root record type
chosen in Edit App Settings...

When a portfolio item is selected as the root type:

* **Export Portfolio Items...** Exports only portfolio items in the portfolio item tree that have been displayed due to the filter at the root level item. Portfolio items of every available level from the root level down are exported.

* **Export Portfolio Items and User Stories...** Only portfolio items and stories in the tree will be exported.

* **Export Portfolio Items, User Stories and Tasks...** These item types will be exported.

* **Export Portfolio Items and Child Items...** Portfolio items, stories, tasks, defects, and test cases will be exported. Test cases that are children of defects (that are children of stories) will be exported, as will defects that are children of test cases that are children of stories. If a defect is a child of a story and is also a child of a test case that is displayed, the defect may not appear where you expect.


When user story is selected as the root type:

* **Export User Stories...** Only stories in the tree will be exported.

* **Export User Stories and Tasks...** These item types will be exported.

* **Export User Stories and Child Items...** Stories, tasks, defects, and test cases will be exported. Test cases that are children of defects (that are children of stories) will be exported, as will defects that are children of test cases that are children of stories. If a defect is a child of a story and is also a child of a test case that is displayed, the defect may not appear where you expect.

If this app is on a Timebox Scoped page, then the appropriate timebox filter
will be applied if the Timebox is valid for the queried model. If the Timebox
is not valid for the selected model, then the Timebox scope will be ignored.

Optionally, project scope can be ignored.

### Caveats
* If an item has a parent that is out of scope, then that item's relationship will not be seen.

* When a portfolio item is chosen as the root level type, the output will contain a column for each portfolio item record type. For lower level items, these columns will be populated with the FormattedID of the ancestor portfolio item that it is associated with.

* The output will contain a column called User Story that represents the top level user story that the item has as an ancestor. If the story hierarchy has multiple levels, the lower level items will continue to put the top level user story ID into this field. Use the fields of the lower level record types to display the closer related record. For example, if a task is on a grandchild story, the grandparent story will show in the User Story column. To show the story the task belongs to directly, choose the WorkProduct field to export.

* For portfolio items and stories, it is possible that the associated ancestor column (e.g., User Story) will have the current record's ID if that record is the appropriate level.
Show a list of portfolio items that have an invalid value in the selected field. This is useful when trying to
find and update artifacts when the allowed values for a custom field are modified.

## Development Notes

Expand Down
Binary file removed screenshot.png
Binary file not shown.

0 comments on commit a9195bb

Please sign in to comment.