general_navigation_grids [CE Item Writing (CPS)]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Grids ======
Grids are used to display information (like [[general_navigation#audit|Audits]]), select records to edit (like [[candidate_entry|Candidates]] or [[attachment_entry|Attachments]]) or to select objects to link to other objects (like linking Attachments to an [[item_entry|Item]] or Items to an [[exam_entry|Exam]]).

{{:wiki:grid.png?600|}}

===== Pagers =====
Paging lets users view large sets of data in small chunks for faster loading and easier navigation. Most grids in the system use paging to break up the large data into manageable pages.  The paging controls let users navigate to first, previous, next and last pages.  The user can also jump directly to a specific page.  The user also has the ability to customize the page size and/or setting the number of records shown on each page.

{{:wiki:gridpagers.png?600|}}

===== Context Menu =====
Each grid has a header context menu.  By right-clicking the header row of the grid (where the column titles are) a context menu is opened.  

The context menu give the user the ability to sort the selected column (ascending or descending), best fit all of the columns shown in the grid or to individually hide or show each column in the grid.  As more columns are shown in the grid, the columns widths adjust to fit the information.  If enough columns are added to the grid, then a horizontal scroll bar will appear allowing the user to scroll over to see the additional columns.  By showing or hiding columns, the user can limit the information they wish to see in the grid.
 
{{:wiki:gridHeaderContext.png?600|}}

===== Scrolling =====
{{:wiki:gridHorizontalScroll.png?600|}}
{{:wiki:gridverticalscroll.png?600|}}

===== Filters =====
Grids give the user the ability to filter on the grid data to drill down to specific sets of records.
  - Select column to be filtered and enter the filter value in the filter control. 
  - Click the filter button
  - Select a filter condition from the filter context menu

==== Filter Conditions ====
^ Filter      ^ Description       ^ Example          ^
| No Filter | Clears the current filter from the column | |
| Contains | Searches the column text for any row that has the filter value contained in it. | Example: "cat dog fish" contains "cat" |
| Does Not Contain | Searches the column text for any row that does not have the filter value contained in it. | "cat dog fish" does not contain "horse" |
| Starts With | Searches the column text for any row that begins with the filter value. | "cat dog fish" starts with  "ca" |
| Ends With | Searches the column text for any row that ends with the filter value. | "cat dog fish" ends with  "sh" |
| Equal To | Searches the column for any row that is equal to the filter value. | If filter="35" then a row with value "35" is shown and a row with value "26" is not shown. |
| Not Equal To | Searches the column for any row that is equal to the filter value. | If filter="35" then a row with value "35" is not shown and a row with value "26" is shown. |
| Greater Than | Searches the column for any row that has a value greater than the filter value. | If filter="35" then a row with value "35" or "20" is not shown and a row with value "56" is shown. |
| Less Than | Searches the column for any row that has a value less than the filter value. | If filter="35" then a row with value "35" or "50" is not shown and a row with value "25" is shown. |
| Greater Than Or Equal To | Searches the column for any row that has a value greater than or equal to the filter value. | If filter="35" then a row with value "35" or "56" is shown and a row with value "25" is not shown. |
| Less Than Or Equal To | Searches the column for any row that has a value less than or equal to the filter value. | If filter="35" then a row with value "35" or "20" is shown and a row with value "50" is not shown. |
| Between | Searches the column for any row that is greater or equal to filter value1 and less than or equal to filter value2.  Filter value1 and Filter value2 are entered with a space between them. | If filter value1="c" and filter value2="f" then row with value "a" of "j" would not be shown, but rows with value "c" or "e" or "f" would be shown. |
| Not Between | Searches the column for any row that is less than or equal to filter value1 or greater than or equal to filter value2.  Filter value1 and Filter value2 are entered with a space between them. | If filter value1="c" and filter value2="f" then row with value "a" of "j" would be shown, but rows with value "c" or "e" or "f" would not be shown. |
| Is Empty | Searches the column for any row that has no text in the column. | cat or "dog" would not be shown, but if the column had no text, it would be shown. |
| Not Is Empty | Searches the column for any row that has text in the column. | cat or "dog" would be shown, but if the column had no text, it would not be shown. |
| Is Null | Searches the column for any row that has a value of Null.  Null is a database concept that is used to indicate no value has been set for this field.  Null is not the same as an empty text or a number=0. |  |
| Not Is Null | Searches to column for any row that does not have a value of Null.  Null is a database concept that is ued to indicate no value has been set for this field.  Null is not the same as an empty text or a number=0. |  |

==== Filter Options ====
There are different filter options based on the data type of the grid column.

=== Numeric Filter ===
{{:wiki:gridNumericFilter.png?200|}}

=== Text Filter ===
{{:wiki:gridtextfilter.png?200|}}

=== Status Filter ===
{{:wiki:gridstatusfilter.png?200|}}

=== Boolean Filter ===
{{:wiki:gridcheckboxfilter.png?200|}}

=== Date Filter ===
{{:wiki:griddatefilter.png?200|}}

===== Selecting Records =====
To select a record in the grid, left click anywhere in the grid row.

{{:wiki:gridselect.png?600|}}
==== Multi Row Selection ====
Some grids support multi row selection.  This could be done for a bulk action on those rows (like Bulk Delete) or to select multiple rows to link an object to another object (like adding Items to an Exam).  

=== Ctrl Selecting ===
Grids support control clicking (ctrl key + left click) to select or unselect a single row.

{{:wiki:gridctrlselect.png?600|}}
=== Shift Selecting ===
Grids support shift clicking (shift key + left click) to select a range of rows.

{{:wiki:gridshiftselect.png?600|}}

===== ToolBar =====
{{:wiki:gridtoolbar.png?600|}}

=== New ===
New creates a new record of the grid object and navigates to that objects edit page.  For example, on the Attachment Entry grid, New creates a new Attachment and on the Reference Entry grid, New creates a new Reference.

=== Bulk Action ===
Bulk Action gives a listing of actions that can affect one or more selected records.  These actions vary from grid to grid and some grids do not have any bulk actions.  Typical bulk actions are Update, Expire and Copy.  Bulk Actions require a row or rows in the grid to be selected.  If no row is selected then Bulk Action reports a warning to the user.

=== Usage ===
Usage will navigate to the [[usage|Usage page]] and displays Usage information for the selected record.  Usage requires a row in the grid to be selected.  If no row or multiple rows are selected then Usage reports a warning to the user.

=== Audit ===
Audit will navigate to the [[audit|Audit page]] and displays Audit information for the selected record.  Audit requires a row in the grid to be selected.  If no row or multiple rows are selected then Audit reports a warning to the user.

=== Grid View ===
A View is the set of columns that are shown in the grid.  Grid View will popup the [[gridview|Grid View page]].  Here users can create, modify, select or delete views.

=== Export ===
Export dumps the data displayed in the grid to either an Excel spreadsheet, Word document or CSV (comma separated values) file.  The content dumped only includes grid columns and rows that are visible.  So, the columns that are shown in the grid are shown in the export file.  The columns hidden in the grid are not show in the export file.  The rows that are visible in the grid are visible in the export file.  The rows that are suppressed by filtering are not show in the export file.

=== Refresh ===
Refresh queries the database for new data.  This will update the information displayed in the grid and reflect any changes to the data since the last data fetch.

=== Clear Filter ===
Clear Filter removes any filter conditions applied to all of the grid columns.