Alarm Service Data Types

Alarm

Represents a current alarm instance in the system.

Property	Type	Description
id	uint?	Object identifier.
name	string	Object name (unique in Alert).
localizedName	string	Name depending on language.
names	MultiLangString	Name in different languages.
lastChange	DateTime?	Date when the object was created or last updated.
local	bool?	Defines if the object can be transmitted in redundancy.
stationId	uint?	Station identifier.
dataServerId	uint?	Data server identifier.
path	string	Path of alarm in data server.
fullPath	string	Full path of alarm including data server path.
value	string	Value of the data tag when alarm is raised.
location	Location	Location when alarm is raised.
message	string	Message when alarm is raised.
resetMessage	string	Message when alarm is reset.
ackMessage	string	Message when alarm is acknowledged.
priority	uint?	Priority of alarm.
state	AlarmState	Current state of alarm.
masked	bool?	No alarm notification will be received if masked.
alarmTime	DateTime?	Date and time when alarm is raised.
resetTime	DateTime?	Date and time when alarm is reset.
ackTime	DateTime?	Date and time when alarm is acknowledged.
ackUserId	uint?	Identifier of the user who acknowledged the alarm.
attachedFile	string	Path of file attached to alarm when triggered.
resetAttachedFile	string	Path of file attached to alarm when reset.
ackAttachedFile	string	Path of file attached to alarm when acknowledged.
comment	string	Comment of alarm on acknowledgement.

AlarmState

Enumeration of alarm states.

State	Value	Description
InactiveAck	0	Alarm is in normal state (no alarm).
ActiveAck	1	Alarm has been raised and acknowledged.
InactiveNoAck	2	Alarm has been raised, got back to normal but not acknowledged.
ActiveNoAck	3	Alarm has been raised but not acknowledged.

AlarmHistory

Represents a historical alarm record.

Property	Type	Description
id	uint?	Object identifier.
tagId	uint	Tag identifier.
tagName	string	Name of the tag.
message	string	Message when alarm was raised.
priority	uint	Priority of alarm.
alarmTime	DateTime	Date and time when alarm was raised.
ackTime	DateTime	Date and time when alarm was acknowledged.
resetTime	DateTime	Date and time when alarm was reset.
alarmDuration	TimeSpan	Duration of the alarm.
reactionDuration	TimeSpan	Duration of the reaction.
comment	string	Comment of alarm on acknowledgement.

AlarmStatistic

Represents statistical data for an alarm tag over a period.

Property	Type	Description
id	uint?	Object identifier.
tagName	string	Name of the tag.
message	string	Message when alarm is raised.
priority	uint	Priority of alarm.
code	uint	Code of the alarm.
failureNumber	uint	Number of times the alarm was triggered.
failureTotalTime	TimeSpan	Total time during which the variable has been in alarm state.
failureMeanTime	TimeSpan	Average time, over the selected period, during which the variable is in the alarm state.

AlarmIntervention

Represents intervention statistics per operator.

Property	Type	Description
id	uint?	Object identifier.
user	string	Name of operator.
interventionNumber	uint	Number of interventions.
reactionMeanTime	TimeSpan	Average operator reaction time.
interventionMeanTime	TimeSpan	Average length of operator intervention time.

CallHistory

Represents a call history record associated with an alarm.

Property	Type	Description
id	uint	Object identifier.
alarmLogId	uint	Alarm object identifier.
tagId	uint	Identifier for the tag associated with the alarm.
alarmTime	dateTime	Date and time when alarm was raised.
message	string	Message when alarm was raised.
resetTime	dateTime	Date and time when alarm was reset.
ackTime	dateTime	Date and time when alarm was acknowledged.
commentText	string	Textual comment associated with the alarm.
alarmLocalTime	string	Local date and time when alarm was raised.
resetLocalTime	dateTime	Local date and time when alarm was reset.
ackLocalTime	dateTime	Local date and time when alarm was acknowledged.
stationName	string	The name of the station.
dataServerName	string	The name of the data server.
tagGroupName	string	The name of the tag group.
callGroupName	string	The name of the call group.
userName	string	The name of the user.
priority	uint	Priority of alarm.
shortMessage	string	A short message associated with the alarm.
tagName	string	Name of the tag.
status	uint	The status of the tag.
identifier	string	An identifier associated with the tag.

CallGroup

Represents a call group configuration.

Property	Type	Description
id	uint	Object identifier.
stationId	uint?	Station object identifier.
status	CallGroupStatus	Current status of the call group (active, pending, or other system-defined state).
groupingId	uint	Identifier of the grouping to which the call group belongs. If not part of a grouping, value is 0.
reliefGroupId	uint	Identifier of the relief group associated with the call group.
activeTeamId	uint	Identifier of the active team within the call group. Value is 0 if no active team.
derogationTeamId	uint	Identifier of the derogation team within the call group. Value is 0 if not defined.
resolution	uint	Code or identifier of the resolution associated with the call group.
audioFile	string	Path to the audio file associated with the call group.
members	List<Member>	List of members of the call group.
program	ScheduleProgram	Pre-established program or action plan associated with the call group.
localizedName	string	The localized name of the call group.
lastChange	dateTime	Date of the last change or update to the call group.

