NEC Sentry Installation Guide

							NDA-30080   Revision 1.0Page 91
Sentry Installation Guide Executive Override
User-Defined 
Parameters
Note:The following parameters contain configuration pairs consisting of a keyword, at least one blank 
space, and an option. Multiple configuration pairs may be specified in a single parameter if space 
permits. Case is ignored for keywords, but options must match exactly. The configuration pairs may 
occur in any order, and the following keywords and options are supported
ParameterEntryDescription
User Defined 
#1/oai/db/cur/tenants
Contains the name of the Tenant Number database 
(see Database Requirements on page 92). If this 
parameter is blank, the Executive Override 
program sends a warning message to the APM 
and the tenant number supplied by the OAI 
configuration is used by default for all extensions. 
If an invalid parameter is specified, an error 
message is sent to the APM and the Executive 
Override program terminates.
User Defined 
#2/oai/app/sentry/
cfg/history/
Movr.cfgThe name of the history log device database (See 
Database Requirements on page 92 and Appendix 
A). If this parameter is blank, the Executive 
Override program sends a warning message to the 
APM and history logging is disabled. If an invalid 
file name is entered, an error message is sent to 
the APM and the Executive Override program 
terminates.
User Defined 
#3type Specifies the type of override this application 
performs. Valid type pairs are “type basic,” “type 
automatic,” or “type monitor.” If this option is 
invalid, the Executive Override program sends an 
error message to the APM and terminates.
User Defined 
#4join Specifies the join method used by this application. 
Va l i d  s y n t a x  i s  
join 
where  specifies the join method, which can 
be “2” or “3”. If this option is invalid, the 
Executive Override program sends an error 
message to the APM and terminates.
User Defined 
#5tone 
						

							Page 92NDA-30080   Revision 1.0
Executive Override Sentry Installation Guide
Database Requirements
Executive Override requires three databases: Authorization Code, Special Station, 
and Tenant Number. 
This section contains requirements for creating the Executive Override databases. 
Use this information with the procedural instructions in the APM Operations 
Manual. If you encounter messages during this process, refer to the “Process” and 
“Error Messages” chapters of the APM Operations Manual.
Database CreationThe following steps are done automatically during installation:
1. Create a Master Definition File
Create the master definition file that defines the fields in the master database 
file.   
2. Create an Application Definition File
Create a definition file for the Executive Override database. This file defines 
the formats by which data from the master file is to be converted to meet the 
needs of Executive Override. 
Database RecordsAfter database is created, perform the following steps to add, modify, or delete 
records:
1. Build a Master Database File
Enter data (such as phone extension numbers) into the master database fields 
that were defined in the master definition file.
2. Process the Application Database
Use the Process Application Databases option on the APM Database 
Administration menu to create the file that will be used by Executive Override. 
When the Process option is activated, data is drawn from the master database 
and converted to the formats specified in the application definition file. 
3. Install the Application Database
Use the Install Application Databases option on the APM Database 
Administration menu to enable Executive Override to copy its database.
4. Reboot each Executive Override application 
						

							NDA-30080   Revision 1.0Page 93
Sentry Installation Guide Executive Override
Authorization 
Code DatabaseEach Authorization Code database contains a list of valid authorization codes. A 
user is prompted for an authorization code when an Executive Override is 
requested from a non-secure station (see Special Station Database on page 94). 
After an authorization code is entered, the authorization code database is searched 
for a matching value. If a match is found, the Executive Override request is 
permitted; otherwise, the request is denied. An authorization code database record 
contains the following fields:
Authorization Code 
This required 
field is a unique numeric value up to ten digits long. A minimum 
number of digits may be specified by defining a minimum numeric value of the 
desired length (a minimum value of 1000 will force codes to be at least 4 digits 
long).
User Name
 The name of user that is assigned the access code.  This field is optional.
User Extension 
The extension of the user that is assigned the access code.  This field is optional.
Each Authorization Code master database must have a unique name and contain 
the following field. 
Table 5-2  Authorization Code Master Database Fields
Each Authorization Code application database must have a unique name and 
contain the following fields.
Table 5-3  Authorization Code Application Database Fields Field Description Type SizeMinimum 
Va l u eMaximum 
Va l u e
Authorization Code Numeric 10 0 9999999999
User Name ASCII 25
User Extension Numeric 5 0 99999
Field Description Data Type
Authorization Code Long Integer
User Name ASCII
User Extension Long Integer 
						

							Page 94NDA-30080   Revision 1.0
