FirstPAGE Alarm Manager Server V9 - SeQent · FirstPAGE Alarm Manager Server V9.00 SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401
Post on 15-Apr-2018
231 Views
Preview:
Transcript
FirstPAGE Alarm Manager Server
V9.00
SeQent Corporate Office Suite 137 – 4500 Blakie Road London, ON, N6L 1G5 Canada Phone: +1.519.652.0401
Table Of Contents
Terms of Use ................................................................................................... 6
Version Information .......................................................................................... 7
Edits ............................................................................................................ 7
Customer Service ............................................................................................. 8
Support Contracts ....................................................................................... 8
Location .................................................................................................... 8
.1. Product Overview ...................................................................................... 10
How it Works ................................................................................................. 11
.2. Installation ............................................................................................... 12
Prerequisites ............................................................................................... 12
Database Conversion ...................................................................................... 13
Installing the Application ................................................................................. 14
Installing Remote Administrator - Setup ......................................................... 15
.3. Configuration ............................................................................................ 22
Setting up the Application ............................................................................. 22
Configuring Key Components - Server ............................................................ 23
Adding a Server .......................................................................................... 23
Enabling and Configuring Security ................................................................. 31
Configuring Key Components – Escalation Schemes ......................................... 34
Adding an Escalation Scheme ..................................................................... 34
Configuring Key Components –Generic Text Agents ......................................... 38
Adding a Generic Text Agent ...................................................................... 38
Adding a Message Template ....................................................................... 42
Configuring Alarms in the Generic Text Agent ................................................. 44
Adding an Alarm ....................................................................................... 44
Configuring Key Components –Generic ODBC Agents .................................... 48
Adding a Generic ODBC Agent .................................................................... 48
Adding a Message Template ....................................................................... 54
Configuring Alarms in the Generic ODBC Agent ............................................... 56
Adding an Alarm ....................................................................................... 56
Configuring Key Components –Gateway for ActivPlant Agents ........................ 61
Adding a Gateway for ActivPlant Agent ........................................................ 61
Adding a Message Template ....................................................................... 66
Configuring Alarms in the Gateway for ActivPlant Agent ................................... 68
Adding an Alarm ....................................................................................... 68
Configuring Key Components –Gateway for HPOM Agents .............................. 72
Adding a Gateway for HPOM Agent ............................................................. 72
Adding a Message Template ....................................................................... 77
Configuring Alarms in the Gateway for HPOM Agent ......................................... 79
Adding an Alarm ....................................................................................... 79
Configuring Key Components –Gateway for CIMPLICITY Agents ..................... 83
Adding a Gateway for CIMPLICITY Agent ..................................................... 83
Adding a Message Template ....................................................................... 88
Configuring Alarms in the Gateway for CIMPLICITY Agent ................................. 90
Configuring Key Components –Gateway for COPA Agents ................................. 95
Adding a Gateway for COPA Agent .............................................................. 95
Adding a Message Template ..................................................................... 100
FirstPAGE Alarm Manager Server V9
Configuring Alarms in the Gateway for COPA Agent ....................................... 102
Configuring Key Components –Gateway for ODBC Agents ............................... 106
Adding a Gateway for ODBC Agent ........................................................... 106
Adding a Message Template ..................................................................... 111
Configuring Alarms in the Gateway for ODBC Agent ....................................... 113
Configuring Key Components –Gateway for OPC Agents ................................. 117
Adding a Gateway for OPC Agent .............................................................. 117
Adding a Message Template ..................................................................... 122
Configuring Alarms in the Gateway for OPC Agent ......................................... 124
Configuring Alarms in the Gateway for RSView Agent ..................................... 128
Adding a Gateway for RSView Agent ......................................................... 128
Adding a Message Template ..................................................................... 133
Configuring Alarms in the Gateway for RSVIEW Agent .................................... 135
.4. Using FirstPAGE Alarm Manager Server ...................................................... 140
Using the FirstPAGE Alarm Manager Administrator Toolbar ............................. 140
Modifying and Deleting Tree View Items ....................................................... 141
Modifying ............................................................................................... 141
Deleting ................................................................................................ 141
FirstPAGE Alarm Manager Tools - Options ..................................................... 142
Setting Options ...................................................................................... 142
FirstPAGE Alarm Manager Reports ............................................................... 143
Viewing and Printing Reports .................................................................... 143
FirstPAGE Alarm Manager Alarm Search ....................................................... 145
Searching Configured Alarms ................................................................... 145
FirstPAGE Alarm Manager Log Files .............................................................. 146
Viewing the Log Files .............................................................................. 146
Glossary...................................................................................................... 147
Page 6 of 149
Terms of Use
Information in this document is subject to change without notice and does not represent
a commitment on the part of SeQent. The software, which includes information contained in any databases, described in this document is furnished under a license agreement or nondisclosure agreement and may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the license or nondisclosure agreement. No part of this manual may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of SeQent.
This software program and associated documentation are provided in an “as is” condition. In no event shall SeQent, its employees, directors or agents be liable for any loss or damage whatsoever (including, but not limited to, damages for loss of business
profits, business interruption, loss of business information, or other monetary loss)
arising out of the use of or the inability to use this software. By installing this software on your computer system you acknowledge that you have read and understood these terms and that you accept them.
© 2011 SeQent All rights reserved.
Printed in Canada
FirstPAGE Alarm Manager is a trademark of SeQent. Other brand and product names are trademarks, or registered trademarks, of their respective holders.
Page 7 of 149
Version Information
Edits
Version Date Author Description
V9.00 Dec. 2010 K. MacLennan Initial Document
Page 8 of 149
Customer Service
Support Contracts
You may purchase a support contract for any of our products. Support is free for product trials and for the first 30 days of product ownership.
To view the SeQent support options, go to our web site (www.SeQent.com). To contact SeQent’s Customer Support department please use the following methods.
Urgent Issues:
Normal Business Hours (Weekdays 9AM-5PM EST):
1. Dial: +1.519.652.0401
2. Select: Option 1
If there is no answer then please leave a voice mail message with your contact
information and your call will be returned promptly.
After Hours (Weekdays 5PM-9AM EST and Weekends):
1. Dial: +1.519.652.0401
2. Select: Option 1
3. Listen to the on-call phone number provided
4. Call the indicated after hours number
If there is no answer then please leave a voice mail message with your contact
information and your call will be returned promptly.
Non-Urgent Issues / Questions
Normal Business Hours (Weekdays 9AM-5PM EST):
1. E-Mail: Support@SeQent.Com
2. Include the following information: - Contact Information - Product Name
- Version - Description of the problem being experienced
Location
Corporate Office 4500 Blakie Road, Suite 137 London, Ontario Canada N6L 1G5
Phone : +1.519.652.0401 Fax : +1.519.652.9275 Email: info@SeQent.com
FirstPAGE Alarm Manager Server V9
Page 9 of 149
c h a p t e r o n e – p r o d u c t o v e r v i e w
Page 10 of 149
.1. Product Overview
SeQent’s FirstPAGE Alarm Manager (FPAM) is another product in the FirstPAGE Suite of
products and may reside on your FirstPAGE Server or access a FirstPAGE Server over a LAN or WAN connection. It is designed to centralize all wireless alarm management into one single application. This means that alarms/events from all automated monitoring systems in your enterprise can be centrally maintained and dispatched from one system.
FPAM adds full alarm management capabilities to FirstPAGE. Utilizing the alarm management features of FirstPAGE Alarm Manager, proper attention can be directed
towards events based on severity including repeat messages and event escalation. Active
alarms are then reported to the engine for initiation and the engine records and tracks the alarm over its lifetime.
Key Features:
o Escalation hierarchy: includes built-in logic including attributes, delay before send,
repeat and more
o Optionally sends terminate message to prevent unnecessary responses once problem
resolved
o Server configuration is hot reloadable, allowing real-time changes to the live system
with no impact on alarms in process
o Time-based escalation
FirstPAGE Alarm Manager Server V9
Page 11 of 149
How it Works
FirstPAGE Alarm Manager Server alarms or events are triggered by automated monitoring systems and communicated to FPAM through a FPAM Gateway for a specific product, or a user developed application. The most popular and reliable interface is
TCP/IP sockets1. Upon receipt of an alarm, the FPAM engine repeatedly notifies and escalates messages until they are cleared by the automated monitoring system. Utilizing the FPAM Administrator, alarm names are selected from a dynamic master list of alarms or events and configured. Destinations and text messages are defined for each level of escalation. Escalation templates are utilized to provide rapid for setup.
FPAM requires the source application only report when an event has started and
(optionally) when an event has stopped. FirstPAGE Alarm Manager Server is educated as to what alarms to process and the messaging attributes to apply to each event. This allows the applicable level of attention to be paid to each event, depending on its severity.
These attributes can include:
o Who should be alerted
o If there is a delay (time active) before the event is sent
o If the message is resent - how often and at what interval
o If the event clears, should we tell the people alerted
o If the text sent by the source application is not applicable, do you want optional text
An alarm message database can be quite dynamic and require a lot of
management. FirstPAGE Alarm Manager Server has the following tools to make the job
easier:
o Mass Add, Position Swap and Mass Delete configuration tools
o Report generator - by alarm or individual
o Workstation administrator to allow decentralized alarm configuration
o Visual icons that display what has /has not been configured
Supported Gateways:
o Activplant
o Chrysler COPA
o Ford ANS
o GE CIMPLICITY
o OPC DA/HDA
o Rockwell RS-View
o SQL Database/ODBC
1 See the FirstPAGE Alarm Manager Protocol manual for a description of the simple handshake
procedure required to inform FPAM when an alarm condition occurs and when it has been cleared or acknowledged.
c h a p t e r t w o – i n s t a l l a t i o n
Page 12 of 149
.2. Installation
Prerequisites
Before beginning the installation, it is important to determine the hardware and software requirements necessary for FirstPAGE Alarm Manager erver to run efficiently. Review the following prerequisite list before the software is installed.
Licensing General: Per server Licensing Options: Additional Agents
System Requirements
One of: Microsoft Win2K3 (SP1+) Microsoft WinXP (SP1a+)
Display: 800x600 Disk Space: 1 GB
RAM: 1GB
Applications: FirstPAGE Server V9.x
Drivers TCP/IP MDAC V2.7 (SP1+)
FirstPAGE Alarm Manager Server V9
Page 13 of 149
Database Conversion
If you are upgrading to a higher version of FirstPAGE Alarm Manager Server, you will
need to run the Database Converter included in your kit. When starting the application for the first time after your upgrade, you will receive a message indicating an incompatible database. You will be instructed to run the Database Convertor.
The Database Convertor is found under: Start > All Programs > FirstPAGE Alarm
Manager> Server > Database Conversion The Conversion Wizard will display a summary of changes that will be made to your database, including the current version that is running and the target database.
Click Start to run the converter. Conversion results will then be displayed. Be sure to stop and restart the FirstPAGE Alarm Manager service after running the Database Conversion utility.
Installation
Page 14 of 149
Installing the Application
Before installing FirstPAGE Alarm Manager Server, the following information must be
considered:
o Determine which disk drive/directory your pager server software will reside on. The server software itself requires 1 GB of disk space for installation and operation.
o Determine the IP Address/Host name of the FirstPAGE Server
To Install FirstPAGE Alarm Manager Server:
1. Run FirstPAGE Alarm Manager Server SETUP.EXE. Click Next.
2. You will be prompted for the installation destination directory.
3. Click Finish to complete the installation. The computer must be restarted before the
FirstPAGE Alarm Manager Server can be configured or operated.
FirstPAGE Alarm Manager Server V9
Page 15 of 149
Installing Remote Administrator - Setup
The FirstPAGE Alarm Manager Administrator utility program is used to configure and
control the FirstPAGE Alarm Manager Server engine. System managers responsible for FirstPAGE are the intended users of FirstPAGE Alarm Manager Administrator.
The features and operations that can be performed with FirstPAGE Alarm Manager Administrator include adding, modifying, deleting, listing, printing database information, viewing logs and changing server configurations, etc.
A copy of FirstPAGE Alarm Manager Administrator is included with the FirstPAGE Alarm Manager Server software; it will be installed automatically when you install the server. The FirstPAGE Alarm Manager Administrator program can be accessed from any administrator workstation by purchasing the remote FirstPAGE Alarm Manager Administrator Kit.
Before installing and configuring FirstPAGE Alarm Manager Administrator, there are two steps that must be completed. The first is to share the files on the server running FirstPAGE Alarm Manager Server. The second is creating a DSN.
Sharing an Application Folder
1. In the Program Files folder, chose your Application folder – in this case, FirstPAGE Alarm Manager. Expand the folder and choose the part of the application you would like to share. In this example, Server is the folder we want to share because it
contains the data and log files.
2. Right click on the folder and choose Sharing and Security. On the Sharing tab, chose "Share This Folder".
FirstPAGE Alarm Manager Server V9
3. Click on the Permissions button and make sure Allow is selected under Permissions
for Everyone. Click Apply.
Installation
Page 17 of 149
4. In your tree view, the FirstPAGE Alarm Manager Server folder will now appear as follows:
Creating a DSN
The next step is to create a DSN. This must be done on the computer where the
FirstPAGE Alarm Manager Administrator will be installed.
1. In Windows, go to Start > All Programs > Administrative Tools > Data Sources (ODBC). Chose the System DSN tab and click on Add.
FirstPAGE Alarm Manager Server V9
2. Double click on Microsoft Access Driver (*.mdb)
Installation
Page 19 of 149
3. Enter the Data Source Name then click on Select to locate the associated database.
4. In the Database Name, type “\\”, the name of the computer the Server Application is installed on, “\” the share name, “\” data “\” and the name of the database file. An example would look like this: \\Lab1\FirstPAGE Alarm Manager\FPAMServer\data\ A list of Lab 1's .mdb's will appear.
5. Choose the FPAMSERVER.mdb and click OK.
FirstPAGE Alarm Manager Server V9
6. Your new DSN name should appear.
FirstPAGE Alarm Manager Server V9
Page 21 of 149
c h a p t e r t h r e e – c o n f i g u r a t i o n
Page 22 of 149
.3. Configuration
Setting up the Application
Before you can begin using FirstPAGE Alarm Manager Administrator, you must add at least one Server to the administrator. Once the Server is added, various settings that control the interface to the Server must be configured. The steps required include:
1. Adding a Server
2. Enabling and Configuring Security
3. Adding an Escalation Scheme
4. Adding Agents
5. Configuring Alarms
6. Adding Message Templates
Configuration
Page 23 of 149
Configuring Key Components - Server
Adding a Server
FirstPAGE Alarm Manager Server includes one Administrator license key that allows the addition of a single server. Additional licenses may be purchased that allow multiple servers to be added and maintained from your FirstPAGE Alarm Manager Server.
New Server Steps
1. After installing and restarting your computer, select Start – Programs – FirstPAGE – Alarm Manager Server – Administrator to launch FPAM.
2. Select the FirstPAGE Alarm Manager Servers icon in the tree view. Click the New icon in the toolbar. You will be prompted to select an ODBC Machine Data Source. If you are configuring FirstPAGE Alarm Manager Administrator supplied with FirstPAGE Alarm
Manager Server, the installation kit has already created this DSN. Simply select the FPAMServer DSN from the Machine Data Source tab, and click OK.
If you are using an upgraded FirstPAGE Alarm Manager Administrator license key, which
supports multiple servers, then the DSN entered here must be created by hand and associated with the FPAMServer.MDB file for the remote server to be maintained. To facilitate this, first share the remote server’s FirstPAGE Alarm Manager\Server directory structure and configure the DSN to use the file: \\remoteservername\fpamsshare\data\FPAMSERVER.MDB.
FirstPAGE Alarm Manager Server V9
3. The Server configuration process includes a Details tab, a Settings tab, FirstPAGE Servers tab, Agent Licenses tab and a Security tab. The Details tab defines the connection from the FPAM Administrator to the FPAM Server allowing it to maintain a server.
Configuration
Page 25 of 149
DETAILS TAB
Server
Host Name A TCP/IP resolvable name which must be in your DNS server or local host file and can be reached from the Administrator workstation
Description Any text the administrator wishes to refer to the server as.
Connection
DSN This field is already populated
User Name Optional
Password Optional
Logging
Path Enter or browse to the Log Path required to access the logs directory on the current Marquee Manager Server. In most cases, if the server is locally installed this path will be a drive
letter based directory specification (e.g.: C:\Program
Files\FirstPAGE Alarm Manager\Server\Logs\). If the server being managed is not the local server then this path will most likely be a UNC path ( \\server\share\directory\), which provides access to the remote servers log directory. (e.g.: \\LAB1\FPAMServer\logs\).
4. After completing the Details tab, click on the Settings tab to configure the server
options. If the server has never been configured before then the contents of the Settings tab contain defaults. If the server is already configured and operational, these fields will be filled with the current server's settings.
FirstPAGE Alarm Manager Server V9
SETTINGS TAB
Server
Server Port Defaults to 8001
License Key Enter a valid license key
Logging
Log Days The number of days the log file will be kept before being purged. Defaults to 7 days.
Log Level The log Level field is for use at the request of SeQent. In the event of any problems, SeQent may request additional levels of logging to assist in problem solving.
Maximum Log Space
To prevent the log files from consuming too much drive space, you can specify how much space to allot to the log file in the Maximum Space field. Default is 50 MB.
Path The path specification, local to the actual FirstPAGE Alarm
Manager Server. It contains the directory where the FPAM Server will store its log files.
5. After completing the Setting tab, click on the FirstPAGE Servers tab to configure the FirstPAGE Server details.
FIRSTPAGE SERVERS TAB
FirstPAGE Server
Server Name Name of the FirstPAGE Server. Localhost should not be used in this field if running a remote FPAM Administrator
Port Port the FirstPAGE Server uses. This defaults to 8003.
Retries The number of attempts that are made to connect to the FirstPAGE Server. Defaults to 3 attempts.
Honor Schedules Check this option if FPAM alarms should honor schedules that
have been configured in FirstPAGE Server.
Configuration
Page 27 of 149
6. After configuring the FirstPAGE Server details, click the Agent Licenses tab to enter
valid license keys for all agents that will be utilized. FPAM has been designed to centralize alarm/event management and notification. To handle the many different types of alarm/event monitoring systems and other plant floor devices, different
agents have been developed to interface with the various types of systems. FPAM allows users to register only the agents desired by inputting a license key specific to that agent.
Select the agent you require then enter in a valid license key. The key will be validated once entered.
7. After configuring the Agent Licenses, click the Security tab to enable Security. You must select a Security Mode from the Security tab. Default selection is NONE. Your choices include:
- WINDOWS - FORD (specific only to Ford users) - CHRYSLER (specific only to Chrysler users) Once a mode is selected and saved, a Users folder appears under the Tools section of the tree view. The Users folder allows the administrator to add destinations with
limited access to various user applications.
FirstPAGE Alarm Manager Server V9
For more detailed instructions on Security settings, see next section called “Enabling and
Configuring Security.”
8. Click on the Save icon to save your settings.
FirstPAGE Alarm Manager Server V9
Page 29 of 149
Sample New FirstPAGE Alarm Manager Server Details tab
Sample New FirstPAGE Alarm Manager Server Settings tab
FirstPAGE Alarm Manager Server V9
Sample New FirstPAGE Alarm Manager FirstPAGE Servers tab
Sample New FirstPAGE Alarm Manager Server Agent Licenses tab
FirstPAGE Alarm Manager Server V9
Page 31 of 149
Enabling and Configuring Security
1. To enable Security, you must select a Security Mode. Default selection is NONE.
Your choices include: - WINDOWS - FORD (specific only to Ford users) - CHRYSLER (specific only to Chrysler users) Once a mode is selected and saved, a User Security Configuration folder appears under the Tools section of the tree view. This folder allows the administrator to add
destinations with limited access to various user applications.
2. Click on the Tools folder then select the User Security Configuration folder. Right click and select New User or click the New icon in the toolbar.
FirstPAGE Alarm Manager Server V9
Page 32 of 149
DETAILS TAB
User ID Enter the Username for this account. This must be the Windows login username. The first user entered must be an administrator with Admin security. The last user removed must also be an Admin.
Domain Select the Domain from the drop-down list of available domains
Password Enter a Password for this username then confirm password.
Confirm Confirm Password by retyping it.
Destination Select the destination from the list of available destinations that have been configured via FirstPAGE Server.
Security Select the level of security this user will have. At least one user must have a security level of Admin for the current server. First user must have Server Administrator security level.
Notes Optional field.
3. Click on the Agent Security tab to configure the Agents this user can access. User with Server Administrator level has full access to all agents so this tab is greyed
out. For all other destinations with User security level, this tab must be configured.
Configuration
Page 33 of 149
4. Select the Privileges each user has for each Agent. Privileges include Agent Administrator for all Agents, ability to do Alarm enable/disable and/or Personal Exceptions Only. This option allows users to add or remove themselves from configured alarms.
5. Save your changes. The next time you start up the application, you will be prompted for a User ID/password and a valid Domain name before you are allowed access.
Configuration
Page 34 of 149
Configuring Key Components – Escalation Schemes
Adding an Escalation Scheme
The Escalation Schemes folder allows you to add and maintain all escalation schemes that determine the precedence hierarchy of incoming alarms. Multiple escalation schemes can be created to handle and organize alarms by priority or by level of
importance. For example, low level escalation schemes might be required to deal with low level priorities and high-level escalation schemes to deal with higher priority alarms. Due to the hierarchical nature of escalation levels, the function of each alarm scheme is directly related to the escalation levels directly above and below it.
1. Select the Escalation Schemes folder and then click on the New Escalation Scheme icon in the menu. The following screen is displayed:
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to
this escalation scheme.
Description Any text the administrator wishes to refer to the escalation scheme as.
Type The Delay option is a scheme that advances through its levels as the alarm ages.
The Count option is a scheme that begins notification only after the specified number of times an incident occurs in a timeframe.
Scheme Items
This field will display escalation scheme items once they have been configured.
2. Click the Save icon in the toolbar to save the new Escalation Scheme. It will now
appear in the tree view. Expanding this scheme will show an Items folder.
Configuration
Page 35 of 149
3. Click the Items folder then click New Escalation Item in the toolbar. If the new Escalation Scheme is a type of Delay, the following screen is displayed:
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to this escalation item/level. ie. an area that this level will
send a message to first: SUPERVISOR_ASSMBLY_LINE1
Description Any text the administrator wishes to refer to the escalation level.
Type This has been set when the Escalation Scheme was created.
Settings
Initial Delay This field will set the delay in seconds before a message is sent after the alarm has been initiated.
After Item Check this option if the message is to be sent after another level has been completed. Select the level from the dropdown. One level must be completed before using this
option. User can select if the message is to be sent after the specified item is completed for x seconds or has been active for x seconds.
Message Count This field is the number of messages to be sent. Default is set to 5 messages.
Delay between Messages
This field is the delay in seconds between each message that will be sent.
4. If the new Escalation Scheme is a Type of Count, the following Details tab will
be displayed on a new Escalation Item:
FirstPAGE Alarm Manager Server V9
Page 36 of 149
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to this escalation item/level. ie. an area that this level will send a message to first: SUPERVISOR_ASSMBLY_LINE1
Description Any text the administrator wishes to refer to the escalation level.
Type This has been set when the Escalation Scheme was created.
Settings
Every x times in x Enter the number of occurrences to monitor the fault occurrence as well as the specified time frame in Seconds,
Minutes, Hours or Days. When criteria is met, notification process will begin.
Message Count This field is the number of messages to be sent. Default is set to 5 messages.
Delay between Messages
This field is the delay in seconds between each message that will be sent.
5. Click the Destinations tab to select the destinations that will be members of this
escalation level. The following screen is displayed:
Configuration
Page 37 of 149
6. Select the destinations that will be members of this escalation item or level.
7. Click the Save icon in the toolbar to save the escalation item. It will now be
displayed in the tree view.
Configuration
Page 38 of 149
Configuring Key Components –Generic Text Agents
Adding a Generic Text Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected gateway is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie. CIMPLICITY and Activplant)
Alarm Terminate supported
If the Agent Type supports this feature, it will automatically be selected.
2. Select Generic Text from the drop down as this chapter section will discuss configuring Generic Text Agents.
3. Once the details of the Generic Text agent have been configured, click the Event Throttling tab to enable this feature that controls whether or not an event should continue to send alarms. Event throttling is used to detect rapidly strobing alarms
Configuration
Page 39 of 149
then disable the associated rules to prevent destinations from being overwhelmed
with messages.
EVENT THROTTLINGTAB
Throttling
Enable Alarm Throttling
Check this option to enable the throttling feature. Enter the number of times and seconds that must occur before the event is disabled.
Page the Administrator when the event is disabled
Check this option if an administrator is to be paged when the alarm’s activation exceeds the specified rate, so it will be known why a particular event stops sending alarms.
4. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired and is global to
every alarm on that agent.
5. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
FirstPAGE Alarm Manager Server V9
Page 40 of 149
6. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
FirstPAGE Alarm Manager Server V9
Page 41 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Send Alarm
Termination message default ‘ON’ for new Alarms
Select this option if an alarm termination message will be
sent for new alarms.
Terminate Msg
Template
Choose the Terminate template from the drop down. The
agent must be configured and saved first before a terminate message template may be configured. If the ‘Alarm Termination supported’ option is not selected at the Agent level, this field will not be enabled.
7. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a Message Templates folder.
Configuration
Page 42 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Generic Text agent
the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the {
symbol can be used to obtain other values . (See Table 1.0 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above entitled “Configuring Key Components – Escalation
Schemes”).
FirstPAGE Alarm Manager Server V9
Page 43 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 44 of 149
Configuring Alarms in the Generic Text Agent
Adding an Alarm
The Alarms folder contains information pertaining to alarms, and their configuration settings including what will be included in the message and destinations that will be paged for that alarm.
This section outlines details of adding Generic Agents. For additional agents, please refer to “Appendix A – Configuring Customer Specific Agents”.
New Alarm Steps
1. In the tree view, click on the Alarms folder for the Generic Text agent the alarm
will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the alarm. This will be displayed in the tree view once saved.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 45 of 149
2. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGETAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent
being configured.
Terminate Message Details
Send Alarm Message Terminate
Select this option if the alarm is to receive a message when the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured. This message will be sent when the
alarm is terminated.
Escalation Text
Same message for
all levels
Select this option if all alarm levels are to send the same
message.
Message This field is the alarm specific message, created at the
alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.0 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 46 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded or added for the current alarm.
FirstPAGE Alarm Manager Server V9
Page 47 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Ser ver Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Ser ver Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT USERTEXT1 – USERTEXT20
Table 1.0 – Generic Text Message Values
Configuration
Page 48 of 149
Configuring Key Components –Generic ODBC Agents
Adding a Generic ODBC Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to
the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie.
CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Generic ODBC from the drop down as this chapter section will discuss configuring Generic ODBC Agents.
3. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
Configuration
Page 49 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways. Disabled
and not required for Generic ODBC.
Port Only required when connecting to the Gateways. Disabled and not required for Generic ODBC.
Connection
DSN Select the DSN required to connect to the ODBC Database.
User Name This field is optional but may be required if database requires.
Password This field is optional but may be required if database requires.
4. Once the Connection details have been specified, the Alarm Source and
Database Properties tabs become enabled. Click on the Alarm Source tab to
configure details of the Source Data. The following screen is displayed:
FirstPAGE Alarm Manager Server V9
Page 50 of 149
ALARM SOURCE TAB
Source Data
Table Select the table from the Generic ODBC Database that will be the
source of data for alarms.
Alarm ID Column in the database that contains the name of the alarm used in the Alarm Initiate commands sent to FirstPAGE Alarm Manager.
Description Column in the database that contains a description to further define the alarm purpose.
Where Clause Allows users to limit the alarms being returned from the alarm
table to those which are applicable to paging.
5. After configuring the Alarm Source details, click the Database Properties tab to
define the fields available for message configuration.
Configuration
Page 51 of 149
DATABASE PROPERTIES TAB
Fields
Field The field names found in the ODBC Database
Alias This field can be configured to a more user friendly field name is
required.
Available Select if the table fields are to be available for message
configuration.
Order Specify the order of the fields as they will appear during message configuration.
6. Click the Event Throttling tab to enable this feature that controls whether or
not an event should continue to send alarms.
EVENT THROTTLINGTAB
Throttling
Enable Alarm Throttling
Check this option to enable the throttling feature. Enter the number of times and seconds that must occur before the event is disabled.
Page the Administrator when the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a particular event stops sending alarms.
7. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
8. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
FirstPAGE Alarm Manager Server V9
Page 52 of 149
9. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
FirstPAGE Alarm Manager Server V9
Page 53 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
10. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
Configuration
Page 54 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Generic Text agent
the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.1 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when
the Escalation Schemes were created. (See section above
entitled “Configuring Key Components – Escalation Schemes”).
FirstPAGE Alarm Manager Server V9
Page 55 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 56 of 149
Configuring Alarms in the Generic ODBC Agent
Adding an Alarm
The Alarms folder contains information pertaining to alarms, and their configuration settings including what will be included in the message and the destinations that will be paged for that alarm.
New Alarm Steps
1. In the tree view, click on the Alarms folder for the Generic ODBC agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the alarm. This will be displayed in the tree view once saved.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 57 of 149
2. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm Message Terminate
Select this option if the alarm is to receive a message when the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.1 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 58 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded from or added to the current alarm.
FirstPAGE Alarm Manager Server V9
Page 59 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
The Alarms created on the Generic ODBC Agent will also include a Message Value of AGENT that includes all available table fields.
Configuration
Page 60 of 149
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
AGENT ALARMINFO
ALARMNAME
AREA
MACHINE
USERTEXT USERTEXT1 – USERTEXT20
Table 1.1 – Generic ODBC Message Values
Configuration
Page 61 of 149
Configuring Key Components –Gateway for ActivPlant Agents
Adding a Gateway for ActivPlant Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right
click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie. CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Gateway for ActivPlant from the drop down as this chapter section will discuss configuring Gateway for ActivPlant Agents.
FirstPAGE Alarm Manager Server V9
Page 62 of 149
3. Once the details of the agent have been configured, click the Connections tab to
specify details for the Gateway. The following screen is displayed:
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for ActivPlant agent
User Name This field is not required for the Gateway for ActivPlant agent
Password This field is not required for the Gateway for ActivPlant agent
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
Configuration
Page 63 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm
Throttling
Check this option to enable the throttling feature. Enter
the number of times and seconds that must occur before the event is disabled.
Page the Administrator when
the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a
particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
FirstPAGE Alarm Manager Server V9
Page 64 of 149
7. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
FirstPAGE Alarm Manager Server V9
Page 65 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
Configuration
Page 66 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Generic Text agent
the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above entitled “Configuring Key Components – Escalation
Schemes”).
FirstPAGE Alarm Manager Server V9
Page 67 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 68 of 149
Configuring Alarms in the Gateway for ActivPlant Agent
Adding an Alarm
The Alarms folder contains information pertaining to alarms, and their configuration settings including what will be included in the message and the destinations that will be paged for that alarm.
New Alarm Steps
1. In the tree view, click on the Alarms folder for the ActivPlant agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Asset Machine name (TANK1)
Category Alarm that is associated with the resource. (HIGH, LOW etc)
Incident Further category to organize alarms
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular
Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation
Scheme
This drop down includes a list of all configured escalation
schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 69 of 149
2. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that
contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 70 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded or added for the current alarm.
Configuration
Page 71 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select the destinations that will be added to/receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme and have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT FULLYQUALIFIEDASSETNAME
ASSETNAME
CATEGORY
INCIDENT
TRIGGERVALUE
TIMESTAMP
ASSET[-1]
ASSET[-2]
ASSET[-3]
ASSET[-4]
ASSET[-5]
Table 1.2 – Gateway for ActivPlant Message Values
FirstPAGE Alarm Manager Server V9
Page 72 of 149
Configuring Key Components –Gateway for HPOM Agents
Adding a Gateway for HPOM Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to
the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie.
CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Gateway for HPOM from the drop down as this chapter section will discuss configuring Gateway for HPOM Agents.
3. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
Configuration
Page 73 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to
the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for ActivPlant agent
User Name This field is not required for the Gateway for ActivPlant agent
Password This field is not required for the Gateway for ActivPlant agent
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
FirstPAGE Alarm Manager Server V9
Page 74 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm
Throttling
Check this option to enable the throttling feature. Enter
the number of times and seconds that must occur before the event is disabled.
Page the Administrator when
the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a
particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
7. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
Configuration
Page 75 of 149
FirstPAGE Alarm Manager Server V9
Page 76 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
Configuration
Page 77 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the HPOM agent the
message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template
is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above entitled “Configuring Key Components – Escalation Schemes”).
FirstPAGE Alarm Manager Server V9
Page 78 of 149
3. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 79 of 149
Configuring Alarms in the Gateway for HPOM Agent
Adding an Alarm
The Alarms folder contains information pertaining to alarms, and their configuration settings including what will be included in the message and the destinations that will be paged for that alarm.
New Alarm Steps
1. In the tree view, click on the Alarms folder for the HPOM agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Node HPOM Node Machine.
Msg Group HPOM Message Group.
Policy The HPOM Policy applicable to this alarm.
Severity The severity of the HPOM alarm.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions:
http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 80 of 149
3. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that
contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.)
6. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
Configuration
Page 81 of 149
7. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
8. Finally, click the Destination Exceptions tab to set which destination will be
excluded or added for the current alarm.
FirstPAGE Alarm Manager Server V9
Page 82 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select the destinations that will be added to/receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme and have been configured in FirstPAGE Server Administrator.
7. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ACTIVEALARM
ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT SOURCEHOST
OBJECT
APPLICATION
SEVERITY
DATECREATED
TIMECREATED
TIMEZONE
MESSAGEGROUP
MESSAGEKEY
MESSAGETEXT
USERTEXT
Table 1.2 – Gateway for HPOM Message Values
Configuration
Page 83 of 149
Configuring Key Components –Gateway for CIMPLICITY Agents
Adding a Gateway for CIMPLICITY Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right
click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie. CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Gateway for CIMPLICITY from the drop down as this chapter section will discuss configuring Gateway for CIMPLICITY Agents.
FirstPAGE Alarm Manager Server V9
Page 84 of 149
3. Once the details of the agent have been configured, click the Connections tab to
specify details for the Gateway. The following screen is displayed:
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for CIMPLICITY agent
User Name This field is not required for the Gateway for CIMPLICITY agent
Password This field is not required for the Gateway for CIMPLICITY agent
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
Configuration
Page 85 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm Throttling
Check this option to enable the throttling feature. Enter the number of times and seconds that must occur before the event is disabled.
Page the Administrator when the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
FirstPAGE Alarm Manager Server V9
Page 86 of 149
7. Finally, click the Alarm Defaults tab to set defaults that will be used during
configuration for new alarms.
Configuration
Page 87 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
FirstPAGE Alarm Manager Server V9
Page 88 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Generic Text agent
the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template
is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above
entitled “Configuring Key Components – Escalation Schemes”).
Configuration
Page 89 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
FirstPAGE Alarm Manager Server V9
Page 90 of 149
Configuring Alarms in the Gateway for CIMPLICITY Agent
New Alarm Steps
1. In the tree view, click on the Alarms folder for the agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Resource Machine name (TANK1)
Alarm Alarm that is associated with the resource. (HIGH, LOW etc)
Class Further category to organize alarms
Message Configured by the user to match message text configured on CIMPLICITY alarm. Wildcards can be used. (*CRITICAL* - will find all alarms with the text ‘CRITICAL’.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Configuration
Page 91 of 149
2. Once the Alarm Details have been configured, click the Message tab. The following
screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that
contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.3 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 92 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded or added for the current alarm.
DESTINATION EXCEPTION TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Configuration
Page 93 of 149
Exception Additions
Select the destinations that will be added to/receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme and have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields Description
SERVER ACTIVEALARM Full string representation of the active alarm, including System, Resource, Alarm Name and Alarm Class.
ALARM Name of the active CIMPLICITY alarm.
APPLICATION Indicates which source (ie Gateway) the alarm originated from.
DATE The date the alarm was initiated.
DATETIME The date and time the alarm was initiated.
DESCRIPTION The FPAM description (display name) of the active alarm.
DESTNAME The destination or distribution list which this alarm is being routed to.
ESCITEM Numeric value of the current level of escalation for this alarm.
HOST The hostname of the machine where the page originated.
TIME The timestamp of when the alarm was initiated.
USERTEXT ALARM Name of the active CIMPLICITY alarm.
CLASS Class of the active CIMPLICITY alarm.
RESOURCE Resource of the active CIMPLICITY alarm.
SYSTEM Project containing the active CIMPLICITY alarm.
STATE State of the active CIMPLICITY alarm.
FirstPAGE Alarm Manager Server V9
Page 94 of 149
RULE String representation of the rule that captured this alarm for action.
MESSAGE Message value of the active CIMPLICITY alarm.
ESCALATIONTEXT LEVEL1…LEVEL10 Level specific escalation text templates as defined on the Messages tab of the alarm.
Table 1.3 – Gateway for CIMPLICITY Message Values
FirstPAGE Alarm Manager Server V9
Page 95 of 149
Configuring Key Components –Gateway for COPA Agents
Adding a Gateway for COPA Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to
the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie.
CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Gateway for COPA from the drop down as this chapter section will discuss configuring Gateway for COPA Agents.
3. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
FirstPAGE Alarm Manager Server V9
Page 96 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for OPC agent.
User Name This field is not required for the Gateway for OPC agent.
Password This field is not required for the Gateway for OPC agent.
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
Configuration
Page 97 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm Throttling
Check this option to enable the throttling feature. Enter the number of times and seconds that must occur before the event is disabled.
Page the Administrator when the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
7. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
FirstPAGE Alarm Manager Server V9
Page 98 of 149
FirstPAGE Alarm Manager Server V9
Page 99 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
Configuration
Page 100 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Gateway for ODBC
agent the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once
saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when
the Escalation Schemes were created. (See section above entitled “Configuring Key Components – Escalation Schemes”).
FirstPAGE Alarm Manager Server V9
Page 101 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 102 of 149
Configuring Alarms in the Gateway for COPA Agent
New Alarm Steps
1. In the tree view, click on the Alarms folder for the agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to
the alarm. This will be displayed in the tree view once saved.
Click the browse button to find the Event this Alarm will
use. These are events that have been configured in FirstPAGE Alarm Manager Gateway for OPC.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions:
http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 103 of 149
2. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that
contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm Message Terminate
Select this option if the alarm is to receive a message when the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent
being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.6 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 104 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded from or added to the current alarm.
FirstPAGE Alarm Manager Server V9
Page 105 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT DATETIME
TRIGGERTAG
TRIGGERVALUE
TRIGGERTEST
TRIGGERTESTVALUE1
TRIGGERTESTVALUE2
USERFIELD1 – USERFIELD5
Table 1.6 – Gateway for COPA Message Values
Configuration
Page 106 of 149
Configuring Key Components –Gateway for ODBC Agents
Adding a Gateway for ODBC Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie. CIMPLICITY and Activplant)
Alarm Terminate supported
If the Agent Type supports this feature, it will automatically be selected.
2. Select Gateway for ODBC from the drop down as this chapter section will discuss configuring Gateway for ODBC Agents.
3. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
Configuration
Page 107 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for ODBC agent.
User Name This field is not required for the Gateway for ODBC agent.
Password This field is not required for the Gateway for ODBC agent.
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
FirstPAGE Alarm Manager Server V9
Page 108 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm
Throttling
Check this option to enable the throttling feature. Enter
the number of times and seconds that must occur before the event is disabled.
Page the Administrator when
the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a
particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
7. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
Configuration
Page 109 of 149
Configuration
Page 110 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
FirstPAGE Alarm Manager Server V9
Page 111 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Gateway for ODBC
agent the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template
is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above
entitled “Configuring Key Components – Escalation Schemes”).
Configuration
Page 112 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
FirstPAGE Alarm Manager Server V9
Page 113 of 149
Configuring Alarms in the Gateway for ODBC Agent
New Alarm Steps
1. In the tree view, click on the Alarms folder for the agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the alarm. This will be displayed in the tree view once saved.
This name must match the Event that has been configured in
FirstPAGE Alarm Manager Gateway for ODBC. Click the
browse button to find the Event this Alarm will use.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Configuration
Page 114 of 149
2. Once the details of the agent have been configured, click the Message tab to specify
details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.5 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
Configuration
Page 115 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded from or added to the current alarm.
Configuration
Page 116 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCLEVEL
HOST
TIME
USERTEXT DATETIME
TRIGGERTAG
TRIGGERVALUE
TRIGGERTEST
TRIGGERTESTVALUE1
TRIGGERTESTVALUE2
USERFIELD1 – USERFIELD5
Table 1.5 – Gateway for ODBC Message Values
FirstPAGE Alarm Manager Server V9
Page 117 of 149
Configuring Key Components –Gateway for OPC Agents
Adding a Gateway for OPC Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
9. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to
the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie.
CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
10. Select Gateway for ODBC from the drop down as this chapter section will discuss configuring Gateway for ODBC Agents.
11. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
FirstPAGE Alarm Manager Server V9
Page 118 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for OPC agent.
User Name This field is not required for the Gateway for OPC agent.
Password This field is not required for the Gateway for OPC agent.
12. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
Configuration
Page 119 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm
Throttling
Check this option to enable the throttling feature. Enter
the number of times and seconds that must occur before the event is disabled.
Page the Administrator when
the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a
particular event stops sending alarms.
13. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
14. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
15. Finally, click the Alarm Defaults tab to set defaults that will be used during
configuration for new alarms.
FirstPAGE Alarm Manager Server V9
Page 120 of 149
FirstPAGE Alarm Manager Server V9
Page 121 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg Template
Select if an alarm termination message will be sent for new Alarms then choose the Terminate template from the drop
down. The agent must be configured and saved first before a terminate message template may be configured.
16. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a
Message Templates folder.
Configuration
Page 122 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
2. In the tree view, click on the Message Templates folder for the Gateway for ODBC
agent the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when the Escalation Schemes were created. (See section above
entitled “Configuring Key Components – Escalation
Schemes”).
FirstPAGE Alarm Manager Server V9
Page 123 of 149
3. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
Configuration
Page 124 of 149
Configuring Alarms in the Gateway for OPC Agent
New Alarm Steps
2. In the tree view, click on the Alarms folder for the agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the alarm. This will be displayed in the tree view once saved.
Click the browse button to find the Event this Alarm will
use. These are events that have been configured in FirstPAGE Alarm Manager Gateway for OPC.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore Acknowledgement
This option is used for FPAM Console which will send pages regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
FirstPAGE Alarm Manager Server V9
Page 125 of 149
3. Once the details of the agent have been configured, click the Message tab to
specify details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for all levels
Select this option if all alarm levels are to send the same message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.6 below for a list of available values.)
7. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
FirstPAGE Alarm Manager Server V9
Page 126 of 149
8. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
9. Finally, click the Destination Exceptions tab to set which destination will be
excluded from or added to the current alarm.
FirstPAGE Alarm Manager Server V9
Page 127 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Server Administrator.
10. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT DATETIME
TRIGGERTAG
TRIGGERVALUE
TRIGGERTEST
TRIGGERTESTVALUE1
TRIGGERTESTVALUE1
USERFIELD1 – USERFIELD5
Table 1.6 – Gateway for OPC Message Values
Configuration
Page 128 of 149
Configuring Alarms in the Gateway for RSView Agent
Adding a Gateway for RSView Agent
Agents may now be configured to monitor various alarm/event monitoring systems and other plant floor devices. The desired agent(s) is enabled with a license key allowing from 10, 100 1000 or unlimited alarms to be configured.
New Agent Steps
1. Select the Agent folder and then click on the New Agent icon in the toolbar, or right click on the Agents folder and select New Agent. The following screen is displayed:
DETAILS TAB
Configuration
Agent Type This field contains all the agents for which a license key has been entered during server configuration.
Display Name This is a logical name utilized by the administrator to refer to
the agent. This will be displayed in the tree view once saved.
Host This field is the host name of the machine where the agent selected is running. This must match the Source Host name that is configured on the Gateway.
Application For known Applications, this field is defaulted. (ie.
CIMPLICITY and Activplant)
Alarm Terminate
supported
If the Agent Type supports this feature, it will automatically
be selected.
2. Select Gateway for ODBC from the drop down as this chapter section will discuss configuring Gateway for ODBC Agents.
3. Once the details of the agent have been configured, click the Connections tab to specify details for the Gateway. The following screen is displayed:
Configuration
Page 129 of 149
CONNECTIONS TAB
Gateway Settings
Host Name Only required when connecting to the Gateways.
Port Only required when connecting to the Gateways. Defaults to the port of the Host Name entered on the Details tab.
Connection
DSN This field is not required for the Gateway for RSVIEW agent.
User Name This field is not required for the Gateway for RSVIEW agent.
Password This field is not required for the Gateway for RSVIEW agent.
4. Once the Connection details have been specified, click the Event Throttling
tab to enable this feature. This feature controls whether or not an event
should continue to send alarms.
FirstPAGE Alarm Manager Server V9
Page 130 of 149
EVENT THROTTLINGTAB
Throttling
Enable Alarm Throttling
Check this option to enable the throttling feature. Enter the number of times and seconds that must occur before the event is disabled.
Page the Administrator when the event is disabled
Check this option if an administrator is to be paged when this feature is enabled, so it will be known why a particular event stops sending alarms.
5. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
6. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
7. Finally, click the Alarm Defaults tab to set defaults that will be used during configuration for new alarms.
Configuration
Page 131 of 149
ALARM DEFAULTS TAB
Alarm Defaults
Esc Scheme This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new alarms.
Msg Template Each message on an agent may be configured then saved as a template for further alarm configuration. To configure the message, use the { symbol to launch a drop down of message options. The agent must be configured and saved first before a message template may be configured.
Terminate Msg
Template
Select if an alarm termination message will be sent for new
Alarms then choose the Terminate template from the drop down. The agent must be configured and saved first before a
terminate message template may be configured.
8. Click the Save icon in the toolbar to save the Agent. It will now be displayed
in the tree view. Once expanded, there will be an Alarms folder and a Message Templates folder.
FirstPAGE Alarm Manager Server V9
Page 132 of 149
FirstPAGE Alarm Manager Server V9
Page 133 of 149
Adding a Message Template
The Message Templates folder contains information pertaining to messages that may be included in the message and destinations that will be paged for that alarm. This must be created first, before Agent alarms are configured.
New Message Template Steps
1. In the tree view, click on the Message Templates folder for the Gateway for ODBC
agent the message will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the message. This will be displayed in the tree view once
saved.
Description This is additional text to refer to this message.
Message
Level x of x This allows up to infinite levels to be configured.
Message Enter text that will be displayed when the message template is added to an alarm. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.2 below for a list of available values.) Also includes ESCALATIONTEXT LEVEL1-LEVEL10 which was added when
the Escalation Schemes were created. (See section above entitled “Configuring Key Components – Escalation
Schemes”).
Configuration
Page 134 of 149
2. Click the Save icon in the toolbar to save the Message Template. It will now be displayed in the tree view.
FirstPAGE Alarm Manager Server V9
Page 135 of 149
Configuring Alarms in the Gateway for RSVIEW Agent
New Alarm Steps
1. In the tree view, click on the Alarms folder for the agent the alarm will belong to. Click the New icon in the toolbar. A Details tab will appear.
DETAILS TAB
Details
Name This is a logical name utilized by the administrator to refer to the alarm. This will be displayed in the tree view once saved.
Description This is additional text to refer to this alarm.
Pattern Match Options are None, Simple Pattern Matching or Full Regular
Expressions. Please refer to this link for further details on creating regular expressions: http://en.wikipedia.org/wiki/Regular_expression
Ignore
Acknowledgement
This option is used for FPAM Console which will send pages
regardless if acknowledgement of the alarm is given.
Escalation Details
Escalation Scheme
This drop down includes a list of all configured escalation schemes. Select one that will be the default on all new
alarms.
Configuration
Page 136 of 149
2. Once the details of the agent have been configured, click the Message tab to specify
details for the Agent alarm. The following screen is displayed:
MESSAGE TAB
Message Details
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent
being configured.
Terminate Message Details
Send Alarm
Message Terminate
Select this option if the alarm is to receive a message when
the alarm is terminated.
Message Template Select a message template from the dropdown that contains a list of already configured templates for the Agent
being configured. This message will be sent when the alarm is terminated.
Escalation Level Message
Same message for
all levels
Select this option if all alarm levels are to send the same
message.
Message This field is the alarm specific message, created at the alarm level. Regular text may be used or the { symbol can be used to obtain other values . (See Table 1.7 below for a list of available values.)
3. Click the Wildcard Exceptions tab if there are exceptions to be made on an
Agent level for events being paged. (ie. if there are greater than 100 tanks
and one is down for maintenance, user can key TANK7 in the Exception
Details and still use Tank* in the alarm configuration. It is essentially the
alarm that will be excluded/ignored when the alarm is fired.
Configuration
Page 137 of 149
4. Click the Add button to add multiple exceptions. (For SeQent supplied
agents, a browse button is available to find alarms to be excluded.)
5. Finally, click the Destination Exceptions tab to set which destination will be
excluded from or added to the current alarm.
Configuration
Page 138 of 149
DESTINATION EXCEPTIONS TAB
Exception Removals
Select which destinations will be excluded from receiving messages regarding this alarm. These are destinations that have been configured in FirstPAGE Server Administrator.
Exception Additions
Select which destinations will be added to and receive messages regarding this alarm. These are additional destinations that are not currently part of the alarm’s escalation scheme. All destinations have been configured in FirstPAGE Server Administrator.
6. Click the Save icon in the toolbar to save the Alarm. It will now be displayed
in the tree view.
Message Value Available Fields
SERVER ALARM
APPLICATION
DATE
DATETIME
DESCRIPTION
DESTNAME
ESCITEM
HOST
TIME
USERTEXT CUSTOMUSERTEXT
DATE
TIME
TAGNAME
TAGVALUE
THRESHOLD
TAGDESCRIPTION
ALARMLABEL
UNIT
Table 1.7 – Gateway for RSVIEW Message Values
FirstPAGE Alarm Manager Server V9
Page 139 of 149
c h a p t e r f o u r – u s i n g f i r s t p a g e a l a r m m a n a g e r
Page 140 of 149
.4. Using FirstPAGE Alarm Manager Server
Using the FirstPAGE Alarm Manager Administrator Toolbar
The FirstPAGE Alarm Manager Administrator user interface is conveniently displayed in a tree view. The Server, when expanded, shows folders for Agents, Escalation Schemes and Tools. They enable the user to register various agents to work closely with a specific alarming/event notification system. An agent is then set up to manage alarms from each notification system.
It includes a Destination folder that serves as a shortcut to already configured destinations, allowing the user to quickly locate the alarms that the destinations are configured to without knowing the agent/alarm that supports them.
There are many features that make using FirstPAGE Alarm Manager Administrator
easier and more effective that include:
o Modifying and Deleting Tree View Items
o FirstPAGE Alarm Manager Tools
o Reviewing and printing reports
o Viewing the Log Files
FirstPAGE Alarm Manager Server V9
Page 141 of 149
Modifying and Deleting Tree View Items
Anything created on the tree view side of the screen (the left hand side) can be
modified or deleted at any time. You can also change the state to disable.
Modifying
Select the item you wish to alter. The information regarding it will show up on the right hand side of the screen. At this point, you can change the name along with any other variables attached to it i.e. configuration settings etc. When you save your changes, they will appear in the tree view. Once the information has been saved, you cannot revert to the old information. The only way to retrieve it is to change it back to its original state.
Deleting
There are two ways of deleting anything on the tree view side of your screen. By selecting the item you wish to delete, you can choose Edit > Delete from the toolbar or
simply click on the delete symbol (red "X"). By deleting it, you are unable to recover the item or any information attached to it. You must recreate it.
In certain applications, if a particular item is being used in another part of the application, you will not be able to delete it at that level. You must go further down in the tree view to discern where it is being used, and delete it there first.
Using FirstPAGE Alarm Manager Server
Page 142 of 149
FirstPAGE Alarm Manager Tools - Options
Setting Options
The Tools menu allows users to set FirstPAGE Alarm Manager Server options and details.
1. Click the Tools menu then select Options. The following screen is displayed:
2. The General tab displays the Data Source name as well as the Administrator license key. This key determines the number of servers that can be configured.
3. FirstPAGE Alarm Manager Server gives you the option to reload the server with any
additions, edits or deletions automatically or when requested by the user. Select if you would like the server to automatically reload after every change or to perform
the reload only when requested.
4. If you choose to reload with every change, the reload will take place when the Save button is clicked. If you choose to reload only when requested, you will be informed that there are data changes the server needs to be notified about and
have the option to either send the reload before closing or close the system without reloading the changes.
FirstPAGE Alarm Manager Server V9
Page 143 of 149
FirstPAGE Alarm Manager Reports
Viewing and Printing Reports
The Reports menu allows users to view and print various reports on configured devices, providers, destinations or aliases.
1. From the Tools menu in the toolbar, click Reports then select report you wish to view or print. The Alarm List report displays the alarms that have been configured for each agent.
2. The Destination Alarm List report displays the destinations that have been configured and the agent they are configured to.
FirstPAGE Alarm Manager Server V9
Page 144 of 149
3. The Destination List report displays the destinations that have been configured and
the agent they are configured to.
4. The Escalation Scheme List report displays each escalation scheme and associated
levels or items.
FirstPAGE Alarm Manager Server V9
Page 145 of 149
FirstPAGE Alarm Manager Alarm Search
FPAM contains a utility that allows users to search for configured alarms either by
alarm type or by the agent they are configured to.
Searching Configured Alarms
1. From the Tools menu in the toolbar, select Search Configured Alarms. The
following screen is displayed:
2. From the Look In Agent field, select the agent that might contain the alarm
being searched. If the exact alarm is known, use the Search for Alarm field
to enter the alarm name. Wildcards may be used here.
Using FirstPAGE Alarm Manager Server
Page 146 of 149
FirstPAGE Alarm Manager Log Files
Viewing the Log Files
In each application, you are able to view the log files associated with the various components of the software. The log files contain an accurate history of every transaction and modification made to the database. Log files are important because
they ensure the integrity of the data and provide a means of data recovery.
1. Select the View menu in the toolbar. Select the View Logs option. This allow you to view the following log files:
2. Double-click the log entry for further information.
3. Click the Filters button and choose viewing options to display only the desired information.
4. The Events On: field defaults to the current day.
5. The Status Message field can be used to search for a portion of the message in the log. Only certain characters may be used in this field. When matching the special
characters left bracket ([), question mark (?), number sign (#), and asterisk (*), enclose them in brackets. i.e. To find all log items that start with [ enter in [[]* in
the Status Message field. The common search characters are as follows:
Character Match Made Example
? Any single character Text in the log is ABC, DBC and
XYZ. If ?BC is used in the Status
Message field, only ABC and DBC
will be returned.
* Zero or more
characters
*Initiated* in the Status Message
field would return all log items
with the word ‘Initiated’
# Any single digit (0-9) Text in the log is Device1,
Device5, Device8, Device10.
Keying in Device# in the Status
Message field, will return Device1,
Device5, and Device8.
6. Select the Automatic Refresh option to automatically refresh the log file based on
the seconds specified.
FirstPAGE Alarm Manager Server V9
Page 147 of 149
Glossary
Administrator
Typically a GUI application, this component facilitates configuration and monitoring
of a server engine. If changes are made to the server configuration the administrator
notifies the engine to reload its running configuration either automatically or on user
demand. An example of an administrator component is FirstPAGE Administrator.
This administrator allows you to maintain the FirstPAGE server's engine configuration.
Administrator Kit
An administrator kit contains the product's administration component only. After
installing this kit on a workstation you may utilize any of the features of the Administrator component.
Agent
A module that is developed to work closely with a specific alarming/event notification
system.
Client
A client component utilizes the facilities of a standard NETCON server. Typically a
GUI application, this component provides a user-friendly interface of the available
services offered by the server engine. An example of a client tool would be FirstPAGE
Client, which presents the user with a list of known messaging destinations and allows them to send messages to one or more destinations.
Destination
A FirstPAGE Server destination is a name assigned to a messaging location to which
text messages may be delivered. Ex. SCOTTS_PAGER, KENS_PHONE, JIMS_EMAIL.
DSN
A DSN, Data Source Name, is the name assigned to an ODBC driver and
configuration information that allows an ODBC enabled application to connect to a
data source.
Engine
An engine component implements a unified interface to a set of common,related
protocols. The engine provides services to clients and gateways such that a common
interface may be used to manipulate many different types of devices. Engines are
FirstPAGE Alarm Manager Server V9
Page 148 of 149
administered via Administrator components and are utilized by clients, gateways or use written components.
Gateway
A gateway component creates a bridge between a third party product and a standard
NETCON server. Typically an engine this component provides a conduit for
forwarding events from the third party product into a SeQent standard server.
An example of a gateway would be an interface to an HMI or SCADA system
forwarding events from that system to FirstPAGE Alarm Manager for processing. An
example of a gateway is Marquee Manager Gateway for VisualPlant. This gateway forwards VisualPlant incidents to Marquee Manager.
Host
The host is the location or machine name where alarms are initiated from.
ODBC
The ODBC protocol is an implementation of the Microsoft ‘Open Database
Connectivity’ API allows FirstPAGE Server to forward messages to any ODBC compliant data source.
Schedule
A FirstPAGE Server schedule is a name assigned to a set of weekday configuration
rules, which define the times during which a destination may receive messages. A schedule, once defined may then be assigned to a destination over a time period.
Server Kit
A server kit typically contains the server engine and administrator components. In
some cases a client component is also included with this kit. The server kit is usually
installed on a centralized host, and one or more clients or gateways utilize this
server. An example of a server kit is FirstPAGE Server. This kit contains the FirstPAGE engine, administrator and client.
User Text
Custom text fields that may be added to alarm messages. Alarm Manager allows up
to 20 user text messages to be configured.
Glossary
Page 149 of 149
Wizard
A wizard is a prompted process that guides an application user through a
complicated data entry process, providing hints as to the appropriate answers required for each field or screen.
top related