NEC Roamer An Open Application Interface Installation Guide

							NDA-30016    Revision 3.0Page 5
Roamer Installation Guide Application Configuration
Chapter 2 Application Configuration
Roamer 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 should be entered to the configuration 
file for Roamer. 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 Roamer to the APM Application Configuration file, define it as an OAI 
application that does not need a CRT or a communication queue, as shown below.
Note:Entries for parameters that are marked with an asterisk (*) should be made ex-
actly as they are shown. All other entries in this guide serve only as examples.
Parameter Entry Description
OAI Application (Y,N) Y Y(es). Roamer is an OAI 
application because it 
communicates with the 
NEAX2400 using OAI 
processes.
CRT Application (Y,N) N (No). Roamer 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). Roamer does not need an 
IPC queue to communicate with 
other processes. 
						

							Page 6NDA-30016   Revision 3.0
Application Configuration Roamer Installation Guide
Step 2: Primary Configuration Parameters
On the APM Configuration Entry screen, make the entries shown below to the 
parameters indicated.
Note:
Entries for parameters that are marked with an asterisk (*) should be made ex-
actly as they are shown. All other entries in this guide serve only as examples.
Parameter Entry Description
Application Name Roamer The name to be displayed in the 
APM menus. This name is 
displayed as it is entered here 
(i.e., capital letters, lower case, 
etc.).
Executable Filename* /oai/app/freeloc The path name of the executable 
file.
Group* (no entry) (Roamer is not a member of a 
group of applications.)
Response Mode I This is a default value since 
Roamer does not belong to a 
group.
Initialization Batch N Roamer is not to be initialized 
automatically when the OAI 
system is initialized.
Termination  Mode* M Roamer is to receive a termination 
message rather than a kill or 
termination signal from the APM, 
when it is to terminate.
Standard Output* /dev/null Roamer’s output is sent to this 
file.
Number of Restarts 0 Roamer may not be restarted by 
the APM if it terminates 
erroneously. 
						

							NDA-30016   Revision 3.0Page 7
Roamer Installation Guide Application Configuration
Step 3: OAI Facilities
According to instructions in the APM Operations Manual, designate the following 
NEAX2400 facilities for Roamer using the Facilities command on the 
Configuration Entry screen:
FLF Free Location MRFR Mode Release (R)
MRFI Mode Release (I) MSF OAI Mode Set
NTF Number Transfer TCFD Terminal Control (D)
TCFI Terminal Control (I)
Note:The same MSF identification number (i.e., from 128 to 192) that is selected in the 
APM during Step 3 must be assigned to Roamer at the NEAX MAT. For more in-
formation, see Chapter 4, “MAT Assignments” on page 15. 
						

							Page 8NDA-30016   Revision 3.0
Application Configuration Roamer Installation Guide
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 Roamer. Use the 
instructions provided for this option in the APM Operations Manual:
Parameter Entry Description
Database Name #1* /oai/db/cur/
roamerdbThe path name of the database 
containing user information. The 
database filename roamerdb, 
shown here with its path, should 
be used as the name of the 
corresponding Application 
Definition File. For more 
information see Chapter 3, 
“Database Requirements” on 
page 11.
Timeout Value #1 60 The number of seconds Roamer 
waits for user numeric input 
before it releases the D
term.
Timeout Value #2 20 The number of seconds Roamer 
waits for input of processing 
symbols such as # before it 
releases the D
term. 
Tenant Number 1 This configuration applies to 
tenant No. 1. 
Source Link Name OAI1X25 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 PBX1X25 The port on the destination side of 
the communication link.
Association Recovery 10 The number of seconds Roamer 
waits before trying to re-establish 
an association with the NEAX 
that has been released. 
						

							NDA-30016   Revision 3.0Page 9