Executive Override Sentry Installation Guide
Special Station 
DatabaseEach special station database contains a list of stations that receive special 
treatment by Executive Override. A station in this database may be designated 
secure, protected, both, or neither. Stations which are not listed in this database are 
assumed to be neither secure nor protected. If a station is designated secure, then 
an authorization code is not needed to perform an Executive Override from this 
station. If a station is designated protected, then conversations on this station can 
not be monitored or joined by Executive Override. A special station database 
record contains the following fields:
Extension (Required) - A unique station extension.
Secure (Required) - Set to ‘y’ if the station is in a secure area, ‘n’ otherwise.
Protected (Required) - Set to ‘y’ if conversations on this station are protected 
from Executive Override, ‘n’ otherwise.
Each Special Station master database must have a unique name and contain the 
following field.
Table 5-4  Special Station Master Database Fields
Each Special Station application database must have a unique name and contain the 
following fields.
Table 5-5  Special Station Application Database Fields Field Description Type SizeMinimum 
Va l u eMaximum 
Va l u e
Extension Numeric 5 0 99999
Secure ASCII 1 n
Protected ASCII 1 n
Field Description Data Type
Extension Long Integer
Secure ASCII
Protected ASCII 
						

							NDA-30080   Revision 1.0Page 95
Sentry Installation Guide Executive Override
Tenant Number 
DatabaseThe Tenant Number database is shared by other Sentry applications, so you might 
not have to build it for Executive Override. You will receive a message from the 
APM if you try to build the Tenant database and it already exists.
The Tenant Number database contains a list of extensions and associated tenant 
numbers used by the PBX. A tenant number can be associated with an individual 
numeric extension or a range of numeric extensions. A given tenant number can 
have more than one record if all of the extensions associated with it are not 
consecutive. 
Tenant numbers can also be associated with individual extensions that contain non-
numeric characters such as ‘*’ or ‘#’. If all extensions have the same tenant 
number, then this database is not required and the tenant number provided by the 
OAI configuration may be used by default. Each tenant number database record 
contains the following fields:
First Extension - The first extension in the range of extensions.
Last Extension - The last extension in the range of extensions.
Te n a n t  N u m b e r - The associated tenant number.
The Tenant Number master database is named “tenant_m” by default and contains 
the following fields.
Table 5-6  Tenant Master Database Fields
The Tenant Number application database is named “tenants” by default and 
contains the following fields.
Table 5-7  Tenant Number Application Database Fields Field Description Type SizeMinimum 
Va l u eMaximum 
Va l u e
First Extension ASCII 10
Last Extension ASCII 10
Tenant Number Numeric 3 1 255
Field Description Data Type
First Extension ASCII
Last Extension ASCII
Tenant Number Short Integer 
						

							Page 96NDA-30080   Revision 1.0
Executive Override Sentry Installation Guide
Executive Override Configuration Sample
Suppose your site wants to use Basic Override with warning tone, Automatic 
Override with warning tone, and Monitor Override. The Automatic Override 
timeout is specified as 15 seconds, and the “no answer” timeout is specified as 20 
seconds. All categories will create three party conferences and share a single list of 
authorized users. 
The Basic and Automatic Overrides share a special stations database, while the 
Monitor Override has its own special stations database. Each category logs history 
events to a common file, and each has a separate history log file. All categories 
share a common serial printer. 
The following steps can be taken to determine the configuration required:
1. Determine the number of APM configurations needed
In this case, three APM configurations are used:
Basic Override with tone and three party conferences
Automatic Override with tone and three party conferences
Override with three party conferences
2. Create the authorization code databases
One authorization code database is required by this example, and is called 
“authCodes”.
3. Create the special station databases
Two special databases are required by this example. They are named as 
follows:
“stations1”: this database is shared by the Basic and Automatic Over-
rides.
“stations2”: this database is used by Monitor Override.
4. Create the history log device databases
Three history log device databases are required by this example. Each 
database file contains entries for the common history log file, the separate 
history log file, and the common serial printer. The databases are named as 
follows:
“Movr1.cfg”: this database is used by the Basic Override.
“Movr2.cfg”: this database is used by the Automatic Override.
“Movr3.cfg”: this database is used by Monitor Override.
For more information about the history log, see Appendix A: History 
Logging on page 109.
5. Create the APM configurations
The following APM configurations are defined for this example. Note that 
only parameters used to differentiate between configurations are listed (see 
Configuration on page 87 for a complete list). Also note that the path names 
used are dependent upon installation and are provided here for illustration 
purposes only. 
						

							NDA-30080   Revision 1.0Page 97
