NAVIGATOR REPORTER User Guide K10321-1V1 7/05 Rev A
Table of Contents Conventions Used in This Manual... iii SECTION 1: General Description... 1-1 About Navigator Reporter...1-1 About User Manager...1-1 SECTION 2: Navigator Reporter... 2-1 Configuration and Communication...2-1 Log on to Navigator Reporter...2-1 Port and Panel options...2-2 Main Menu Description...2-3 Event Configuration...2-3 Option Screen Description...2-4 Panel User Configuration...2-5 Zone Configuration...2-6 Partition Configuration...2-6 Report Configuration...2-7 Report Preview...2-8 Report Example...2-9 Communicating With the Control Panel...2-9 Terminal Window Field Description...2-10 Acknowledge and Annotate...2-10 Annotation...2-11 Awaiting Acknowledgement...2-11 Acknowledged Events...2-11 Stop Scrolling Option...2-12 SECTION 3: Managing Navigator Reporter Database... 3-1 About the Navigator Reporter Database...3-1 Check On the Database Size...3-1 Archive Data...3-1 Restore Data...3-2 Purge Data...3-3 SECTION 4: User Manager... 4-1 About User Manager...4-1 Main Screen Description...4-2 Changing Operator Names and Passwords...4-2 SECTION 5: Database Manager... 5-1 About Database Manager...5-1 To Access Database Manager...5-1 Operators Screen...5-2 Backing Up the Database...5-2 Restoring the database...5-3 Compacting the database...5-3 Audit Trail...5-4 ii
Conventions Used in This Manual Before you begin using this manual, it is important that you understand the meaning of the following symbols (icons). UL These notes include specific information that must be followed if you are installing this system for a UL Listed application. These notes include information that you should be aware of before continuing with the installation, and that, if not observed, could result in operational difficulties.! This symbol indicates a critical note that could seriously affect the operation of the system, or could cause damage to the system. Please read each warning carefully. This symbol also denotes warnings about physical harm to the user. iii
iv
S E C T I O N 1 General Description About Navigator Reporter The Navigator Reporter is a software application, which allows alarm system owners and facility managers to view and print reports of activities on the alarm systems for a specific time and date period. These reports are recorded in a database on your computer. These reports remain stored until you delete them from the database. Reports can be generated for: Openings and Closings Alarms and Restores Bypasses System Events (AC Loss, System Low Battery, etc.) The Navigator Reporter can also Monitor & acknowledge online events Configure user names, zone and partition descriptions Configure event responses (sounds, e-mail, etc.) NOTE: Not all types of activity are available on all alarm systems About User Manager User Manager is used to change the operator names and passwords for the Navigator Reporter application. You cannot gain access to the User Manager application while the Navigator Reporter is running. 1-1
Navigator Reporter User Guide 1-2
S E C T I O N 2 Navigator Reporter Configuration and Communication Log on to Navigator Reporter Type a valid Master or Operator name and password. After you log on as the MASTER, make sure you change the login details. Failure to change the login details prevents the MASTER user from accessing the system and also displays the following warning message: 2-1
Navigator Reporter User Guide Port and Panel options For the MASTER user, the screen on the left is displayed. For an OPERATOR user, the screen on the right is displayed. Master Port and Panel Options Screen Operator Port and Panel Options Screen The MASTER user can change the names of the panel that has already been typed into the computer by the Installer. To change the panel name, type the new name in the New Name box and click APPLY. Port Options Connect OK Close Select the port on the computer to which the control panel is connected. Click to connect to the control panel shown in the Name box. Click to configure users, partitions, and zones for the control panel, or to generate reports. Click to quit the application. If the following message is displayed, close the Navigator Controller and continue with what you were doing in the Navigator Reporter. 2-2 E t Al t L l
Section 2 - Navigator Reporter Configuration and Communication Main Menu Event Display Stops the Scrolling Up of Current Events Option Button Event Alert Level Color Code Acknowledged Events and Events Awaiting Acknowledgement MAIN REPORTER SCREEN Main Menu Description Report Data Configure Server View Help Click to create a new report configuration, open an existing report configuration, or to print a report. Click to archive, restore, or purge the data. Click to configure events, users, partitions, and zones for the control panel. Click to connect or disconnect from the selected control panel. Click to view the Toolbar and Status Bar. Click to display the version of Navigator Reporter. Event Configuration Click CONFIGURE on the Main Menu. Click OPTIONS to gain access the Options screen. 2-3
Navigator Reporter User Guide Option Screen Description Show Events Select Alert Level Select Number of Events Configure E- Mail Only those levels checked will display in the Event Display Window. Use the Change Font Color buttons to determine the color of each level type. Click the Event and select the Alert Level for each type of event. Select the number events to be contained in the Event Display Window. For example, if you select 100 as the limit, and when the 101st event occurs, the 1st event is removed from the display. NOTE: You can specify a maximum of thousand events. Click to display the E-Mail Configuration screen. Using this screen, you can configure the SMTP Host Address, the From Address, the User Name, and Subject that must be used while sending e-mails (see screen below). NOTE: To send an e-mail, you must connect an event to the e-mail address on the Event Configuration screen (accessed via the Advanced button). 2-4
Advanced Section 2 - Navigator Reporter Configuration and Communication Click to display the Event Configuration screen. Use this screen to configure an Acknowledgement, E-mail, Sound, and Annotate to an event. OK Cancel Edit Apply To send e-mails to multiple addresses, type the e-mails IDs separated by semi colon in the E-MAIL TO box. Click to save the changes and to exit from the screen. Click to exit the screen without saving any changes. Select an event by using the bookmark and click Edit to configure the various options for the selected event Whenever an event is configured, click Apply to save the configuration. Click Apply before moving on to the next event. Panel User Configuration Click CONFIGURE on the Main Menu. Click PANEL USERS to gain access the Panel Users screen. Select the control panel for which you wish to add, modify, or delete users. Note: The panel selected while logging in is displayed by default. 2-5
Navigator Reporter User Guide Highlight the user and click DELETE to delete the user. Click SAVE to save any changes of user information. Click OK to save the changes made to the panel users and exit the screen. Click CANCEL to exit without saving any changes. Note: INSTALLER or MASTER can configure the users for all the configured panels at the same time. Zone Configuration Click CONFIGURE on the Main Menu. Click ZONE to gain access the Zone screen. Use this screen to add, modify, and delete zones and edit the zone descriptions for the control panel selected. Highlight the zone and click DELETE to delete the selected zone. Click SAVE to save any changes of zone information. Click OK to save the changes made to the zones and exit the screen. Click CANCEL to exit without saving any changes. Note: INSTALLER or MASTER can configure the zone for all the configured panels at the same time. Partition Configuration Click CONFIGURE on the Main Menu. Click PARTITION, to access the Partition screen. Use this screen to add, modify, and delete partitions and edit the partition descriptions for the selected control panel. 2-6
Section 2 - Navigator Reporter Configuration and Communication Highlight the partition and click DELETE to delete the selected partition. Click SAVE to save any changes of partition information. Click OK to save the changes made to the partition and exit the screen. Click CANCEL to exit without saving any changes. Note: INSTALLER or MASTER can configure the partition for all the configured panels at the same time. Report Configuration Click REPORT on the Main Menu. To create a new report configuration, click NEW CONFIGURATION. To open an existing report configuration, click OPEN CONFIGURATION. Report Field Choice Report Field Selections Date and Time Range Selection 2-7
Navigator Reporter User Guide Select the fields for the report criteria from the SELECT FIELDS list and click the forward arrow to move them to the Report Field selection. To remove the fields from being selected in the report criteria, select the fields in the Report Field selection list and click the backward arrow. Select the Date and Time ranges for the report. Click SAVE AS to save the report configuration. The computer prompts for a report name. This type of report is now stored in the database and can be used at any time in the future. Add or Modify report criteria Click ADD/MODIFY CRITERIA to change the report criteria. Select a FIELD NAME from the list of field names. Select the criteria, data, and the sort option. Click MODIFY CRITERIA to add the criteria to the report. You can generate a report for this set of data. Report Preview After configuring the report criteria, click REPORT PREVIEW in the REPORT CONFIGURATION USER. This enables you to preview the report before printing. For records more than 100,000 If the number of records retrieved for preview is more than 100,000, the following warning message is displayed: Note: The report preview may take a long time to be generated depending on the system configuration. 2-8
Section 2 - Navigator Reporter Configuration and Communication For records exceeding 500,000 You cannot generate a report preview for a record count of more than 500,000. If the number of records retrieved for preview is more than 500,000, the following warning message is displayed: Report Example ARMED / DISARMED REPORT The preceding screen is an example of a report that you can generate using Navigator Reporter. This report is for arming and disarming of partition 1. Communicating With the Control Panel To communicate with a control panel, perform the following steps: 1. Click SERVER on the Main Menu. 2. Click CONNECT SERVER. 2-9
Navigator Reporter User Guide Terminal Window Field Description Partition Event Date/Time Event User A/C Zone Descriptor Event Description Displays the partition number or, if configured, the description. Displays the date and time of the event. Displays the event name. Displays the user number or, if configured, the user name. Displays the account number of the user. Displays the zone number or, if configured, the zone description. Displays the event description. Acknowledge and Annotate If the acknowledge option was enabled for an event during Event Configuration, the event simultaneously appears in the Awaiting Acknowledgement tab. An event can be acknowledged in 2 ways. 1. Double click the event. 2. Right click the event. The acknowledgement option window appears. 2-10
Section 2 - Navigator Reporter Configuration and Communication Acknowledge Annotate Instruction Acknowledge All Refresh Acknowledges the selected event. Acknowledges and annotates the selected event. Displays the instruction entered, if any, by the user for the selected event. Acknowledges all the events without any annotation. Displays the first 1000 events awaiting acknowledgement. Annotation If annotation was enabled for an event and when an event is acknowledged, the annotation display appears. This allows the operator to type a comment for the event. You cannot acknowledge such events without an annotation. Awaiting Acknowledgement The Awaiting Acknowledgement tab displays the first 1000 events awaiting acknowledgement on startup. New events requiring acknowledgement are appended to the list. The Awaiting Acknowledgement list displays only 1000 events at any given point of time. Acknowledged Events ACK Date/Time ACK User Name Annotation Event Description Displays the date and time the event was acknowledged. Displays the operator who has acknowledged the event. Displays the annotation the operator entered while acknowledging. Displays the description of the acknowledged event. The Acknowledged Events tab displays only the last 50 acknowledged events by default. If you wish to see other events, right click the Acknowledged Events list. The following option window appears: Click DATE RANGE. The following window appears. 2-11
Navigator Reporter User Guide Select the date range and click OK. Select SELECT ALL TIME if you want to view all the events that have occurred between the FROM and TO dates. Stop Scrolling Option By default, the terminal window scrolls to display the last occurred event. If you do not want the terminal window to scroll, select STOP SCROLLING. The terminal window does not scroll up to display the last occurred event. 2-12
S E C T I O N 3 Managing Navigator Reporter Database About the Navigator Reporter Database You can archive, restore, and purge the current and stored databases of the Navigator Reporter. This ensures that the events are organized in a logical manner and also prevents them from getting lost. The current database includes all the events currently displayed in the Events Display Window and also all the events in the Awaiting Acknowledgement list. The stored database consists of the events that have been archived. Check On the Database Size When the database size exceeds 500 MB, the following message is displayed: Click NO if you want to see the message every 15 minutes. Click YES if you want to increase the limit for the database size check. The following screen is displayed: Enter the database size warning. Archive Data Archiving the data removes all the events within the selected date range from the current database. Click DATA on the Main Menu. Click ARCHIVE to display the Archive Data screen. Select a destination file path. 3-1
Navigator Reporter User Guide If the name of the file already exists, then the previously archived data is overwritten by the current archive operation. If you want to keep the old data intact, then specify a new file name for the new data. Select the date range for the events you want to archive. Click ARCHIVE. If the number of records to be archived is more than 200,000, then the following message is displayed. You can choose a lesser number of records by specifying a smaller date range. The archived data is removed from the current database. Any events waiting acknowledgement within the specified date range is archived. However, you can get the data back by restoring. A warning message is displayed when there is insufficient disk space to complete the archive operation. A message is also displayed besides the legend if there is insufficient free space for the Reporter to function efficiently. Restore Data You can restore a specific set of archived data to the current database. Click DATA on the Main Menu. Click RESTORE to display the Restore Data screen. 3-2
Select the source path. Select the date range. Click RESTORE. If the server is connected, then the following message box is displayed. Section 3 Managing Navigator Reporter Database Click YES to continue with the restore operation. Upon completion of the restore operation, the computer displays a message for restarting the server. If the number of records to be restored is more than 200,000, then the following message is displayed. You can choose a lesser number of records by specifying a smaller date range. All data within the specified date range is restored to the current database. Note: If there were more than 1000 events awaiting acknowledgement after restoring data, then the system displays only the first 1000 events on the terminal window. The following message is displayed alerting you to this fact. A warning message is displayed when there is insufficient disk space to complete the restore operation. Refer the note in the Archive Data section. Purge Data Purging the data completely deletes all the events within the specified date range from the current database. Click DATA on the Main Menu. Click PURGE to display the Purge Data screen. 3-3
Navigator Reporter User Guide Select the date range. Click PURGE to delete the data from the current database within the specified date range. If the number of records to be purged is more than 200,000, then the following message is displayed. You can choose a lesser number of records by specifying a smaller date range. The purged data is completely deleted from the system. Data once purged cannot be retrieved. 3-4
S E C T I O N 4 User Manager About User Manager User Manager provides the ability to change the operator names and passwords for the users of Navigator Reporter. The User Manager is automatically installed when you install the Navigator Reporter software. LOG-IN SCREEN Enter the Operator Name and the Password. Click OK. The User Manager application cannot be accessed if Navigator Reporter is running. If you attempt to run the User Manager while Navigator Reporter is open, the following message displays: If you used the Master name and password to log-in, the following screen displays: Operators List Type the new name here Click to apply changes. Click to change password of selected operator 4-1
Navigator Reporter User Guide Main Screen Description The Main Screen displays all the operators having access to Navigator Reporter. From this screen a Master user may change the operator s name and password by clicking on the selected operator. The Master is the only operator with the privilege to edit all other operator s details. All other operators can only edit their own name and password. Be sure the correct operator is highlighted before modifying, or editing any details. Changing Operator Names and Passwords To change the operator name, click on the current operator name. Type the new name in the text box provided. The name can be up to 25 characters long. Click APPLY to save the change. Next time the operator attempts to log-in to Navigator Reporter they must use the new name. To change the operator password click on the operator name. Click CHANGE PASSWORD. The following screen displays: Selected Operator name. Click to apply changes. Type the new password here Master Operator Change Screen Selected operator name will be displayed in Name box. Type the new password in the New Password box and then retype the password again in the Retype Password box. Click OK to exit and save the changed password. Click CANCEL to exit without saving the change. If an operator other than the Master logged in the User manager, the following screen displays: 4-2
Section 4 User Manager Normal Operator Change Screen Operator Privileges The following chart outlines the privileges the operators have for Navigator Reporter and User manager. Features Installer Master Operator 1 Operator 2 Operator 3 Operator Operator 4 5 Operator 6 Operator 7 Navigator Reporter View Incoming messages on the screen Yes Yes Yes Yes Yes Yes Yes Yes Yes View Stored Messages and Configure Reports Yes Yes Yes Yes Yes Yes Yes No No Archive /Restore/Purge/Backup/Compact Database Yes Yes Yes Yes Yes No No No No Connect/Disconnect Serial Port Monitoring Yes Yes Yes Yes Yes Yes Yes Yes Yes Add New Control Panels Yes No No No No No No No No Change Panel Names Yes Yes No No No No No No No Add/Change/Delete User Name, Partition Description, Zone Description Yes Yes No No No No No No No Options (Event Configurations) Yes Yes No No No No No No No User Management Change Password Of Other Users Yes Yes No No No No No No No Change Password Of Self Yes Yes Yes Yes Yes Yes Yes Yes Yes 4-3
Navigator Reporter User Guide 4-4
S E C T I O N 5 Database Manager About Database Manager Database manager is automatically installed with Navigator Reporter and Navigator Controller. The Database manager performs the following functions: Takes a backup of the entire VISTA Navigator database and stores it into a zip file Restores the entire VISTA Navigator database from the backed up zip file Compacts the VISTA Navigator database Enables you to view an Audit trail of the database activities that were carried out on a particular date To Access Database Manager Enter the Operator Name and the Password. Click OK. Note: Only the Installer, Master, Operator1, 2 or 3 can gain access the Database Manager. The following security level message is displayed if you attempt to gain access as any other user. You cannot gain access to the Database Manager while the Navigator Reporter or Navigator Controller is running. The following message is displayed when you try to gain access the Database Manager with the Navigator Controller still running: 5-1
Navigator Reporter User Guide Operators Screen If you are logged with a valid name and password, the following screen is displayed: This screen enables you to perform the backup and restore operations as well as to view the details of audit trail. Backing Up the Database Backup Database makes a copy of the entire database and archives it to a predefined path. You should back up the database to save the data in the event of system crashes. Honeywell recommends that you backup the database to either a network drive or some external media (CD-ROM, tape, etc.). Be aware that every time you back up the database, it overwrites the old backed up database. To backup the database, click the Backup and Restore tab option provided in the Database Manager screen. Select the Backup Database option. Type the location of the file for which you want a backup in the Location box. Or, click Browse and select the file path. Click the Backup button. The Action Status provides the status of the backup operation. Once the backup is completed, the following screen appears: 5-2
Section 5 Database Manager Restoring the database Restore Database restores the backed up database into the current database. All the data in the current database is replaced with the backed up data. To restore the database, click the Backup and Restore tab option provided in the Database Manager screen. Select the Restore Database option. Type the location of the already backed up files you want to restore in the Location box. Or, click Browse and select the file path. Click the Restore button. The current data in the database is overwritten after the restore operation. Once the restore is completed, the following screen appears: Click OK to confirm the restore operation. The Action Status provides the status of the restore operation. Once the restore is completed, the following screen appears: Compacting the database Use this feature to compact and repair the database. To compact or repair the database, click the Backup and Restore tab option provided in the Database Manager screen. Click the Compact button. The following message is displayed when there is insufficient disk space to complete the compact operation. A message is also displayed beside the legend if there is insufficient free space for the Controller to function efficiently. 5-3
Navigator Reporter User Guide Audit Trail To view the Audit Trail, click the Audit trail tab in the Database Manager screen. The following screen appears, which displays the details of the audit trail. Action description Select Dates Display for all dates 5-4
ÊK10321-1V1IŠ K10321-1V1 7/05 Rev A