Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info | ||
---|---|---|
| ||
In complex installations it is often desirable to have multiple ways to view the core types of data: Members, Activities, and Learning Plans a.k.a., Applications. For example, there may be multiple contexts in which a user may need to view or search Member data, and the relevant filter criteria, result columns, and access control business rules may be different in each one. System Administrators can use advanced configuration features to create separate search screens for each scenario, without needing any custom programming in the core application. |
Supported Entities
- /wiki/spaces/DOCS/pages/580681819
- /wiki/spaces/DOCS/pages/619544577
- Learning Plan Instance Search
- Member Search (DRAFT)
Common Functionality
Member Search was implemented first and contains some special features not supported in the other cases.
Search Form Configuration | |
---|---|
| |
Capability | Purpose / Syntax |
Configurable search form | The list of form fields displayed to the user is configurable, so that it can be restricted to only those properties that make sense for a given implementation. |
Search against values that are NOT in the Workflow Attribute collection | Each implementation of the search framework contains a base search model that can expose information that is not represented as Workflow Attributes. These properties can be targeted by a search field.
|
Search against values that ARE in the Workflow Attribute collection | To search against Workflow Attributes, use the "entity-scoped" syntax:
|
Configurable field labels | Each search field is given a label, and the label can be a fixed string or can be pulled from the Glossary.
|
Multiple search types |
|
Multiple input modes | Search values can be entered into the search form using a variety of different mechanisms.
(Member Search specific)
(Activity Instance Search specific)
|
Search Results Configuration | |
---|---|
| |
Capability | Purpose / Syntax |
Display columns of data NOT in the Workflow Attribute collection | Each implementation of the search framework contains a base search model that can expose information that is not represented as Workflow Attributes. These properties can be displayed in the results table.
|
Display columns of data that ARE in the Workflow Attribute collection | To display Workflow Attributes in the results grid, use the "entity-scoped" syntax:
|
Custom formatting | Custom formatting can be used to display a link:
|
Column labels using Glossary Terms | To give a column a label that is controlled by a Glossary term:
|
Custom actions or links for each search result | |
---|---|
| |
Capability | Purpose / Syntax |
FontAwesome Icon | Each custom link can use a FontAwesome icon
|
Entity-type-specific link handling | Each custom link can be given a custom CSS class, which can be used to add dynamic behavior to that link. (This is an advanced configuration and may require development assistance)
|
Custom Page Buttons | |
---|---|
| |
Capability | Purpose / Syntax |
Specify button order |
|
Entity-type-specific link handling | Each button can be given a custom CSS class, which can be used to add dynamic behavior to that button. (This is an advanced configuration and may require development assistance)
|
Forced Filters | |
---|---|
Capability | Purpose / Syntax |
Apply a custom search filter in addition to whatever criteria the user selects | { |
{ |
Additional Directives | |
---|---|
Capability | Purpose / Syntax |
Configure instructions, button labels, and other messaging |
|
Show or Hide the Workflow Button for each result row |
|
Specify default sort order |
|
Configure data set limits |
|
Perform a default search automatically on page load | "autoSearch": true |
Child pages (Children Display) |
---|
Jira Legacy | ||||||||
---|---|---|---|---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
The terms "queue" and "search" are both to describe this feature, but indicate different use cases. A queue is a page that shows users a list of things that they should work on next. This is often used to represent things like a "review queue" where the default criteria return the list of things the user needs to worry about. A search is a page that displays multiple search criteria fields and allows users to run ad-hoc searches. Technically speaking, a "queue" is just a "search" page with a default filter that does something meaningful. |