Items available for the System Information topic

The following table lists the items available for the System Information topic in alphabetical order.

Item

Value

Parameter

Alarm changes

The time of the latest change of the number of active alarms.

None

Alarm count

The total number of alarms in the alarm list.

None

Alarm ecount

The number of objects currently in alarm.

None

Alarm title

Given an alarm number the alarm text is returned.

Only available for REQUEST transactions.

Alarm number. Mandatory.

All alarms

Information on all alarms in the alarm list. For each alarm index for an object in alarm, alarm number and alarm priority are returned. If the REQUEST format is CF_TEXT, the three numbers describing the alarm are comma-separated and the individual alarms are semicolon-separated. If the REQUEST format is XlTable, the list is returned in a two-dimensional Microsoft Excel array where each row describes an alarm.

Only available for REQUEST transactions.

[=ppp] lists all alarms with this priority

[>ppp]  lists all alarms with a priority higher than the specified one

[<ppp]  lists all alarms with a priority lower than the specified one

[ACK]  lists all acknowledged alarms

[NACK]  lists all unacknowledged alarms

[DIAL]  lists all alarms marked for dialup through WinPager

[NDIAL]  lists all alarms which are not marked for dialup through WinPager

All parameters take the & operator, for example,
"all alarms#[>4&NACK&DIAL]"

will list all alarms with a priority higher than 4, which are not acknowledged and marked for dialup through WinPager.

If no alarms match the specified filter, the transaction fails.

Area

Area name.

None

Cfg time

The time of the latest change made to the configuration. The configuration is time stamped when saved from Definition. The time is in number of second since December 30, 1899.

Only available for REQUEST transactions.

None

CfgName

The name of the configuration.

None

CfgPath

The path to the active configuration.

None

Config

Tells if the configuration is loaded or not.

0: Configuration not loaded

1: Configuration loaded.

This item can be requested and subscribed to and is available at any time. This can be of great importance since all subscription to objects is invalidated the moment the configuration is stopped. The status item will then change to 0 and you know that all subscribed values are invalid. When the status item changes to 1 again, a new configuration is available and subscriptions can be re-established.

None

Full name

Area and object name.

None

Get systime

The current system time returned as number of days since December 30, 1899.

Only available for REQUEST transactions.

None

Install time

Shows the time of the latest installation of the configuration.

None

Language

The language code of the primary language.

None

Name

Given an object index, like returned by "All alarms" the object name will be returned. If the index does not exist, the transaction will fail.

Only available for REQUEST transactions.

Object index. Mandatory.

ODBCname

The name of the IGSS ODBC data source as shown in the ODBC Data Source Administrator in the Control Panel.

None

RepPath

The path to the report folder as defined in the System Configuration program.

None

Set systime

Sets the current system time. The new system time must be specified as number of days since December 30, 1899. The time is changed on all other server and operator stations in the system.

Only POKE transactions are available.

None

Size

The total number of objects used in the configuration.

Only available for REQUEST transactions.

None

SysPath

The path to the primary system folder (default: <Installation path>\Gss).

None

TZbias

The offset compared to UTC time (correlated for summer/winter time).

None

TZname

The name of the time zone as shown in the Control Panel.

"ASCII" will return the name in plain text. If the parameter is not included, Unicode will be used allowing you to show special characters in the name.

UTCname

The text "UTC" will be returned.

None

Version

The version number and build number of IGSS.

None