From RPM Wiki
| Table of contents |
[edit]
Summary
Views are used to display information in a table (grid). This grid has columns defined by the view, rows defined by the view (filters), paging, sorting, and an Excel download.
[edit]
Details
[edit]
View selection
- Custom views are used by selecting one by name from the custom view selection menu in the Grid control bar
- This feature is only for staff.
- Per user the last view for each category is saved in the session and is used as the default view for that page.
- If the user hasn't selected a view yet or the view that should be used has been deleted, use the built in "All" view
- Views are listed in this order:
- Built-in
- Shared
- Private
- Temporary
[edit]
Task column
Regardless of the view’s column setup, a special task column is always rendered as the left most column.
- This column has no header
- This column shows simply a link "View"
- The link goes to the appropriate details page for whatever it is the users is "Selecting" on this page (the whole purpose of the page)
- This column is the only thing in the grid displayed as a normal link, everything else is "gridLink"
[edit]
Links
- If the contents of a column are a name or other unique id and there is a details page for the content then the column contents should be a link to that page. Examples include Supplier, Agency, Account, etc.
- Use the "gridLink" style where the link is only revealed on mouse over.
- "Task" columns are an exception, they are always shown as regular (underlined) links (see above).
The following column contents are displayed as links (gridLink class unless they are the "task" column). Note that they can come from different columns, for example both owner and staff reference columns contain staff and both are subject to these linking rules.
| What | To |
|---|---|
| Process | Select a (process) |
| Staff | Staff details |
| Supplier | Supplier details |
| Customer | Customer details |
| Account | Account details |
| Agency | Agency details |
| Rep | Rep details |
| Commission run | Commission run summary |
| Commission item | Commission item |
| Process | Select a {PROCESS} |
| Agency adjustment | Select an agency adjustment |
| Supplier adjustment | Select an agency adjustment |
| Commission group | Commission schedule |
| Product | Product details |
| Email address | mailto: link |
| Website | Opens the link in a new window |
| Schedule (agency) | Agency commission schedule page |
| Account group | Account group details page |
[edit]
Paging
- All these grids will use paging.
- Paging is the "encyclopedia Britannica" style that lists the range of values for each page. The values come from the column currently being sorted by since that both guarantees consecutive order and is most likely what the user is concerned about trying to find a page by.
- There is one exception and that is commission items. Commission items use a custom "set of pages" paging method because of the potentially great number of items.
[edit]
Footer
- Commission item views have a "Total" row that sums any money columns
- Other custom views do not have a sum row
[edit]
Security
- Use of view functionality for a given category requires access to the information in that category.
- Example: To use view for the process "Order", a staff user would have to belong to a role that has privilege to see "Order" forms.
- If a staff user has access to that category then no further privilege is required to use shared & private views and edit & save private views.
- Saving shared views in any category requires the "Save shared views" privilege.
[edit]
History
- This page was last modified 18:51, 26 Sep 2006.
- This page has been accessed 1358 times.