bacnetalarminterface

8/2/2019 BACnetAlarmInterface

1/49

ProTeus Alarm Interface for BACnetInstallation and Configuration Instructions

This document provides technical information for the installation and configuration ofProTeus Alarm Interface (PAI) and is intended only for use by a trained System Integrator.

This document discusses the following topics:

ProTeus Alarm Interface Requirements

Installation Instructions

Alarm Manager Setup and Configuration

ProTeus Group Rights Setup and Configuration

User Guide Alarm Configuration

User Guide Alarm Manager

User Guide Alarm Viewer

1


2/49

ProTeus AIBACnet Version

Rev 02/22/2006

Requirements for ProTeus AI software.....................................................................................4Installation..............................................................................................................................4

Alarm Configuration/Alarm Manager..................................................................................4

Alarm Viewer......................................................................................................................4Programs................................................................................................................................4ProTeus..............................................................................................................................4

Checklist.....................................................................................................................................5Eagle......................................................................................................................................5

Installation Instructions..............................................................................................................5ProTeus Client........................................................................................................................5ProTeus Database.................................................................................................................5

Alarm Configuration...............................................................................................................5Step 1: Install the Alarm Configuration..............................................................................5Step 2: Oracle installs only- Modify the ODBC Data Source.............................................6Step 3: Install PolarSoft to bind BACnet protocol to network adapter...............................6

Alarm Manager.......................................................................................................................6Step 1: Install the Alarm Manager......................................................................................6Step 2: Oracle installs only- Modify the ODBC Data Source.............................................7Step 3: Install PolarSoft to bind BACnet protocol to network adapter...............................7

Alarm Viewer..........................................................................................................................7Step 1: Install the Alarm Viewer.........................................................................................7Step 2: Oracle installs only- Modify the ODBC Data Source.............................................8

Alarm Manager Setup and Configuration..................................................................................8Alarm Manager Settings........................................................................................................8

Print Manager.....................................................................................................................9Log File...............................................................................................................................9

Auto-Poll...........................................................................................................................11

E-Link................................................................................................................................12Protocol.............................................................................................................................13Device ID..........................................................................................................................14

BACDOOR Client Configuration..........................................................................................15BACnet/IP Parameters.....................................................................................................16

ProTeus Group Rights Setup and Configuration....................................................................17Group Rights........................................................................................................................17

Alarm Configuration..........................................................................................................17Alarm Viewer....................................................................................................................17Alarm Manager.................................................................................................................17Purge/Archive Alarms.......................................................................................................17

User Guide- Alarm Configuration............................................................................................19Prerequisites........................................................................................................................19Field Description..................................................................................................................19

Search..............................................................................................................................19Work Order Details...........................................................................................................20

Login.....................................................................................................................................22Procedure.............................................................................................................................22

User Guide- Alarm Manager....................................................................................................32Prerequisites........................................................................................................................32File menu option...................................................................................................................32Field Description..................................................................................................................32Procedure.............................................................................................................................34

2


3/49

User Guide- Alarm Viewer.......................................................................................................35Prerequisites........................................................................................................................35Program Settings.................................................................................................................35

Options.............................................................................................................................36E-mail Setup.....................................................................................................................37Field Names......................................................................................................................38Minimize to Tray...............................................................................................................39

Field Description- Alarm/Event............................................................................................40Field Description- Alarm/Event History................................................................................41Field Description- Alarm/Event Archive...............................................................................43Procedure- Alarm/Event.......................................................................................................45Procedure- Alarm/Event History..........................................................................................46Procedure- Alarm/Event Archive.........................................................................................48

3


4/49

Requirements for ProTeus AI software

Installation

Alarm Configuration/Alarm Manager

Must be located on the same Local Area Network (LAN) as the ProTeus

database. Can only be run from one workstation.

Supported operating systems include: Windows 2000 Professional and WindowsXP Professional.

Cannot be installed on a ProTeus Multi-Site workstation.

Alarm Viewer

This is a standalone installation and does not require the ProTeus client to beinstalled.

This program can be installed and run on multiple workstations.

Requires connectivity to the ProTeus database.

Supported operating systems include: Windows 2000 Professional and WindowsXP Professional.

Cannot be installed on a ProTeus Multi-Site workstation.

Programs

ProTeus

BACnet Interface option must be enabled in the ProTeus database. This requiresa product enable code from Eagle.

Permissions must be assigned to user groups in the Group Rights program forpermissions to the Alarm Viewer, Alarm Manager and Alarm Configuration

programs. Compatible with ProTeus 9.6 databases.

4


5/49

Checklist

Eagle

1. ProTeus client software is installed. Details on page 5.2. ProTeus database is created/installed. Details on page5.3. Alarm Configuration software is installed. Details on page 5.

