NEC Guardian An Open Application Interface Operations Manual

							NDA-30008   Revision 2.0Page 11
Guardian Operations Manual Installation Introduction
Application Configuration
Guardian is configured into the APM system using the Add function of the 
Application Configuration option on the APM System Administration menu.
1. Enter the APM option from the APM Platform Management Menu.
2. Enter the system administrator password at the APM password screen. 
3. Enter the Application Configuration option from the System Administration 
menu.
This section contains the information that you should enter into the configuration 
file for Guardian. For specific instructions on what these parameters mean and how 
to make these entries, use the APM Operations Manual.
Setting up Multiple 
TenantsA tenant is defined as a group of users that may represent a campus, a corporate 
department, or an entire organization. Using Guardian, you can have one or 
multiple tenants. For instance, a university may be configured as one tenant, or 
each of its campuses or academic departments may be configured as a tenant, 
depending upon the needs of the university. Each tenant is associated with an 
application name. This name must then be specified before any action can be taken 
through the Administration menu. Multiple tenants can be handled in either of two 
ways: 
Each tenant can be configured individually and identified by a unique 
application name (e.g., Guardian1 or Guardian2). In configuring each tenant, 
only the application name and the tenant number (through OAI-Conf 
command) must be changed. Once the tenants are configured, the Guardian 
system administrator can specify a specific tenant’s application name so that all 
actions taken through the menu options affect only the indicated tenant rather 
than all of the tenants.
Guardian can be configured once for tenant No. 0, which means all tenants. The 
single configured application name is then used to gain access to the 
Administration menus, and all actions taken thereafter through those menu 
options affect every tenant served by Guardian.
If there is more than one switch in a network, Guardian will work with all the 
PBX’s and maintain its reports and database no differently than a single switch 
environment. 
There should be a separate application configuration in the APM for each Guardian 
switch. All parameters should be identical except for the destination link, standard 
out file and Guardian ID (UDP #14).
Note:The following installation is based upon a single tenant (#0). If you need multiple 
tenants, complete this configuration for each one. 
						

							Page 12NDA-30008   Revision 2.0
Installation Introduction Guardian Operations Manual
Step 1: Application 
CharacteristicsIn adding Guardian to the APM Application Configuration file, define it as an OAI 
application that does not need a CRT or a communication queue, as follows:
Step 2: Primary 
Configuration 
ParametersOn the Configuration Entry screen, make the entries shown below to the 
parameters indicated:
Table 2-1  Application Characteristic Entries
Parameter Entry Description
OAI Application (Y,N) Y Indicates whether or not (Yes or No) this 
tenant communicates with the NEAX using 
OAI processes.
CRT Application (Y,N) N Indicates whether or not (Yes or No) this 
tenant requires a terminal screen that is of 
the same type as the one used by the APM.
Communication Queue (Y,N) N Indicates whether or not (Yes or No) this 
non-OAI application needs an IPC queue to 
communicate with other process.
Table 2-2  Primary Configuration Parameter Entries
Parameter Entry Description
Application  Name Guardian The unique logical name of this application.
Executable Filename /oai/app/guard/grdrt The path name of the executable file.
Group (no entry) (Guardian is not a member of a group of 
applications.)
Response Mode I This is a default value since Guardian does 
not belong to a group.
Initialization Batch Y Guardian is set to initialize automatically 
when the OAI system is initialized.
Termination Mode  M Guardian is set to receive a termination 
message from the APM when it is to 
terminate, rather than a kill or termination 
signal.
Standard Output /oai/log/dbg/grd.dbg Guardian’s output is sent to this file.
Number of Restarts 5 Guardian may be restarted by the APM up 
to 5 times that it terminates erroneously. 
						

							NDA-30008   Revision 2.0Page 13
Guardian Operations Manual Installation Introduction
Step 3: OAI 
FacilitiesAccording to instructions in the APM Operations Manual, designate the following 
PBX facility for Guardian using the Facilities command on the Configuration 
Entry screen:
Authorization Code Facility (ACF)
Step 4: Secondary 
OAI Configuration 
ParametersUsing the OAI-Conf command on the Configuration Entry screen, make the entry 
shown for each of the following parameters required by Guardian. Use the 
instructions provided for this option in the APM Operations Manual:
Table 2-3  Secondary Configuration Parameter Entries
Parameter Entry Description
Database  Name  #1 /oai/app/guard/data/ The path name of the database that contains 
the back-up files.
Database  Name  #2 /oai/db/cur/ The path name of the database that contains 
the current master databases.
Timeout Value #1 30 The number of seconds Guardian waits 
before trying to reopen a PBX facility that 
has been closed.
Tenant Number 0 This configuration applies to all tenants. 
(See “Setting up Multiple Tenants” on 
page 11..)
Source Link Name OAI1TCP The port on the source side of the 
communication link. Entry should 
correspond to a Link Name in the APM 
System Configuration file. 
Destination Link Name PBX1TCP The port on the destination side of the 
communication link.
Association Recovery 60 The number of seconds Guardian waits 
before trying to reestablish an association 
with the NEAX that has been released. 
						

							Page 14NDA-30008   Revision 2.0
Installation Introduction Guardian Operations Manual
Step 5: User-
Defined 
ParametersMake the following additional parameter entries through the UserDefined 
command on the APM Configuration Entry screen.
Table 2-4  User-Defined Parameter Entries
Parameter Entry Description
User Defined #1 10 IO Delay Factor – The period of time in 
which Guardian collects a block of codes 
before recording them.
User Defined #2 5 IO Block Factor – The number of historical 
records accumulated and written as a unit to 
the history file.
User Defined #3 4 Default Disable Time – For Group 0 
(default group), the amount of time that any 
extension in the group is to be system 
disabled in response to an excessive 
frequency of invalid call attempts.
User Defined #4 3 Frequency Period – For Group 0, the time 
interval in minutes in which invalid call 
attempts are counted to obtain a frequency. 
User Defined #5 3 Frequency Count – For Group 0, the 
number of invalid attempts that are counted 
before the frequency is considered 
excessive and the extension is system 
disabled.
User Defined #6 100 Lifetime Invalid Attempts – For Group 0, 
the maximum lifetime number of 
accumulated invalid requests that are 
allowed before the extension is system 
disabled.
User Defined #7 /oai/app/guard/grdrc Record File – The path name of the file in 
which processing data is recorded for 
reporting purposes.
User Defined #8 vvvvvvviii  Authcode Mask – A string of characters 
designating which digits of a dialed 
authorization code are to be verified, using 
the following characters:
Note:
The verifiable digits of the mask must 
be consecutive.
I or i: Ignore the digit in this position of 
the code.
V or v: Verify the digit in this position of 
the code. 
						

							NDA-30008   Revision 2.0Page 15
Guardian Operations Manual Installation Introduction
This completes the configuration of Guardian in the APM. See “Database 
Requirements” on page 16. to create its databases.
User Defined #9 /oai/app/guard/ Base Directory – The path name, where 
binary files reside.
User Defined #10 /oai/db/cur/grdacf Authorization Code Database – The path 
name of the Authorization Code database.
User Defined #11 /oai/db/cur/grdgrpf Group Database – The path name of the 
Group database.
User Defined #12 /oai/db/cur/grdextf Extension Database – The path name of the 
Extension database.
User Defined #13 /oai/db/cur/grdutf Time Interval Database – The path name of 
the Time Interval database.
User Defined #14 1 Integer – Guardian ID (1-10); Unique for 
each switch in the network.
Table 2-4  User-Defined Parameter Entries
Parameter Entry Description 
						

							Page 16NDA-30008   Revision 2.0
Installation Introduction Guardian Operations Manual
Database Requirements
Each configured Guardian tenant requires five working databases (Group, 
Authorization Code, Extension, Time Interval, and ID). Each database is created 
through the Database Administration option on the APM System Administration 
Menu. Database creation involves the following four-step process for each 
required database:
1.Create a Master Definition File: This step involves creating the master defini-
tion file that defines the fields in the master database file. Four master definition 
files must be created for Guardian the following databases: Group, Authoriza-
tion Code, Extension, and Time Interval. The Authorization Code master defi-
nition file supports both the Authorization Code and the ID databases. When 
more than one tenant has been configured for Guardian, one master definition 
file and master database file can support the database required for each tenant. 
That is, for example, if three tenants have been configured, one Group master 
definition file and one Group master database file can support three Group da-
tabases, one for each tenant.
2.Build a Master Database File: This step involves entering tenant-specific data 
(e.g., extensions, group definitions, authorization codes, student IDs, or time in-
tervals) into the master database fields that were just defined in the four master 
definition files in Step 1.
3.Create an Application Definition File: In this step, a definition file is created 
for each of the Guardian databases for each tenant. This file defines the formats 
by which data from the corresponding master file is to be converted to meet the 
needs of Guardian.
4.Process the Application Database: In this step, the Process/Install Application 
Databases option on the APM Database Administration menu creates the file 
that will be used by Guardian. When the Process command is activated, data is 
drawn from the master database and converted to the formats specified in the 
corresponding application definition file. The Install command on the Process/
Install Application Databases option is activated to enable the Guardian tenant 
to copy its database into a working file.
InstructionsThe information required in all four steps for each Guardian database is provided 
in table form on the following pages. Using this information with the procedural 
instructions provided in the APM Operations Manual, enter the Database 
Administration option on the APM System Administration Menu, and build the 
Guardian databases, one at a time
. Any messages displayed during these steps are 
addressed in the Process and Error Messages chapter of the APM Operations 
Manual.
Note:Complete Step 4, Process the Application Database, for each database after en-
tering the information on the following pages.
Step 1
 - Create
Master Definition FileStep 2 
- Build
Master Database FileStep 3
 - Create
Application Definition FileStep 4
 - Process
Application Database 
						

							NDA-30008   Revision 2.0Page 17
Guardian Operations Manual Installation Introduction
Group Database 
InformationThe Group database field entries are shown in the table below and defined in “Field 
Definitions” on page 17. Name the master definition file grdgrpf
_m and the 
application definition file grdgrpf.
Field Definitions
Group ID – A number that identifies a group, lying within the range from 1 to 
1000. This is the key field for database sorting, so entries must be arranged in 
ascending order. 
Note:
Groups 1-9 have access to all authorization codes and extensions; groups 10-
1000 have access to only the codes and extensions assigned to them.
Interval Index – The index to the specific interval of time in the Time Interval 
Database during which the group extensions are routinely, administratively 
turned off. The index uses the following values:
0: Constantly off.
1-15: Index that corresponds to the desired time interval in the Time Interval 
Database.
Temp Disable Time Max – Number of 15-minute periods that extensions in the 
group will be automatically, temporarily turned off by the system in response to 
an excess frequency of invalid call attempts; maximum 255 periods.
Lifetime Invalid Attempts – The maximum lifetime number of accumulated 
invalid requests that are allowed before the extensions in the group are turned 
off by the system; maximum 255 requests.
Frequency Period – The time interval in minutes in which invalid call attempts 
are counted to obtain a frequency; maximum 15 minutes.
Frequency Count – The number of invalid call attempts that are counted before 
the frequency is considered excessive, and the extension is turned off by the 
system; maximum of 7 requests.
Table 2-5  Group Database Field Entries
Field DescriptionMaster Definition File Application 
Definition File Master 
Database
Type Size Min.
ValueMax.
ValueData Type Typical
Entry
Group ID N 4 1 1000 Short Integer 2
Interval Index N 2 0 15 Short Integer 5
Temp Disable Time 
MaxN 3 0 255 Short Integer 2
Lifetime Invalid 
AttemptsN 3 0 255 Short Integer 255
Frequency Period N 2 0 15 Short Integer 10
Frequency Count N 1 0 7 Short Integer 2 
						

							Page 18NDA-30008   Revision 2.0
Installation Introduction Guardian Operations Manual
Authorization 
Code and ID 
Database 
InformationThe Authorization Code master definition file and master database file support 
both the Authorization Code database and the ID database. Create separate 
Authorization Code and ID application definition files to process the master 
database into the two separate databases. Name the master definition file 
grdacf
_m, name the Authorization Code application definition file grdacf, and 
name the ID application definition file grdidf, as shown below:
The Authorization Code database field entries are shown in the table below and 
defined in Field Definitions on page 19:
†Use these values for the NEAX2400.
Authorization Code
Application Definition File
&Database
grdacfMaster Definition File
& Master Database
grdacf_m
ID
Application Definition File
&Database
grdidf
Table 2-6  Authorization Code Database Field Entries
Field DescriptionMaster Definition File Application 
Definition 
File* Master
Database
Type Size Min.
ValueMax.
ValueData Type Typical 
Entry
Authorization Code* A 10 ASCII 1246247
Assigned A 1 ASCII Y 
ID* A 10 ASCII 585241398
Interval Index N 2 0 15 Short Integer 5 
Extension or Group
FlagA 1 ASCII G 
Extension/Group 
ValueN 5 0 99999 Long Integer 2 
Route Restriction 
ClassN20†15†Short Integer 5 
1‡8‡
Service Feature Class N 2 0†15†Short Integer 1 
1‡8‡
Reserved A 2 ASCII (
No Entry)  
						

							NDA-30008   Revision 2.0Page 19
Guardian Operations Manual Installation Introduction
‡Use these values for the NEAX2000.
*The fields of the two application definition files (Authorization Code and ID) that 
are derived from the authorization code master database must be entered in the 
following sequence:
Order Authcode Definition File ID Definition File
#1 Authorization Code ID
#2 Interval Index Authorization Code
#3 Extension/Group Value
#4 Route Restriction Class
#5 Service Feature Class
#6 Extension or Group Flag
#7 Assigned
#8 Reserved
Field Definitions
Authorization Code – Key field of the Authorization Code Database consisting 
of ten digits. Codes must be arranged in ascending order. The authorization 
code is also the second field in the ID Database.
Assigned – Indicates whether or not (Yes or No) this authorization code has 
been assigned to a telephone user.
ID – The telephone user identification number assigned to this authorization 
code.
Interval Index – The index to the specific interval of time in the Time Interval 
Database during which the authorization code is routinely disabled. The index 
uses the following values:
0: Constantly off.
1-15: Index to an interval in the Time Interval Database.
Extension or Group – The assignment of the authorization code to a single 
extension or to a group of extensions. Possible field entries are as follows:
Ext: Extension
Grp: Group
Extension/Group Value – The actual extension or group to which the 
authorization code is assigned, corresponding to the Extension or Group 
assignment:
If assignment is Ext: An extension number of up to 5 digits in length.
If assignment is Grp: A group ID ranging from 1 to 1000.
Route Restriction Class – A value from 0 to 15 on the NEAX2400 or a value 
from 1 to 8 on the NEAX 2000 that represents different combinations of 
distance and routing privileges available to code holders.
Service Feature Class – A value from 0 to 15 on the NEAX2400 or a value 
from 1 to 8 on the NEAX 2000 that represents different combinations of PBX 
call processing features available to code holders.
Reserved – System-reserved space. This field is not modified by the user. 
						

							Page 20NDA-30008   Revision 2.0
Installation Introduction Guardian Operations Manual
Extension 
Database 
InformationThe Extension database field entries are shown in the table below and defined in 
“Field Definitions” on page 20. Name the Extension master definition file 
grdextf
_m and the application definition file grdextf.
Field Definitions
Extension No. – The extension number of up to 5-digits in length. This is the 
key field of the database, and entries must be arranged in ascending order.
Group ID – The identification number of the group to which the extension is 
assigned. This number must lie within the range from 1 to 1000.
Interval Index – The index to the specific interval of time in the Time Interval 
database during which the extension is routinely, administratively turned off. 
The index uses the following values:
0: Constantly off.
1-15: Index of the Time Interval database corresponding to the desired time 
interval.
Time Interval 
Database 
Information The Time Interval database field entries are shown in the table below and defined 
in Field Definitions on page 21. Name the Time Interval master definition file 
grdutf
_m and the application definition file grdutf.
Table 2-7  Extension Database Field Entries
Field DescriptionMaster Definition File Application 
Definition FileMaster
Database
Type Size Min.
ValueMax.
ValueData Type Typical
Entry
Extension Number N 5 0 99999 Long Integer 3601
Group ID N 4 0 1000 Short Integer 2
Interval Index N 2 0 15 Short Integer 5
Table 2-8  Time Interval Database Field Entries
Field DescriptionMaster Definition File Application 
Definition FileMaster
Database
Type Size Min.
ValueMax.
ValueData Type Typical
Entry
Interval Index N 2 0 15  Short Integer 5
Begin Day of Week N 1 0 6 Short Integer 5
Begin Hour N 2 0 23 Short Integer 22
Begin Minute N 2 0 59 Short Integer 0
End Day of Week N 1 0 6 Short Integer 1
End Hour N 2 0 23 Short Integer 5