Query

This context lets you access and manage a single query.

[?]

Default Action

This action executes the query and shows its result to the user. Its flow differs for simple and parameterized queries.

For simple (non-parameterized) query:

1. Query is executed

2. Query result is shown to the user using

Edit Properties UI Procedure. If query result contains some editable fields, user can edit them and save changes. All changed data will be saved back to the contexts from which it originally came.

For parameterized query:

1. User is

prompted to enter query parameters

1. Parameters entered on step 1 are used to produce final query text according to the text of parameterized query

2. Query is executed

3. Query result is shown to the user using

Edit Properties UI Procedure. If query result contains some editable fields, user can edit them and save changes. All changed data will be saved back to the contexts from which it originally came.

If query is Parameterized or Disable Editable Result flag is enabled in query properties, query result is shown using Edit Data UI Procedure instead of Edit Properties.

If some errors occur during query execution or parameterization, they are shown to the user using Show Error UI Procedure.

This action is used to execute query in debug mode. Its has only one difference from the Execute Query action: if query produces any debug output, debug report is shown to the user immediately after query execution using Edit Data UI Procedure in read-only mode. When user closes debug report, query result is shown.

This action is used to edit Query properties.

Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier.

[?]

Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status

This context has no states. It is always represented by the icon.

Advanced Information

Context Information

Context Type: query

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.queries.QUERY_NAME

Context Mask: users.*.queries.*

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	Query execution. Basic event monitoring. Status browsing.
Operator	Configuration browsing.
Manager	Query configuration and removal.
Engineer	Same as Manager.
Administrator	Same as Manager.

Public Variables (Properties)

[?]

Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)

Query

Properties

See description of the variable and its fields here.

Variable Name:	childInfo
Records:	1
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String	1 - 50 characters
description	String	1 - 50 characters
parameterized	Boolean
query	String
parameterizer	String
outFormat	Data Table
fields	Data Table
disableEditableResult	Boolean

Query Results

This variable is used to execute query and get its result.

Variable Name:	data
Records:	0...unlimited
Permissions:	Readable/writable at Observer permission level
Record Format:	Dynamic

Public Functions

[?]

Execute Query

Executes the query and returns its result set.

Function Name:	execute
Permissions:	Accessible at None permission level
Input Records:	1
Input Format:	Dynamic, may change when query properties are edited. If the query is not parameterized, the input format is empty, i.e. it's possible to execute a query without specifying any input. If the query is parameterized, the input format of this function matches format defined in query parameterizer.
Output Records:	0...unlimited
Output Format:	Dynamic

Public Events

[?]

Common Events: info (Information)

DPF_EXPORT_V5.8.8 / TIME_1743710561 / 2025-04-03 20:02:41 / STRLEN_13500 / STRLEN_HTML_15960

{VERSION}

Was this page helpful?

Tell us more

Send

Thank you!