Model

This context lets you access and manage a single model.

Unique Actions

[?]

Configure

This Configure action is used to edit the properties of the model.

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.

Action Type:

Configure

Common Actions

[?]

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

Context States and Icons

Icon	Code	State
	0	This model is relative.
	1	This model is absolute.

Advanced Information

Context Information

Context Type: model

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.models.MODEL_NAME

Context Mask: users.*.models.*

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	Basic event monitoring. Status browsing.
Operator	All Observer permissions. Model configuration browsing.
Manager	All Operator permissions. Model removal.
Engineer	All Manager permissions.
Administrator	All Engineer permissions. Model configuration.

Public Variables (Properties)

[?]

Absolute models add variables they declare to their own context. Thus, one variable is created per each record in the model's Variables table.

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

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
template	String
type	String
validityExpression	String
validityListeners	Data Table
defaultContext	String
containerType	String
containerTypeDescription	String
containerName	String
objectType	String
objectTypeDescription	String
objectNamingExpression	String
enabled	Boolean
ruleSetCallStackDepthThreshold	Integer
normalConcurrentBindings	Integer
maximumConcurrentBindings	Integer
maximumBindingQueueLength	Integer
logBindingsExecution	Boolean

Variables

This variable contains definitions of model variables.

Variable Name:	modelVariables
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String
description	String
format	Data Table
writable	Boolean
help	String	Nullable
group	String	Nullable
readPermissions	String
writePermissions	String
updateHistoryStorageTime	Long
addPreviousValueToVariableUpdateEvent	Boolean

Functions

This variable contains definitions of model functions.

Variable Name:	modelFunctions
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String
description	String
inputformat	Data Table
outputformat	Data Table
help	String	Nullable
group	String	Nullable
permissions	String
type	Integer
implementation	String
expression	String
query	String
plugin	String	Nullable

Events

This variable contains definitions of model events.

Variable Name:	modelEvents
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String
description	String
format	Data Table
help	String	Nullable
level	Integer
group	String	Nullable
permissions	String
firePermissions	String
historyStorageTime	Long

Rule Sets

This variable contains model's rule sets.

Variable Name:	ruleSets
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
name	String
description	String
type	Integer
rules	Data Table

Bindings

This variable contains model bindings.

Variable Name:	bindings
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name	Field Type	Notes
target	String
expression	String
activator	String
condition	String
onstartup	Boolean
onevent	Boolean
periodically	Boolean
period	Long

Thread Pool Statistics

Returns statistical information about model's thread pool.

Variable Name:	threadPoolStatus
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
activeCount	Integer	Number of active tasks.
completedCount	Long	Number of completed tasks.
totalCount	Long	Total number of tasks.
coreSize	Integer	Pool core size.
largestSize	Integer	Pool largest (peak) size.
maximumSize	Integer	Pool maximum allowed size.
queueLength	Integer	Task queue length.
rejectedCount	Long	Number of rejected tasks.

Statistics

This variable is a view of model variable statistics, i.e. aggregated data collected by model variables' statistical channels.

Variable Name:	statistics
Records:	0...unlimited
Permissions:	Readable at Observer permission level

Record Format:

Field Name	Field Type	Notes
name	String	Name of the channel.
variable	String	Name of variable the channel is based on.
statistics	Data Table	Brief statistical data.

Public Functions

[?]

Absolute models add functions they declare to their own context. Thus, one function is created per each record in the model's Functions table. Additionally one function is created per each record in model's Rule Sets table.

Public Events

[?]

Absolute models add events they declare to their own context. Thus, one event is created per each record in the model's Events table.

Binding Execution

This event is generated each time a model binding is executed.

Event Name	bindingExecution
Permissions:	Accessible at Observer permission level
Expiration Period:	Non-persistent
Records:	1

Record Format:

Field Name	Field Type	Notes
context	String	Model instance context, i.e. a context of an absolute model, a context a relative model is attached to, or an instantiable model's instance context.
target	String	Binding target.
expression	String	Binding expression.
value	String	String representation of binding expression result.
activator	String	Binding activator.
condition	String	Binding condition.
execution	String	Binding execution mode (On startup, On event, or Periodical).
cause	String	Binding execution cause (reference to an event or changed variable that has caused the execution).

Binding Error

This event is generated each time a model binding fails with an error.

Event Name	bindingError
Permissions:	Accessible at Observer permission level
Expiration Period:	Non-persistent
Records:	1

Record Format:

Field Name	Field Type	Notes
context	String	Model instance context, i.e. a context of an absolute model, a context a relative model is attached to, or an instantiable model's instance context.
target	String	Binding target.
expression	String	Binding expression.
activator	String	Binding activator.
execution	String	Binding execution mode (On startup, On event, or Periodical).
cause	String	Binding execution cause (reference to an event or changed variable that has caused the execution).
error	String	Text of the error message.
stack	Data Table	Table that contains stack trace of binding error.

Common Events: info (Information)

DPF_EXPORT_V5.8.8 / TIME_1743710542 / 2025-04-03 20:02:22 / STRLEN_26109 / STRLEN_HTML_29691

{VERSION}

Was this page helpful?