Page Queries and Filters
Page Queries and Filters
This page explains how to use page queries and filters so that your pages only display objects that match certain conditions that you specify.
By default Index Pages, and Association Type nodes on Object Pages, list all the instances of the Object Type you specified - for example all Processes in your model.
However, you can create association queries and conditional filters which result in only a restricted list. For example, you might want an Index Page which shows a list of Processes, but you only want to see Processes of a certain Category, or that are associated to another object.
These queries and conditional filters can be applied to most Index Pages, as well as most Object Pages which use Association Type nodes to display Associated Objects.
There are two types of conditional filters that can be applied to the results to form a query:
1.Filters based on object properties
2.Filters based on associations.
Filter Operators
Text-string filters and select-list filters can be combined in a formula using filter operators. This allows for greater versatility when filtering objects.
The filter operators and their functions are listed below:
|
Operator |
Function |
Description |
|
= |
equals |
Matches to any values that are equal to the inputted value. |
|
!= |
does not equal |
Matches to any values that are not equal to the inputted value. |
|
> |
is greater than |
Matches to any values that are greater than the inputted value. |
|
< |
is less than |
Matches to any values that are less than the inputted value. |
|
>= |
is greater than or equal to |
Matches to any values that are equal to or greater than the inputted value. |
|
<= |
is less than or equal to |
Matches to any values that are equal to or less than the inputted value. |
|
IN |
is within |
Matches to any values that are one of the inputted list of values. Operates with List, Text and Numeric values. |
Filter based on object properties
Filters based on object properties can be applied to any Layout or Behaviour on any Index Page or Association Type node on an Object Page.
These filters restrict the results based on one or more properties of the objects to be displayed.
You can add multiple property filters, which combine to form a single query where each condition must be met for the object to be included in the results, so for example:
Display all Processes where:
Category = 'X'
AND Validated = 'TRUE'
While individual conditions are joined with the AND operator in your complete filter query, when you add a condition referencing a Drop-down, ID or Single Line Text property, you can specify multiple values which are treated as OR within that particular condition. So, for example, you could create a filter query like:
Display all Processes where
Category = 'X' OR 'Y' OR 'Z'
AND Validated = 'TRUE'
|
|
IMPORTANT: You can only use OR conditions with the following standard property types: Name, Category, UUID, ID. User-defined property types are not supported: In addition, you can only use one OR condition in a filter set. NOTE: The OR operator is shown as 'IN' in the Evolve Designer interface. |
Add a property-based filter
Filters based on association
|
|
IMPORTANT: You can only use a filter based on association when you are not already using an Association Type node for any other purpose in your Index or Object Page. |
In addition to property based filters, you can restrict the list of objects displayed on a page by way of association. This could be by association to any object of a specified type, or to a specific object or objects of a specified type.
For example, you could create a filter like:
Display all Processes where Category = 'X'
AND Process Is Associated To any Location.
You could extend the filter to reference a specific associated object, such as:
Display all Processes where Category = 'Y'
AND Process Is Associated To Location 'Z'.
You can even extend these basic examples to add multiple nested association conditions to filter the results by way of indirect association. For example:
Display all Processes where Process Is Associated To any Location
AND where Location Is Associated To Organization 'UK'.
Finally, you can of course add property-based filters to any association filter, enabling you to create sophisticated page queries such as:
Display all Applications where Date for Review > 'date'
AND Application Is Associated To an Organization
where Organization Category = 'X' OR 'Y'
AND Organization Is Associated To the Location 'US'
|
|
When filtering results by association on an Object Page, remember that the parent node will always be an Association, so the list you are filtering is a list of associated objects. On an Object Page it is not possible to present a list of objects indirectly associated to the object that is the subject of the page. It is only possible to list objects that are indirectly associated to objects that are associated to the subject. |
Add a filter based on association
Filters Properties
The following properties can be used to configure a filter:
|
Name |
Notes |
|
Average Rating |
|
|
Category |
|
|
Created By |
Format: DD/MM/YYYY HH:MM:SS E.g.: 22/12/2015 14:34:42 |
|
Creation Date |
Format: DD/MM/YYYYHH:MM:SS E.g.: 22/12/2015 14:34:42 |
|
Date Validated |
|
|
Display Name |
|
|
Freeze Level |
|
|
Id |
|
|
Name |
|
|
Owner |
|
|
Template |
|
|
Total Comment |
|
|
Unique Identifier |
|
|
Updated By |
|
|
Updated Date |
Format: DD/YY/MMMM HH:MM:SS E.g.: 22/12/2015 14:34:42 |
|
Validated |
|
Property Groups
Property Groups
Working with Property Groups
Property Groups are page elements that display the properties of the object in question. They are used on Index Pages, such as within an Accordion, or Table, or in Object Pages.
There are two ways you can enter Property Groups into your pages:
1.By using the Empty Group option
2.By using the From CM Panel option.
The Empty Group option creates one group within the page and then you can choose which of the object's properties to display within it - nothing is selected for you by default
The From CM Panel option allows you to choose a group based on one of the Panes in the object's properties, such as General, and automatically selects all the properties within that Pane to be displayed in the group.
|
|
When inserting a Property Group, we recommend you only display a small number of properties in any particular group - |
Property Group Layouts
When you insert a Property Group there is a Layout setting which determines how the content within the group is displayed.
Certain layouts only work with certain types of properties. Please use the Property Group Layout Table to see which layout to use when.
Property Groups and Tables
The Property Group feature is also used when configuring a Table to specify which properties you want to be displayed as columns in the Table. The details for using Property Groups in this way are included in the instructions for creating a Table. See Working with Tables for further information.
What do you want to do?
Insert a Property Group on an Object Page
|
|
If you use Tabs on your Object Page you can only insert a Property Group beneath a Tab node. |
To insert a Property Group on an Object Page:
1.Expand the node for the Object Page you want to add the Property Group to
2.Right-click the node (Tab or Object Type) you want to add the Property Group to and choose
New Property Group > Empty Group, or New Property Group > From CM Panel > [Group Name]
See the beginning of this page for explanations of each option.
3.Configure the Property Group settings:
- Use Property Group Name to specify the name of the group as it is displayed in the web page.
- The Identifier setting holds a unique identifier for the Property Group. You should have no reason to change this setting.
- Use Layout to specify which layout to apply to your Property Group.
See Property Group Layouts for explanations of each layout type.
- Use Selected Properties to specify all the properties that will be displayed in the Property Group.
|
|
Remember, we recommend only using a small number of properties in any one group. |
4.Save your Site.
The Index Page's properties are saved.
Insert a Property Group inside an Index Page Accordion
To insert a Property Group inside an Index Page Accordion:
1.Expand the node for the Index Page you want to add the Property Group to
2.Right-click the node that is two steps above the Accordion you want the Property Group to be displayed in and choose
New Property Group > Empty Group, or New Property Group > From CM Panel > [Group Name]
See the beginning of this page for explanations of each option
3.Configure the Property Group settings:
- Use Property Group Name to specify the name of the group as it is displayed in the web page.
- The Identifier setting holds a unique identifier for the Property Group. You should have no reason to change this setting.
- Use Layout to specify which layout to apply to your Property Group.
See Property Group Layouts for explanations of each layout type.
- Use Selected Properties to specify all the properties that will be displayed in the Property Group.
|
|
Remember, we recommend only using a small number of properties in any one group. |
4.Save your Site.
The Index Page's properties are saved.
Property Group Layouts
When you use Property Groups to display object properties within your Site Pages, you must choose a Layout to apply to the group.
The layout controls how the properties are displayed, but some layouts are only to be used with certain types of property.
The table below details each layout and in which case it should be used:
|
Layout |
Description |
Used for |
|
table |
This is the default layout which can be used with any type of property. Properties are displayed in a tabbed format with property name > property value. |
Any type of property, except multi-line text fields. |
|
FlatList |
The FlatList layout is especially useful on Diagram Popouts as it can be used to combine multiple properties, including multi-line texts, in one simple 'flat' layout. |
Any type of property - especially on Diagram Popouts |
|
memotext |
This layout is especially for multi-line text properties, such as 'Description'. It is better at presenting potentially longer pieces of text than the standard table. The use of Enhanced Multi-line Text Control will enable the use of rich text formatting for HTML content. |
Multi-line text fields with plain text content. |
|
htmlbox |
This layout is has been deprecated in version 3.0 and replaced with the Memotext Layout (above). |
n/a |
|
helptext |
This layout allows users to proceed without selecting any properties. The Property Group Name can then be used to display help text |
Displaying help text |
|
gauge |
The gauge layout displays a visual gauge on a scale of 0 to 100. The pointer represents the value of the property. This type of layout is especially useful for displaying percentages in a visual way. |
Number fields where the value is between 0 and 100. Text fields which include just a number will also work. |
|
embedURL |
The embedURL layout creates a frame within your page that can open and display the target of a URL property - as long as it is properly formatted and starts with 'http://'. Therefore, if you have a URL property which contains a link to your corporate website, you can display the web site within the frame in your object page. If you want to use this layout in your Property Group, you can only use the group to reference one property. Note: In order for URLs to work in this way, the URL property on your object must be on its own Pane. See the CW Suite help for positioning Property Types on Panes. Note 2: You cannot edit the URL Property using the embedURL layout. To make a URL property editable in Evolve you must expose the property on another part of the Object Page. [Note 3:] If you reference a PDF document, ensure that if your users are accessing your Site using Internet Explorer that they have a PDF reader plugin installed. |
URL property types only. |
|
image |
The image layout is used to display properties that are image files, and result in the image being displayed in the web page. Images are not commonly used as properties. |
Image property types only. |
|
imageFromURL |
The imageFromURL layout is used to display an image for an object which uses a Single-Line Text or URL Property Type to store an HTTP reference to an image file. If you want to use the imageFromURL layout in your Property Group, you can only use it to reference one property. |
URL or Single-Line Text properties used to store HTTP references to an image file. |
|
radar |
The radar layout is used to create a chart that displays three or more Object properties on different axes which start from the same central point. |
Number fields |
Property Group Name
The property group name is displayed in the title bar of the property group. In the case of options such as 'embeddedURL' or 'imagefromURL' the default title is the full URL.
Since Evolve 2016.1.1 the ability to use a 'Custom Display String' means it is now possible to use any text, or property variables in this display.
For example: The default use of an embeddedURL may look like this:
However the URL is seldom a useful attribute. So using the 'Custom Display String' to display some simple text, and optionally a variable (e.g. Name), it is possible to adjust the configuration like this:
