ItemID Property

General info

Label

Item ID

Description

The unique item identifier which has been configured in the external system.

Data type

String

Type

Regular

Code

142

Symbolic name

MODEL_PROP_ITEMID

Lua access code

syslib.model.properties.ItemID

Available since

1.0

Parent properties

PropertyInformation

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_TAG The property is a tag name supplier for the object.
PROP_DETECTABLE Property is detectable by system-driven server endpoint investigation.
PROP_MANDATORY The property is a mandatory field, that means an input is necessary.

Examples

Read from or write to the ItemID property.

  • Lua

  • C#

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

-- Write to the ItemID
syslib.setvalue("<OBJECT FULL PATH>.PropertyInformation.ItemID", "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 ItemID
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.PropertyInformation.ItemID"));
// Write to the ItemID
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.PropertyInformation.ItemID"));