NEC America reserves the right to change the specifications, functions,
or features in this document at any time without notice. NEC America
has prepared this document for use by its employees and customers. The
information contained herein is the property of NEC America and shall
not be reproduced without prior written approval from NEC America.
This manual descri bes th e i nstal lati on, dat abases , an d confi gurat ion f or the Sen try
Alarm Control Terminal and the appli cations that can be used with the terminal.
Overview
This manua l contains the following chapters:
Chapter 1, Introduction - Describes the chapters in this installation guide.
Chapter 2, Sentry Alarm Control Terminal - Provides an overview of Sentry
Alarm Control Terminal and describes the installa tion, databases and conf iguration
parameters.
Chapter 3, Annoyance Trap - Provides an overview of the Annoyance Trap
application an d descri bes the instal lation, configur ation pa rameters , and database s.
Chapter 4, Emergency Conference - Provides an overview of the Emergency
Conference application and describes the installation, configuration parameters,
and databases.
Chapter 5, Executive Override - Pr ovides an over view of the Exec utive Override
application and descr ibes the installatio n, configuration para meters, and databases.
Also provides a sample configuration.
Chapter 6, MAT Assignments and PBX Information - Describes the NEAX
Maintenance Administration Terminal (MAT) commands that need to be used for
each OAI Monitor application as well as the PBX software and conference cards
that you need to run Sentry Alarm C ontrol Ter minal
Chapter 7, Platform Maintenance - Describes how to use the plat form
maintenance utility to perform adm inistrative tasks, including: activating,
deactivati ng, and resetting terminals.
Appendix A, History Logging - Provides a description of the History Logging
configuration.
NDA-30080 Revision 1.0Page 1
IntroductionSentry Installation Guide
This Page Left Blank.
Page 2NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Chapter 2Sentry Alarm Control Terminal
This chapter describes the databases and configuration parameters for the Sentry
Alarm Cont rol Termina l software. F or information about us ing the Sentry Alarm
Control Te rminal, see the Sentry Alarm Control Terminal User Guide.
Overview
The Sentry Alarm Control Termin al is a versa tile UAP operator interface
application that communic ates with on e or more Sentry OAI Monitor applicat ions
(such as the Emergency Conference Monitor or the Annoyance Trap Monitor)
using message protocols defined by these applications. Data received from the
monitors is displayed in real time.
Multiple instances of the Sentry Alarm Control Terminal may be executed
simultaneously from the system console and/or from one or more d u mb te rmi nal s
connected to the UAP via RS-232. The content and format of displayed data is
controlled through configuration files, allowing a high degree of customization.
Each terminal can use a separate configuration, or configurations can be shared.
The Sentry Alarm Control Termina l uses text windows to display i nformatio n and
allows the user to manipul ate window te xt from a keyb oard. Specia l functi on keys
are defined to permit the user to quickly perform needed tasks. System messages
are used to inform the user of er rors and othe r status chan ges. Dialog windo ws are
displayed to show current configuration settings or when the program requires
information from the user.
The following features are controlled through the configuration file set:
Window and Dialog Attributes
•Screen position
•Size in rows and columns
•Text colors and attributes (bold, blinking, etc.)
•Static text fields
•Dynamic text field formats
Real Time Message Display Attributes
•Message text field format s
•Text colors and attributes (bold, blinking, etc.)
Screen Saver Attributes
•Time out values
•Text colors and attributes (bold, blinking, etc.)
•Static text fields
Function Key Assignments
NDA-30080 Revision 1.0Page 3
Sentry Alarm Control TerminalSentry Installation Guide
There are several processes included in the Sent ry Alarm Control Terminal
installation:
•Software Installation - Install software from media and follow prompts.
•Database Creation - Build, process, and install databases.
•Window Configuration Files - Creat e con figuration files for te rminal windows.
•Configuration Parameters- Set configuration parameters.
•Activate Terminals - Use platform maintenance tools t o activate terminals.
The following sections describe these processes.
Page 4NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
login: apmadm
password:
NEC America APM Administra tion Wed J an 31, 1996
APM Platform Release Rel2. 0 (Oct 09, 1995
Main Menu
APM
Debug Facilities
Halt APM System
File Archive
Installation of Appli cations/Packages
Removal of Packa ges
Start-up APM Sys tem
Logout
UNIX
Enter Option: [ ]
APM Status: ACTIVE
Software Installation
The Sentry Alarm Control Terminal software must first be loaded from the release
media. Remember to use the Applications Manager (A PM) I ns tal lation Manual if
you need fur ther instructions for installing softw are using the APM.
Note:
You will be prompted for several values when you install the software. For more
information about these and other parameters, refer to the next section,
Configuration P arameters on page 16.
1.T o begin the Sentry Alarm Control Terminal software installation, log in to the
APM Platform Management Menu by typing apmadm at the UNIX login
prompt, then press Enter. The login and password prompts are shown below.
If your “apmadm” account requires a password, enter the appropriate
password at the subsequent password prompt.
The APM Administration main menu displays.
)
NDA-30080 Revision 1.0Page 5
Sentry Alarm Control TerminalSentry Installation Guide
2.Type i and press Enter to select the Installation of Applications/Packages
option. The Installation of Application/Packages screen displays.
NEC America APM Administr ation Wed - Jan 31, 19 96
Installation of Appli cations/Packages
Available Package s are:
applications asl mtl tcpip u pdate x25
Enter Package to be installed :
3.At the “
press Enter. The “
Enter Package to be installed
Enter Release Media Device
NEC America APM Administr ation Wed Ja n 31, 1996
Installation of Appli cations/Packages
Available Package s are:
applications asl mtl tcpip u pdate x25
Enter Package t o be installed : applicati ons
Release Media Devices are :
(F)loppy Disk De vice (C)artridg e Tape Device
Enter Release M edia Device:
” prompt, type applications and
” prompt displays.
Page 6NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Installation Proced ure
Installing from /dev/fd0
Insert OAI Release Media #1
Enter <Return> t o continue:
Has all release media been lo aded [y or n] ?
x oai/app/sentryTr m/install/ansi_sa t, 1038 bytes, 3 tape blocks
x oai/app/sentr yTrm/install/M default.cfg , 434 bytes, 1 tape blocks
x oai/app/sentryTr m/install/.profil e, 1673 bytes, 4 tape blocks
.
x oai/chksum_app, 1011 bytes, 2 tape block s
x oai/app/sentryTrm. ins, 8459 bytes, 17 tape blocks
x oai/app/sentryT rm/bin/sentryT erm, 540414 bytes, 1056 ta pe blocks
.
.
.
4.Select th e floppy dis k devic e as the inst allation media b y typing f and pressing
Enter.
The following screen displays:
5.Insert the Sentry Alarm Contro l Terminal disk ette into the fl oppy dis k devic e,
and press Enter to continue.
The screen displays files in the application installation. Many files may scroll
off the screen, until all of the files from the diskette have been processed.
The “
Has all release media been loaded
” prompt displays.
NDA-30080 Revision 1.0Page 7
Sentry Alarm Control TerminalSentry Installation Guide
6.Type y and press Enter to indicate that all release media has been loaded.
The APM installation begins processing all of the Sentry Alarm Control
Terminal installation files and checking them for correctness. The screen
indicates the status of the installation.
OAI Platform is a t revision 5 f or machine i386 (Dec 19 1 994 Rel 1.6. 1)
sentryTrm Revisi on: 5 mach ine type: i 386 Versio n: 1.7
Processing, plea se wait...
Validating insta lled files
..............
Validation Compl eted
Installing t he Release Files
Processing files
After the files have been processed, the “root password” prompt displays. In
order to com plete the Sentry Alarm Co ntrol Terminal installation, you must
modify certain files that require “root” privileges.
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
Installation re quires Super Us er (root) p rivileges.
Please Enter su/root Pas sword:
Page 8NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Creating Sentry Terminal direc tories . . .
/oai/app/sentry created
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
/oai/app/sentry /bin created
/oai/app/sentry /install created
/oai/app/sentry /cfg created
/oai/app/sentry /cfg/terminals creat ed
/oai/app/sentry /cfg/terminals/de fault created
/oai/log alread y exists
/oai/log/sentry created
Press Enter to continue. [ ]
Installing sent ry user on SCO UNIX.
Enter (sentry) user id [6000]:
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
User (sentry) a lready belongs to a group.
User (sentry) i nstalled.
Press Enter to continue. [ ]
7.Type in the root password at the prompt and press Enter to continue.
The Sentry Alarm Control T erminal installation will create any directory that
does not already e xi st. The pa th s of the direc tori es will display on the scree n,
as illustrat ed below.
8.Press Enter to continu e the inst al la ti on. The sentry user is added to the SCO
UNIX operating system.
NDA-30080 Revision 1.0Page 9
Sentry Alarm Control TerminalSentry Installation Guide
9.Press Enter again and the sntryadm user is adde d to the SCO UNIX operati ng
system.
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
Installing sntr yadm user on SC O UNIX.
Enter (sntryadm ) user id [6000 ]:
Warning: The us er id [6000] is already as signed on this system,
Install (sntrya dm) with user i d [6000] (y /n)
10. A warning indi cating t hat the user ID has a lready b een assi gned to t he syste m
displays. T ype y and press Enter to install the sntryadm user with the same ID.
The sntryadm user is added to the system.
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
Installing sntr yadm user on SC O UNIX.
Enter (sntryadm ) user id [6000 ]:
Warning: The us er id [6000] is already as signed on this system,
Install (sntrya dm) with user i d [6000] (y /n) y
User (sntryadm) alrea dy belongs to a group.
User (sntryadm) installed.
Press Enter to continue [ ]
Page 10NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Installing the Sentry Terminal Binary . . .
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
Installing the Sentry Database Files . . .
Installing the Default Termina l Configura tion Files . . .
Installing the ansi_s at terminal information . . .
Installing the Sentry Platform Maintenanc e Utilities . . .
Installing /etc /mygetty . . .
Updating /etc/g ettydefs . . .
Press Enter to continue. [ ]
Sentry Terminal Installation C omplete.
The following c onfiguration ta sks must be completed bef ore
NEC America Inc Sentry Termin al Installa tion Wed - Ap r 29, 1998
1. Build, proce ss, and install the sentry _m database.
starting Sentry Terminal appli cation
2. Build a wind ow configuratio n file for each entry in the
sentry_m dat abase
See the Sentry Terminal Ins tallation guide for more inf ormation.
Press Enter to continue. [ ]
11. Press Enter to continue the installation.
12. Press Enter to continue.
The following screen displays when the installati on is comple te.
13. Press Enter.
NDA-30080 Revision 1.0Page 11
Sentry Alarm Control TerminalSentry Installation Guide
UNIX Subsystem
Database Update
The SCO UNIX Subsystem database must be update d for the Sentry Alarm Control
Terminal.
At the UNIX prompt, login as the superuser (root) and execute the SCO UNIX
Subsystem Database authorization checking program (/tcb/bin/authck -s) and
password deletion program (passwd -d) as shown below.
The following us ers have Protec ted Passwor d Database ent ries
that do not matc h their Subsyst em Database entries:
.
.
sentry sntryadm
.
There are errors in the databas e.
fix them (y/n)> Y <ENTER>
# passwd -d sent ry
Deleting passwor d for user sen try
# passwd -d sntryadm
Deleting passwor d for user snt ryadm
Answer yes when asked to fix the subsyst em databases. This ensures that the SCO
UNIX Subsystem Databases are left in a proper state.
Page 12NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Database Creation
The Sentry Master Database contains information used by the Emergency
Conference, Annoyance Trap, and Sentry Alarm Control Terminal applications.
The Feature Application Database contains a sub se t of the Sentry Master Databa se
and is used by the Sentry Ala rm Control Ter minal program. Eac h featu re database
record contains an entry for each Sentry feature (Emergency Conference or
Annoyance Trap) used by the system. Refer to the APM Configuration Manual for
more information.
Each sentry master database record contains the following fields:
Monitored Number
The monitored number used by the caller to access the Emergency Conference or
Annoyance Trap.
Category
An ASCII string containing the record category, which is set to “conference” for
Emergency Conference records or “annoyance” for Annoyance Trap records.
Name
An ASCII string containing the Emerge ncy Confere nce or Annoyan ce Trap name.
Minimum Lines Used
The minimum number of lines requi red by an Emergency Confe rence. This field is
not used by the Sentry Alarm Control Terminal.
First Line Number
The first line number of the dedicated conference card set used by an Emergency
Conference. This field is not used by the Sentry Alarm Control Terminal .
Override Allowed
A simple Y/N character that determines whether or not an emergency conference
will override bus y dest in ations . This fie ld is not used by the Se ntry Alarm Con trol
Terminal.
Warning Tone Issued
A simple Y/N char acter t hat deter mines whether or not a n Emerg ency Co nfe rence
will issue a warning tone when a caller joins a conference. This field is not used by
the Sentry Alarm Contr ol Terminal.
Window Symbol
The name of the window symbol associated with an Emergency Conference or
Annoyance Trap.
Contact Database
The name of the contacts database file used by an Emergency Conference. This
field is not used by the Sentry Alarm Control Terminal.
Authorized Database
The name of the authorized ca ller database fi le used by an Emergency Confer ence.
This field is not used by the Sentry Alarm Control Terminal.
NDA-30080 Revision 1.0Page 13
Sentry Alarm Control TerminalSentry Installation Guide
Sentry Maste r
Database
Field DescriptionT ypeSize
Monitored NumberASCII105776
Minimum Lines UsedNumeric20420
First Line NumberN umer ic50999990
Override AllowedASCII1ny
Warning Tone IssuedASCII1yy
Window SymbolASCII25ALARM_WIN
Contact DatabaseASCII25/oai/db/cur/conf1
Authorized DatabaseASCII25/oai/db/cur/caller1
Feature
Application
Database
The Sentry master database is named “sentry_m” by default and contains the
following fields.
Minimum
Value
CategoryASCII25conference
NameASCII25conference1
Table 2-1 Sentry Master Database Fields
Maximum
Value
Example
Value
The feature applic ation database uses data contained in the sentry master database.
It is called “features” by default and contains the following fields.
Field DescriptionData Type
Monitored NumberASCII
NameASCII
Window SymbolASCII
CategoryASCII
Table 2-2 Feature Application Database Fields
Page 14NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Window Configuration Files
To create window configuration files:
1.Log in as apmadm to access the APM Administration Main Menu.
2.At the APM Administration Main Menu, type U to exit to UNIX.
3.At the UNIX prompt, type the following to change to the Sentry Alarm
Control Terminal default configuration directory:
cd /oai/app/sentry/cfg/terminals/default
4.Make a feature configuration file for each Sentry Feature by copying the
“feature.def” file us ing the following command:
cp feature.def <name.cfg>
where <name.cfg> is a unique name assigned by you. For example,
cp feature.def fire.cfg
5.Use a UNIX editor (such as vi) to edit each feature configuration file,
following the instructions contained in the file’s head er. For example,
vi fire.cfg
6.After the feature configuration files have been created and edited, use the
following command to change to the Sentry Alarm Control Terminal
configuration directory:
cd /oai/app/sentry/cfg/terminals
7.Use a UNIX editor (such as vi) to edit the Default Master Configuration file
(Mdefault.cfg). Add the full path of each feature configuration file to the list
within the Master Configuration file. For example,
vi Mdefault.cfg
Note:
Refer to the next section, Configuration Parameters on page 16 and Feature
Window Configuration on page 29 for more information about configuration
param eters .
NDA-30080 Revision 1.0Page 15
Sentry Alarm Control TerminalSentry Installation Guide
Configuration Parameters
The Sentry Alarm Control Terminal application uses configuration parameters
defined in configuration files found in the “/oai/app/sentry/cfg/terminals”
directory. The following sections describe the formats and functionality of these
files.
Master
Configuration File
When a Sentry Alarm Control Terminal is started it will determine which UNIX tty
device it is using (t ty01, tty02, etc.). It will then look f or a master config uration file
in the “/oai/app/sentry/cfg/terminals” directory that is associated with the tty
device (“/oai/app/sentry/cfg/terminals/Mtty01.cfg”, “/oai/app/sentry/cfg/
terminals/Mtty02.cfg”, etc.).
If a master configuration file has not been created for this tty then the file
“Mdefault.cfg” is used by default. Ea ch ma ster confi gurati on fi le co nta ins a list of
configuration file paths. A subdirectory is normally created to hold the
configuration fil es associat ed with th e default c onfiguration a nd each tt y (“oai/app/
sentry/cfg/terminals/default/”, “/oai/app/sentry/cfg/terminals/tty01/”, etc.).
The master configuration file can lis t files that are lo cated in different directories,
allowing different tty devices to share configuration files. Each master
configuration file contains a complete path for the following configuration files:
db.cfg
The data buffer configuration file (
See, Data Buffer Configuration File on page 17
).
init.cfg
The initialization configuration file (
See, Initialization Configuration File on page 21
logos.cfg
The screen save configuration file (
See, Screen Saver Con figuration File on page 22
).
keys.cfg
The function keys configuration file (
23
).
See, Function Ke y s Con figuration File on page
).
dialogs.cfg
The dialogs configuration file (
See, Dialogs Configuration File on page 25
).
titleBar.cfg
The title bar configuration file (
See, Title Bar Configuration on page 27
).
msgBar.cfg
The message bar configuration file (
See, Message Bar Configuration on page 28
).
login.cfg
The login screen configuration file (
See, Login Screen Configuration on page 28
).
status.cfg
The status window configuration file (
See, Status Window Configuration on page 28
xxxxxx.cfg
One or more feature window confi guration fil es (
on page 29
Page 16NDA-30080 Revision 1.0
).
See, Feature Window Conf igurati on
).
Sentry Installation GuideSentry Alarm Control Terminal
Data Buffer
Configuration File
The data buffer configuration file, “db.cfg”, contains constants and data buffer
field definitions. Data buffers are used to store fields of ASCII character
information contained in messages or read from a ter minal. The fields withi n a data
buffer may be used to build configurable display strings.
The data buffer configuration file contains field definitions consisting of a field
symbol, the number of characters in the field, and the offset of the field (offsets
start with 0). Data buffer configurations will not require modifications unless the
Sentry Alarm Control Te rminal appli cation is cha nged. The foll owing data buf fers
are defined below.
Dynamic Window Area Configuration
The dynamic window area is the portion of the screen that is used to display
dynamic windows. Usually, this area is located be tween the title and mes sage bars.
The following constants define the dynamic window area:
DYNAMIC_START
The screen positi on of the first row of the dynamic windo w area (row 0 = the first
row of the screen, row 23 = the last row of the screen).
DYNAMIC_END
The screen position of the last row of the dynamic window.
Feature Window Sorting Methods
Each feature window can have a unique sor ting method which controls the or der of
stations in the window. (See, Feature Window Configuration on page 29.) The
sorting method is selected from one of the following:
SORT_NONE
Stations are not sorted.
SORT_BY_TIME
Stations are sorted b y event time, with the newest events at the top of the window
and the oldest events at the bottom.
Feature Window Filtering Methods
Each feature window can have a unique filtering method which limits station
updates to a pa rt ic ula r class of station includin g c al le r, oper at or, and source. (See,
Feature Window Configuration on page 29.)
The filtering method is selected from one of the following:
PASS_CALLER
Stations are not sorted.
PASS_OP
Stations with a clas sificat ion of oper ator are passed. Al l other st ations a re ignore d.
PASS_SRC
Stations with a classification of source are passed. All other stations are ignored.
NDA-30080 Revision 1.0Page 17
Sentry Alarm Control TerminalSentry Installation Guide
PASS_OP_CALLER
Stations with a c lassificati on of operato r or caller are passed . All other s tations are
ignored.
PASS_SRC_CALLER
Stations with a classification of source or caller are passed. All other stations are
ignored.
PASS_SRC_OP
Stations with a classification of source or operator are passed. All other stations
are ignored.
PASS_ALL
All stations are passed.
Login Screen User Name and Password Data Buffer
Configuration
The user name and p assword data buffer is used b y t he login screen to contain the
user name and password. It contains the following fields.
U_NAME The user na me field.
U_PASSWORDThe user passw ord field.
Feature Title Data Buffer Configuration
The feature title data buffer is used to build a feature title string. It contains the
following fields:
FEAT_TITLEThe feature title field.
Feature Statistics Data Buffer Configuration
The feature statistics data buffer contains feature stati stics. The following fields are
defined:
FEAT_NAMEThe feature name field.
FEAT_EXTThe feature monitored number extension field.
FEAT_RING The ringing caller count field.
FEAT_ANSThe answered caller count field.
FEAT_RELThe released caller count field.
FEAT_QUEUEDThe queued caller count field.
FEAT_ABANDONThe abandoned caller count field.
FEAT_ACTIVEThe active caller count field.
FEAT_IDLEThe idle caller count field.
FEAT_TOTALThe total caller count field.
FEAT_RECORDThe recording flag field.
FEAT_OFFLINEThe monitor off line flag field.
Page 18NDA-30080 Revision 1.0
Sentry Installation GuideSentry Alarm Control Terminal
Clock and Caller Information Data Buffer Configuration
The clock and caller information data buffer contains date and time fields which
may be used to create date and time dis play strings. The optiona l caller status fiel ds
(along with the date and time fi elds) are used to display ca ller status. The following
fields are defined:
The numeric month (1...12, where 1 = January, 2 =
February, etc.)
The three character month name (Jan, Feb, etc.).
The full month name (January, February, etc.)
The numeric date (1...31).
The three character week day (Mon, Tue, etc.).
The full week day (Monday, Tuesday, etc.).
The last two digits of the current year (95 for 1995, 96
for 1996, etc.)
The full current year (1995, 1996, etc.).
The 24 hour v al ue (0. ..23 , wh ere 0 = midnight, 1...11
= 1:00 AM to 11:00 AM, 12 = noon, and 13...23 =
1:00 PM to 11:0 0 PM).
The 12 hour value (1...12).
The minutes value (0...59).
The seconds value (0...59).
The AM/PM string (“AM” or “PM”).
The caller window row.
The caller’s extension.
The location of the caller’s extension.
The caller’s status (“Released”, “Ringing”,
“Answered”, “Queued”, or “Abandoned”).
The caller’s class (“Operator”, “Caller”, or “Source”).
Contains the extension of the party connected to the
caller. This data is a vailable for Anno yance Trap calls
only
Sentry Alarm Control TerminalSentry Installation Guide
Function Key Assignments Data Buffer Configuration
The function key assignments data buffer contains the function key assignment
descriptions which are display ed in the function key h elp dial og (see Function K e y
Help Dialog Configuration on page 25). A function key assignment descri pt ion
field corresponding to the respective function key may be defined in the function
key assignment data buffer. The following function key assignment description
fields and the corresponding function keys are defined below.
The title bar ter mina l name data buffer contains the tt y terminal name used by the
title bar window (s ee T itle Bar Conf iguration on page 27). It conta ins the foll owing
fields:
TITLE_TERM The tt y terminal name field.
Page 20NDA-30080 Revision 1.0
Loading...
+ 98 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.