NEC Ucd-Xl Installation Guide

							NDA-30078   Revision 1.0Page 69
UCD-XL Installation Guide UCD-XL Utilities
Appendix B UCD-XL Utilities
There are four utility programs that enable the UNIX system administrator to 
access the shared memory and semaphore set utilized by the components of UCD-
XL. These programs are located in directory /oai/app/ucdxl and may be run from 
the UNIX command line. 
Note:
Upon initialization, the Monitor clears shared memory and the semaphore set, 
creating them if necessary.
chkbins  []
 Shared memory key (same as given in Monitors UDP
#8, page 36).
 Number of seconds between checks. If 0 or not given,
program does one check and exits. Otherwise, it runs
continuously until the interrupt key (Ctrl+c) is
pressed.
This utility checks the statuses of the request bins in shared memory on a periodic 
basis. Information includes:
list of active Messengers with process IDs
quantity of bins in use
ID of next empty bin (first is 0)
ID of bin containing next outstanding request (first is 0)
bin counts according to status: 
empty - available for an OAI request from the Monitor
outstanding - Monitors request not read by a Messenger yet 
pending - Monitors request being processed by a Messenger 
response - contains result of Monitors request
chksem  []
 Semaphore set key (same as given in Monitors UDP
#9, page 36).
 Number of seconds between checks. If 0 or not given,
program does one check and exits. Otherwise, it runs
continuously until the interrupt key (Ctrl+c) is
pressed. 
						

							Page 70NDA-30078   Revision 1.0
UCD-XL Utilities UCD-XL Installation Guide
This utility checks the set of two semaphores utilized by UCD-XL on a periodic 
basis. The first semaphore is a flag that prevents more than one UCD-XL 
component from modifying shared memory simultaneously: 1 = unlocked, 0 = 
locked. The second semaphore is equivalent to a count of outstanding requests. 
Every Messenger waits for this semaphore to become non-zero, then takes its turn 
reading the next outstanding request in shared memory. Each request is processed 
by exactly one Messenger.
clrbin  
 Shared memory key (same as given in Monitors UDP
#8, page 36).
 Bin ID, starting with 0; -1 means all bins are cleared.
This utility clears a specific request bin or all request bins in shared memory, 
regardless of their statuses. It should only be used when a software problem 
prevents a Messenger from processing the bin(s) or when garbage data appears in 
the bin(s). Since this utility changes the contents of shared memory 
indiscriminately, it may affect the performance of UCD-XL. 
dispbin  
 - Shared memory key (same as given in Monitors UDP
#8, page 36).
 - Bin ID, starting with 0.
This utility displays the contents of a specific request bin in shared memory. 
Information includes:
Status: empty, outstanding, pending, response
Facility/function: SCF 4 (connect call), SCF 5 (announce call) or SMFR 3 
(status check)
Response: busy, make busy, lockout, idle, success, failure, clear (no response)
time of response
Transaction: incoming call, queued call, announcement, inspection, failed 
connection
Calling party - terminal ID (an OAI data structure) of the caller
Announcement message number (for announcement transaction)
Destination - extension to which call is connected
Group index - record ID of group associated with the call
Port index - record ID of port associated with the call
Pattern index - record ID of the ANI pattern, if any, associated with the call
Office code - PBX office code, if any, associated with the call 
						

							NDA-30078   Revision 1.0Page 71
UCD-XL Installation Guide UCD-XL Environment and Hardware
Appendix C UCD-XL Environment and Hardware
This appendix describes the physical environment and hardware needed to support 
UCD-XL.
A Digiboard DigiCHANNEL, NEC Multi-8/16, or similar serial 
communications board is required in the UAP to supply sufficient ports for the 
MCI links among the PBX, the VMS, and UAP (UCD-XL). RS232 cables 
comprise the links. Connectors may be DB-25 (25 pins) or RJ-45 (8 pins) 
standard. Special adaptors may also be necessary.
Two A/B boxes (or an AaBb box) are recommended to provide an alternative 
path for MCI messages between PBX and VMS if UCD-XL (specifically, the 
Mediator component) is unavailable. One box is placed along the link between 
the PBX and UAP; the other is placed along the link between the VMS and 
UAP. The A output of each box is routed to the UAP; the B outputs are 
connected together directly using a RS232 cable. A diagram of the layout is 
shown below. If the UCD-XL Mediator application is terminated for any reason,
the two boxes should be manually switched from A to B, enabling MCI traffic 
to bypass the UAP and ensuring that users continue to have access to their voice 
mailboxes.
The PBX’s MCI port is wired as a DCE device. Therefore, the VMS’s MCI port 
must be a DTE device, or converted to one using a null modem adapter, in order 
for communication to occur.
PBX VMS
UA P
B
A inB
Ain
MCIMCI
to
PBXto
VMS
(UCD-XL) box #1box #2 
						

							Page 72NDA-30078   Revision 1.0
UCD-XL Environment and Hardware UCD-XL Installation Guide
The NEC Multi-8 and Multi-16 Boards are DTE devices that use RJ-45 
connectors. The signals are laid out on a Multi-8/16 RJ-45 connector as follows:
The MCI link between A/B box #1 (the PBX side) and the NEC Multi-8/16 
Board on the UAP requires an adapter that connects DTE (Multi-8/16) to DCE 
(PBX). This wiring configuration is as follows:
Table C-1  RJ-45 Pin Assignments for NEC Multi-8/16 Board
Signal DescriptionPlug 
Pin #Socket 
Pin #
TXD Transmit Data 1 2
DTR Data Terminal Ready 2 3
RTS Request to Send 3 4
SGND Signal Ground 4 5
CGND Chassis Ground 5 6
RXD Receive Data 6 7
CTS Clear to Send 7 8
DCD Data Carrier Detect 8 9
Table C-2  Adapter for Multi-8/16 to PBX
Multi-8/16 Side PBX Side
SignalRJ-45 
PinSignalDB-25 
Pin
TXD 2
TXD 2
DTR 3
DTR 20
RT S 4
RT S 4
SGND 5
SGND 7
CGND 6
CGND 1
RXD 7
RXD 3
CTS 8
CTS 5
DCD 9
DCD 8 
						

							NDA-30078   Revision 1.0Page 73
UCD-XL Installation Guide UCD-XL Environment and Hardware
The MCI link between A/B box #2 (the VMS side) and the NEC Multi-8/16 
Board on the UAP requires an adapter that connects DTE (Multi-8/16) to DTE 
(VMS). This wiring configuration is as follows:
Table C-3  Adapter for Multi-8/16 to VMS
Multi-8/16 Side VMS Side
SignalRJ-45 
PinSignalDB-25 
Pin
TXD 2
RXD 3
DTR 3
DCD 8
RT S 4
CTS 5
SGND 5
SGND 7
CGND 6
CGND 1
RXD 7
TXD 2
CTS 8
RT S 4
DCD 9
DTR 20 
						

							Page 74NDA-30078   Revision 1.0
UCD-XL Environment and Hardware UCD-XL Installation Guide
The Digiboard DigiCHANNEL serial communications board is a DTE device 
that uses either RJ-45 or DB-25 connectors. The pin assignments for both types 
are given below:
For the connection between A/B box #1 (PBX side) and the DigiCHANNEL on 
the UAP, there is no special wiring unless an RJ-45/DB-25 adapter is needed. In 
that case, the signals are maintained by wiring together the RJ-45 and DB-25 
pins for each signal as listed in Ta b l e C - 4.
Table C-4  RJ-45 and DB-25 Pin Assignments for DigiCHANNEL
Signal DescriptionRJ-45 
PinDB-25 
Pin
RI Ring Indicator 1 22
DSR Data Set Ready 2 6
RTS Request to Send 3 4
CGND Chassis Ground 4 1
TXD Transmit Data 5 2
RXD Receive Data 6 3
SGND Signal Ground 7 7
CTS Clear to Send 8 5
DTR Data Terminal Ready 9 20
DCD Data Carrier Detect 10 8 
						

							NDA-30078   Revision 1.0Page 75
UCD-XL Installation Guide UCD-XL Environment and Hardware
For the connection between A/B box #2 (VMS side) and the DigiCHANNEL 
on the UAP, the following wiring configuration is needed to form a DTE-DTE 
connection:
The previous information was extracted from the BusinessMate 386/25 Multi-
8/Multi-16 Reference Guide, copyright 1990 by NEC Corporation, and the 
DigiCHANNEL PC/8i and DigiCHANNEL PC/4i Installation Guide/Reference 
Manual, copyright 1989 by DigiBoard Incorporated. The information is subject 
to change without notice.
Table C-5  Adapter for DigiCHANNEL to VMS
DigiCHANNEL Side VMS Side
SignalRJ-45 
PinDB-25 
PinSignalDB-25 
Pin
TXD 5 2  RXD 3
RXD 6 3  TXD 2
RT S 3 4 < - - > CT S 5
CTS 8 5  RTS 4
DSR 2 6  DTR 20
SGND 7 7  SGND 7
DCD 10 8  DTR 20
DTR 9 20  DSR&DCD 6&8 
						

							UCD-XL Environment and Hardware UCD-XL Installation Guide
Page 76NDA-30078   Revision 1.0
This Page Left Blank.