4. Alarm Manager software is installed. Details on page 6.5. Alarm Viewer software is installed. Details on page 6.6. Product Enable code applied for BACnet Interface.7. Permissions assigned in the Group Rights application for ProTeus Alarm Interface.8. Settings configured for the Alarm Manager program. Details on page 7.

Installation Instructions

ProTeus Client

1. This program requires MDAC 2.7. This installation program will automatically updateor install MDAC to meet requirements.

2. Refer to the existing client installation instructions located on the ProTeus CD in theDoc\Install folder for the database type being installed.

ProTeus Database

1. Refer to the existing server installation instructions located on the ProTeus CD in theDoc\Install folder for the database type being installed.

Alarm Configuration

For Windows 2000 Professional, and Windows XP Professional, all installations mustbe performed logged in with ADMINISTRATOR rights to the LOCAL PC.

This program requires MDAC 2.7. This installation program will automatically updateor install MDAC to meet requirements.

Step 1: Install the Alarm Configuration

1. Insert the ProTeus Alarm Interface installation CD. If the CD Browser does notautomatically launch, browse to the CD ROM drive, and double-click onLaunch.exe.

2. From the first screen of the CD Browser, click on [APPLICATION] under theheading, Alarm Configuration. Then select the database type from the list.

3. After the file transfer has completed, a DB Name dialog will appear requiringinformation to be entered that will be used for connection. Select the appropriatedatabase type from the drop down list.For MSDE:

Server Name: Enter the name of the computer hosting the ProTeus

database.For MSSQL:

MSSQL Server Name: Enter the name of the server hosting the ProTeusdatabase.

Database Name: Enter the name of the ProTeus database. The defaultname will be maintman.

For Oracle:

Enter Oracle Connect String: Enter the name of the SID or Service Name.

4. Follow the on-line instructions to complete the installation.

5


6/49

Step 2: Oracle installs only- Modify the ODBC Data Source

1. From Windows Control Panel (Windows 2000/XP>Administrative Tools), openODBC Data Source Administrator.

2. Select the System DSN Tab.3. Highlight MaintManOra from the list of data sources and then click the

Configure button.4. In the Server Name field, enter the service name created in Step 1.

5. Click OK and then close the ODBC Data Source Administrator.

Step 3: Install PolarSoft to bind BACnet protocol to network adapter.

The BACnet protocol uses third party software from PolarSoft Inc. Reference theinstallation document, BACdoor OEM Client Ethernet 8802-3 Driver Install.pdf,located on the PAI CD in the Doc\Install folder for installation details.

Note: Adobe Acrobat is required to view this document.

Note: If the Alarm Configuration program is installed on the same computer as theAlarm Manager program, this procedure only needs to be completed onetime.

Note: Step 9 of the PolarSoft Inc. document makes reference to the folder wherethe BACDOC client was installed to. The default location for this folder isC:\Program Files\Eagle\Alarms\BACnet Alarm Config\Drivers.

Alarm Manager



Step 1: Install the Alarm Manager

1. Insert the ProTeus Alarm Interface installation CD. If the CD Browser does not

automatically launch, browse to the CD ROM drive, and double-click onLaunch.exe.

2. From the first screen of the CD Browser, click on [APPLICATION] under theheading, Alarm Manager. Then select the database type from the list.


Server Name: Enter the name of the computer hosting the ProTeusdatabase.

For MSSQL:



For Oracle:


4. Follow the on-line instructions to complete the installation.

6


7/49






Step 3: Install PolarSoft to bind BACnet protocol to network adapter.

The BACnet protocol uses third party software from PolarSoft Inc. Reference theinstallation document, BACdoor OEM Client Ethernet 8802-3 Driver Install.pdf,located on the PAI CD in the Doc\Install folder for installation details.

Note: Adobe Acrobat is required to view this document.

Note: If the Alarm Manager program is installed on the same computer as theAlarm Configuration program, this procedure only needs to be completed onetime.

Note: Step 9 of the PolarSoft Inc. document makes reference to the folder wherethe BACDOC client was installed to. The default location for this folder isC:\Program Files\Eagle\Alarms\BACnet Alarm Config\Drivers.

Alarm Viewer



Step 1: Install the Alarm Viewer

1. Insert the ProTeus Alarm Interface installation CD. If the CD Browser does not

automatically launch, browse to the CD ROM drive, and double-click onLaunch.exe.

2. From the first screen of the CD Browser, click on [APPLICATION] under theheading, Alarm Viewer. Then select the database type from the list.


Server Name: Enter the name of the computer hosting the ProTeusdatabase.

For MSSQL:



For Oracle:


