Alarms manipulation

Library to interact with the module alarms.

The value of hideUntil must be a timestamp in milliseconds.

alarms.acknowledge(id: <string | string[]>)

Acknowledges alarms

Arguments:

• id

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.addJournal(id: <string | string[]>, text: string, user: string)

Adds journal entry to alarm

Arguments:

• id

• text

• user

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.clear(id: <string | string[]>)

Remove an alarm or a list of alarms.

Arguments:

• id

alarms.create(severity: <number | string>, summary: string, location: string, source: string, serial: string, tags: string[], additionalData?: object, hideUntil?: number, forceHide?: boolean)

Creates an alarm (Directly added to the live collection without being processed by the pre-insertion rules)

Arguments:

• severity

• summary

• location

• source

• serial

• tags

• additionalData

• hideUntil – Time to hide alarm [ms]

• forceHide

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.edit(id: <string | string[]>, summary: string, location: string, source: string, hideUntil: number, forceHide: boolean, additionalData: object)

Edits alarms

Arguments:

• id

• summary

• location

• source

• hideUntil – Time to hide alarm [ms]

• forceHide

• additionalData

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.editAdditionalData(id: <string | string[]>, additionalData: object)

Edit alarms additional data

Arguments:

• id

• additionalData

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.editForceHide(id: <string | string[]>, forceHide: boolean)

Edit alarms force hide

Arguments:

• id

• forceHide

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.editHideUntil(id: <string | string[]>, hideUntil: number)

Edit alarms inhibition time

Arguments:

• id

• hideUntil – Time to hide alarm [ms]

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.editLocation(id: <string | string[]>, location: string)

Edit alarms location

Arguments:

• id

• location

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.editSource(id: <string | string[]>, source: string)

Edit an alarm or a list of alarms

Arguments:

• id

• source

alarms.editSummary(id: <string | string[]>, summary: string)

Edit alarms summary

Arguments:

• id

• summary

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.escalate(id: <string | string[]>, severity: <number | string>)

Escalates alarms

Arguments:

• id

• severity

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.insert(severity: <number | string>, summary: string, location: string, source: string, serial: string, tags: string[], additionalData?: object, hideUntil?: number, forceHide?: boolean)

Inserts an alarm (Added to the live collection after being processed by the pre-insertion rules)

Arguments:

• severity

• summary

• location

• source

• serial

• tags

• additionalData

• hideUntil – Time to hide alarm [ms]

• forceHide

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.lockSeverity(id: <string | string[]>, severity: <number | string>)

Locks alarms severity

Arguments:

• id

• severity

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.runActionRule(id: string, data: object, delay: number)

Runs an alarms actions (action.alarms). The data are the parameters passed to the action when run.

Arguments:

• id

• data

• delay

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.tag(id: <string | string[]>, tag: string)

Tags alarms

Arguments:

• id

• tag

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.unacknowledge(id: <string | string[]>)

Un acknowledge an alarm

Arguments:

• id

Returns:

An object that contains attribute :

• success (boolean) Indicates whether the operation was successful.

• message (string) Contains additional information about the operation’s success or failure.

alarms.unlockSeverity(id: <string | string[]>)

Unlock severity of an alarm or a list of alarms

Arguments:

• id

alarms.untag(id: <string | string[]>, tag: string)

Remove a tag from an alarm.

Arguments:

• id

• tag