NEC Code Master An Open Application Interface Installation Guide

							NDA-30013   Revision 6.0Page 11
Code Master Installation Guide Application Configuration
Step 4 – Secondary OAI Configuration Parameters
Using the OAI-Conf command on the APM Configuration Entry screen, make the 
entry shown for each of the following parameters required by Code Master. Use the 
instructions provided for this option in the APM Operations Manual:
Parameter
EntryDescription
Database Name #1 /oai/db/cur/cmdb The path name of the tenant mask 
database. The database filename 
cmdb, shown here with its path, 
should be used as the name of the 
corresponding Application 
Definition File (see Database 
Requirements).
Database  Name  #2 /oai/db/cur/authdb The path name of the authorization 
code database. The database 
filename authdb, shown here with 
its path, should be used as the name 
of the corresponding Application 
Definition File (see Database 
Requirements). 
Timeout Value #1 60 The number of seconds to spend 
collecting codes from call attempts 
before recording.
Timeout Value #2 10 The number of codes to collect 
before recording them.
Tenant  Number 0 The number of the tenant served by 
Code Master; 0 means all tenants.
Source  Link  Name OAI1TCP The UAP 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 PBX port on the destination 
side of the communication link; 
entry should correspond to a Link 
Name in the APM System 
Configuration file.
Association Recovery 15 The number of seconds Code 
Master will wait before trying to 
reestablish an association with the 
NEAX that has been released. 
						

							Page 12NDA-30013   Revision 6.0
Application Configuration Code Master Installation Guide
Step 5 – User-defined Parameters
Make the following additional parameter entries through the User Defined 
command on the APM Configuration Entry screen.
Parameter
EntryDescription
User Defined #1 0 Specifies the method of recording 
authorization codes dialed, using 
the following values: 
0 = no codes recorded
1 = invalid codes only
2 = valid codes only
3 = all codes recorded
User Defined #2 /oai/app/auth.record Indicates the path name of the 
executable file for the recorder 
program.
User Defined #3 /oai/log/auth.log Indicates the path name of the file 
or device for recording codes used 
in attempted calls. 
						

							NDA-30013   Revision 6.0Page 13
Code Master Installation Guide Database Requirements
Chapter 3 Database Requirements
Code Master requires the following two databases, both of which are created 
through the APM:
Tenant/Mask Database
This database contains all of the tenants served by Code Master and for each, 
the mask that defines the contents of the required authorization code. This 
database is configured as /oai/db/cur/cmdb.
Authorization Code Database
This database contains all of the authorization codes that can access Code 
Master and for each, the tenant to which it is assigned. This database is 
configured as /oai/db/cur/authdb.
Each database is created through the Database Administration option on the APM 
System Administration Menu. Database creation involves the following five-step 
process for each required database
:
 
1.Define Master Database Fields: This step creates the master definition file that 
defines the fields in the master database file. Code Master requires two separate 
sets of files, one for the tenant data and one for the authorization code data.
2.Build Master Database: This step involves entering data (e.g., authorization 
codes) into the master database fields that were just defined in the master defi-
nition files in Step 1.
3.Specify Application Database Fields: This step creates a definition file for 
each of the Code Master databases. This file defines how data from the corre-
sponding master file is to be converted to meet the needs of Code Master.
4.Process Application Database: This step uses the Process Application Data-
base option on the APM Database Administration menu to create the file that 
will be used by Code Master. 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, enabling Code Master to copy its da-
tabase into a working file.
5. Install Application Database: This step installs the Application Database by 
activating the Install Application Database option on the APM Database Ad-
ministration menu.
Step 1 – Create
Master Database 
FieldsStep 2 – Build
Master 
DatabaseStep 3 – Specify 
Application Database 
FieldsStep 4 – Process
Application 
DatabaseStep 5 – Install
Application 
Database 
						

							Page 14NDA-30013   Revision 6.0
Database Requirements Code Master Installation Guide
Instructions
The information required for each Code Master database is provided in table form 
in Tenant/Mask Database Information on page 14 and Authorization Code 
Database Information on page 15. Using this information alongside of the 
procedural instructions provided in the APM Operations Manual, enter the 
Database Administration option on the APM System Administration Menu, and 
build the Code Master 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:
Remember to complete Step 4, Process Application Database, and Step 5, Install 
Application Database, for each database after entering the information on the 
following pages in Steps 1 through 3.
Tenant/Mask Database Information
This database contains all of the tenants served by Code Master and, for each, the 
mask that specifies how the authorization code data must be entered by telephone 
users. Name the master definition file cmdb
_m and the application definition file 
cmdb.
† – Note that the maximum value for the NEAX2000 is 64 and the maximum 
value for the NEAX2400 is 255. 
Field Definitions:
Tenant Number – The tenant served by Code Master. If the mask is to apply to 
all tenants, enter exactly one record with a tenant number of 0. Otherwise, 
specify a record between 1 to 255.
Field DescriptionMaster Definition FileApplication Defini-
tion FileMaster
Database
Ty p e S i z eMin.
Va l u eMax.
Va l u eData TypeTypical
Entry
Te na n t N u m b e r
N300064†Integer 0
MaskA 10 ASCII 1vvvvvviii 
						

							NDA-30013   Revision 6.0Page 15
