Handler - EntitySearch
- You should never use attributes containing
EntitySearchhandler in table searches, as this will almost certainly result in performance problems (because every time such an attribute is displayed as a search result, additional searches due to the handler are also performed). - For the same reason attributes containing
EntitySearchhandler should not be included in saved reports. - As of Refreshed Efecte (E7) attributes with
EntitySearchhandler are excluded from list (table) views by default.
EntitySearch handler adds dynamic search results in data card edit and display views as illustrated below. The attribute with this handler looks the same in both the edit and display views.
Example of EntitySearch in data card display and edit: on an "Incident" data card, the handler is configured to search for recent incidents from the same contact person:
The default outlook of the EntitySearch handler results list may be altered by using isReferenceShowSelected general meta data.
The search conditions are specified using EQL ("Efecte Query Language"), which is a powerful tool for defining arbitrary searches. In the attribute metadata edit view, there is an editor for constructing EQL queries. See the EQL Editor documentation for more information about using the editor.
EQL query for the "related incidents" example. "Edit" button opens the EQL editor:
- It is not recommended to edit
EQLmanually but by using theEQL Editor. - Please note that #
target# macro can not be used with theEntitySearchhandler. Use #referrer# macro instead. -
EntitySearchhandler generates the attribute values dynamically, based on search results. This means that the values can not be edited manually, nor can they be used as quick or advanced search conditions.
Additional potent EQL capability designed to elevate your queries: harness the 'hidden' option to finely adjust results based on data card visibility, enabling targeting of 'visible' or 'hidden' cards. The 'hidden' flag can also be combined with other filters, such as 'deleted', to further refine query outcomes. This feature seamlessly integrates with the editor for enhanced functionality. For example, we can add to the query 'hidden = 0 and deleted = 0'.
Furthermore, exercise control over data card display on result lists through the HiddenState handler. Configuration can be established on the 'first' attribute page, granting nuanced management over data card visibility. This specification synergies with search bindings utilizing the 'hidden' option, enhancing your understanding as highlighted previously.
Optimize queries across multiple templates by leveraging 'or' conditions. This empowers you to extract data cards from diverse templates within a single query. Please note that this 'or-conditions' method is not supported within the editor's environment and opening such a query in the editor may convert them to 'and-conditions'.
Table 1. Attribute Settings
| Handler name | Datatype |
|---|---|
EntitySearch |
Reference |
Table 2. Required Attribute Metadata
| Name | Value | Description |
|---|---|---|
Query |
[EQL clause] |
See EQL Editor |
Table 3. Optional Attribute Metadata
| Name | Value | Description |
|---|---|---|
limit |
[an integer value] |
Number of matching data cards to show directly on the data card. When the number of matching results exceeds the total number, the user can click " If limit is set to 0 (and there are some matching data cards), only the " |
Table of Contents