WEBfactory 2010

WFAlarmConnector Class Overview

Abstract

Check out this article and learn more details about the WFServerConnector Class and the parameters involved in its management.

WFAlarmConnector provides methods to raise new or to deactivate custom alarms.

The following methods are implemented by WFAlarmConnector class:

  • Raise custom alarm

    • int RaiseCustomAlarm(string serverName, string signalName, string alarmTag, DateTime activationTime, List<object> alarmParameters);

  • Deactivate custom alarm

    • int DeactivateCustomAlarm(string serverName, string signalName, string alarmTag, DateTime deactivationTime);

  • AlarmAcknowledged event

    • int DeactivateCustomAlarm(string serverName, string signalName, string alarmTag, DateTime deactivationTime);

The following chapters will describe each method of the WFAlarmConnector class.

RaiseCustomAlarm

Method definition

int RaiseCustomAlarm(string serverName, string signalName, string alarmTag, DateTime activationTime, List<object> alarmParameters);

Calling parameters

serverName: Server name. A null or empty value stands for "."

signalName: Signal name. This parameter cannot be null

alarmTag: Alarm tag. This parameter cannot be null

activationTime: Time when the alarm was raised

alarmParameters: Alarm parameters

Return value

0: Success

5001: License expired

5011: Alarm not found

5012: Database error

5013: Argument null

  5010: Server SDK error

Description

This method raises a custom alarm in the WEBfactory system. The combination of the serverNamesiqnalName, and alarmTag parameters uniquely identifies the alarm to be raised.

DeactivateCustomAlarm

Method definition

int DeactivateCustomAlarm(string serverName, string signalName, string alarmTag, DateTime deactivationTime);

Calling parameters

serverName: Server name. A null or empty value stands for "."

signalName: Signal name. This parameter cannot be null

alarmTag: Alarm tag. This parameter cannot be null

deactivationTime: Time when the alarm was deactivated

Return value

0: Success

5001: License expired

5011: Alarm not found

5012: Database error

5013: Argument null

Description

This method deactivates a custom alarm in the WEBfactory system. The combination of the serverName siqnalName, and alarmTag parameters uniquely identifies the alarm to be deactivated.

Alarm Acknowledged event

Description

This event occurs when one or more alarms are acknowledged.

The arguments of the event contain the list of acknowledged alarms.