CallGroupGrouping

Represents a grouping of call groups.

Property	Type	Description
id	uint	Object identifier.
stationId	uint?	Station object identifier.
parentGroupId	uint?	Identifier of the parent group.
fullName	string	Complete name, including parent group name.
localizedFullName	string	Localized complete name, including parent group name.
name	string	The name of the group.
localizedName	string	The localized name of the group.
lastChange	dateTime	Date of the last change or update.

DataServer

Represents a data server connection.

Property	Type	Description
id	uint	Object identifier.
stationId	uint?	Station object identifier.
enabled	bool	Indicates whether the DataServer is enabled.
isDisabled	bool	Indicates whether the DataServer is disabled.
isFailed	bool	Indicates whether the DataServer has failed.
dataServerGroupId	uint	Identifies the group to which the DataServer belongs. Value is 0 if no parent group.
name	string	The name of the data server.
localizedName	string	The localized name of the data server.
lastChange	dateTime	Date of the last change or update.

DataServerGrouping

Represents a grouping of data servers.

Property	Type	Description
id	uint	Object identifier.
stationId	uint?	Station object identifier.
parentId	uint	Identifier of the parent entity.
name	string	The name of the data server grouping.
localizedName	string	The localized name of the data server grouping.
lastChange	dateTime	Date of the last change or update.

DataTag

Represents a data tag within a data server.

Property	Type	Description
id	uint	Object identifier.
stationId	uint?	Station object identifier.
fullName	string	Complete name of the data tag, including data server name.
localizedFullName	string	Localized version of the complete name, including localized data server name.
type	uint?	Type of the data tag (category/classification).
dataServerId	uint?	Identifier of the associated data server.
enabled	bool	Indicates whether the data tag is enabled.
path	string	The path of the data tag.
fullPath	string	The full path of the data tag.
unit	string	Unit of measurement, if applicable.
groupList	List<uint>	List of tag group identifiers attached to the data tag.
baseGroup	uint?	Identifier of the base tag group.
valueType	uint?	The type of value associated with the data tag.
valueAccess	uint?	Access level for the value.
value	string	The current value of the data tag.
valueQuality	uint	The quality of the value.
bitMask	uint	The bitmask associated with the data tag.
eventCondition	EventCondition	The event condition associated with the data tag.
alarmShortMessage	string	Short message associated with the alarm.
alarmFormat	string	Format for the alarm message.
alarmActions	List<Action>	List of actions associated with alarms.
resetMessage	string	Message for the reset action.
resetFormat	string	Format for the reset message.
resetShortMessage	string	Short message for the reset action.
resetActions	List<Action>	List of actions associated with resets.
priority	uint	Priority level associated with the alarm.
ackShortMessage	string	Short message associated with acknowledgment.
eventSchedule	EventScheduleActivation	Event schedule activation associated with the data tag.
localizedName	string	The localized name of the data tag.
lastChange	dateTime	Date of the last change or update.

Member

Represents a member of a call group.

Property	Type	Description
id	uint	Object identifier.
relief	bool	Participation or association of the user in rescue activities.
name	string	The name of the user.
localizedName	string	The localized name of the user.

ScheduleProgram

Represents a schedule program for a call group.

Property	Type	Description
daysInMonth	uint?	The number of days in the month for which the schedule program is defined.
days	List<ScheduleDay>	The days of the program.

ScheduleDay

Represents a single day in a schedule program.

Property	Type	Description
periods	List<SchedulePeriod>	The periods in the schedule day.
recurrence	uint?	The frequency with which the program repeats over a given period.

SchedulePeriod

Represents a time period within a schedule day.

Property	Type	Description
start	TimeSpan	The start time for the schedule period.
teamId	uint?	The identifier of the team associated with the schedule period.
reduceDuty	bool	Indicates whether duty reduction is enabled for this period.
forcedDuty	bool	Indicates whether forced duty is enforced for this period.

EventCondition

Defines the condition under which an event (alarm) is triggered for a data tag.

remarque

Detailed property documentation will be available in a future release.

Action

Defines an action to be executed in response to an alarm, reset, or acknowledgment event.

remarque

Detailed property documentation will be available in a future release.

EventScheduleActivation

Defines whether there is a predefined schedule or timing for events related to a data tag. Specifies when certain actions should occur based on predefined conditions or criteria.

remarque

Detailed property documentation will be available in a future release.