Continuum Alarm Event Archiver User Guide Rev 2.6
Continuum Alarm Event Archiver User Guide Rev 2.6
User Guides
Installation ...................................................................................5
Overview 5
Select the Cyberstation that will perform Automatic Archiving 5
Select the location of the Archive Directory 5
Install the Continuum Reports “Alarm Event Archiver” bundle. 6
Import the Plain English Programs into Cyberstation 6
Attach Object Level Security 8
Please Note… 9
Activate the Archiver Applications 9
Add new database indexes to the Continuum Database 10
Using “WinSQL” to add Indexes 10
Using “SQL Query Analyzer” to add Indexes 10
Configure Automatic Archiving 11
Schedule the creation of the initial archive database 13
Configure Automatic Archiving For Workstation With CFR Logging 14
• Archive files and directories can reside on any drive, directory or computer
• Archive files can be backed-up or moved to tape, CD-ROM or removable
media. Any backup application can be used, along with manual copying.
• Archiving “to a directory” automatically creates monthly archive files that
are named using “year and month” to clearly indicate data contents.
• No limit as to the number of archive files kept on-line.
• Removed archive files can be restored from tape, CD-ROM or “Dragged
and Dropped” back into the archive directory. No other steps are required.
Please Note
“Automatic Alarm Event Archiver” and “Archived Alarm Events Report” each
require a software license and activation code for the software key connected
to the workstation’s printer port. Contact Andover Controls to purchase
software licenses, software keys, and activation codes.
1. Read through this entire document to familiarize yourself with all of the
applications, the installation process and automatic archiving operation.
2. Select the Cyberstation that will perform automatic alarm event archiving.
3. Select the location of the Archive Directory.
4. Install the Continuum Reports “Alarm Event Archiver” bundle.
5. Import the Archiver Plain English Programs into Cyberstation.
6. Attach Object Level Security to the Plain English Programs.
7. Activate the Archiver Applications by entering the Activation Code.
8. Add new database indexes to the Continuum database.
9. Configure Automatic Archiving.
10. Schedule the creation of the initial archive database.
Any Cyberstation can run the Archiver, however if possible, select the
workstation that has:
We recommend that you choose a directory on a drive that has at least 2GB of
free space. Be aware that large Continuum databases can generate archive
files that required 5GB, 10GB or greater. As a rough indicator of the archive
drive space requirements, look at \MSSQL7\Data\ContinuumDev.* The current
size of the file roughly approximates the amount of disk space needed to
create a full archive.
Note: If you previously had "Save as File" enabled, you will need to re-enable
this option.
If you are installing Continuum Reports into Cyberstation for the first time,
follow the steps outlined in the “Continuum Reports Installation Guide”.
You will import the “Continuum_Reports.dmp” file, which will create the
standard PE programs that launch each of the individual reports, plus the
“Reports Suite”. Below is the Reports Suite main menu.
Please Note:
The “Automatic Alarm Event Archiver” application, which performs
unattended archiving of all alarm events is not included on the “Reports
Suite” Main Screen because it is designed to be launched by a “shortcut”
in the “All Users Startup Folder”.
8. Create new menu buttons with the following configuration: (Don't bother
with the Wizard ⎯ just create the hotspot and edit the properties.)
Note:
Before you run the “Alm_Arch_Rep” program for the first time, or before you
use the “Archived Alarm Events Report” button for the first time:
(Performing these steps will prevent the “Act_Arc_Rep” program from reporting
the message, “Sorry! Cannot find the default.lar file!”)
It is strongly recommended that you use object level security to allow the PE
programs to be "run", but not “edited” or “viewed”. (See below)
If you are using Continuum 1.3 or above, the first time you launch Continuum
Reports, you may be asked to enter the database password. If this occurs,
enter the password, then re-launch Continuum Reports.
You will be presented with the "enter password" screen. This will reset all
parameters.
• Use the report’s “Key Writer” to determine the software key’s serial
number or to enter the Activation Code. (See below)
3. Enter : reports key writer (Note: case sensitive) The following window will
appear. (Notice the Software Key Serial Number)
3. Click on the "Run Query" button. Please patient as WinSQL creates the
new index.
4. The successful index creation will result with, "This command did not
return data, and it did not return any rows".
3. Enter:
1. “Right Click” on the Task Bar, “Start” button and select “Explore All users”.
If you want to Archiver to launch and stay maximized, change the “Target” to
read:
Note: If you did not install Continuum Reports in the default directory, you
must include the DOS installation path after “MIN” or “MAX” in the run string.
11
15
14
16
12 23
13 17
18
19
20 22
21
13. Click on the “Browse” button to select the archive directory or file.
14. Set the “Date & Time of Last Logged Event (Query Start)” to a date prior to
the oldest alarm event. (Simply changing the year to 1998.)
17. Click on “OK” to minimize the application into the system tray.
22. CFR Logging indicator. The indicator is invisible if CFR logging is not
enabled. (Purchased Option)
The next time Continuum starts up the archiver will automatically be launched.
Click on the Auto Archiving Icon (or Text) to turn on or off Automatic Archiving.
Archiving Frequency
Enter the archiving frequency. The default value of “Archive every 24 hours”
can be changed to any value between once a minute, to once every 999 days.
Note: Make sure to monitor the Archive Log “Processing Time”. Especially if
the processing frequency is less than 3 minutes.
We recommend that you use the default value of “Archive every 24 hours”.
To prevent overload, if an archive build finishes after the ”Next Archive Date &
Time”, the system will skip the current cycle and wait until the next cycle.
Clicking on the “Archive NOW” button will immediately start an archive cycle.
During the archive cycle, the Auto Archiving Icon and Text will display:
After the archive cycle, you will notice that the “Next Archive Date & Time” will
be recalculated based on the scheduled archive time, plus the archive
frequency. If an archive build finishes after the ”Next Archive Date & Time”,
the system will skip the current cycle and wait until the next cycle.
Automatically, the Archiver will display (and save) the date and time of the last
logged event, which will then be used as the “Query Start” date and time
parameters for the next archive cycle.
Under normal operation, you will not alter the date or time. If you want to
create or rebuild an archive directory or file, you can manually change the date
and time accordingly.
Each time an Archive cycle completes, a log entry is created. To view the
Archive Log, click on the “Show Archive Log” button.
To shrink or clear out the log file, use Notepad or Excel to open & edit
“AlmEvtArchiveLog.csv”.
• Archiving to a “File” stores your entire archive in one file, which you
name.
When you change to “File” mode, you will notice that the Archiver defaults the
Archive file to “Alm_Archive.dbf”. If “Encrypt Files” is checked the file name will
default to “E_Alm_Archive.dbf”.
To choose a different file, click on the “Browse” button. You may enter a New
archive name, or select an existing archive name.
To choose a different directory, click on the “Browse” button. You may select
the Archive Directory.
Data Encryption
The data being archived can be encrypted by checking off the “Encrypted
Archive Files” check box. If archiving to a single file that one file will be
encrypted. If archiving to a directory, all the files that get created by the
archiving process will be encrypted.
The Automatic Alarm Event Archiver has an Alarm Event table truncation
feature that will delete archived data from Continuum. This feature will keep
the size of the alarm event table from growing too large and hence, keep the
Continuum database from also growing too large. Since this feature checks
the archive database before deleting data from the Continuum database, you
will not run the risk of deleting data that has not yet been archived.
Truncation Frequency
Set the next Truncation Date and Time. Subsequent truncation dates and
times are based on the current date and time plus the truncation frequency
setting.
Enter the age of the alarm event data to delete. This age is relative to the
current date but fixed to the Time setting of the “Next Truncation Time”. So if
the next truncation time is 4:00am, the number of days is 28, then an
automatic (or manual) truncation will delete records with a DateTime prior to
4:00am, 28 days ago.
Truncate NOW
Click on the “Truncate NOW” button to perform a truncation. The archiving
status and icon on the screen and on the System Tray changes to:
When you are satisfied with the settings, hide the Automatic Alarm Event
Archiver Window by clicking on the “OK” button.
The window will hide and an icon appears in the system tray. To show the
Automatic Alarm Event Archiver Window, Right-Click on the icon.
Since all parameters are automatically saved, the application will resume
processing the next time it is launched. Nothing will be lost.
When you decide to remove monthly archive files from the directory, delete
both the database and index files. If tape, CD-ROM or removable media
space is an issue, consider “zipping up” the files before you back them up. (As
last resort, consider only backing up “zipped” database (.DBF) files.)
When CFR logging is enabled all changes to the Automatic Alarm Event
Archiver are written to the Continuum Alarm Event Log.
Use the Date Selection Quick Picks, or the calendar controls to select the start
and end dates. Use the Start and End time controls to complete the date/time
qualification.
Click on the “Gather Events” button to start the search of the archive directory
(or file) for archived alarm events.
Date
Selection
Quick Picks
Please Note:
Archived Alarm Event reporting is always a 2 step process:
After a successful “gather”, the main screen will morph into the report selection
screen:
Use the “Include All” button to select all of the cardholder names.
Use the “Exclude All” button to de-select all of the cardholder names
Check off the Continuum point or points in the Include column that you wish to
include in the report.
Use the “Include All” button to select all of the cardholder names.
Use the “Exclude All” button to de-select all of the cardholder names
Controller Names
1. Using the Calendars to manually select the Month, Day & Year.
Year
Day
Date Setting
Always confirm the Date by checking the Date Setting below the
Calendar.
Use the “Date Selection Quick Picks” to automatically select dates:
The Archived Alarm Event Report has the ability to run reports on encrypted
archives. The report can retrieve the encrypted files from a selected directory,
or a specific file.
To report on encrypted directories or files you must first check off “Encrypted
Archive Files”
If “Search All Archive Files in Directory” is selected, the report will only gather
encrypted data from the selected directory.
Note: When reporting on a specific file a file picker will prompt the selection of
a file. If the encryption option has been purchased you need to be conscious of
which files have been encrypted, otherwise the following message will appear
when gathering data.
Enter the complete email address for each recipient of the emailed report.
Report Filters
By default the report will display data for Alarm Events, RTN Events, and
Faults. To filter the gathered data uncheck what you wish to exclude from the
report. For example if you wish to only view Alarm Events, uncheck RTN
Events and Faults.
Report Sorting
The Report can be displayed in three different sort orders, Alarm, Alarm
Message or time. The default sort order is by Alarm.
All of the Archived Alarm Event Report settings, including the report selection,
start and end dates/times, Alarms, etc., can be saved to “settings files” for easy
recall.
The “default” settings are the settings that are loaded automatically, each time
the application is loaded. Please Note: If there are no archived alarm events
for the default time frame, the following dialog box will appear:
To set your “default settings” after archived alarm events have been gathered
If you make changes and want to re-load the default settings, just click on the
“Load Default” button. The system will automatically “gather events” and apply
your default selections.
After you load a settings file, the screen will reflect the stored settings and the
“Current Settings” field will show the settings file name.
1. If you load a settings file and make changes, don’t forget to save the
settings back to the file. Otherwise, your changes will be lost.
2. When you manually select the start date/time and end date/time and save
the settings to a file, the “absolute” dates are not saved. What are saved
are the relative dates. That is, if you selected yesterday at 7:00pm as the
start date and today at 7:00am as the end date, whenever you load this
settings file, the start date/time will always be set to yesterday at 7:00pm
and the end date/time will always be set to today at 7:00am.
3. Normally, you save your settings files in the “Continuum_Reports”
subdirectory. If you plan to use the automatic, time scheduled, “Save to
File”, you should place the settings file in the subdirectory where you want
the report to be saved.
or “Arc “File”
If you want to change the Archive Directory or Archive File, click on the
“Change” Button.
The display will return to the Main Screen, where you can change the archive
directory or file.
The data that has been gathered for reporting can also be restored to
Continuum by clicking the “Send to Continuum” button.
Save As File
When “Save as File” is checked, you will have the ability to save the report to
a file.
After the report has been run and is being closed a dialog will pop up
prompting you to save.
Notice the save as type is set to your defaulted report format (txt, pdf or htm).
If Outlook is not loaded and running prior to emailing a report, you will
encounter the following error dialog:
The Emailed report can be a standard text , Adobe Acrobat pdf, or htm file.
If “Show Logging Timestamps” is checked the report will display the Log Time
of each alarm.
Note: If the main report does not show information for a particular point or
alarm, refer to this summary page to confirm whether or not the point or alarm
name appears in the list. If the name does appear, this indicates that there
were no alarm events. If their name does not appear, then the point or alarm
was not included in the selection set, and the report needs to be re-run with the
proper criteria.
The “Print Preview Navigation Bar” provides you with the ability to:
First Page
Print Report
Previous Page
Go to Page#
Zoom In/Out
Last Page
Next Page
Schedule Program
Report Frequency
Report Time
The default report time is 3:00 AM. Change: ReportTime = "3:00 AM" to the
time of day you want the scheduler to launch the archived alarm even report.
Always include AM or PM in the string.
2. If you select “Email”, the email recipients are those saved in the settings
file.
3. If you select “Save”, the report (text) file is saved in the folder where the
settings file is located
Note:
To use a settings file in a different path, include the DOS path. ie:
SettingsFile = "J:\MyPath\Default"