4. Complete the installation by clicking OK to the DB Name dialog.

7


8/49






Alarm Manager Setup and ConfigurationThis section describes settings that are required to be configured prior to any attempts toconnect to the ProTeus database. This program can only be run from one workstation.

Alarm Manager Settings

1. Open the Alarm Manager Settings.a. Select Start>Programs>ProTeus V>Alarms>BACnet Alarm Managerto open

the Alarm Manager program.

b. Select Edit>Settings>Alarm Managerfrom the menu list to display the settingsdialog.

8


9/49

Print Manager

The information on this tab is optional and only needs to be filled in if the AlarmManager will print work orders.

Reports Path: Displays the directory selected for the location of the work orderreports.

Note: If this installation was performed on a workstation that also has the

ProTeus client installed, the report path must be set to the ProTeusdirectory.

Printer Setup: Click this button to select which printer will print the work orders.If no printer is selected, then the Windows default printer will be used.

Log File

The log files should be configured during initial startup. Otherwise, they can beunselected to preserve hard drive space.

Exceptions Log: This log will contain errors that occur while the Alarm Manageris running. Check this box to have the exceptions written to file. Click the Purgebutton to empty the contents of the log file.

Warnings Log: This log will contain information pertaining to alarms and eventsthat have been detected but not configured. Check this box to have the warningswritten to file. Click the Purge button to empty the contents of the log file.

9


10/49

Manager Output: Details pertaining to each poll will be written to this file. Thisinformation includes; time of poll, number of alarms detected, number of newalarms, number of existing alarms and if any warnings or exceptions haveoccurred.

10


11/49

Auto-Poll

Auto-Poll Interval: This is the time interval in seconds that the Alarm Managerwill wait before checking for any new alarms. A value greater than 0 is required.

11


12/49

E-Link

The information on this tab is optional and only needs to be filled in if the AlarmManager will be used to send alarm details to a mail recipient.

SMTP Server Name: Enter the name of the SMTP server that is hosting the mailservices.

Your E-mail Address: Enter the E-mail address of the individual sending the

mail. The name entered here will appear in the From field of the E-mail.Authentication Required: Check the checkbox if username and passwordauthentication is required on the mail server. If the SMTP Authenticationcheckbox is checked, then a User Account name and Password is required.

User Account: Enter the name of the user account that has been established onthe mail server.

Password: Enter the password that will be used with the name entered in theUser Account field.

12


13/49

Protocol

BACnet/IP: Select this radio button if alarms will be received on the BACnet/IPprotocol.

Standard Ethernet/ARCNET: Select this radio button if alarms will be receivedon Ethernet (ISO 8802-3) protocol.

13


14/49

Device ID

Device ID: Enter a unique device id that does not conflict with any other deviceids on the BACnet network.

14


15/49

BACDOOR Client Configuration

The settings for BACDOOR will only need to be modified under two conditions. If thecomputer has two network interface cards installed or if PAI will be registered as aforeign device.

1. Open the BACDOOR Configuration settings.a. Select Start>Programs>ProTeus V>Alarms>BACnet Alarm Managerto open

the Alarm Manager program.b. Select Edit>Settings>BACDOOR Configuration from the menu list to display

the settings dialog.

15


16/49

BACnet/IP Parameters

Network Adapter: To change the network adapter that BACDOOR will bind to,click on the drop down list and select the appropriate item from the list.

Foreign Device: To register PAI as a foreign device, the checkbox must bechecked and a valid IP address must be entered.

Registration Time-to-Live: This is the amount of time in seconds that

BACDOOR will wait before registering as a foreign device again.Note: Any changes to these settings will require the Alarm Manager to be

closed, then reopened for the changes to take affect.

16


17/49

ProTeus Group Rights Setup and ConfigurationThis section describes settings that are required to be configured for access to the ProTeus

Alarm Interface programs. This portion of the setup must be performed at a ProTeusworkstation.

Group Rights

1. Select Start>Programs>ProTeus V>Rights to open the Group Rights program.2. Login as ProTeus Administrator.3. Select the Alarm Rights tab.

Alarm Configuration

Write: User can read and configure BACnet objects to ProTeus work orders.

Read: User can read configured data.

None: No permissions

Alarm Viewer

Write: User can Clear, Activate, Print, Refresh, View Work Order Details,View Alarm Details and set Options for Alarms and Events.

Read: User can Refresh, View Work Order Details, View Alarm Details forAlarms and Events and Print work orders that have a Status ofActive or Printed.

None: No permissions.

Alarm Manager

Write: User has permissions to setup, configure and run the program.

None: No permissions.

Purge/Archive Alarms

Checkbox checked: User can Archive alarms from the Alarm Viewer and

Purge alarms from the Archive Viewer.