Code Master Installation Guide Database Requirements
Mask – The ten-character notation that indicates how the authorization code 
must be entered by telephone users assigned to this tenant, using the following 
format:
Digit – The exact digit (0-9) that must be entered by the user for Code Master 
to validate the authorization code.
v – Indicates that this position should be read as a digit of the authorization 
code of up to ten characters that must be validated (compared to the Autho-
rization Code Database).
i – Used as fillers to complete the authorization code to a length of ten char-
acters. For example, given the typical entry specified above, an authorization 
code for any tenant is valid if the first digit is “1” and the next six digits 
match an entry in the Authorization Code Database. The last three digits of 
the code, if any, will be ignored.
Authorization Code Database Information
This database contains all of the authorization codes and the tenant numbers to 
which they are assigned. Name the master definition file authdb
_m and the 
application definition file authdb.
Field DescriptionMaster Definition FileApplication 
Definition File Master Data-
base
Ty p e S i z eMin.
Va l u eMax.
Va l u eData TypeTypical
Entry
Authorization 
Code
A 10 ASCII 574869
Tenant
Number Field 1A 25 ASCII 1,2,3,4,
Tenant
Number Field 2A 25 ASCII 5,6,7,8
Tenant
Number Field 3A 25 ASCII 9,10,11,
Tenant
Number Field 4A 25 ASCII 12,13,14,15,
Tenant
Number Field 5A 25 ASCII 16,17,18,19,20,
Tenant
Number Field 6A 25 ASCII 21,22,23,24,25,
Tenant
Number Field 7A 25 ASCII 26,27,28,29,
Tenant
Number Field 8A 25 ASCII 30,31,32,33,34
Restriction N 2 0 15 Short Integer 0 
						

							Page 16NDA-30013   Revision 6.0
Database Requirements Code Master Installation Guide
Field Definitions:
Authorization Code – An actual authorization code; valid characters are digits 
0 – 9, #, and *. Records are sorted in ascending order. An entry may be less than 
ten digits long, and should be equal in length to the verifiable portion specified 
in the mask.
Tenant Number Field – A sequence of one or more tenants entered in the 
Tenant/Mask database to which this authorization code is assigned; tenant 
numbers should be entered separated only by commas, no spaces. If multiple 
tenant number fields are used, the last number in each field must have a comma 
except for the last tenant number in the last tenant number field does not require 
a comma. If the tenant number is 0, the authorization code is used by all tenants.  
The maximum number of tennant numbers is 50.
Restriction - If a restriction code (RSC) is entered, this RSC is returned to the 
PBX to be assigned to the station using the authorization code facility. After the 
call is completed, the station will use the default RSC. If the restriction code is 
0, the authorization code will use the restriction of the PBX.
Note:
DO NOT change the types and sizes of the fields! 
						

							NDA-30013   Revision 6.0Page 17
Code Master Installation Guide NEAX Command Assignments
Chapter 4 NEAX Command 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 NEAX2400 
Maintenance Administration Terminal (MAT) commands, the NEAX2000 
Customer Administration Terminal (CAT), or the NEAX2000 Maintenance 
Operations Console (MOC).   Such settings include, for instance, system index 
values and assignment of Interface I/O Port Data in the Interface Processor (IP). 
For more information about the system data settings and about the Code Master 
settings discussed in this section, refer to the following technical manuals for the 
specific NEAX system in use:
OAI System Manual.
Command Manual.
Job Specification.
Programming Manual (for RDS, MDS, and HDS systems).
System Data Design Manual (for ICS systems).
Code Master is only effective if the Authorization Code or Forced Account Code 
service feature is engaged, and the station has been assigned to use the feature. The 
following data assignments set up this configuration on the NEAX MAT.
NEAX2400 Commands
Use the NEAX2400 Maintenance Administration Terminal (MAT) to enter these 
commands.
ASYD: 
(Assignment of 
System Data)This command is used to set the following specific system data indices needed to 
support Code Master: 
System Data 1:
Index 43, bit 0 For remote access to PBX, is authorization code required 
after ring back tone (RBT)?
0 = Yes
1 = No.
Index 43, bit 2 Will SST be sent after dialing access code? 
0 = No
1 = Yes
System Data 2:
Index 3, bit 5 0 = Authorization Code
1 = Forced Account Code 
						

							Page 18NDA-30013   Revision 6.0
