NEC Code Master An Open Application Interface Installation Guide

							CODE MASTER
AN
OPEN APPLICATION INTERFACE (OAI)
INSTALLATION GUIDE
NEC America, Inc.
NDA-30013-006
Revision 6.0
April, 1999
Stock # 241713 
						

							LIABILITY DISCLAIMER
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.
Copyright 1999
NEC America, Inc. 
						

							NDA-30013  Revision 6.0Page iii
Code Master Installation Guide CONTENTS
TABLE OF CONTENTS
Page
Chapter 1 - Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   1
Chapter 2 - Application Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   5
Step 1 – Application Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  5
Step 2 – Primary Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
Step 3 – OAI Facilities  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
Step 4 – Secondary OAI Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  7
Step 5 – User-defined Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 3 - Database Requirements  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   9
Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
Tenant/Mask Database Information  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
Field Definitions: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  10
Authorization Code Database Information  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  11
Field Definitions: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  12
Chapter 4 - NEAX Command Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   13
NEAX2400 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
ASYD: (Assignment of System Data)  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  13
ASPA: (Assignment of Special Access Code) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
AMND: (Assignment of Maximum Necessary Digits) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
AATC: (Assignment of Authorization Code Data)  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
ASFC: (Assignment of Service Feature Class Data) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
ASDT: (Assignment of Station Data) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  14
NEAX2000 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
CM20: (Assignment of Access Code)  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
CM42: (Assignment of Maximum Digits for Authorization Code) . . . . . . . . . . . . . . . . . . . . . . . .  15
CMD79:  (Assignment of Internet Address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  15
CM08:  (Checking ID Codes Using AP01) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
CMD53:  (Handling of ID Codes When the IP is Down). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
CMD7B:  (Number of ID Code Digits When IP down) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  16
Chapter 5 - Initialization and Termination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   17
Appendix A - Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .   19 
						

							Page ivNDA-30013  Revision 6.0
CONTENTS Code Master Installation Guide
This Page Left Blank. 
						

							NDA-30013   Revision 6.0Page 5
Code Master Installation Guide Introduction
Chapter 1 Introduction
This guide provides specific field entries that need to be made in the process of 
installing and configuring Code Master. In addition to this guide, use the following 
manuals for this installation:
Applications Manager (APM) Installation Manual – Contains step-by-step 
instructions for installing the software from the release media.
Applications Manager (APM) Operations Manual – Explains how 
applications like Code Master are configured in the APM environment, using 
the entries and values provided in this guide.
NEAX System Manuals – Give very detailed explanations about the 
assignments that need to be made with the NEAX2400 Maintenance 
Administration Terminal (MAT) commands, the NEAX2000 Customer 
Administration Terminal (CAT), or the NEAX2000 Maintenance Operations 
Console (MOC). See “NEAX Command Assignments” on page 13.
Briefly, the installation and set up of Code Master involves the following 
processes:
Software Installation
Code Master software must first be loaded from the release media. Log in to the 
APM Platform Management Menu, select the Installation of Applications/
Packages option, and follow the instructions provided in the APM Installation 
Manual to complete this part of the installation.
Application Configuration 
Code Master is internally supported by the APM and must be configured in the 
APM environment. Chapter 2 of this guide provides the information that must be 
entered into this APM configuration file. Use the instructions provided in the APM 
Operations Manual to make the entries provided in this section.
Database Requirements 
Code Master requires two databases which are constructed and maintained through 
the APM Database Administration option. The process begins with the creation of 
a master definition file and its related master database. Then an application 
definition file is constructed which enables the processing of the master database 
file into a Code Master application database. Chapter 3 of this guide defines the 
information which must be included in these definition and database files. Use the 
instructions provided in the APM Operations Manual to make the entries 
contained in this section. 
						

							Page 6NDA-30013   Revision 6.0
Introduction Code Master Installation Guide
NEAX Command Assignments
Before Code Master will function, specific data settings must be assigned at the 
NEAX2400 Maintenance Administration Terminal (MAT) commands, the 
NEAX2000 Customer Administration Terminal (CAT), or the NEAX2000 
Maintenance Operations Console (MOC). Chapter Chapter 4 on page 13 of this 
guide specifies the necessary commands and the values at which they are to be set. 
Use the instructions provided in the appropriate NEAX System Manuals to make 
the entries contained in this section.
Notes 
1. Only one application may access the NEAX Authorization Code Facility (ACF) 
at a time. Therefore, when Code Master is running, no other application can use 
the ACF.
2. An authorization code is not included in a Station Message Detail Record (SM-
DR) if it is dialed prior to the outgoing number. It is included in the record if the 
outgoing number is dialed first. A forced account code is always put into an SM-
DR.
3. The verifiable portion of a dialed authorization code is designated during instal-
lation. The digits in the designated portion are verified against the database 
while the remaining digits are ignored by Code Master. This option allows flex-
ibility in determining the sequence of digits which must be dialed as an autho-
rization code. Non-verifiable information may include, for instance:
Leading digits that tell the NEAX how many digits must be entered for the 
authorization code.
Specialized information, such as a count of FAX pages for transmission that 
can be made available to a call accounting program.
4. Code Master does not provide utilities for managing the file or device where the 
authorization code records are written. It is possible for the hard disk or device 
to become full unless the user takes steps to prevent that situation. 
						

							NDA-30013   Revision 6.0Page 7
Code Master Installation Guide Introduction
The installation process, including its presentation in this manual and reference to 
other manuals that are necessary, is illustrated below:
Code Master Installation Requirements
Discussed in:
Instructions In
Chapter 1Software InstallationAPM Installation
Introduction
Software Release MediaManual 
Chapter 2Application CharacteristicsAPM Operations
Application Configuration
Primary Parameter ConfigurationManual
OAI Facilities (Optional)
OAI Configuration Parameters (Optional)
User-Defined Parameters
Chapter 3Master Definition FileAPM Operations
Database Requirements
Application Definition FileManual
Application Database
Chapter 4
NEAX2400 MAT CommandsNEAX2400 IMS
MAT Assignments
NEAX2000 CAT/MOC CommandsSystem Manuals
or
NEAX2400 IVS
System Manuals 
						

							Introduction Code Master Installation Guide
Page 8NDA-30013   Revision 6.0
This Page Left Blank. 
						

							NDA-30013   Revision 6.0Page 9
Code Master Installation Guide Application Configuration
Chapter 2 Application Configuration
Code Master is configured into the APM system using the Add function of the 
Application Configuration option on the APM System Administration menu. To 
access the Application Configuration option:
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 should be entered to the configuration 
file for Code Master. For specific instructions on what these parameters mean and 
how to make these entries, use the APM Operations Manual.
Step 1 – Application Characteristics
In adding Code Master to the APM Application Configuration file, define it as an 
OAI application that does not need a CRT or a communication queue, as follows:
Parameter
EntryDescription
OAI Application (Y,N) Y Yes, Code Master is an OAI 
application because it communicates 
with the NEAX using OAI processes.
CRT Application (Y,N) N No, Code Master does not require a 
terminal screen that is of the same type 
as the one used by the APM.
Communication Queue (Y/N) N No, Code Master does not need an IPC 
queue to communicate with other 
processes. 
						

							Page 10NDA-30013   Revision 6.0
Application Configuration Code Master Installation Guide
Step 2 – Primary Configuration Parameters
On the APM Configuration Entry screen, make the entries shown below to the 
parameters indicated:
Parameter
EntryDescription
Application Name Code_Master The name that is to be displayed in 
the APM menus. This name is 
displayed however it is entered 
here; i.e. capital letters, lowercase, 
etc.
Executable Filename /oai/app/auth.verify The path name of the executable 
file.
Group (no entry) (Code Master is not a member of a 
group of applications.)
Response  Mode  I The action that APM is to take with 
Code Master when a member of its 
group terminates; the “I” serves as 
a default value since Code Master 
does not belong to a group.
Initialization  Batch  N Code Master is not to be initialized 
automatically when the OAI 
system is initialized. (The user can 
choose “Y” for convenience, if 
desired.)
Termination Mode  M Code Master is to receive from the 
APM a termination message, 
rather than a kill or termination 
signal, when it is to terminate.
Standard Output /dev/null Code Master’s output is sent to this 
file for debugging purposes.
Number of Restarts  0 The number of times the APM may 
restart Code Master in the event 
that it terminates erroneously; 0 
indicates that it is not to be 
restarted at all.
Step 3 – OAI Facilities
According to instructions in the APM Operations Manual, designate the 
following facility for Code Master using the Facilities command on the 
Configuration Entry screen:
ACF – Authorization Code Facility