17


18/49

4. Click Save to apply changes.

18


19/49

User Guide- Alarm ConfigurationThis program will display device objects in a tree view and create the mapping of an objectto a DM (Demand Maintenance) or PM (Preventive Maintenance) work order template. Thetree will include all or a filtered set of active BACnet objects depending on search criteriaentered. The work order template section will allow users the ability to enter work orderinformation once an object is selected for configuration. The process of mapping must be

completed for each object that is to be monitored. Any DMs that are created that do nothave a piece of Equipment attached will not be displayed in the Alarm Configurationprogram.

Note: The term Alarm is used with two different contexts throughout this manual.

One referring to the specific alarm type. Reference will be made to this meaningwhen it is necessary to distinguish specifically between an Alarm or Event. Thiscan be identified by the phrase, alarm or event or alarm and event.

The other references the state of an object. This can be identified by the phrase,alarm.

Prerequisites

1. Equipment must be created in ProTeus prior to mapping any objects to work orders.2. A valid ProTeus login.3. Minimum ProTeus Rights required.

Write rights for Alarm Configuration.

Field Description

Search

This section of the window will allow filtering to be set on the search and willdetermine the results displayed in the Object Tree list.

Vendor: This field will filter the Object Tree list by Vendors. Selecting All willreturn a list of all vendor objects. Choosing a specific Vendor from the drop down

list will return only vendor specific objects.

Note: A text file containing the list of vendors is stored in the AlarmConfiguration directory and is called Vendors.eti. Additional vendors canbe added to this list and, in turn, will be displayed in the drop down list.Likewise, vendors can be removed from the file. New vendor entriesshould be made in the format of, Vendor Name=ASHRAE Vendor ID.

Object Type: This field will filter the Object Tree list by the Object Type.Selecting All will return a list of all supported objects. Choosing a specific objecttype from the drop down list will return only objects of the type selected.

Configuration: This field will filter the Object Tree list for objects that havealready been configured or objects that need to be configured. Selecting All will

return a list of all objects. Selecting Configured will return a list of objects thatare already configured to work orders. Selecting Unconfigured will return a listof objects that can be configured.

Range: This is a required field. Entering a starting value and an ending value willsearch for the device ids within the range entered.

19


20/49

Find Objects: Click this button to begin building the device object tree.

Load File: Clicking this button will load a saved text file.

Work Order Details

This section of the window is for setup and mapping to a work order.

WO Type: This field is read only. Either DM or PM will be displayed based on thework order template selection.

Job No.: This field is read only. Data will be displayed from the Job No. field ofthe work order selected.

Cycle Type: This field is read only and pertains to PMs only. Data will bedisplayed from the Cycle Type field of the work order selected.

Equipment No.: This field is read only. Data will be displayed from theEquipment No. field of the work order selected.

Equipment Name: This field is read only. Data will be displayed from theEquipment Name field of the work order selected.

Select DM: This option will allow mapping of objects to existingwork orders.Clicking on this button will open a new window to allow for a search of availableDM Templates in the ProTeus database. Only work orders that are not already

mapped to an object will be displayed in this list. To configure an object to a newwork order, use the procedure, Create DM, described below.

Select PM: This option will allow mapping of objects to existingwork orders.Clicking on this button will open a new window to allow for a search of availablePM Masters in the ProTeus database. Only work orders that are not alreadymapped to an object will be displayed in this list. To configure an object to a newwork order, use the procedure, Create PM, described below.

Create DM: Use this option to create a DM work order on-the-fly andsimultaneously map to an object. This right click option is available in the ObjectTree list box.

Create PM: Use this option to create a PM work order on-the-fly and

simultaneously map to an object. This right click option is available in the ObjectTree list box.

E-Link: Clicking on this button will open a new window to allow setup for sendingwork orders via SMTP to e-mail or pager.

Vendor Name: This field will display the vendor name of the object that wasselected. The name entered here can also be changed.

Object Description: This field is optional. Users may enter a detailed descriptionof the object; up to a maximum of 255 characters.

Priority: This is the Priority field from ProTeus. The value selected here will getattached to the DM Template or PM Master. Also, changes made from DMTemplate or PM Master in ProTeus will update the Alarm Configuration.

Additional Priorities may be added to the database by clicking the icon next to thePriority field.

Parameter1: This field is optional. Any data entered here will be displayed in theAlarm Viewer and on the work order. A maximum of 20 characters can beentered.

Auto Print: By checking this box, the work order will automatically print when thealarm associated with the work order is detected. Auto Print will alsoautomatically activate the work order.

20


21/49

Auto Activate: By checking this box, the work order will be activatedautomatically when the alarm associated with the work order is detected.