NEAX Command Assignments Code Master Installation Guide
ASPA: 
(Assignment of 
Special Access 
Code)This command is used to designate the kind of service or the route to be used when 
a trunk access or special access code has been entered. Services include, for 
instance, speed calling, attendant manual override, individual trunk access, 
authorization code/forced account code, call park remote retrieval, least cost 
routing, etc.
(a) Enter the same tenant number that was configured for the application 
through the APM.
(b) Enter Service Code (SSC) as Kind of Service (SRV).
(c) Enter Normal Service (N) as the Connection Status Index (CI),
(d) Enter 42 to indicate Authorization Code and Forced Account Code as the 
Service Feature Index (SID).
(e) Enter as the Number of Necessary Digits (NND) the number of service ac-
cess code digits that users will need to input at the D
term.
AMND: 
(Assignment of 
Maximum 
Necessary Digits)This command is used to assign the maximum number of digits to be read as the 
authorization code or forced account code. More than one entry may be made to 
support multiple patterns.
(a) Always specify the tenant number (TN) 0, indicating that the MND will ap-
ply to authorization codes. 
(b) Specify the destination code (DC) to enable the PBX to recognize the dialed 
digits as an authorization code.
(c) Specify the maximum necessary digits (MND), from 1 to 10, that comprise 
an authorization code, including the destination code.
For example, suppose that you want seven-digit authorization codes with 1 or 2 as 
the first digit. Use AMND to enter the following data:
TN=0, DC=1, MND=7
and 
TN=0, DC=2, MND=7
AATC: 
(Assignment of 
Authorization 
Code Data)This command is used to provide the PBX with a backup database of authorization 
codes, in case the OAI application is not operating. (Remember that the PBX will 
verify all digits that the user enters.)
ASFC: 
(Assignment of 
Service Feature 
Class Data)This command is used to assign a Class of Service that allows a Service Feature 
Index of 27 for stations set up to access Code Master; this command activates the 
authorization code feature.
ASDT: 
(Assignment of 
Station Data)This command is used to associate the tenant configured for Code Master and the 
authorization code service feature class to specific station Dterm that will be used to 
access Code Master. 
						

							NDA-30013   Revision 6.0Page 19
Code Master Installation Guide NEAX Command Assignments
NEAX2000 Commands
Use the NEAX2000 Customer Administration Terminal (CAT), or the NEAX2000 
Maintenance Operations Console (MOC) to enter these commands. (Refer to the 
NEAX2000 System Manuals for more information.)
CM20: 
(Assignment of 
Access Code)Y=Tenant Group:  Access Code for ID code class change.
1st dataAccess Code (1-3 digits)
2nd dataService Type
:086:Authorization code
Use A57 for the first digit of the authorization code
:087:Forced Account code
CM42: 
(Assignment of 
Maximum Digits 
for Authorization 
Code)Sets ID code digits.
1st data:11:Authorization code
:12:Forced Account Code
:13:Remote Access to System ID code
2nd data:01–10:  Number of digits (The default is 10 digits.)
CMD79:  
(Assignment of 
Internet Address)Assigns the Internet Address of TCP/IP-Ethernet.
1st data00–03:  Division No. of Internet Address
2nd data0–255:  Address Data (1–3 digits)
The Internet Address must be assigned to the 1st data 00–03 as follows:
1st data (1)00
01
02
03
Internet Address: XXXXXXXXX
[XXX: 2nd data (2)]
XXX 
						

							Page 20NDA-30013   Revision 6.0
NEAX Command Assignments Code Master Installation Guide
CM08:  (Checking 
ID Codes Using 
AP01)Basic Functions
1st data:217Check ID code
2nd data::0:Check through MP
:1:Check through AP01 package when using ACF. (Set checking through AP01 
package when using ACF.)
CMD53:  (Handling 
of ID Codes When 
the IP is Down)Registers ID codes and temporary class data.
1st data:ID code
2nd data :a b b c c d d e e:Temporary class data
:a: 0–2,9:Temporary class type
:b b: 01–08:Temporary connection restriction 
class
:c c: 01–15:Temporary service restriction class – 
A
:d d: 01–15:Temporary service restriction class – 
B
:e e: 01–15:Temporary service restriction class – 
C
:NONE (Initial value)
Note:
This data uses PBX internal class change data when ACF is in operation and the 
AP is stopped.  The number of digits is set through CMD7B
CMD7B:  (Number 
of ID Code Digits 
When IP down)ACF
1st data:00:Number of ID code digits when AP stops during ACF operation
2nd data:1–3:Number of ID code digits when AP stops
:0 (Initial Value):No ACF operation