DCI

Represents Data Collection Item (DCI).

Instance attributes

activeThresholdSeverity: int

Severity of the active threshold. If there are no active thresholds, defaults to 0 (NORMAL).

comments: String

DCI Comments

dataType: int

Data type of the DCI.

description: String

Description

errorCount: int

Number of consecutive data collection errors

flags: int

DCI flags

hasActiveThreshold: bool

TRUE if DCI has active threshold

id: int

Unique DCI identifier

instance: String

DCI instance (only for single value DCIs): %{instance}

instanceName: String

DCI instance name (only for single value DCIs): %{instance-name}

lastPollTime: int64

Time of last DCI poll (either successful or not) as number of seconds since epoch (1 Jan 1970 00:00:00 UTC)

lastCollectionTime: int64

Time of last successful DCI poll as number of seconds since epoch (1 Jan 1970 00:00:00 UTC).

Added in version 4.0

name: String

Parameter’s name

origin: int

Data origin of the DCI.

pollingInterval: int

Current polling interval

pollingSchedules: Array

Array of custom schedules in cron format

pollingScheduleType: int

Collection schedule:

  • 0 = Server default interval

  • 1 = Custom interval

  • 2 = Advanced schedule

relatedObject ⇒ NetObj

Related object or null if there is no object

status: int

Data status of the DCI.

systemTag: String

System tag. Contains information about DCI Interpretation.

template ⇒ Template

Template object if DCI came from Template or NULL.

templateId: int

Template id if DCI came from Template or 0.

templateItemId: int

DCI item id in template if DCI came from Template or 0.

thresholdDisableEndTime: int

UNIX time (number of seconds since epoch) till which threshold processing for this DCI is disabled. -1 if threshold processing is disabled infinitely. 0 if threshold processing is enabled.

transformedDataType: int

Tranformed data type.

type: int

DCI type:

  • 1 = single value

  • 2 = table

userTag: String

User tag.

Added in version 5.2

Instance methods

forcePoll(): void

Start DCI force poll.

generateAnomalyProfile(): bool

Triggers asynchronous generation of an AI-based anomaly detection profile for this DCI. Only works for single value DCIs.

Return

true if profile generation was started, false if DCI is not a single value type.

See also

FindDCIByName, FindDCIByDescription, FindAllDCIs, GetDCIValue, GetDCIObject, CreateDCI, Table, DataPoint