Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added Related Articles section, fixed minor grammatical issues


Problem (Issue) Statement:

How to Configure Alarm Definition in xPortalNet Software

Description:

Alarm Definition is used to re-classify transaction as alarm events and its handling. All existing alarm transactions are initialized in Alarm Definition. User can modify the existing default Alarm Definition or create new one.

When the configured alarm is triggered, the transaction can be found from the Latest Alarm Event List tab at the Client main window. User can perform action like acknowledge alarm, mute alarm audio and jump to the floor plan where the device of the alarm triggered is located. 

Related Software:

xPortalNet PS v1.5.0.147 or higher

Related Hardware:

NIL

System Application:

Door Access System

Symptom and Finding:

NIL

Cause:

For first time guide to configure the Alarm Definition. 

Solution:


Summary 

Step-by-step Guide: 

  • Anchor
    addalarmdefinitions
    addalarmdefinitions
    To Add New Alarm Definitions:

In these steps, user will be guided to add new Alarm Definition.


Step 1: Login to xPortalNet Client. 


Step 2: Open Alarm Definition. Go to Data Setup > System Setting > Alarm Configuration > Alarm Definition.


Step 3: The Alarm Definition Library window will be shown. 


Step 4: Click Add to add new Alarm Definition.
Alarm Definition Library WindowImage Modified
Figure 1: Alarm Definition Library Window. 


Step 5: Fill up the fields according to the description below.
Add Alarm Definition WindowImage Modified
Figure 2: Add Alarm Definition Window.

Add Alarm Definition Field Description
Table 1: Add Alarm Definition Field Description.


Step 5: Configure the Options Tab.



  • Anchor
    configureoptions
    configureoptions
    To Configure the Options Tab:

In these steps, user will be guided to configure the options for this Alarm Definition. These options provided to cater for most of user's preferences.


Step 1: Select Options Tab.


Step 2: Configure the fields according to the description below.
Options Tab WindowImage Modified
Figure 3: Options Tab Window.

Options Field DescriptionImage Modified
Table 2: Options Field Description.


Step 3: Configure the Assigned Events Tab.



  • Anchor
    configureassignedevents
    configureassignedevents
    To Configure the Assigned Events Tab:

In these steps, user will be guided to add new assigned events for this Alarm Definition. When the software received the configured transactiontransactions, it will then trigger the alarm.


Step 1: Select Assigned Events Tab.


Step 2: Click Add to add new assigned events
Assigned Events WindowImage Modified
Figure 4: Assigned Events Window.


Step 3: The Add Alarm Event window will be shown. Configure the fields according to the description below.
Add Alarm Event WindowImage Modified
Figure 5: Add Alarm Event Window.

Add Alarm Event Field DescriptionImage Modified
Table 3: Add Alarm Event Field Description.


Step 4: Configure the Configuration Tab.



  • Anchor
    configureconfigurations
    configureconfigurations
    To Configure the Configurations Tab:

In these steps, user will be guided to configure the configurations for this Alarm Definition. These section consists sections consist of Instruction, Audio Notification and Alarm Icon configurations.


Step 1: Select Configurations Tab.


Step 2: Configure the fields according to the description below.
Configurations WindowImage Modified
Figure 6: Configurations Window.

Configurations Field DescriptionImage Modified
Table 4: Configurations Field Description.


Step 3: Configure the SMS / Email Notification Tab.



  • Anchor
    configuresmsemailnotification
    configuresmsemailnotification
    To Configure the SMS/ Email Notification Tab:

In these steps, user will be guided to configure the smsSMS / email notification for this Alarm Definition. SMS / email notification will be sent to the selected user when the alarm is triggered.


Step 1: Select SMS / Email Notification Tab.


Step 2: Configure the fields according to the description below.
Sms or Email Notification WindowImage Modified
Figure 7:
Sms SMS or Email Notification Window.

Sms or Notification Field DescriptionImage Modified
Table 5:
Sms SMS or Notification Field Description


Step 3: Click OK to confirm and save the changes.

Document Date

31/07/2018 (Rev 1.0)

Status
subtletrue
colourYellow
titleProof-read

.

Section
bordertrue


Column
width100%

Related Articles.

Containing the label "alarm-configuration"  

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sortcreation
cqllabel = "alarm-configuration" and space = "MKB" and title ~ "!\"how to configure alarm definition in xportalnet software\""