Alarm settings

Web Port alarm settings are set mainly in SYSTEM SETTINGS/ALARMS (see chapter "Basic settings".

Alarm settings for tags are made in the tag list (see chapter Tags->Alarm options).

Basic settings

Basic alarm settings are accessed via SYSTEM SETTINGS/ALARMS/BASIC SETTINGS.

The following settings can be made:

Setting:	Description:
Activate alarm support(checkbox)	Enables alarm management
Alarm Scan rate	Indicates how often alarms are checked. Smallest valid value is 0.1 (100ms)
Standard Criteria	Indicates the default criterion for alarms, such as alarms at tag=1
Standard Category	Indicates the default category for alarms, for example 1, 2, 3, A, B, C
Standard delay	Indicates any default delay for alarms in seconds
Show state image	Indicates if the symbol for the state should be displayed in the tag list
Show state text	Indicates whether the state text be displayed in the tag list
Show Popup	Enable or disable the red popup for alarms in the bottom right corner.
Enable user filter	Indicates whether default alarm filter can be saved on user. Used both for filter of visualization and transmissions. See information below
Block alarm transmissions on active portal	If checked, alarm transmissions from node is blocked. If connection is lost between node and portal, Node will send out the alarms.

Column settings can be used to customize names, contents and order of columns in the alarm list:

Heading x	Indicates text on the heading
Value x	Indicates the information to be displayed in the column

Information

If activate user filter is enabled, a default filter for alarms can be saved to users. The filter is saved by the user via in the alarm list click on Filter, then adds the preferred filter terms, and checks “Use as default” before filtering. The selected filter will be saved to the user and be valid until a new default filter is saved. To remove default filter, open the filter popup once more, clear all the fields, and check “Use as default”.

Note!

Default filter will control both what the user sees in the alarm list, and also which alarms will be transmitted to the user when it is defined as an alarm receiver.

Send alarm via email

To send an alarm via e-mail, SMTP settings must first be made (see chapter "Email settings"). Alarm transmission configuration is done in SYSTEM SETTINGS/ALARMS/ALARM RULES
Sending via e-mail can be done for Active alarm, Inactive (reverted) alarm and acknowledged alarm. Heading and message text can contain dynamic values that are replaced by alarm information.

Below is a list of dynamic values. (They can be inserted in the header and message texts)

Value:	Description:
[DATE]	Date when the alarm state changed
[TIME]	Time when the alarm state changed
[DESC]	Alarm description
[TAG]	Tag Name
[STATE]	State Text
[PRIORITY]	Alarm Category
[AREA]	Area Text
[PAGE]	Link to the page where the alarm is linked. The host name will depend on what has been configured as Web Port URL under System settings/Server/General settings
[PAGENAME]	Name of the alarming page
[PAGEDESC]	Alarming page description
[R]	Line break
[T]	Tab

The following settings can be made to transmit an alarm via email:

Setting:	Description:
Activate	Enables alarm transmission
Heading	Message header (see example below)
Message	Message text (see example below)
Reciever	Message reciever are found under Alarm Filter

Information

An alarm filter always needs to be configured; however, all fields except recievers are voluntary. The following filter settings can be made, and multiple filter criteria can be separated with a comma (,)

Setting:	Description:
Priority	Filtering of the alarm category, for example 1, 2, 3, A, B, C
Tag	Filtering of tag names, for example LB01, LB02. Supports starting and ending wildcards (*) You can also exclude tags from the filter using "-tagname"  Example: -LB01_GT11_AL,-LB01_GT12_AL
Descriptions	Filtering of tag descriptions, such as service, fire. Supports starting and ending wildcards (*)
Page	Filtering of page, for example VENTILATION_LB01. Supports starting and ending wildcards (*)
Days	Filtering of days, set as 1 (on), 0 (off).  Each digit corresponds to a specific day or category in this order: Mon, Tue, Wed, Thu, Fri, Sat, Sun, Eve, Holiday For example: 111110000 (on all weekdays)
Start time	Filtering of start time by format 0000, alt 00:00
End Time	Filtering of end time by format 0000, alt 00:00. (2400, is 0000)
Start Date	Filtering of start date by format 20230109
End Date	Filtering of end date by format 20230401
Recievers	Email address of recievers e.g. [e-mail], [e-mail] or *

Example

The following example shows how alarm transmission can be done by all A-alarms, Monday-Friday between 07:00-17:00.

The alarm is sent to two different e-mail recievers.

Heading
Alarm from Plant1

Text
Alarm: [TAG][R]Description:[DESC][R]Time: [DATE][TIME][R]Page:[PAGE]

Filter

Priority	A
Days	1111100
Recievers	[e-mail], [e-mail]

Tip 1!

Several filter expressions can be created one after the other. This means that settings for A-alarm can be separated from B-alarm settings.

Tip 2!

As a reciever you can also write * which means that the alarm is sent to anyone who has ADVANCED permissions for the alarm and who is configured as an alarm reciever in ACCESS/USERS.

Send alarm via SMS

Sending of SMS alarms is done in the same way as for E-mail (see chapter "Send alarm via email"). The difference is that the recievers are listed as telephone numbers instead of e-mail addresses.

Note!

To send SMS, a GSM modem is need to be connected to the computer where Web Port is installed.

See chapter "SMS settings" for settings.

If connecting hardware isn't an option or there are other limitations, you can use a third-party email-to-SMS service instead.

Send SMS via Email

If you’re unable to connect a GSM modem or have other limitations, you can use a third-party Email-to-SMS service instead. 

To use this, you first need to activate the "Email Settings" option. Then, create an account with a third-party provider offering Email-to-SMS services.

NOTE!

For cloud customers.
If you are a cloud customer, please contact us to activate the service. We will create an account with a third-party provider and configure the service for your cloud environment. This ensures that everything functions correctly and that the service is ready for use.

Once your account is set up, you can configure the integration in Web Port in two ways:

Option 1

If users are marked as alarm recipients, enter the email format [e-mail] in the Phone Number field of the user.

e.g. [e-mail]

In the SMS alarm filter, set the recipient field to *. This will send SMS notifications to all users marked as alarm recipients with the appropriate alarm filter permissions.

Option 2

In SMS alarm filter you enter the email format in the recipient field: [e-mail]

e.g. [e-mail]

When an alarm is triggered using this filter, an email will be sent to Generic, which will convert it to an SMS and forward it to the recipient's mobile number.

Email Watchdog

Email watchdog can be used when an external service requires a cyclical email message to indicate that a Web Port installation is working.

The following settings can be made in SYSTEM SETTINGS/ALARM/Email watchdog:

Setting:	Description:
Activate(checkbox)	Activates watchdog
Watchdog interval	Indicates how often watchdog messages are sent, in seconds
Heading	Message header
Message	Message text
Reciever	Reciever of message, or filter expression

Note!

To use Email Watchdog, properly configured SMTP settings are required.

See chapter Email-settings

Send alarm via Tag

Transmitting alarms via tag can be used, for example, to activate a tag for collective alarms or to trigger a script. As reciever, "Tag name=value" is set. It is also possible to trigger an script using the recipient expression script#SCRIPTNAME(par1=value1). Parameters are optional, and the default parameters fromtag and alarmstate will also be accessible to the script. You can send only one parameter due to limitations in separating parameters with ",". Multiple parameters would cause issues as recipients are also separated by ",".

Filters can otherwise be made according to chapter Alarm via email under Alarm settings.

Example:

Reciever
AS01_SUMMALARM_AL=1

The summary alarm for unit AS01 is set to 1, when a new alarm is activated.

Reciever script#test(par=1)

The script named test will be executed, where the parameters par, fromtag and alarmstate are available to use. Can be tested, for example, by the code below that prints the parameters to the debug log:

debug(fromtag); 
debug(alarmstate.ToString());
debug(par);
return true;