QueryRun Action Parameters
Supported QueryRun Action Parameters
The QueryRun
action supports the following input arguments:
scope
Defines which kind of query is to be used if two queries with the same name exist:
Public
or Private
.
This parameter is supported by both QueryRun
and Query
Designer
actions.
query
The name of the query.
This parameter is supported by both QueryRun
and Query
Designer
actions.
For QueryRun
actions this parameter is mandatory.
maxRows
Defines the maximum number of result rows per page.
Default: 50.
form
Defines the form displayed for parameterized queries.
Default: QueryParametersTemplate.
headerGroupName
The type of the header specified in headerName
.
Enter the name of a header group or "Special" for an info area-independent special header.
headerName
Defines the optional header.
hideContextMenu
If set to true
, no context menu is displayed for the result
records.
Default: = false.
link/linkId
link:
Optional parent record of the query results:
Record
or Linked
.
linkId
: ID of the link used for 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.
These parameters are supported by both QueryRun
and Query
Designer
actions.
Default=-1
menu
Defines the menu displayed for the result rows. By default, this menu contains the menu of the default expand configuration of each info area contained in the query result.
resultHeaderGroupName
The type of the header specified in resultHeaderName
.
Enter the name of a header group or "Special" for an info area-independent special header.
resultHeaderName
Defines the optional header displayed above the result list.
disableDefaultAction
If set to true
, double-clicking on a result row does not execute the
default action. For further details, see Default Action.
Default: false.
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: Multi
virtualInfoAreaReadMode
Determines whether virtual info areas are used for context menus of query result rows
(static
| dynamic
). For further details, virtualInfoAreaReadMode.
This parameter is supported by both QueryRun
and Query
Designer
actions.
catalogParametersAsText
Enter a comma-separated list of catalogs (example K2,K7
) to be using
text input instead of catalog input allowing users to enter catalog values as text
strings in parameterized queries to allow sub-string searches.
This parameter is supported by both QueryRun
and Query
Designer
actions. In addition, you can use this parameter for
QueryParameterForm
and QueryResultPresenter
widgets.