Sentry Installation Guide Executive Override
Executive Override Configuration Sample (Continued)
Basic Override with tone and three way conferences uses the following 
configuration:
Executable File Name: “/oai/app/sentry/bin/override”
Application Name: “BasicToneThreeWay”
Application Database 1: “/oai/db/cur/auth1”
Application Database 2: “/oai/db/cur/stations1”
Time Out Value 1: 20
Time O ut Value 2: 0
MSF Assignments: 140
User Defined 1: “/oai/db/cur/tenants”
User Defined 2: “/oai/app/sentry/cfg/history/Movr1.cfg”
User Defined 2: “type basic   tone 1   join 3”
Automatic Override with tone and three way conferences uses the following 
configuration:
Executable File Name: “/oai/app/sentry/bin/override”
Application Name: “AutoToneThreeWay”
Application Database 1: “/oai/db/cur/auth1”
Application Database 2: “/oai/db/cur/stations1”
Time Out Value 1: 20
Time Out Value 2: 15
MSF Assignments: 141
User Defined 1: “/oai/db/cur/tenants”
User Defined 2: “/oai/app/sentry/cfg/history/Movr2.cfg”
User Defined 3: “type automatic   tone 1   join 3”
Monitor Override with three way conferences uses the following configuration:
Executable File Name: “/oai/app/sentry/bin/override”
Application Name: “MonitorThreeWay”
Application Database 1: “/oai/db/cur/auth2”
Application Database 2: “/oai/db/cur/stations2”
Time Out Value 1: 20
Time O ut Value 2: 0
MSF Assignments: 142
User Defined 1: “/oai/db/cur/tenants”
User Defined 2: “/oai/app/sentry/cfg/history/Movr3.cfg”
User Defined 3: “type monitor   join 3” 
						

							Executive Override Sentry Installation Guide
Page 98NDA-30080   Revision 1.0
This Page Left Blank. 
						

							NDA-30080   Revision 1.0Page 99
Sentry Installation Guide MAT Assignments and PBX Information
Chapter 6 MAT Assignments and PBX Information
This chapter 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 Control 
Terminal.
PBX Software
The Sentry applications require PBX Software Version DE 6.25 or higher.  This 
version provides the following features:
1. An SCF 3 will work with a single line (analog ) telephone.
2. The SCF 3 timeout is disabled, so the SCF 3 will ring the calling party until the 
calling party answers or the call is terminated.
3. The inter-digit timer will generate an off hook alarm when an incomplete 
extension is dialed.
MAT Assignments
This guide assumes that data settings that affect the operation of all OAI software 
on a system-wide basis have already been assigned on the NEAX MAT. Such 
settings include system index values which are described in “Emergency 
Conference” on page 102 (step 7) and assignment of Interface I/O Port Data in the 
Interface Processor (IP). For more information about these system data settings and 
the MAT commands described below for Sentry Alarm Control Terminal, refer to 
the OAI Module Installation Manual for the NEAX2400 IMS, the NEAX2400 IMS 
Command Manual, the NEAX2400 IMS Job Specification Manual, and the 
NEAX2400 IMS Programming Manual.
Executive OverrideThe user-defined parameter #6 assigned during the application configuration  
identifies the function key that the phone user presses to activate Executive 
Override. You must now assign this key at the MAT to the Mode Set Facility 
(MSF) for all D
terms that will be able to display calling party information.  Using the 
AOKC command, assign the MSF facility and its Op-Code to one of the 14 OAI 
Key Codes in the MAT. Each of these OAI Key Codes corresponds to an AKYD 
Function Key Index (FKI) value that is then assigned to the specific D
term function 
key. This process is illustrated in Figure 6-1. 
						

							Page 100NDA-30080   Revision 1.0
MAT Assignments and PBX Information Sentry Installation Guide
Executive Override 
(Cont)
Figure 6-1   OAI Function Key Assignment
A knowledge of the Dterm stations in the NEAX system and which ones will be set 
up to access Sentry Alarm Control Terminal is necessary for using the following 
commands.  Executive Override requires the following PBX programming.  You 
should program one or more D
term function keys on the desired stations to generate 
the appropriate MSF values (AOKC, AKYD) required by each Executive Override 
configuration.
AOKC Command: (Assignment of OAI Key Codes)
This command is used to associate the MSF facility and its Op-Code that was 
configured in the APM for the application to one of the OAI Key Codes in the 
MAT. 
1. Select an unused OAI Key Code, from 1 to 14. To determine what Key Codes 
are available for assignment, use the LOKC command to list the AOKC Key 
Codes that are already assigned. 
2. Enter the type of facility using the value that designates the MSF. 
3. Enter the same MSF Op-Code that was configured for Executive Override in the 
APM. Retrieve it using the Providers command on the APM Configuration 
Entry screen. 
APM
Application
Configuration
Designation of
 Facility 
(Type)
 and its Op-
Code
 for Use by 
Application
MAT
AOK C
Command
Assignment of
 an OAI 
Key Code
 (between 1 
and 14)
 to the Same 
Facility Type and Op-
Code
MAT
AKYD
Command
Assignment of 
Corresponding MAT 
Function Key Index to 
a
 specific Dterm 
Function Key
. . . . .. . . . .
. . .
. . .
  
PBX Correspondence of
 AOKC AKYD
  OAI Function
 Key Codes
Key Indices
  1 < . . . .> 34
  2 < . . . .> 35
  3 < . . . .> 36
  4 < . . . .> 37
  5 < . . . .> 38
  6 < . . . .> 39
  7 < . . . .> 40
  8 < . . . .> 41
  9 < . . . .> 42
 10 < . . . .> 43
 11 < . . . .> 44
 12 < . . . .> 45
 13 < . . . .> 46
 14 < . . . .> 47