Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Virtual items are used like any other server item, except for one detail; : they are not connected to any real datapoint on bus level. They can be used to store data. They may be connected to a any other server item.

Info
title

File location of configuration:

<WorkspaceDirectory>\DataFiles\nxaVirtualItems.40.dat

Info

Since version R2 Build 2071, changes within this definition file are immediately effective after saving. Server restart is not required.

Info

Since version R2 Build 2071, there is second virtual item definition file:

<WorkspaceDirectory>\DataFiles\nxaVirtualItems.VT.40.dat

This file is automatically generated by the template engine of the visualization editor and loaded after the original definition file.

#

Name

M/O

Description

Descrition

Available since

1

Name

IDThis field is naming

M

Name of the virtual item. Together with the path it must be unique.

2

Path

The string within this field determines

O

Specifies the path of the virtual item. Delimiter between sections of the path is the backslash

(" ")

\.

3

Description

O

Set

Description of the

description for the

virtual item

here

. It will be displayed in the item tree.

4

Data Type

M

Possible data types are BOOL,

STRING

STR,

FLOAT

BYTE,

DOUBLE

CHAR,

INT8

 INT8, UINT8, INT16, UINT16, INT32, UINT32, INT64,

and UINT64

UINT64, FLOAT, DOUBLE, DATE, TIME.

5

Access Rights

O

Shall

Allowed operations on the virtual item

be writable or is it read only?

:

  • RW: read-write (default)

  • R: read-only

  • W: write-only

6

Persistent

O

This parameter specifies

Specifies whether the value of the virtual item is persistent (restored from the database after server start up ) or not. Default is F (non-persistent).

7

HistoricalThis parameter specifies whether historical values of the virtual item are stored within the database or not.8SynchronizeIf this parameter is

Synchronize

O

If set to "T", the value is synchronized between the main and backup server (if present). Default is F (no synchronization).

This

will work only if synchronize is enabled in the NMESH configuration

applies only to main/backup configurations of the NETx

BMS Core

Server.

9

8

Link Item ID

O

If a connection to another item is necessary the item ID of this one has to be placed here (bidirectional link between Virtual item and Linked item).

10

9

Script For OnReceive

O

Implement any LUA script here which shall be called

at

by the OnReceived event.

11

10

Script For OnSend

O

Implement any LUA script here which shall be called

at

by the OnSent event.

12

11

Script For OnSet

O

Implement any LUA script here which shall be called

at 14Extended Data 1Internal use only.15Extended Data 1Internal use only.

by the OnSet event.

13Extended Data 1Internal use only.

12

Comment

O

Optional comment of the virtual item definition. The value is only used for documentation purposes.

13

Absolute path

O

If set to “T”, the Path column will be used as an absolute path, putting the item under “NETx”.

If set to “F” (default), the Path will be interpreted as relative path and the virtual item will created in the sub tree “NETx\Virtual”

>= R2 Build 2071

14

Default value

O

Specifies a default value if item is not set on server startup.

>= R2 Build 2071