E-Link: By checking this box, the details of the work order can be e-mailed orsent to pager through SMTP.

Update: Clicking this button will save all information.

Delete: Clicking this button will clear all information and remove the mapping ofthe object to a work order.

21


22/49

Login

The Alarm Configuration and Alarm Manager programs cannot be openedsimultaneously.

1. Select Start>Programs>ProTeus V>Alarms>BACnet Alarm Config to open theAlarm Configuration program.

2. Login as a valid ProTeus user.

Login Name: Enter a valid ProTeus user login name.Password: Enter the password of the user logging in.

Procedure

1. Select optional search criteria from the Vendor, Object Type and Configuration dropdowns.

2. Range is a required field. Enter a starting value and an ending value to search for alldevice ids that are within the range entered.

3. Click the Find Objects button to begin the search for device objects.4. Once the search has completed, the object tree will be displayed and objects can

now be mapped to a work order.

a. The Object Tree can be saved to file by right clicking in the Object Tree list boxand selecting Save to File. This will substantially decrease the amount of waittime for subsequent loading of the Object Tree.

b. To load a saved file, click on the Load File button.Note: The Load File feature cannot be used if a device or object is renamed. The

procedure forFind Objects must be completed and a new file saved.

22


23/49

To configure an object to an existingwork order, complete the procedure in Step 5. Toconfigure an object to a newwork order, complete the procedure in Step 6.

5. Choose either the Select DM orSelect PM button to create the work order typedesired. Refer to 5a for details on selecting a DM Template. Refer to 5c for details onselecting a PM Master.

a. Select DM: Clicking on this button will open a new window to allow for aselection of the DM Templates in the ProTeus database.Note: Only DMs that have a piece of Equipment attached will be displayed.

DMs that are already configured will not be displayed.

23


24/49

b. Click on the appropriate Job No. to select the record and then click the Selectbutton to create the mapping between the work order and the object.

c. Select PM: Clicking on this button will open a new window to allow for a searchof the PM Masters in the ProTeus database.Note: PMs that are already configured will not be displayed.

d. Click on the appropriate Job No. to select the record and then click the Selectbutton to create the mapping between the work order and the object.

24


25/49

6. To create a new work order and map an object, highlight an object in the tree, rightclick and then choose Create DM or Create PM. Refer to 6a for details on creating aDM Template. Refer to 6c for details on creating a PM Master.

25


26/49

Refer to the ProTeus User Manual for detailed information on the field definitions anda guide for creating work orders.

a. Create DM: Selecting this option will open a new window to allow for the creationof a new DM Template.

b. Fill in the appropriate information. A piece of Equipment must be selected beforesubmitting.

c. Create PM: Selecting this option will open a new window to allow for the creationof a new PM Master

26


27/49

d. Fill in the appropriate information. A Job No. must be entered, a piece ofEquipment must be selected and a cycle type must be created before submitting.

Note: Only one Cycle Type can be configured.

27


28/49

7. Click the E-Link button to access the setup.Note: This step is optional.

a. Click the Select Employee button to search for an employee. Only employeesthat have an e-mail address or pager number associated to an Employee Namewill be displayed. Employee Name, Pager No. and E-mail Address will get filledin when an employee is selected from the list.

28


29/49

b. Highlight an employee displayed in the list.c. Click the Select button to assign the employee to the work order.

d. Once an employee is selected, the Select Employee button will gray out.e. If a different employee needs to be assigned, the Delete button must be clicked

first to remove the previous employee.f. Clicking the radio button for Pager or E-mail will determine where the work order

details will be sent.

g. Add any additional details or text message to the text box.

29


30/49

h. Click Update to apply changes.

8. Use the Object Description field to enter a detailed description of the object.9. Select a Priority. This will determine the order in which the alarm will be displayed in

the Alarm Viewer. Click the icon next to the Priority field button to add a new Priorityto the ProTeus database.

10. Additional information may be entered into the Parameter1 field as required.11. Click the checkbox forAuto-Print to have the work order print automatically when an

alarm is detected for the selected object. Selecting Auto-Print will also automaticallyactivate the work order.

12. Click the checkbox forActivate Work Orderto have the work order automaticallyactivate when an alarm is detected for the selected object.

30


31/49

13. Click the checkbox forE-Link to have the details of the work order e-mailed when analarm is detected for the selected object. If this checkbox is checked, an employeemust be selected under the E-Link setup.

14. Click the Update button to apply changes.15. Repeat steps 5-14 for each object that is to be monitored for an alarm.

31


32/49

User Guide- Alarm ManagerThe Alarm Manager is the program that will receive the alarm notification from the objectsand activate the appropriate work order. This program must be running in order to receivealarms.




Prerequisites

