owner-alarm.ip-rct

IpRct alarm owner

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • linkedDevice

The IP-RCT device device.ip-rct ↗️ that this output will use to communicate.

For example servers.ip-rct.device.ip-rct could be a path of the IP-RCT device.

type

string

  • alarmType

The type of alarm linked to this value :

  • ALARM : A complete state of the alarm. The linked value has to be TEXT.

  • PRIMARY_ATP : The state of the primary ATP (the primary path is usually an internet physical link). The linked value has to be BOOLEAN.

  • ALTERNATIVE_ATP : The state of the alternative ATP (the secondary path is usually a GSM link). The linked value has to be BOOLEAN.

  • ATS : The global state of the ATS (the ATS is fine if at least one path is connected). The linked value has to be BOOLEAN.

Learn more about IP-RCT ↗️.

type

string

enum

ALARM, PRIMARY_ATP, ALTERNATIVE_ATP, ATS

default

ALARM

  • criteriaExpression

A regular expression that filters alarms based on their criteria.

For example, the regular expression Nri1/OP.* is a valid expression. It will get you every criteria that fall in this regular expression.

Learn more about IP-RCT ↗️.

type

string

  • linkedAction

The action to execute when an alarm is received.

For more information about actions ↗️.

LinkedActionConfigurationEntity

additionalProperties

False

LinkedActionConfigurationEntity

type

object

properties

  • actionId

The id of the action to execute

type

string

  • parameters

The value accessors used to send parameters to the action

type

object

additionalProperties

ValueAccessorConfiguration(Object)

  • expiration

The duration after which the action will be timed out

DurationConfigurationEntity

  • moduleId

The module that will execute the action

type

string

additionalProperties

False

ValueAccessorConfiguration(Object)

type

object

properties

  • value

A constant value

  • values

A list of value accessors

type

array

items

ValueAccessorConfiguration(Object)

  • field

A field of the value

type

string

enum

ID, CONTENT, ERROR, TYPE, TIMESTAMP

  • fieldParser

An expression to access a field of the JSON content of the value

type

string

  • properties

An object of value accessors

type

object

additionalProperties

ValueAccessorConfiguration(Object)

additionalProperties

False

oneOf

allOf

not

not

not

not

allOf

not

not

not

not

allOf

not

not

not

allOf

not

not

not

not

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False