KPINameClickPath Property

General info

Label

Name clickpath

Description

Controls what happens when a user clicks the name of a KPI. The user will either be shown the trend of the KPI (default) or the user will be taken to the first link defined for the KPI (if one exists).

Data type

UInt32

Default value

1 (syslib.model.codes.KPINameClickPath.TREND)

Type

CodingGroup

Code

2072

Symbolic name

MODEL_PROP_KPINAMECLICKPATH

Lua access code

syslib.model.properties.KPINameClickPath

Available since

1.20
Parent classes

GenKPI

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_HAS_DEFAULT The property has a default value as standard.

Codings

Coding group: KPINameClickPath

Name Code Label Tooltip

TREND

1

Trend

Trend.

URL

2

Url

Url.

Examples

Read from or write to the KPINameClickPath property.

  • Lua

  • C#

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

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

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

A switch-like function of the codings.

function get_coding_name(code)
    local _kpincp = syslib.model.codes.KPINameClickPath
    if _kpincp.TREND==code then return 'TREND'
    elseif _kpincp.URL==code then return 'URL'
    end
end
return get_coding_name(syslib.model.codes.KPINameClickPath.TREND)