1. Settings in the Alarm Manager program must be established prior to any attempts toconnect to the ProTeus database. Refer to the section, Alarm Manager Setup andConfiguration for detailed information on the requirements.

2. Objects must be mapped to a work order. Refer to the Alarm Configuration section ofthis manual for details.

3. Event notification must be configured in the object.4. Minimum ProTeus Rights required

Write

File menu option

Minimize to Tray: Selecting Minimize to Tray will place the Alarm Manager programin the system tray when the minimize button is pressed on the program.

1. Select File>Minimize to Tray from the menu list. A checkmark will indicate thatthe program will get minimized to the system tray.

Field Description

Automatic Polling: The Start button will allow the Alarm Manager to check for newalarms at the preset interval set during the configuration. The Stop button will haltthis process.

Note: Clicking the Stop button will not halt the process instantaneously if the AlarmManager is currently retrieving information.

Manual Polling: The Go button will invoke a one time check for alarms at a giveninstant without interrupting the automatic cycle. If the Alarm Manager is not runningat the time this button is clicked, it will startup for one cycle, then shut back down.

32


33/49

Alarm Manager Log: The text area will display events and reference a log file whenan error occurs. The details will be written to a warnings or an exception log if thecheckbox for Generate Log Files was selected during the Alarm Manager setup.The log files can be located in the Logs folder and is a subdirectory of the originalinstallation path.

33


34/49

Procedure

The Alarm Manager and Alarm Configuration programs cannot be openedsimultaneously.

1. Select Start>Programs>ProTeus V>Alarms>BACnet Alarm Managerto start theprogram.

2. Click the Start button to start the server.

3. Click the Stop button to stop the server4. Click the Go button to invoke a manual check for alarms.

34


35/49

User Guide- Alarm ViewerAlarm/Event Viewer: Will display critical information pertaining to current alarms andevents. Users will have the ability to view the status of an alarm and details of that alarmpertaining to both the configuration and settings. The default display order for alarms andevents will be based on the value of the Priority field. If two objects have the same Priority,then the second order will be by the time stamp. The order can be changed by selecting a

field from the Search By drop down list.

Alarm/Event History: Will display all objects that have been processed as an alarm orevent and cleared from the viewer. The status of the alarm, event or work order will also bedisplayed. The default display order for alarms and events will be based on the value of theDate Closed field.

Alarm/Event Archive: Will display all objects that have been archived from Alarm or EventHistory.




Prerequisites

1. Alarm Manager must be running.2. ProTeus Rights required

Write rights for access to all right click options and Alarm Viewer settings.

Read rights to view alarms, view Work Order Details and view Alarm Details. Ifthe Status is Active, the work order can also be printed.

Purge/Archive Alarms checkbox must be checked to have the ability to purgeand archive alarms and events. Write rights are also required for the AlarmViewer.

User must be a ProTeus Administrator to edit the Field Names.

Program Settings

1. Select Start>Programs>ProTeus V>Alarms>Alarm Viewerto open the AlarmViewer program


35


36/49

Options

The options will allow global settings to be selected for clearing Alarms and Eventsfrom the Alarm Viewer as well as setting how often the program will wait beforeupdating any of the display information.

1. Select File>Options from the menu list to display the available options.

2. Click on the drop down to make the appropriate settings for clearing alarms orevents.

Manually: Each alarm displayed will have to be cleared by a user. Theexception will be an active work order that is closed or skipped in ProTeuswill be cleared from the viewer and moved to history.

After Activated: The alarm will automatically get moved to history when thework order is activated. Activation can occur through ProTeus, the AlarmManager or the Alarm Viewer. The Status will be updated to display Activewhen the alarm is moved to history.

After Printed: The alarm will automatically get moved to history when thework order is printed. Printing can occur through ProTeus, the AlarmManager or the Alarm Viewer. The Status will be updated to display Printedwhen the alarm is moved to history.

After Closed: The alarm will automatically get moved to history when thework order is closed. Closing can only occur through ProTeus. The status willbe updated to display Closed when the alarm is moved to history.

36


37/49

3. Enter the Refresh Rate in seconds.4. Click the OK button to apply changes.

E-mail Setup

E-mail setup is required if a work order has been configured with E-Link and isactivated manually from within the Alarm Viewer program.

5. Select File>E-mail Setup from the menu list to display the E-mail setup.6. Enter the appropriate information.

SMTP Server Name: Enter the name of the SMTP server that is hosting the mailservices.

Your E-mail Address: Enter the E-mail address of the individual sending themail. The name entered here will appear in the From field of the E-mail.

Authentication Required: Check the checkbox if username and passwordauthentication is required on the mail server. If the SMTP Authenticationcheckbox is checked, then a User Account name and Password is required.

