Structure

This context provides information about the expression language references in various parts of Iotellect, allowing the relationships and interactions between different contexts to be analyzed. It is not shown in the visible context tree.

Unique Actions

None

Common Actions

None.

Context States and Icons

None.

Advanced Information

Context Information

Context Type: structure

Context Name: structure

Context Description: Structure

Context Path: structure

Context Mask: structure

Context Permissions

[?]

Level

Description

None

No access allowed.

Observer

Basic event monitoring.

Status browsing.

Operator

All Observer permissions.

Configuration browsing.

Manager

All Operator permissions.

Engineer

All Manager permissions.

Administrator

All Engineer permissions.

Public Variables (Properties)

[?]

Structure Nodes

The Structure Nodes table provides a list of contexts which reference or are referenced by another context. Every node has at least one corresponding entry in the Structure Links variable, where its id is indicated as the source or target of a link. Nodes which reference themselves will have their id appear as both the source and target of a link.

Variable Name:

structureNodes

Records:

0…Unlimited

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

path

String

Context path if the node is a server context, or component name if it’s a dashboard component.

description

String

Description of the context, if one exists.

scopePath

String

Applies to nodes which are dashboard components. Context path to the node.

scopeDescription

String

Applies to nodes which are dashboard components. Context description.

id

String

Concatenation of scopePath and path, separated with a forward slash (/) character to create a unique node identifier.

The Structure Links table provides a list of connections between nodes, indicating how various nodes are referencing other nodes, or themselves.

Variable Name:

structureLinks

Records:

0…Unlimited

Permissions:

Readable at Observer permission level, writable at Manager permission level

Record Format:

Field Name

Field Type

Notes

source

String

The structureNodes$id of a node that contains a reference to the target node.

target

String

The structureNodes$id of a node which is the target of the reference in the source node.

entity

String

The name of the event, variable, or function which is targeted by the reference.

kind

String

Indicates whether the reference target is an event, variable, or function.

action

String

Indicates whether the reference will FIRE the target event, GET or SET the target variable, or CALL the target function.

count

Integer

A running count of the number of times the reference has been activated since the most recent server restart, or clear action, whichever was most recent.

pinpoint

String

Text explaining the location of the source reference.

id

String

Unique link identifier.

updateKey

String

Unique link update key.

Public Functions

[?]

Clear Structure

Clears all data from the Structure Links and Structure Nodes variables (properties). The Structure context will immediately begin repopulating the variables with data reflecting the current links and nodes.

Function Name:

clearStructure

Permissions:

Accessible at Observer permission level

Input Records:

0

Input Format:

None

Output Records:

0

Output Format:

None

Was this page helpful?