NEC NDA-30007-003 User Manual

Page 1
CONFERENCE ROOM SCHEDULER
AN
OPEN APPLICATION INTERFACE (OAI)
INSTALLATION GUIDE
NEC America, Inc.
NDA-30007-003
Revision 3.0
January, 1997
Page 2
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 1996
NEC America, Inc.
Page 3
Conference Room Scheduler Installation Guide CONTENTS
TABLE OF CONTENTS
Page
Chapter 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Software Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Application Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Database Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Mat Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 2 - Application Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Step 1 – Application Characteristics (Both Components). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Step 2 – Primary Configuration Parameter s (Both Components). . . . . . . . . . . . . . . . . . . . . . . . . . 4
Step 3 – Facilities (Conf_R o om _ S ch o n ly ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Step 4 – Secondary OAI Configuration Parameters (Conf_Room_Sch onl y). . . . . . . . . . . . . . . . . 5
Step 5 – User-Defined Parameters (Both Components). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Conf_Room_Sch User-defined Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Conf_Room_Sch User-defined Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Conf_Room_Sch_Rpt User-defined Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 3 - Database Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Conference Room Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Field Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Employee Identification Database Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Field Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 4 - MAT Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
AOKC COMMAND: (Assignment of OAI Key Codes). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
AKYD COMMAND: (Assignment of Dterm Function Key) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
NDA-30007 Revision 3.0 Page i
Page 4
CONTENTS Conference Room Scheduler Installation Guide
This Page Left Blank.
Page ii NDA-30007 Revision 3.0
Page 5
Conference Room Scheduler Installation Guide Introduction

Chapter 1 Introduction

This guide provides specific field entries that need to be made in the process of installing and configuring Conference Room Scheduler. In addition to this guide, use the following manuals for this in stallation:
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 Conference Room Scheduler are configured in the APM environment, using the entries and values provided in this guide.
NEAX2400 System Manuals – Give very detailed explanations about the
assignments that need to be made through the Maintenance Administration Terminal (MAT) commands on the NEAX2400.
Briefly, the installation and set up of Conference Room Scheduler involves the following processes:

Software Installation

Conference Room Schedule r soft ware must firs t be load ed from the rel ease me dia. 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 pa rt of the installation.

Application Configuration

Conference Room Scheduler 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. Conference Room Scheduler is comprised of two components, both of which must be configured. Use the instructions provided in the APM Operations Manual to make the entries provided in this section.

Database Requirements

Conference Room Scheduler requires two application databases which are constructed and mainta ined through the APM Databa se Administration op tion. For each application database, the process begins with the creation of a master definition file and its related master database. Then, for each, an application definition file is constructed which enables the processing of the master files into an 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.
Note:
Conference Ro om S cheduler maintains a 9 0-d ay ca len dar o f room reservations. This 90-day period dynamically rotates so that it always extends from the current day only base on a daily basis. Under
tion
database and designate a daily
if Conference Room Scheduler is set to automatically update its data-
on the
APM System Administra-
menu, use the
Database
Control Options
command to select the Conference Ro om Schedu ler
time at which it will be automatically updated.
NDA-30007 Revision 3.0 Page 1
Page 6
Introduction Conference Room Scheduler Installation Guide

Mat Assignments

There are data settings which must be assigned at the NEAX Maintenance Administration Terminal (MAT) before Conference Room Schedule r will function.
Chapter 4 of this gui de spe cifi es th e nece ssa ry command s and t he val ues a t wh ich
they are to be set. Use the instructions provided in the NEAX2400 IMS System Manuals to make the entries contained in this section.
The installation proce ss, incl uding i ts pres entat ion in thi s manual an d refer ence to other manuals that are necessary, is illustrated below:
ASSET MASTER
INSTALLATION REQUIREMENTS
Discussed in: Instructions in:
Chapter 1 Software Installation APM Installation Introduction
Software Release Media
Manual
Chapter 2 Application Configuration
Chapter 3 Database Requirements
Chapter 4 MAT Assignments
AKY1 (Assignment of D
Application Characteristics
Primary Parameter Configuration
OAI Facilities (Optional)
OAI Configuration Para m et er s (O ptio nal)
User-Defined Par ameters
Master Definition File
Master Database File
Application Definition File
Application Database
NEAX2400 IMS
Maintenance Administration
Terminal (MAT) Assignments
AOKC (Assignment of OAI Key Codes)
term
Function Keys)
APM Operations
Manual
APM Operations
Manual
NEAX2400 IMS
System Manuals
Page 2 NDA-30007 Revision 3.0
Page 7
Conference Room Scheduler Installation Guide Application Configuration

Chapter 2 Application Configuration

Conference Room Scheduler is configured into the APM system using the 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 Conference Room Scheduler. The following components must be configured:
Conf_Room_Sch The compon ent application that maintains the real-
time database and interacts with th e user at the
term
D
.
Conf_Room_Sch_RptThe component application that displays or prints
the real-time database.
For specific instructions on what these parameters mean and how to make these entries, use the
APM Operations Manual
.

Step 1 – Application Characteristics (Both Comp onents)

Add
In the APM Application Configuration option, make the entries shown below for the components:
Parameter Description Conf_Room_Sch Conf_Room_Sch_Rpt
OAI Application Indicates whether or not (Yes
or No) this component communicates with the NEAX2400 using OAI processes.
CRT Application Indicates whether or not (Yes
or No) this component requires a terminal screen that is of the same type as the one used by the APM.
Communication Queue Indicates whether or not (Yes
or No) this non-OAI application needs an I PC queue to communicate with other processes.
YN
NY
NN
NDA-30007 Revision 3.0 Page 3
Page 8
Application Configuration Conference Room Scheduler Installation Guide

Step 2 – Primary Configurat ion Parameters (Both Components )

On the APM Configuration Entry sc reen, make the entries shown below to the parameters indicated:
Parameter Description Conf_Room_Sch Conf_Room_Sch_Rpt
Application Name Indicates the name to be
displayed in the APM menus. This name is displayed in the same way it is entered here (i.e., capital letters , lower case , etc.)
Conf_Room_Sch Conf_Room_Sch_Rpt
Executable Filename Indicates the path name of the
executable file.
Group (Neither component is a
member of a group of applications.)
Response Mode Indicates the default value
since the components do not belong to a group.
Initialization Batch Indicates that neither
component is to be initialized automatically when the OAI system is initialized.
Termination Mode Indicates how the AP M is to
notify the component to terminate.
Standard Output Indicates where the compon ent
output is sent.
Number of Restarts Indicates that the APM is no t to
restart either component if it terminates erroneously.
/oai/app/c
rm /oai/app/c_rm.rpt
_
(make no entry) (make no entry)
I(gnore) I(gnore)
N(o) N(o)
M(essage) K(ill signal)
/oai/log/dbg/cr.dbg /dev/null
00
Page 4 NDA-30007 Revision 3.0
Page 9
Conference Room Scheduler Installation Guide Application Configuration

Step 3 – Facili ties (Conf_Room_Sch only)

According to instructions in the APM Operations Manual, designate the following NEAX2400 facilities for the Conf_Room_Sch component using the Facilities command on the APM Configuration Entry screen:
MRFI Mode Release Facility (I)
MRFR Mode Release Facility (R)
MSF OAI Mode Set Facility NTF Number Transfer Facility TCFD Terminal Control Facility (D)
Note:
The same MSF identification number (i.e., fro m 128 to 192) that is selected in the APM during Step 3 must be assigned to Confer ence Room Sch eduler at the NEAX MAT. For more information, see Chapter 4 .

Step 4 – Secondary O AI Configuration Parameters (Conf_Room_Sch only)

Using the OAI-Conf command on the APM Configur ation Entry s creen, make the entry shown for each of the following parameters required by Conf_Room_Sch. Use the instructions provided for this option in the APM Operations Manual:
Parameter Entry Definition
Database Name #1 /oai/db/cur/cr minfofi l Indicates t he path name of the databas e
containing the conference room information. This name must be the first listed database. The database filename (i.e.,
crminfofil
with its path, should be used as the name of the corresponding Appl ication Definition File (Refer to Chapter 3.)
Database Name #2 /oai/db/cur/crmidf ile Indicates t he path name of the database
containing the employee identification data. This name must be the second listed database. The database filename (i.e.,
crmidfile
), listed here with its path, should be used as the name of the corresponding Application Definition File (Refer to Chapter 3.)
), listed here
Timeout Value #1 90 Designates the number of seconds
Conf_Room_Sch will wait for user
term
input before it will release the D
.
Tenant Nu mber 0 Specifies the number of the tenant that
Conf_Room_Sch serves.
NDA-30007 Revision 3.0 Page 5
Page 10
Application Configuration Conference Room Scheduler Installation Guide
Parameter Entry Definition
Source Link Name OAI1X25 Identifies the port on t he source si de of
the communication link; entry should correspond to a link name in the APM system configuration file.
Destination Link Name PBX1X25 Identifies the port on the destination
side of the communication link; entry should correspond to a li nk name in the APM system configuration file.
Association Recovery 60 Designates the number of seconds
Conf_Room_Sch will wait before trying to re-establish an association with the NEAX that has been released .

Step 5 – User-Defined Parameters (Both Components)

Conf_Room_Sch User-defined Parameters

Make the following additional parameter entries through the UserDefined command on the APM Configuration Entry screen.
User-defined Entry Definition
#1 4 Indicates the length of the identification
number assigned to each authorized employee (maximum 9 digits.)
#2 /oai/app/data/crdata Specifies the path name of the
reservation database built and maintained by Conf_Room_Sch as users make, modify, and cancel conference room reservations. (This path must be in the same partition as /oai.)
Page 6 NDA-30007 Revision 3.0
Page 11
Conference Room Scheduler Installation Guide Application Configuration

Conf_Room_Sch User-defined Parameters

User-defined Entry Definition
#3 /oai/app/data/tmpcr Specifies the path name of a temporary
database that serves a s a backup when the conference room reservation database is being updated. (This path must be in the same partition as /oai.)

Conf_Room_Sch_ Rpt User-defined Parameters

User-defined Entry Definition
#1 1 or 2 Indicates how Conf_Room_Sch_Rpt
sorts and display s names from the 90-day reservation database to create various reports of the data and uses the foll owing values:
1. Sort by the name in the first position.
2. Sort by the name in the second posi­tion.
For example: If names are entered to the database in the or de r first name then last name
, then selection of option #1 sorts the database by the first nam e and option #2 sorts the database by the la st name. On the other hand, if names are entered to the database in the or de r last name
, then selection of option #1 sorts the database by the last name and optio n #2 sorts the database by the first name.
#2 Conf_Room_Sch Indicates the name of the other
component with which Conf_Room_Sch_Rpt must communicate in order to create its reports. This name must be entered in exactly the same way as the n ame entered to the Application Name parameter in Step 2.
name then first
This completes the conf iguration of Conference Room Scheduler in the APM. Now go to Chapter 3 to create its database support.
NDA-30007 Revision 3.0 Page 7
Page 12
Application Configuration Conference Room Scheduler Installation Guide
This Page Left Blank.
Page 8 NDA-30007 Revision 3.0
Page 13
Conference Room Scheduler Installation Guide Database Requirements

Chapter 3 Database Re quirements

Conference Room Scheduler requires three databases (i.e., Conference Room, Employee Identification, and Reservation). Two of these databases need to be constructed and thereafter maintain ed through the APM; the third database ( i.e., Reservation) is built by Conference Room Scheduler itself while it is running. Databases are created through the Database Administration option on the APM System Administration Menu. Database creation involves the following 4-step process for
each of the two required databases:
Step 1 –
Master Definition File
Create
1. Create a Master Def inition File: Thi s step involves creating th e master d efi ni-
2. Build a Master Database File: This step involves entering data (e.g., confer-
3. Create an Appl icat ion Def i nitio n File: In this ste p, a def ini ti on f ile is creat ed
4. Process the Application Database: In this step, the Master Database input is
Step 2 –
Master Database File
Build
Step 3 –
Application Definition File
Create
Step 4 –
Application Database
Process
tion file that def ines the f ie lds in the mas ter data base f ile. General ly one maste r definition file parents databases for several applications. Conference Room Scheduler, however, requires two separate sets of files, one for the conference room data and one for the employee identification data.
ence room numbers and number of people accommodated) into the master da­tabase fields that were just defined in Step 1.
which defines how data from the master files is to be converted to meet the needs of Conference Room Scheduler. The database names in the application configuration file (
crminfofil
and
crmidfile
) must be used for these definition
file names.
conv e rt ed t o dat aba se files accor di ng t o t he definitions cr ea ted in Step 3, using the Process/Install Application Databas es option on the APM Databa se Admin­istration menu. When the Process command is acti v ated, data is dr awn from the master database and converted to the formats specified in the corresponding ap­plication definition file. The Install command is then a ctivated to enable Con- ference Room Scheduler to access the database.
NDA-30007 Revision 3.0 Page 9
Page 14
Database Requirements Conference Room Scheduler Installation Guide

Instructions

The information required in all four steps for each Confere nce Room Schedu le r database is provided in table form on the following pages. 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 an d buil d the Confer ence Room Schedul er databases , one at a time. Any messages displayed during these st eps are addressed in the Process and Error Messages chapter of the APM Operations Manual.
Note:
Remember to complete STEP 4, Process the Application Database, for each database after entering the information on the following pages in STEPS 1 through 3.

Conference Room Database Information

This database contains all conference rooms, by room number, which are to be managed by the system and, for each, the number of people the room can accommodate. Name the master definition file crminf definition file crminfofil.
Master Definition File
Field Description
Type Size
Conference Room
Capacity
N 5 0 99999 Long Integer 315 N 4 0 9999 Long Integer 25
Min.
Value
Max.
Value
_
m and the application
Application
Definition
File
Data Type
Master
Database
T ypical
Entry

Field Definitions

The following are the defini tions for eac h fiel d in the Con feren ce Room Databa se:
Conference Room – A number that identifies the room, lying within the range from 0 to 99999.
Capacity The number of people that the identified room can accommodate, up to 4 digits in length.
Page 10 NDA-30007 Revision 3.0
Page 15
Conference Room Scheduler Installation Guide Database Requirements

Employee Identification Database Information

This database contains the identification number and name of all employees who are authorized to us e the syst em. Name the master defi niti on fi le crmid application definition file crmidfile.
Field Description
Master Definition File
Type Size
Min.
Value
Max.
Value
Application
Definition
File
Master Database
Data Type Typical Entry
_
m and the
Employee Identification
Employee Name A 8 ASCII Thompson

Field Definitions

N 9 0 999999999 Long Integer 585273
The following are the definitions for each field in the Employee Identification Database:
Employee Identification – A number that identifies the employee (e.g., social security number), lying within the range of 0 to 9-digits in length.
Employee Name The name of the employee associated with the identification number. The 90-day reservation database is l ater sorted for displa y and reporti ng purposes by this employee name. Coordinate the order in which this name is ente red (e.g., last name, first name) with the way in which the database is configured to sort. Refer to Step 5 – User-Defined Parameters
(Both Components) on page 6 for sorting
information.
Note:
NDA-30007 Revision 3.0 Page 11
Conference Ro om Sch eduler maintai ns a 90-day cal endar of room reservations. This 90-day period dynamically rotates so that it always extends from the current day only base on a daily basis. Under
tion
database and designate a daily
if Conference Room Scheduler is set to automatically update its data-
menu, use the
Database
Control Options
command to select the Conference Ro om Schedu ler
time at which it will be automatically updated..
APM System Administra-
on the
Page 16
Database Requirements Conference Room Scheduler Installation Guide
This Page Left Blank.
Page 12 NDA-30007 Revision 3.0
Page 17
Conference Room Scheduler Installation Guide MAT Assignments

Chapter 4 MAT Assignments

This guide assumes that dat a s et ti ngs t h at af fe ct t he operation of all OAI sof tware on a system-wide basis have already been assigned on the NEAX Maintenance Administration Terminal (MAT). 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 these system data settings and the MAT commands described below for Conference Room Scheduler, 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.
APM
Application
Configuration
Designation of Facility (Type)
and its Op-Code
for Use by
Conference
Room Scheduler
Conference Room Scheduler requires MAT assignment of the Mode Set Facility (MSF) to an OAI-assigned functi on key on all D
terms
affected by appl icat ion. This process involves assign ing the MSF and its Operation Code (Op-Code ), configured for Conference Room Schedul er in the APM Applic at ion Confi gurat ion opti on, to one of the 14 OAI Key Codes. (The MSF Op-Codes range from 128 to 191; available for on-screen viewing through the Providers command in the APM Application Configura tion op tion.) Each of the OAI Ke y Codes co rr esponds to an AKY1 Function Key Index (F KI) value which is the n assigned to the sp ecific D function key. This process is illustrated below.
PBX Correspondence of
AOKC AKYD
OAI Function
MAT
AOKC
Command
Assignment of
an OAI Key Code
(between 1 and 14)
to the Same Facility Type and Op-Code
Key Codes
1 < 2 < 3 < 4 < 5 < 6 < 7 < 8 < 9 <
10 < 11 < 12 < 13 < 14 <
Key Indices
> 34 > 35 > 36 > 37 > 38 > 39 > 40 > 41 > 42 > 43 > 44 > 45 > 46 > 47
MAT
AKYD
Command
Assignment of Corresponding MAT Function Key Index to a
specific D Function Key
term
. . . . .
. . . . .
. . . . . .
term
Figure 4-1 OAI Function Key Assignment
A knowledge of the D
term
stations in the NEAX system and whic h ones will have access to Conference Room Scheduler is necessary to using the following commands:
NDA-30007 Revision 3.0 Page 13
Page 18
MAT Assignments Conference Room Scheduler Installation Guide

AOKC COMMAND: (Assignment of OAI Key Codes)

This command is used to associate the MSF facility and its Op-Code that w as configured in the APM for Con feren ce Roo m Schedul er to on e of th e 14 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 MSF as the faci lity to be as signed to the selected K ey Code, using the v al­ues on the screen.
3. Enter the same Op-Co de that was configured for Conference Room Scheduler in the APM. If necessary, retrieve it using the Provider command on the APM Configuration Entry screen.
AKYD COMMAND: (Assignment of D
This command is used to assig n key data on the D Conference Room Scheduler. MAT Function Key Indexes #34 to #47 have been designated for use in the OAI system and cor re spon d to the 14 OAI Key Codes as illustrated on the previous page. The AKYD command is used to assign a D function key to the sp ecifi c MAT Function Key I ndex th at, i n turn , co rresp onds t o the previously assigned OAI Key Code . This command must be used to as sign the function key on each D Scheduler.
1. Enter the same tenant number that is configured for Conference Room Schedul- er in the APM Application Configuration option (page 6).
2. Enter the station number of the D signed.
term
term
Function Key)
terms
that are to be us ed to acc ess
that is to be set up with access to Conference Room
term
on which the function key is being as-
term
Page 14 NDA-30007 Revision 3.0
Page 19
Conference Room Scheduler Installation Guide MAT Assignments
APM
Application
Configuration
Conference
Room Scheduler
configured
for
MSF #129
3. Enter to t he D
term
function key field the MAT Function Key Index that corre-
sponds to the previously assigned OAI Key Code.
PBX Correspondence of
AOKC AKYD
OAI Function
Key Codes
1 <
MAT
AOKC
Command
2 < 3 < 4 < 5 <
OAI Key
Code #10 given
MSF facility type
and
Op-Code #129
6 < 7 < 8 <
9 < 10 < 11 < 12 < 13 < 14 <
Figure 4-2 OAI Function Key Assignment Example
Key Indices
> 34 > 35 > 36 > 37 > 38 > 39 > 40 > 41 > 42 > 43 > 44 > 45 > 46 > 47
Function Key
D
MAT
AKYD
Command
Index #43
assigned to
term
Function
Key #3
. . . . .
. . . . .
. . . . . .
The example above indicates that MSF #129 is configured for Confere nce Room Scheduler and is as signed through th e AOKC command to OAI Key Code 10. OAI Key Code 10 corresponds in t he PBX to MAT Function Key I ndex 43. Each D
term
in the system that is to access Conference Room Scheduler has function key 3 assigned to MAT Function Key Inde x 43 via the AKYI command. Now whe never a phone user presses function key 3 on any assigned D
term
, MSF 129 initiates
communication with Conference Room Scheduler. Conference Room Scheduler is now instal led and ready to be in itiali zed. Enter the
APM Operations Menu and initialize Conference Room Scheduler according to instructions provided in the APM Operations Manual.
NDA-30007 Revision 3.0 Page 15
Page 20
MAT Assignments Conference Room Scheduler Installation Guide
This Page Left Blank.
Page 16 NDA-30007 Revision 3.0
Loading...