versions and later Honeywell Security and Custom Electronics User Guide K /07 Rev. A

Transcription

1 Compass Downloader Automatic Event Log Upload Feature versions and later Honeywell Security and Custom Electronics User Guide K /07 Rev. A

2 2

3 Contents Purpose...1 Setting Up an Automatic Event Log Upload job...2 Recurrent Job Notes...4 Rescheduling an Automatic Event Log Upload job...5 Deleting an Automatic Event Log Upload job...7 Viewing the Updated Event Log...8 Compass Database Changes...10 Access database changes...10 SQL Server database changes...10 Database Space Requirements...11 Contacting Support...11 Purpose As of this release you can schedule Recurrent Jobs. These are in addition to the scheduled Normal Jobs that are implemented once. Specifically, this release supports an Automatic Event Log Upload recurrent job, and later releases may support other recurrent jobs. The Automatic Event Log Upload recurrent job automatically retrieves the latest Event Log data from a panel on a timed basis. This can be done by itself, or in addition to a normally scheduled job. When an account is selected, any scheduled jobs along with their status are identified as shown below. 1

4 Setting Up an Automatic Event Log Upload job To setup an Automatic Event Log Upload for a particular customer, perform the following: 1. From Compass, select the Customer List. 2. Select the customer in the results grid. 3. In the Panel Options box, select Schedule. A message window appears. Note, if a normal job is already scheduled a similar message window appears. 4. Click No to proceed with Recurrent Scheduling. The Communications window appears. 2

5 5. Ensure the correct options for that account are selected, then click Schedule. The Unattended PC Commands window appears. 6. Enter the Start Date, End Date, Start Time, and End Time. Then use the > button to move the Event Log command from the left pane to the right pane. The Get EventLog From Panel window appears. 7. Select your options: Upload Log Select Partial to upload just the events that are new since the last upload (note, this is faster), or select Full to upload the complete log. Partition Select a particular partition, or ALL. Recurrent Interval Select either Daily, Weekly, or Monthly. Notes: If the user selects the Daily option, the recurrent job will be executed daily from the scheduled start date to the scheduled end date. If the user selects the Weekly option, the recurrent job will be executed every 7 days from the scheduled start date to the scheduled end date. Example: If you select the Weekly option, and the Start Date is October 19, 2006 and the End Date is October 19, 2007, and if the Start Date happens to be a Thursday, the job will be executed every Thursday until October 19, If the User selects the Monthly option, the recurrent job will be executed on a monthly basis from the scheduled start date to the scheduled end date. 3

6 Example: If the user selects the monthly option and the Start Date is October 19, 2006 and the End Date is October 19, 2007, the recurrent job will get executed on 19th of every month until 19th October In case the Start Date is October 31, 2006, then the recurrent job will get executed on the last day of every month (In case of Feb, it will implemented on the 28th or 29th depending if it s a leap year or not). Further, if the user selects 29th or 28th of February or 31st of Jan, March, May, July, August, October, December or 30th of April, June, September, November as Start date, the recurrent job will be implemented on the last day of every month. The last date concept will also be considered if Feb 28th is the last day in February for that particular year. Otherwise, the appropriate date will be considered. 8. Click OK. 9. The Automatic Event Log Upload recurrent job has been scheduled. Recurrent Job Notes The Automatic Event Log Upload feature is currently supported for ADEMCO (Honeywell) panels only. Focus and Omni panels will be supported in future builds. The Increase Priority option is not available for recurrent job scheduling. If the recurrent job has finished or failed, its status will be changed to Pending by changing the start date as per the recurrent schedule details. If the recurrent job has been executed successfully when the End Date is reached, its status will change to Finished. If the recurrent job goes to a retry state, it will be retried 3 times. If successful and the start date and end date match, then its status will go to Finished, otherwise it will go to Pending. If unsuccessful, its status will go to Failed and will be rescheduled again. The Event Log cannot be accessed while a recurrent job is being implemented. You can view the event log and/or save the data in text format normally using the Viewlog button. For an account, only one recurrent job can be scheduled. You cannot schedule recurrent jobs for multiple partitions. You can select the desired partition, or ALL partitions. Multiple recurrent jobs cannot be scheduled for the same account. For an account, there can be only one scheduled recurrent job and one scheduled normal job in a Pending state. When scheduling a recurrent job, the Panel Initiated mode option will not be available. Only the PC Initiated mode will be available. Since LYNX panels do not send year data (only month and day) as part of the event log upload, the year data is taken from current system date and appended to the event log data. If the month data is greater than current month, then the year will be set as the previous year, otherwise the current year is used for the event log. During communications if the subscriber ID/CSID is incorrect, the job will go to a Pending state after 4 retries. You have to check the activity logs for such messages and take corrective actions. This is applicable for all failure modes in TCP/IP or Dial-Up communications. 4

