ID Property

General info

Label

ID

Description

The unique identification.

Data type

String

Type

Regular

Code

730

Symbolic name

MODEL_PROP_ID

Lua access code

syslib.model.properties.ID

Available since

1.0

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_MANDATORY The property is a mandatory field, that means an input is necessary.
PROP_USER_TAG This property is the user modifiable object or tag name.

Capabilities

Name Description
TranslationTable The user will be able to provide a translation list for the content of this property, which will be reflected on User Interfaces

Examples

Read from or write to the ID property.

  • Lua

  • C#

-- Read from the ID
syslib.getvalue("<OBJECT FULL PATH>.ID")

-- Write to the ID
syslib.setvalue("<OBJECT FULL PATH>.ID", "new value")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the ID
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.ID"));
// Write to the ID
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.ID"));