LinkDescription Property

General info

Label

Link Descriptions

Description

List of associated Link or URL descriptions (semicolon separated, limit 10) for the object. These are used to both shorten and give better meaning to links (e.g., instead of www.xyz.com?x=5&type=2, the user could see SOPs or Shift Report).

Data type

String

Type

Regular

Code

2012

Symbolic name

MODEL_PROP_LINKDESCRIPTION

Lua access code

syslib.model.properties.LinkDescription

Available since

1.20

Parent classes

GenKPI | KPIEmbeddedContent | KPITable

Parent properties

KPIChartSettings | KPIGroupSettings

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.

Examples

Read from or write to the LinkDescription property.

  • Lua

  • C#

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

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