Roamer Installation Guide Application Configuration
Step 5: User-Defined Parameters
Make the following additional parameter entries through the UserDefined 
command on the APM Configuration Entry screen:
Parameter Entry Description
User Defined #1 3 The number of the Roamer Dterm 
function key LED. This number 
must correspond to the function 
key assigned to Roamer at the 
NEAX MAT. For more 
information, see Chapter 4, “MAT 
Assignments” on page 15.
User Defined #2 0 The default Route Restriction 
Class value.
User Defined #3 Y Y(es), implement the Name 
Display feature; N (o), do not 
implement the Name Display 
feature and only display phone 
numbers.
User Defined #4 R The way the privilege level is 
determined when there is more 
than one user assigned to a D
term, 
using the following characters:
H = Highest Priority level 
among assigned users.
L = Lowest priority level 
among assigned users.
R = Most recently added user 
privilege level.
User Defined #5 Y Y(es). Roamer is to reset all 
logical numbers to their home 
numbers at the designated Reset 
Time
N(o). Roamer is not to reset the 
logical numbers daily. (See User 
Defined #6.)
User Defined #6 3:00 The Reset Time on a 24-hour 
clock at which all logical numbers 
are reset daily to their home 
numbers. This entry is valid only 
if User Defined #5 is set to Y(es). 
						

							Page 10NDA-30016   Revision 3.0
Application Configuration Roamer Installation Guide
This completes the configuration of Roamer in the APM. Now go to Chapter 3, 
“Database Requirements” on page 11 to create its database support. User Defined #7 0 The number of 30-minute 
intervals that the backup file will 
remain valid after a power failure. 
The largest allowable value is 48 
(24 hours). A longer delay must 
be indicated with the value 0 
(always valid).
User Defined #8* /oai/app/data/
roamerbuThe name of the backup file that 
reflects the current status of 
assignments. This file preserves 
the current status of the Roamer 
system in the event of a power 
failure. If no backup is desired, 
leave this field blank.
User  Defined  #9 16 The length of the User Name field 
in the Roamer database.
Parameter Entry Description 
						

							NDA-30016    Revision 3.0Page 11
Roamer Installation Guide Database Requirements
Chapter 3 Database Requirements
Roamer uses the following two databases, only the first of which is created through 
the APM:
The Roamer Database 
This database contains default assignment information. Each user ID is 
associated to telephone numbers and privileges, a tenant, and a reset option. 
This database is created through the APM and is configured as /oai/db/cur/
ro am erd b.
The Backup Database 
This database reflects the current status of Roamer activity and is created and 
maintained by Roamer. It is configured in the APM as /oai/app/data/roamerbu. 
The Roamer database is created through the Database Administration option on the 
APM System Administration Menu and involves the following four-step process: 
1.Create a Master Definition File: This step involves creating the master defini-
tion file that defines the fields in the master database file.
2.Build a Master Database File: This step involves entering data that was de-
fined in the master definition file, in Step 1, into the master database fields.
3.Create an Application Definition File: In this step, a definition file is created 
for the Roamer database. This file defines the formats by which data from the 
corresponding master file is to be converted to meet the needs of Roamer.
4.Process the Application Database: In this step, the Process and Install Appli-
cation Databases options on the APM Database Administration menu create the 
file that will be used by Roamer. When the Process option is activated, data is 
drawn from the master database and converted to the formats specified in the 
corresponding application definition file. The Install option is then activated to 
enable Roamer to copy its database into a working file.
Step 1
 - Create
Master Definition FileStep 2 
- Build
Master Database FileStep 3
 - Create
Application Definition FileStep 4
 - Process
Application Database 
						

							Page 12NDA-30016   Revision 3.0
Database Requirements Roamer Installation Guide
Instructions
The information required in all four steps is provided in table below. 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 Roamer database. Any messages displayed 
during these steps are discussed in the Process and Error Messages chapter of the 
APM Operations Manual.
The Roamer definition and database files must contain the information in the table 
below. Name the master definition file roamer
_m and the application definition 
file roamerdb.
Field DescriptionMaster Definition File Application 
Definition File Master
Database
Type Size Min.
Va l u eMax.
Va l u eD a t a  Ty p e Ty p i c a l
Entry
User ID N 10 0 99999
9999ASCII 598241297
User Name A 16 ASCII Thompson
Logical Number N 5 0 99999 Long Integer 201
Exempt from Reset? A 2 ASCII n
RSC N 2 0 15 Short Integer 1
SFC N 2 0 15 Short Integer 2
Physical Number N 5 0 99999 Long Integer 3200
Tenant Number N 3 0 255 Short Integer 1
Phone Type N 2 0 10 Short Integer 10 
						

							NDA-30016   Revision 3.0Page 13
Roamer Installation Guide Database Requirements
Field DefinitionsUser ID A unique 10-digit number that describes each user 
(e.g. social security number). The database is sorted by 
this field.
User Name The 16-character user name that is displayed on the 
D
term.
Logical Number The station number associated with the user name 
under Roamer control.
Exempt from Reset? Whether or not (Yes or No) this user is to be reset to a 
home phone when all system phones are reset. (See 
User-Defined Parameters #5 and #6 on page 9.)
RSC The Route Restriction Class assignment of the user.
SFC The Service Feature Class assignment of the user.
Physical Number The station number associated with the phone under 
NEAX control.
Tenant Number The number of the tenant to which this physical 
number is assigned. (See Tenant Number on page 8.)
Phone Type The equipment type of this phone. To indicate a D
term 
V, this field must be set to 10.
Note 1:
To enter an unassigned physical number into the database, list it under a User ID 
that is not associated with a user name and leave the Logical Number, Exempt 
from Reset?, RSC, and SFC fields blank. A user can be entered to the database 
without a phone assignment by leaving the Physical Number, Tenant Number, and 
Phone Type fields blank (e.g., security staff who are mobile and not assigned to a 
home phone).
Note 2:
Remember to complete Step 4, Process the Application Database, after entering 
the information above. 
						

							Database Requirements Roamer Installation Guide
Page 14NDA-30016   Revision 3.0
This Page Left Blank.