Class

This context lets you access and manage a single class and its instances.

Unique Actions

[?]

Configure

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

Changing class name is not allowed.

Action Type:

Common Actions

[?]

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

Context States and Icons

This context has a single status. It is always represented by theicon.

Advanced Information

Context Information

Context Type: class

Context Name: provided by user

Context Description: provided by user

Context Path: users.USER_NAME.classes.CLASS_NAME

Context Mask: users.*.classes.*

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	Class instance management. Class configuration browsing. Basic event monitoring. Status browsing.
Operator	Same as Observer.
Manager	Class removal.
Engineer	Same as Manager.
Administrator	Class configuration.

Public Variables (Properties)

[?]

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	Description
name	String	1 - 50 characters
description	String	1 - 50 characters
permissionsEnabled	Boolean	Flag to apply the permissions defined in the permissions configuration.
namingExpression	String
storageContext	String
normalConcurrentBindings	Integer
maximumConcurrentBindings	Integer
maximumBindingQueueLength	Integer
normalConcurrentInstanceBindings	Integer
maximumConcurrentInstanceBindings	Integer
maximumInstanceBindingQueueLength	Integer

Fields

See description of the variable and its fields here.

Variable Name:	fields
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Admin permission level

Record Format:

Field Name	Field Type	Description
name	String
type	String
description	String
defaultValue	String
readonly	Boolean
nullable	Boolean
key	Boolean
selvals	Data Table
extselvals	Boolean
hidden	Boolean
inline	Boolean
encrypted	Boolean
help	String
editor	String
editorOptions	Data Table
group	String
primaryKey	Boolean
length	Integer

Many to Many Relations

See description of the variable and its fields here.

Variable Name:	manyToManyRelations
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Admin permission level

Record Format:

Field Name	Field Type	Description
name	String
description	String
relatedClass	String
cascadeDelete	Boolean

Life Cycles

See description of the variable and its fields here.

Variable Name:	lifecycles
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Admin permission level

Record Format:

Field Name	Field Type	Description
name	String
description	String
states	Data Table
stateTransitions	Data Table

Views

See description of the variable and its fields here.

Variable Name:	views
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Admin permission level

Record Format:

Field Name	Field Type	Description
name	String
description	String
columns	Data Table
filter	Data Table
sorting	Data Table

Permissions

See description of the variable and its fields here.

Variable Name:	permissions
Records:	0...unlimited
Permissions:	Readable at Observer permission level, writable at Admin permission level

Record Format:

Field Name	Field Type	Description
userContextMask	String
fields	Data Table
instancesFilter	Data Table

Bindings

This variable contains class bindings. Each row allows the target field to be updated according to the evaluation results of the expression.

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

Record Format:

Field Name	Field Type	Description
target	String	Indicates which field to be updated with the result of evaluating the expression. Must contain the name of a field from the class in order to be valid.
Expression	String	Expression to evaluate when the binding is activated.
		Expression Resolution Environment:
		Default Context	Context of the current class instance.
		Default Data Table	None
		Default Row	0
		Environment Variables	Standard variables only.

Public Functions

[?]

Open Storage

Open storage session.

Function Name:	storageOpen
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	id	Long	Storage Session Id.
	view	String	Name of class view.
	query	String	Query string.
	table	String	Table name.
	columns	DataTable	Columns setting table. Same fields as the Columns Table described in Views.
	filter	DataTable	Instance filters used when id parameter is null.
	smartFilterExpression	String	Filtering expression to apply before returning the output.
	processCalculatedFields	Boolean	When set to `True`, this parameter enables the application of the smartFilterExpression to calculated fields. If `False`, filters will not impact calculated fields.
	sorting	DataTable	Sorting settings table. Same fields as the Instance Sorting table described in Views.
	getData	Boolean	Defines whether the storage should open session or just return data.
	limit	Integer	Maximum count of returned instances.
	offSet	Integer	Number of skipped instances from the beginning of result list.
Output Records:	1
Output Format:	Name	Type	Description
	id	Long	Storage Session Id.
	count	Integer	Count of returned instances.
	data	DataTable	If parameter getData is true, then contains table with returned instances.

Close Storage

Close storage session.

Function Name:	storageClose
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
Input Format:	id	Long	Storage Session Id
Output Records:	0
Output Format:	None

Get Data

Returns table with instances retrieving in session.

Function Name:	storageGet
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	id	Long	Storage Session Id.
	first	Integer	Index of the first returned instance.
	count	Integer	Count of returned instances.
	processCalculatedFields	Boolean	When set to `True`, this parameter enables the application of filters to calculated fields. If `False`, filters will not impact calculated fields.
Output Records:	1
Output Format:	Name	Type	Description
	size	Integer	Count of returned instances.
	data	DataTable	Table with returned instances.

Update Data

Update instances in a specific storage session or according to a filter.

Function Name:	storageUpdate
Permissions:	Accessible at Observer permission level
Input Records:	0...unlimited
Input Format:	Name	Type	Description
	id	Long	Storage Session Id.
	row	Integer	Number of row to update. Used when id parameter is not null.
	column	String	Name of column to update.
	value	DataTable	Value to be inserted, formatted as a dataTable with a single field "value" and one row containing the target value.
	table	String	Table name. Used when id parameter is null.
	filter	DataTable	Instance Filters \| ls_classes_instance_filtersUsed when id parameter is null.
Output Records:	1
Output Format:	Name	Type	Description
Output Format:	count	Integer	The number of affected records.

Delete Data

Delete instances in a specific storage session or according to a filter.