37


38/49

User Account: Enter the name of the user account that has been established onthe mail server.

Password: Enter the password that will be used with the name entered in UserAccount.

7. Click the OK button to save changes.

Field Names

Users can access the Field Name program to select which columns will be displayedand set the field width of the columns in the viewer. Only ProTeus Administrator has

the ability to change the displayed field name.

A file will be created on the local workstation for each user of the Alarm Viewerprogram that will store changes made in Field Names. The file can be located in thedirectory that the Alarm Viewer was installed to and will be in the format ofloginname_AlarmViewer.eti. For example, when MM logs into the Alarm Viewerprogram, the file will be created as MM_AlarmViewer.eti. This file can also be copiedonto other workstations.

1. Select File>Field Names from the menu list to display the available field namelist.

2. Click the checkbox next to the field name to select which field names will bedisplayed or hidden. A checked checkbox will display the field name. The four

field names that have a grayed out checkbox cannot be modified. These fieldswill always be displayed.

3. To change the displayed field name, edit the word under the heading, CurrentField Name.Note: The Default Field Name is not editable.

38


39/49

4. To change the field width, enter a numeric value in the field under the heading,Field Width.Note: The field width can also be changed from the Alarm Viewer screen,

eliminating the need to access Field Names. This can be accomplishedby using the mouse to click and drag the bar that divides the field namesin the Alarm Viewer screen.

5. All changes will be saved when the Close button is clicked.

Minimize to Tray

Selecting Minimize to Tray will place the Alarm Viewer program in the system traywhen the minimize button is pressed on the program.

1. Select File>Minimize to Tray from the menu list. A checkmark will indicate thatthe program will get minimized to the system tray.

39


40/49

Field Description- Alarm/Event

Alarm Id: This is the unique identifier of the alarm object.

Event Id: This is the unique identifier of the event object.

Priority: This is the Priority field from the DM Template or the PM Master template.

Object Description: The data that was entered into the Object Description fieldduring the Alarm Configuration will be displayed.

Alarm Time: This is the time that the alarm was captured by the Alarm Manager.The time displayed will be from the workstation that the Alarm Manager program isrunning on.

Event Time: This is the time that the event was captured by the Alarm Manager. Thetime displayed will be from the workstation that the Alarm Manager program isrunning on.

WO Type: This is the Work Order Type and will be displayed as either DM or PM.

Work Order Status: This field will display the current status of the work order.

Pending: The Alarm Manager has captured the alarm.

Active: The work order template has been activated.

Printed: The active work order has been printed.

Skipped: A work order that was active has been skipped from within theProTeus application.

User Defined: The default value is Ignored. A user has cleared the alarmfrom the viewer without activating the work order. This status will only bedisplayed if the previous status was Pending.

Closed: The work order has been closed from ProTeus.

Value: The Value is the value of the object at the time the alarm occurred.

Work Order Ref: The Job No from PM or the Work Order Number from DM will bedisplayed based on the value from the WO Type field. A DM that has not been

activated will not have a work order number available. Under this circumstance, NotAvailable Yet will be displayed and the Status will be pending.

Object Type: This is the type of object that was configured.

Description: This is the description of the object passed along from the Vendorwhen the object went into alarm.

Notification Class: This is the Notification Class of the object from the Vendor.

Vendor Name: The Vendor that the alarm has been detected from will be displayed.

Status Flags: The status of the object at the time the alarm occurred.

40


41/49

Parameter 2, 3, 4 and 5: These fields are for displaying additional values of anobject. They are currently not used in the BACnet interface.

Field Description- Alarm/Event History

Alarm Id: This is the unique identifier of the alarm object.Event Id: This is the unique identifier of the event object.

Priority: This is the Priority field from the DM Template or the PM Master template.

Date Cleared: This is the date that the alarm was moved to history.



Event Time: This is the time that the event was captured by the Alarm Manager. Thetime displayed will be from the workstation that the Alarm Manager program is

running on.


41


42/49





User Defined: The default value is Ignored. A user has cleared the alarm

from the viewer without activating the work order. This status will only bedisplayed if the previous status was Pending.


Employee Name: For alarms that are cleared manually, this will be the name of theuser logged in to the Alarm Viewer program. For alarms that are clearedautomatically by the Alarm Manager, the user name that the Alarm Manager isrunning under will be entered here.


Work Order Ref: The Job No from PM or the Work Order Number from DM will bedisplayed based on the value from the WO Type field. A DM that was not activatedwill not have a work order number available. Under this circumstance, Not Available

Yet will be displayed.Object Type: This is the type of object that was configured.




42


43/49


Field Description- Alarm/Event Archive

Alarm Id: This is the unique identifier of the alarm object.