7 Rescheduling an Automatic Event Log Upload job To reschedule an existing Automatic Event Log Upload for a particular customer, perform the following: 1. From Compass, select the Customer List. 2. Select the customer in the results grid. 3. In the Panel Options box, select Schedule. A message window appears. Note, if a normal job and a recurrent job is already scheduled a similar message window appears. 4. Click Yes to proceed to reschedule the job. The Communications window appears. 5

8 5. Ensure the correct options for that account are selected, then click Schedule. The Unattended PC Commands window appears. Note that the existing Start Date, End Date, Start Time, and End Time are shown. 6. Enter the new Start Date, End Date, Start Time, and End Time. Then click OK. 7. The existing Automatic Event Log Upload recurrent job has been rescheduled. Notes: When rescheduling an account using the Unattended Job" screen, no selection for Recurrent or Normal scheduled jobs is present. If you are rescheduling a job that was already scheduled for Normal mode; then in the "Unattended Job" screen it is assumed to be rescheduled in Normal mode. If you are rescheduling a job that was already scheduled for Recurrent mode; then in the "Unattended Job" screen it is assumed to be rescheduled in Recurrent mode. 6

9 Deleting an Automatic Event Log Upload job To delete an existing Automatic Event Log Upload job for a particular customer, perform the following: 1. From Compass, select the Customer List. 2. Select the customer in the results grid. 3. In the Panel Options box, select Schedule. A message window appears. 4. Click Yes to proceed with deleting the existing job. The Communications window appears. 7

10 5. Click Schedule. The Unattended PC Commands window appears. 6. In the right pane, select the job. Then use the < button to remove the Event Log command from the right pane. 7. Click OK. A message window appears. 8. Click No. The existing Automatic Event Log Upload job has been deleted. Viewing the Updated Event Log To view the updated Event Log for a particular customer, perform the following: 1. From Compass, select the Customer List. 8

11 2. Select the customer in the results grid. 3. In the Panel Options box, select Viewlog. A drop-down selection appears. 4. Select Recurrence Event Logs. The Saved Event Log screen appears. The data displayed will be default to a one week time frame. You can change the Start Date and the End Date and click Show to view a different span of events. The screen will hold around 1000 records and the data can be Saved (in text format), Printed or Deleted by clicking the appropriate button. Clicking the Delete button brings up a confirmation prompt. If the number of record for the time frame entered exceeds 1000, then a message box will be displayed requesting that you change the dates entered. Like other Delete functionality in Compass, the Delete button for recurring Event Log data is based on user privileges. Currently the Event Log data Delete option is provided only for deleting recurring event logs. 9

12 Compass Database Changes The Automatic Event Log Upload feature has made some changes to the database schema. These changes are discussed below. Access database changes The event log details are stored in a separate database, eventlog.mdb, in the compass\database folder. This database will be created during installation of this compass build. The schema for the tables is shown below. Log Header Schema Field Data Type Description log_header_id counter group by event log panel_id number panel this log came from description text event log name/description creation_date date/time date/time of creation last_modified_date date/time last time edited log_type number allows eventlog, ecpdevice, alarms, firetests to share same logindex table job_number number pointer to each job that is scheduled Log Event Detail Schema Field Data Type Description log_event_detail_id counter the primary key for the table log_header_id number reference to log_header table (foreign key) date date/time event date time time text time of creation event text details of the event event_point number zone point user number operator name partition number details of the number of partition SQL Server database changes Two additional tables by named Log_Header_R and Log_Event_Detail_R will be added to save the recurrent schedule details. The schema for these tables is shown below. Note: The queries to create these tables will be provided as part of release notes. Log Header Schema Field Data Type Description log_header_id integer group by event log panel_id integer panel this log came from description varchar (50) event log name/description 10

13 creation_date datetime date/time of creation last_modified_date datetime last time edited log_type number allows eventlog, ecpdevice, alarms, firetests to share same logindex table job_number number pointer to each job that is scheduled Log Event Detail Schema Field Data Type Description log_event_detail_id integer the primary key for the table log_header_id integer reference to log_header table (foreign key) date_time datetime event date time time varchar (13) time of creation event varchar (50) details of the event event_point smallint zone point user_ smallint operator name partition smallint details of the number of partition Database Space Requirements The Automatic Event Log Upload feature requires additional space (maximum amount) as noted below. Additional Space for an Access database The new space for the eventlog.mdb file will be 96KB. For low end panels using the upload all event log command, the new space will be 64KB (Tested with Vista20P-5). For high end panels using the upload all event log command, the new space will be 128KB (Tested with Vista128BP-3). Additional Space for a SQL database For low end panels using the upload all event log command, the new space will be 55KB (Tested with Vista20P-5). For high end panels using the upload all event log command, the new space will be 110KB (Tested with Vista128BP-3). Contacting Support Support Group Technical Support Contact Information support3@honeywell.com phone:

14 Notes 12

15

16 2 Corporate Center Drive, Suite 100 P.O. Box 9040 Melville, NY Copyright 2007 Honeywell International Inc. ÊK14975cŠ K /07 Rev. A