Topology Properties
The Topology tab of the Graph component contains the parameters necessary for defining the links between the nodes of the graph.
Provider
Selects topology data provider type. The list of available types may vary in different Iotellect installations. For example, available types may include:
Custom(Visualize any topology based on a custom data set)Network(Network topology of all types, i.e. both Level 2 and Level 3)Level 2(OSI model layer 2 topology)Level 3(OSI model layer 3 topology)
Variable Name: | provider |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
provider | String | Possible values:
|
Node Expression
Used only when Provider is set to Custom. This expression must resolve to a Data Table. Each record in this table defines one topology node, so it must contain information which can be used by the Node Id Expression to create unique identifiers which allow the Source Expression and Target Expression to link nodes together. The record may also include other node properties, such as color, width, description, etc. These other node properties can be accessed by other expressions such as Color Expression or Type Expression.
Node Expression Resolution Environment: | |
None. | |
None. | |
0 | |
Standard variables only. | |
Property name: nodeExpression
Property type: String
Link Expression
Used only when Provider is set to Custom. This expression must resolve to a Data Table. Each record in this table will define one topology link, so each result must include a unique identifier for the link, the source node and the target node. This data is then retrieved by Link Id Expression, Source Expression and Target Expression. The record may also define other link properties, such as color, width, and description. Those properties will be retrieved via Color Expression, Width Expression, and so on.
Link Expression Resolution Environment: | |
None. | |
None. | |
0 | |
Standard variables only. | |
Property name: linkExpression
Property type: String
Link Id Expression
Used only by the Custom Provider. This expression is evaluated for every record of the table returned by Link Expression. For each row of the data table, the expression must resolve to a String that will be interpreted as the ID of a link.
Link Id Expression Resolution Environment: | |
None. | |
Result of Link Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: linkIdExpression
Property type: String
Link Type Expression
Used only when Provider is set to Custom. This expression is evaluated for every record of the table returned by Link Expression. The expression must resolve to a String that will be interpreted as the type of link to be displayed. A number of different styles are available:
graphin-line(Default link type when graph Mode is set toEditand the user manually creates a link between nodes.)linepolylinearcquadraticcubiccubic-verticalcubic-horizontallooptwo-directed-line
Link Type Expression Resolution Environment: | |
None. | |
Result of Link Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: linkTypeExpression
Property type: String
Node Id Expression
Used only when Provider is set to Custom. This expression is evaluated for every record of the table returned by the Node Expression. The expression must resolve to a String that will be interpreted as the Id of a node.
Node Id Expression Resolution Environment: | |
None. | |
Result of Node Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: nodeIdExpression
Property type: String
Source Expression
Used only when Provider is set to Custom. This expression is evaluated for every record of a table returned by Link Expression. The expression must resolve to a String that will be interpreted as a path of a topology link source context (e.g. device context) or the Id of a node as defined by the Node Id Expression.
Source Expression Resolution Environment: | |
None. | |
Data Table returned by the Link Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: sourceExpression
Property type: String
Target Expression
Used only when Provider is set to Custom. This expression is evaluated for every record of a table returned by Link Expression. The expression must resolve to a String that will be interpreted as a path of topology link target context (e.g. device context) or the Id of a node as defined by the Node Id Expression.
Target Expression Resolution Environment: | |
None. | |
Data Table returned by Link Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: targetExpression
Property type: String
X
Used only when Provider is set to Custom. This expression is evaluated for every record of a table returned by the Node Expression. The expression must resolve to an Integer which will be interpreted as the X coordinate for the node when the Preset Layout is selected
None. | |
Data Table returned by Node Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: graphXExpression
Property type: String
Y
Used only when Provider is set to Custom. This expression is evaluated for every record of a table returned by the Node Expression. The expression must resolve to an Integer which will be interpreted as the Y coordinate for the node when the Preset Layout is selected
None. | |
Data Table returned by Node Expression. | |
Currently processed row of the default table. | |
Standard variables only. | |
Property name: graphYExpression
Property type: String
Node Mask
Holds a Context Mask to describe which devices to include in the graph when the Provider property has a value of Network, Level 2, or Level 3.
Property name: nodeMask
Property type: String
Was this page helpful?