SystemAlias Property
General info
Label |
System Alias |
Description |
The system alias is an additional name for an object, which can be used as a shortcut for identification and has to be unique in the system. |
Data type |
String |
Type |
Regular |
Code |
518 |
Symbolic name |
MODEL_PROP_SYSTEMALIAS |
Lua access code |
syslib.model.properties.SystemAlias |
Available since |
1.0 |
- Parent classes
-
ActionItem | Asset | Datasource | FeedbackItem | GenFolder | GenItem | HolderItem | ITLogGroup | IoItem | IoItemGroup | IoNode | IoProperty | MessageBroker | RedItem | RedundancyServiceGroup | RemoteServiceGroup | ReportItem | S95EMPCUnit | SecurityPerimeter | VariableGroup
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_SYSTEM_UNIQUE | This Property has to be unique system-wide. This will be checked by the core on create. |
Examples
Read from or write to the SystemAlias property.
-- Read from the SystemAlias
syslib.getvalue("<OBJECT FULL PATH>.SystemAlias")
-- Write to the SystemAlias
syslib.setvalue("<OBJECT FULL PATH>.SystemAlias", "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 SystemAlias
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.SystemAlias"));
// Write to the SystemAlias
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.SystemAlias"));