Function Name:	storageDelete
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	id	Long	Storage Session Id.
	rowList	DataTable	List of row numbers to delete. Used when id parameter is not null.
	table	String	Table name. Used when id parameter is null.
	filter	DataTable	Instance Filters \| ls_classes_instance_filtersUsed when id parameter is null.
Output Records:	1
Output Format:	Name	Type	Description
Output Format:	count	Integer	The number of affected records.

Insert Data

Insert new instances in storage session or by table name.

Function Name:	storageInsert
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	id	Long	Storage Session Id.
	values	DataTable	Table contains inserted instances.
	table	String	Table name. Used when id parameter is null.
Output Records:	0...unlimited
Output Format:	Name	Type	Description
Output Format:	instanceId	String	Inserted instance id.

Link Instances

Link instances with many-to-many relation.

Function Name:	storageLinkInstance
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	table	String	Table Name.
	relatedTable	String	Related Table Name.
	relationName	String	Relation Name.
	relatedIds	DataTable	Table of pairs of instance Ids to be linked.
Output Records:	0
Output Format:	None

Unlink Instances

Unlink linked instances with many-to-many relation.

Function Name:	storageUnlinkInstance
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	table	String	Table Name.
	relatedTable	String	Related Table Name.
	relationName	String	Relation Name.
	relatedIds	DataTable	Table of pairs of instance Ids to be unlinked.
Output Records:	0
Output Format:	None

Get Format

Returns an empty table with format which matches format of class and view (if specified).

Function Name:	getFormat
Permissions:	Accessible at Observer permission level
Input Records:	1
Input Format:	Name	Type	Description
	table	String	Not used for class context
	view	String	Name of class view
Output Records:	0...unlimited
Output Format:	Dynamic

Process Bindings

Processes every class binding. Each expression is evaluated and the results are applied to the target fields according to the supplied filter, or applied to every row of the class if no filter is supplied.

	Name	Type	Description
Function Name:	processBindings
Permissions:	Accessible at Observer permission level
Input Records:	0…Unlimited
Input Format:	Filter table from a class view.
	logical	Integer	Logical Operation, (0) for first record, (1) for AND, or (2) for OR.
	type	Integer	Condition (0) or Nested Condition (1).
	column	String	Field name of the class to be filtered.
	operation	String	Indicate the type of comparison to run on the field value. Must be a valid comparison type.
	value	String	Value to compare with the field.
	nested	String	Optional data table of the same format, indicating a nested condition.
Output Records:	0
Output Format:	None

Prepare Filter

Takes as arguments the properties of an Instance Filter and outputs an Instance Filter data table suitable for use as the filter parameter of the Open Storage, Update Data, and Delete Data functions.

	Name	Type	Description
Function Name:	prepareFilter
Permissions:	Accessible at Observer permission level
Input Records:	0...unlimited
Input Format:	Follows the format of an Instance Filter:
	logical	Integer	Logical Operation, (0) for first record, (1) for AND, or (2) for OR.
	type	Integer	Condition (0) or Nested Condition (1).
	column	String	Field name of the class to be filtered.
	operation	String	Indicate the type of comparison to run on the field value. Must be a valid comparison type.
	value	String	Value to compare with the field.
	nested	String	Optional data table of the same format, indicating a nested condition.
Output Records:	0...unlimited
Output Format:	Follows the format of an Instance Filter. The table returned by this function is ready to be used in any other function that requires a class instance filter parameter, such as storageOpen.

Public Events

[?]

Common Events: info (Information)

Class Instance Created

This event is generated each time a new class instance is created.

Event Name	classInstanceCreated
Permissions:	Accessible at Observer permission level
Expiration Period:	Non-persistent
Records:	0...unlimited

Record Format:

Field Name	Field Type	Description
instanceId	String	ID of the new instance.
instanceDescription	String	Human-readable description of the new instance.
modificationAuthor	String	Username of user who has created the instance.

Class Instance Changed

This event is generated when one or more class instance fields are modified.

Event Name	classInstanceChanged
Permissions:	Accessible at Observer permission level
Expiration Period:	Non-persistent
Records:	0...unlimited

Record Format:

Field Name	Field Type	Description
instanceId	String	ID of the modified instance.
instanceDescription	String	Human-readable description of the modified instance.
modificationAuthor	String	Username of user who has initiated the modification.
fieldName	String	Name of changed field.
fieldDescription	String	Description of changed field.
oldValue	String	Old field value converted to string.
newValue	String	New field value converted to string.

Class Instance Deleted

This event is generated each time a class instance is deleted.

Event Name	classInstanceDeleted
Permissions:	Accessible at Observer permission level
Expiration Period:	Non-persistent
Records:	0...unlimited

Record Format:

Field Name	Field Type	Description
instanceId	String	ID of the deleted instance.
instanceDescription	String	Human-readable description of the deleted instance.
modificationAuthor	String	Username of the user who has deleted the instance.
instance	DataTable	Table that contains deleted instance field values.

Class Instance Commented

This event is generated when a comment is added to a class instance.

Event Name	classInstanceCommented
Permissions:	Accessible at Manager permission level
Expiration Period:	Non-persistent
Records:	0...unlimited

Record Format:

Field Name	Field Type	Description
instanceId	String	ID of the commented instance.
instanceDescription	String	Human-readable description of the commented instance.
author	String	Username of user who has added the comment.
comment	String	Text of the comment.

DPF_EXPORT_V5.8.8 / TIME_1743710550 / 2025-04-03 20:02:30 / STRLEN_48228 / STRLEN_HTML_53558

{VERSION}

Was this page helpful?