AckAlarm
Acknowledges the alarm identified by ``. The identifier can be the reference (String) or the Oid (Integer).
AckCall
Acknowledges the call for the user who has the ID ` or whose name is ` if UserId = 0.
AddUser
This function adds a user in a call group or a team.
AlarmIsInSuperviseList
Returns TRUE if the tag `` already exists in the supervision list.
CheckLogin
This function verifies that the ` and ` pair is valid.
CloseSession
Closes the user or data server session specified by ``, the identifier of the last session opened by the OpenSession function.
CreateAlarm
Creates an alarm defined by the string identifier ``.
CreateObject
Creates an object of the given type.
CreateTag
Creates or updates a tag designed by the string identifier ``.
CreateUser
Creates a user with name `, first name and access level then returns the ID of the created user in `.
DeleteAlarm
Deletes the alarm identified by ``.
DeleteObject
Deletes the specified object.
DeleteUser
Deletes the user identified by ``.
EnumAlarm
Returns in ` the next alarm id from the alarm id specified in input in . The parameter can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
EnumNotifiedTeam
Returns the team at index ` from the advised teams (call acknowledged) for the alarm in the parameter `.
EnumObject
Enumerates all the objects of a given type. If an object is found, its ID is returned in ` and its name in ` (full tag identifier if data server not specified, else short tag identifier).
ExecuteCommand
Executes the command ``.
FindObject
Searches for the object specified by the parameter `. This parameter can specify the name of the object to search (type string and defined as below) or any other object attribute. If the object is found, its ID is returned in `.
FindObjectEx
Searches for the object specified by the parameter `. This parameter can specify the name of the object to search (type string and defined as below) or any other object attribute. If the object is found, its ID is returned in `.
FindUser
Searches for the user of name ` and first name . If the user is found, his ID is returned in `.
FindUserDialNumber
Searches for the first user having the call number ` for the call driver referred to by , starting from the user id following the id defined in (0 at the beginning). If the user is found, his ID is returned in `.
GetAlarmCallStatus
This function retrieves the call status (in `) of the alarm identified by `.
GetAlarmClientRef
Get in ` the ClientRef value of the alarm tag `.
GetAlarmComment
Returns in ` the alarm comment for . The parameter can be the tag OId or the text identifier (Integer or String). The ` parameter must contain the maximum requested size for the comment.
GetAlarmDelay
Gets in ` the alarm delay value of the alarm tag identified by `.
GetAlarmInfo
Returns the alphanumeric identifier of the alarm tag ` in , with its first on-call group to call in , its base alarm group in , its long message in and in option its short message in `.
GetAlarmMessage
Gets in ` the formatted alarm message of the alarm tag identified by `.
GetAlarmOncallUser
Returns in ` the user ID of the th called user for the specified Alarm . can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
GetAlarmPriority
Returns in ` the priority value of the alarm tag . can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
GetAlarmState
This function returns in ` the current alarm state of alarm tag identified by . can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
GetAlarmStatus
Gets the full alarm status of the alarm tag identified by `. can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
GetAlertStatus
Returns in `` the current Alert status:
GetAudioFile
Gets in ` the name of the audio file associated to the alarm . can be the numeric object id of the alarm tag or its alphanumeric identifier, according with the type of ` (Integer or String).
GetDayType
Returns in ` the type of day (0=Monday, ... 6=Sunday, 7=Holiday) of the date specified by the optional parameter ` (current date by default).
GetGroupCallStatus
Gets in ` the current call status of the call group identified by . ` can be the numeric object id of the call group or its name, according with its type (Integer or String).
GetGroupOncallUser
Gets in ` the user ID of the th called user in the call group . ` can be the numeric object id of the call group or its name, according with its type (Integer or String).
GetLocation
Gets the location (in GPS coordinates) of the tag referred to by `. ` can be the numeric object id of the tag or its alphanumeric identifier, according with the parameter type (Integer or String).
GetMaxAlarmDuration
Returns in ` the maximum duration in the active state of the alarm identified by `.
GetTagValue
Gets in ` the value of the variable identified by . ` can be the numeric object id of the tag or its alphanumeric identifier, according with the parameter type (Integer or String).
GetUserCallStatus
Gets in ` the current call status of the user identified by ` (numerical ID or user name).
GetUserDialNumber
Gets in ` the first active call number of the user with the specified media . ` can be the numeric object id of the user or his name, according with the parameter type (Integer or String).
GetUserDuty
This function returns the duty status of the user `` (numerical ID or user name).
GetUserInfo
Returns the name of the user designated by the numeric identifier ` in , his first name in , his code in and his language in `.
GetUserWhoAckAlarm
Returns in ` the Oid of the user who acknowledged the alarm `.
GetXMLRecord
Gets object attributes into an XML record.
MaskAlarm
Masks or unmasks the alarm identified by ` according to the value of ` parameter (FALSE=unmask, TRUE=mask).
MaskGroup
Masks or unmasks the alarms of the tag group identified by ` according to the value of ` parameter (FALSE=unmask, TRUE=mask).
OpenSession
Opens a data server or user session.
RemoveUser
This function removes the user ` from a call group or a team. ` can be the numeric object id of the user or his name, according with the parameter type (Integer or String).
SendGroupMessage
Generates a temporary alarm for the call group `` (Numeric identifier or group name).
SendTeamMessage
Sends a service message to all operators of a team.
SendUserMessage
Sends a service message to the user designated by the `` ID (numeric identifier or user name).
SetAction
Creates or modifies an action for the alarm variable designated by `` (Numeric or alphanumeric identifier of the variable).
SetAlarm
Sets or resets the alarm tag identified by `. ` can be the numeric object Id of the alarm tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmAck
Sets the group to be called and the message to be transmitted to signal the acknowledgment of the alarm identified by `. ` can be the numeric object Id of the alarm tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmClientRef
Set the ClientRef value ` of the alarm tag `.
SetAlarmCode
Defines in ` the short message associated with the alarm tag defined by the identifier. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmComment
Defines a comment for the alarm defined by the ` identifier. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmDelay
Sets the alarm delay value ` of the alarm tag identified by `.
SetAlarmGroup
Defines in ` the base tag group attached to the tag defined by the identifier. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmMessage
Defines in ` the long message associated with the alarm tag defined by the identifier. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmPriority
Defines in ` the priority of the alarm identified by . ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAlarmReset
Sets the group to be called and the message to be transmitted to signal the reset of the alarm identified by `. ` can be the numeric object Id of the alarm tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetAudioFile
Defines in ` the name of the sound file associated with the alarm tag identified by . ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetDriverInfo
Transmits the custom info string ` to the driver referred to by `.
SetEventCondition
Sets the event condition for the alarm tag identified by `. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetInstructions
Defines in ` the name of the instruction file associated with the alarm tag identified by . ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetLocation
Sets the location (in GPS coordinates) of the tag referred to by `. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetMaskTag
Sets the masking tag of the alarm identified by `. ` can be the numeric object Id of the alarm tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetMaxAlarmDuration
Sets the maximum duration in the active state of the alarm identified by ` to the value `.
SetObjectStation
Assigns an object (variable, call group, tag group or user) to the station `` (referenced either by its numeric Id or by its name).
SetReport
Records the user report ` issued from the user defined by the name and optional first name `.
SetSchedule
Defines a time slot in the schedule of the group specified by the `` parameter (numeric identifier or group name).
SetTagValue
Sets the value of the tag defined by `. ` can be the numeric object Id of the tag or its alphanumeric identifier depending on the type of the parameter (Integer or String).
SetUserDialNumber
Defines the call number of ` index of the user designated by `.
SetUserDuty
This function is used to put the user designated by ` on or off duty or to replace him with another user. ` can be the numeric OId of the user or his name depending on the parameter type (Integer or String).
SetUserReport
Creates a report for the user designated by ``.
SetXMLRecord
Configures an Alert object and its attributes from an XML string.
Status
Gets or sets the status of Alert according to the `` parameter:
Trace
Adds a line to the Alert event log.