Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
protogrid:filter [2019-11-29 14:49] – created 46.140.51.3protogrid:filter [2023-05-16 13:57] (current) – [Filter] dru
Line 1: Line 1:
 ====== Filter ====== ====== Filter ======
  
-====== TableViews ======+Protogrid has built-in filter mechanisms which are enabled by default for the most common use cases. For example if you have embedded a tableview on a proto for displaying next working steps the displayed entries are automatically filtered so only those next working steps are shown which are assigned to the current responsible (which is placed in a relation field on the same proto).
  
-A Filter is basically a field for choosing a filter condition and limiting, which items are shown in the list of all Cards in a TableView.+For every field type you can control specific behavioral aspects which are related to data filtering.
  
-By choosing one of the filter options the related cards will be displayed.+Additionally to data filters Protogrid provides 2 data security features to restrict access to data: "Read Access Role Definition" and "Write Access Role Definition" fields (see [[protogrid:Read And Write Access Role Definition|Read And Write Access Role Definition]]). 
 +==== Filter Options ====
  
-=== Defining Filter ===+Depending on the field type you have any of the following filtering options available for field definition:
  
 +=== Limit Using Compatible Filters on the same Card ===
  
 +Available for: Relation Field Definition, Tag Field Definition
  
 +The available choices are filtered using neighboring relation fields and filters that use the same Proto as a relation field in the target data.
 +
 +=== Additional filter based on read access setting ===
 +
 +Available for: Relation Field Definition
 +
 +The available choices are filtered based on the read access rights of the target data. The system default is that users can see the shortname of a card, even when the card itself is resticted from access using a read access role definition.
 +
 +=== Disable filter effect on neighboured fields on the same card ===
 +
 +Available for: Relation Field Definition
 +
 +With this option you can disable the filtering effect on neighboring relation or tags fields. 
 +
 +=== Filtering of cards represented in this field ===
 +
 +Available for: TableView Definition
 +
 +With this option you can control if the TableView is filtered at all, only by filter fields, only by relation fields, or both.
 +==== Filter Fields ====
 +
 +A Filter field is basically a field for choosing a filter condition and limiting which Cards are shown in a Table View or Chart View.
 +
 +Currently there exist 4 types of filter fields:
 +  * Relation Filter Field
 +  * Text Filter Field
 +  * Number Filter Field
 +  * Date Filter Field
 +
 +=== Relation Filter ===
 +
 +A relation filter field let's the user select from the available values in the target field and limits the embedded tableview based on the selection.
 +
 +=== Text Filter ===
 +
 +A text filter field let's the user enter any input. Filtering occurs only on full match of the input term.
 +
 +Please note that the content of text fields is relevant for filtering only up to and including the 300th character.
 +
 +=== Number Filter ===
 +
 +A number filter field let's the user enter any input. Filtering occurs only on full match of the input number.
 +
 +=== Date Filter ===
 +
 +A date filter field provides a date picker to select a date. Filtering for time values is not supported.
 +
 +
 +=== Example: Creating a Relation Filter to filter a Table View ===
 +  - Open the Proto on which the Table View, you want to filter, is defined
 +  - Go to "Fields and Widgets" and then click on the "Create" button on the right
 +  - Choose "Relation Filter Definition" to create a new "Relation Filter Definition" on the current Proto
 +  - Assign a meaningful name for the new Relation Filter Field
 +  - Define the "Related Proto" so that Cards based on this Proto will become filter choices
 +  - Save & Close the "Relation Filter Definition"
 +  - The new "Relation Filter Definition" now appears at the bottom of the "Fields and Widgets" list. You can drag & drop it to the desired position in this list
 +  - Open the Table View you want to filter, and use the new "Relation Filter Field" to choose your filtering value
 +
 +=== Example: Creating a Date Filter to filter a Chart View ===
 +  - Open the Proto on which the Chart View, you want to filter, is defined
 +  - Go to "Fields and Widgets" and then click on the "Create" button on the right
 +  - Choose "Date Filter Definition" to create a new "Date Filter Definition" on the current Proto
 +  - Assign a meaningful name for the new Date Filter Field
 +  - Define the "Filter Target DateTime Field", which is the field you want the data in the Chart View to filter for
 +  - Save & Close the "Date Filter Definition"
 +  - The new "Date Filter Definition" now appears at the bottom of the "Fields and Widgets" list. You can drag & drop it to the desired position in this list
 +  - Open the Chart View, you want to filter, and use the new "Date Filter Field" to choose the data to filter for
  
Print/export