Event Id: This is the unique identifier of the event object.Priority: This is the Priority field from the DM Template or the PM Master template.

Date Cleared: This is the date that the alarm was moved to history.



Event Time: This is the time that the event was captured by the Alarm Manager. Thetime displayed will be from the workstation that the Alarm Manager program isrunning on.


43


44/49





User Defined: The default value is Ignored. A user has cleared the alarm

from the viewer without activating the work order. This status will only bedisplayed if the previous status was Pending.


Employee Name: For alarms that are cleared manually, this will be the name of theuser logged in to the Alarm Viewer program. For alarms that are clearedautomatically by the Alarm Manager, the user name that the Alarm Manager isrunning under will be entered here.


Work Order Ref: The Job No from PM or the Work Order Number from DM will bedisplayed based on the value from the WO Type field. A DM that was not activatedwill not have a work order number available. Under this circumstance, Not Available

Yet will be displayed.Object Type: This is the type of object that was configured.





44


45/49

Procedure- Alarm/Event

Note: The following procedure outlines details pertaining to Alarms. However, theprocedure for Events is identical.

1. Select Start>Programs>ProTeus V>Alarms>Alarm Viewerto open the AlarmViewer program


3. View alarm data, work order information or clear alarms as necessary.Right Click Options:

Clear: The alarm will be cleared and moved into History. If the Status is Pendingand the alarm is cleared, there is no further action that can occur with theselected alarm (i.e. activate, print). The user will be prompted to enter a reasonfor clearing the alarm. A default value of Ignored will be displayed. The words,Active, Printed, Closed and Skipped cannot be used. If an alarm is clearedand the status is not Pending, the alarm will get moved to History and the Statuswill remain the same. The Clear option is available regardless of the Status.

Activate: The work order associated with the alarm will get activated in ProTeus.The Activate option will only be available if the prior Status is Pending.

Print: The work order associated with the alarm will get printed. The work orderwill get activated automatically if the prior Status is Pending. The Print option willbe available if the Status is Pending, Active or Printed. A printer can be selectedby choosing File>Printers from the menu list.

Note: The printer selected will be the default printer for printing work orders anddoes not have to be selected each time a work order is printed. Thissetting also ignores the Windows default printer.

Refresh: Selecting Refresh will check the ProTeus database for any new recordsto be displayed.

View Work Order: The details of the work order associated to the alarm will bedisplayed. Alarm details will only be displayed in the Work Order Description field

if the work order has been activated. A DM with a work order status of Pendingwill not display any data.

45


46/49

View Alarm Details: Details of the object parameters will be displayed at thetime the object went into alarm. These details will also appear in the Work OrderDescription field of an active work order.

Procedure- Alarm/Event History

Note: The following procedure outlines details pertaining to Alarm History. However,the procedure for Event History is identical.

1. Select Start>Programs>ProTeus V>Alarms>Alarm Viewerto open the AlarmViewer program.

2. Login as a valid ProTeus user.3. Click on the Alarm History tab.4. View alarm data or work order information for alarms that have been cleared from

the viewer.Right Click Options:

Refresh: Selecting Refresh will check the ProTeus database for any new recordsto be displayed.

View Work Order: The details of work order associated to the alarm will bedisplayed. This selection will only be available if the Status is either Active orPrinted. The work order details or alarm details of a Closed or Skipped workorder will be stored in ProTeus history for the respective work order. Use thevalue stored in the Work Order Ref. field to determine the Work Order No. or JobNo. to reference in ProTeus history. A DM work order with a Work Order Ref. ofNot Available Yet will not have a history record in ProTeus.

46


47/49

View Alarm Details: Details of the object parameters will be displayed at thetime the object went into alarm. This selection will only be available if the Statusis either Active or Printed. The details of a Closed or Skipped work order will bestored in ProTeus history for the respective work order. Use the value stored inthe Work Order Ref. field to determine the Work Order No. or Job No. toreference in ProTeus history.

Select All: This option will select (highlight) all records.

Archive: Selecting Archive will move all selected records from History to Archive.The Ctrl and Shift keys can be used to multi-select records.

47


48/49

Procedure- Alarm/Event Archive

Note: The following procedure outlines details pertaining to Alarm Archive. However,the procedure for Event Archive is identical.

1. From the Archive menu drop down, select Alarm Archive.

2. View archive data or purge archived records from the database.Right Click Options:

Refresh: Selecting Refresh will check the ProTeus database for any new recordsto be displayed

Select All: This option will select (highlight) all records.

48


49/49

Purge: Selecting purge will permanently remove all selected records from theProTeus database. The Ctrl and Shift keys can be used to multi-select records.

bacnetalarminterface

Documents