Search Action Parameters
Learn about the input arguments supported by the Search Action Parameters.
The Search
action supports the following input arguments:
fixedFilterName
Allows you to specify a fixed filter which is applied to the search and cannot be changed by the user. The filter name is not visible for the user.
<InfoAreaId>.<FilterName>
in the action definition (e.
g. KP.Filter1
).fixedFieldValues
Fixed field values for the search. This cannot be changed by the user.
Syntax: <fieldId>:<value>
- You can specify either field IDs or XML names as
<
fieldId>
. - Separate multiple items by semicolons.
- If
<value>
is a string, it must be enclosed in double quotes. Do not use double quotes when specifying catalog codes.Example (for a FI search):
Company:"my search string";Country:#2;Rep2ID:"$curRep"
- The specified fields must be part of the respective Search control, otherwise they are ignored.
- To enter the current rep:
<fieldId>:"$curRep"
- To enter the current rep's group:
<fieldId>:"$curOrgGroup"
- To enter the current date:
<fieldId>:"$curDay"
- To enter the number of the current user's login language:
<fieldId>:LOGINLANGUAGE
- To set a value for a catalog field:
<fieldId>:#<catalogCode>
For hierarchical catalogs you can enter
<fieldId>:#<childCode>~#<parentCode>
Example: For a Ticket (KM)
Search
action you can defineProblem:#3~#1
instead of
ProblemGroup:#1;Problem:#3
- To set a value for a variable catalog field using the external key:
<
fieldId>:EXT:<external key>
Example:
ProblemGroup:EXT:1_324_2
- To set the value of a Boolean field enter
true
orfalse
. - If you want to enter a value from a linked record into a field in the search mask,
use the syntax
<targetFieldId>:<infoAreaId>.<fieldId>
Example: When searching for all mailings (BR) that were sent to a person (KP) and want to specify the mailing channel based on the person's preferred channel, enter
Channel:KP.PreferredChannel
in theSearch
action for mailings used in the person context menu. - If you have a field from a linked info area in your search mask, you can
automatically enter a value using
<infoAreaId>.<fieldId>:<value>
Example: To search only for persons with specific interests, enter
IT.InterestGrp:#2
in the personSearch
action
searchAndListName
The name of the Search&List configuration to be used.
If undefined or not found, the Search&List configuration
<infoAreaId>
is used. This is the default Search&List
configuration for the info area from which the action is called. For linked searches a
special logic is implemented for determining the Search&List configuration. For
further details, see Search&List Configuration.
defaultFilterName
Allows you to specify a filter which is applied to the search by default. Users are
still able to select another filter unless disableFilter
=
true
.
<InfoAreaId>.<FilterName>
in the action (e. g.
"KP.Filter1"). In Aurea CRM.Web they are then displayed as
<FilterName>
(e. g. "Filter1").createNewTab
See createNewTab in Expand Action Parameters.
filterNameSpace
Defines a namespace for the filters available on the Search page.
To use an info area multiple times, it is common to apply a fixed filter when calling
Search pages. If you do not want users to see all filters defined for an info area but
only those applicable to the context of the current Search page, you can define a prefix
in filterNamespace
. Users only see filters whose name begins with this
prefix in the Add more drop-down list.
Syntax:
<InfoAreaId>.<Namespace>.<FilterName>
Example: If you have two filters "FI.usage1.myFilter" and
"FI.usage2.anotherFilter", and specify "usage1" as the filterNamespace
of a Search page, the user only sees "myFilter" in the Add more
drop-down list of this Search page.
filterNamespace
for all your Search pages, otherwise filters are
displayed including the namespace.disableFilter
Disables the filter selection and definition functionality for the user. Both the predefined filters and the More Filters entry are removed from the Add more drop-down list of the Search page.
Search.NoFilterDefinition
(type: Checkbox): This removes the
More Filters entry from the Add more
drop-down list on all Search pages. For further details, see Search.NoFilterDefinition. Users
may only select predefined filters and can no longer create or edit any filters in Aurea
CRM.Web.link/linkId
link:
Optional parent record of the search results (for linked
searches, example - all MA records linked to a KP): Record
or
Linked
.
linkId
: ID of the link used for link
(default=-1
i.e. the default link). This parameter is only relevant
if multiple links between two info areas exist in the data model (example - mulitple
FI-links in KM). For further details, see Link IDs.
scripts
A comma-separated list of one or more (local) JavaScript files to be loaded to the page.
showSearch
If set to true
, the search mask is visible. If set to
false
, it is displayed collapsed and can be expanded by clicking
.
Default: true
relationName
Name of the relation to the parent/child records, for example $Children
for hierarchical info areas like OJ in the BTB vertical.
Possible values:
-
$Parent:
Reads the "logical" parent record, example - the parent record of a sub-ticket is a ticket etc. -
$ParentLink:
Reads the parent record as defined in the data model. -
$Children:
Reads the children of a record, example - all MA records of a KP.
selectionMode
Determines if users can select multiple rows from the list and thus perform action on multiple list items at once. The following values are available:
-
Single:
Selecting multiple list items is disabled. -
Multi:
Selecting multiple list items is enabled (default).
Default: Multi
listParams
Additional list parameters separated by semicolon: key,value;key,value;
etc. For durther details, see ListParams.
autoSearch
If set to true
, the search is immediately executed when the user opens
the page.
Auto-search does not happen when the user updates a filter in the search mask. If you
want auto-search to be activated when a filter is updated in the search mask, you have
to set autoApplyFilter to
true
.
Default = false
defaultFieldValues
Default field values for the search that can be changed by the user. Syntax. For further details, see fixedFieldValues.
Syntax for entering ranges and functions:
<fieldId>:<value>:<operator>
Example:
MA.Date:TODAY-7:>=;MA.Date:TODAY+14:<=
To avoid that a default value is overwritten by the user's search settings (see Remember Search Settings), use the
following syntax: !<fieldId>:<value>
Example:
!Street="Default Street"
defaultsUid
The uid of the record from which defaultFieldValues
are read:
Record
or Linked
. If undefined, the
link
argument is used as a fallback.
maxRows
Determines the maximum number of results returned by the search. This parameter
overrides the global value specified in the Search.MaxResults
Web
Configuration parameter. For further details, see Search.MaxResults.
subListParams
Additional list parameters for sub-lists separated by semicolon:
key,value;key,value;
etc. For further details, see ListParams.
subListParams
defined in the Search
action
override the corresponding SubListParams defined for individual
sub-lists in SearchSubList
headers. For further details, see Related Data area (Header Info Areas).createNewPopup
See createNewPopup.
autoExpandOnSingleHit
If set to true
and the search returns exactly one record, the search
results list is not displayed but the default action is automatically executed for the
record. For further details, see Default Action.
This setting overrides the global setting defined in the
Search.AutoExpandOnSingleHit
Web Configuration parameter. For
further details, see Search.AutoExpandOnSingleHit.
Default = false
sourceCopyFieldGroupName
The name of the field group used to define a dynamic filter for the search. The filter values are defined as functions in the List control. For further details, see Dynamic Filters.
flavor
Use this input argument to customize the behavior (example - default action, menu etc.) of a specific search view (example - in a process).
Available values:
-
Auto
-
Select
: A search view with flavorAuto
gets the flavorSelect
if used within a process or record selector. If used within a record selector, the buttons configured in theSearchResults
header are hidden. -
Search
: You can use this flavor to display the buttons configured in theSearchResults
header when using the search view in a process or form.Alternatively you can configure the buttons in the
SearchResultsSelect
header. In this case the buttons are available both in processes and record selectors that call this search view.
To make sure header buttons are displayed in a search view configured in a form, you can set SearchView > resultHeader > view > showButtons to true.
Default: Auto
sourceUid
The record from which values are read for dynamic filters. For further details,
see Dynamic Filters. If
undefined, link
is used as a fallback.
rememberSearch
Add this argument and set it to true
or false
to
override the global setting of the Search.RememberDynamicFieds
Web
Configuration parameter. For further details, see Remember Search Settings.