Section 520 - TSAPI Installation and Feature Description The contents of this document are subject to change without notice and do not constitute a commitment on the part of Panasonic Telecommunication System Company (PTSC). Every effort has been made to ensure the accuracy of this document. However, due to ongoing product improvements and revisions, Panasonic cannot guarantee the accuracy of printed material after the date of publication nor can it accept responsibility for errors or omissions.
Contents Chapter 1. Overview of Telephony Services for the DBS . . . . . . . . . . . 1 Chapter 2. Limitations and Specifications . . . . . . . . . . . . . . . . . . . . . . . 3 Chapter 3. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Telephone System Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Installing the API Circuit Card/Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table of Contents Section 520 - TSAPI Answer requests from DBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 PC packet sends aborted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 RX Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 TX Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Section 520 - TSAPI Table of Contents Query MWI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Query DND. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Query FWD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Query LNR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table of Contents Section 520 - TSAPI h: N/A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 i: Set Debug Trace Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 1. Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 2. Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1. Overview of Telephony Services for the DBS Most businesses already use computers and telephones extensively in their day-to-day operations. With few exceptions, however, business telephone and computer systems have historically remained independent entities - no interaction or common communication was possible between the two types of systems.
Chapter 1. Overview of Telephony Service for the DBS Section 520 - TSAPI With Telephony Services, a Novell Netware® Network is required. To communicate with the DBS, a Panasonic DBS driver called “Panadrvr” (developed as a Netware Loadable Module or NLM) is installed on the telephony server. Application developers designing to Netware Telephony Services specifications can design products that communicate to the DBS driver via the Novell Tserver NLM, which is also installed on the telephony server.
Chapter 2. Limitations and Specifications DBS/Telephony Services Item Capacity Maximum DBS extension ports monitored Maximum individual monitors per extension port Maximum monitors per client on network Maximum Outstanding CSTA requests (Applications must wait for either a positive or negative response from Panadrvr prior to issuing further requests.
Section 520-TSAPI Chapter 2. Limitations and Specifications This page intentionally left blank. 4 Issued April 2000 Doc. No.
Chapter 3. Installation Overview This chapter describes how to install Telephony Services for use with the DBS. The first part of this chapter describes installation of the API hardware and procedures for programming the DBS. The second part of the chapter describes how to install the Panadrvr Telephony Services NetWare Loadable Module (NLM) on the Novell Server. Requirements • One VB-43941 Telephony Services Kit.
Chapter 3. Installation Figure 1. Section 520 - TSAPI DBS API Circuit Card/ Serial Connector Installation AU AU X X 1 1 3. Attach the API serial port connector to the side of the DBS cabinet with two screws. 4.
Section 520 - TSAPI Chapter 3. Installation 5. Connect the provided serial cable from Port 1 (or Port 2) to the serial port on the Network Server. The cable must be configured as shown in Figure 2 below. The API port used must match the DBS API Port Type setting specified in FF1 2# (41-42)# 1# (0-1)# and the port specified with the NetWare Loadable Module driver “Panadrvr”. See “Programming the DBS” on page 8 and “DBS Driver Installation” on page 9 for more information.
Chapter 3. Installation Section 520 - TSAPI Programming the DBS 1. Enter the DBS programming mode 2. Set the API port to Telephony Services as follows:. Program Name Address API Port Type FF1 2# 1# (41 or 42)# 1# (0-1)# API Port Number 41 = Port 1 42 = Port 2 Port Type: 0 = Standard API protocol (default) 1 = Telephony Services protocol Note: The Telephony Services NLM defaults to use the first port (41). 3. Set the Telephony Services API Port Baud rate to the desired baud rate as follows:.
Section 520 - TSAPI Chapter 3. Installation DBS Driver Installation Caution: Installation of the DBS Driver must be performed by a Novell Netware Technician. Overview The Panasonic Telephony Services DBS driver ‘Panadrvr’ is a NetWare Loadable Module created to run on a Novell 3.12 or 4.X 486 (or greater) server with at least 8 megabytes of RAM and equipped with a serial port of 9600 baud plus capacity (16550 UART required). The driver is distributed on a single 1.44MB diskette.
Chapter 3. Installation Section 520 - TSAPI Novell loader will advise of unresolved external symbols and Panadrvr will not be loaded. Loading Panadrvr Before Panadrvr can be loaded, Telephony Services must be installed and running and a client logged into the server as Administrator or Supervisor. During the installation process, Panadrvr is copied to the system directory of the server.
Section 520 - TSAPI Chapter 3. Installation Option: port= Range: 1 to 8 Default: 1 Runtime modifiable: No Purpose: Specifies which serial port on the server PC is connected to the DBS for Telephony Services. Option: baud= Range: 9600 or 19200 Default: 9600 Runtime modifiable: No Purpose: Specifies the DBS API baud rate. This must match the DBS setting. Option: security= Range: 1 to 3 Default: 2 (Medium) Runtime modifiable: No Purpose: Specifies the CSTA stream control security level.
Chapter 3. Installation Section 520 - TSAPI Option: clearcall= Range: 0 or 1 Default: 1 (Enabled) Runtime modifiable: Yes Purpose: Specifies whether the driver honors CSTA clearcall commands from applications. Clearcall commands allow the application to disconnect ALL parties on a given call. Option: log Range: N/A Default: Off Runtime modifiable: Yes Purpose: Specifies whether the driver should create a trace log file in the SYS volume in the SYSTEM directory called panadrvr.log.
Section 520 - TSAPI Chapter 3. Installation Panadrvr and call cleared events sent to all the applications monitoring the affected extensions. Note, this has not effect on the actual DBS call. Option: c= Range: N/A Default: None Runtime modifiable: N/A Purpose: Specifies a load time ASCII text configuration file containing the aforementioned options. The name and full path of the file must be specified. The format of the file is as follows: api=1 port=2 /this is a comment baud=19200 ...
Chapter 3. Installation Section 520 - TSAPI Setting up Telephony Services Users Caution: Set-up of Telephony Services Users must be performed by the Novell Netware Technician. Overview The individuals or agents who use telephony services are known in the Netware Telephony Services environment as users. A user can be either an actual person or an application. Each user must have various attributes defined so that the server knows which PBX and device or extension the user is linked to.
Section 520 - TSAPI Chapter 3. Installation 8. The Quick Add dialog box will appear. Enter the following information in the appropriate fields. • User Login. This is the NetWare log-in identifier for the user. This must match the user’s NetWare log-in previously set up on the server. • User Name. If desired, enter the name of the user. This information is optional and is provided for the convenience of the network administrator. • PBX. Select the appropriate PBX the user is to be linked to.
Chapter 3. Installation Section 520 - TSAPI This page intentionally left blank.
Chapter 4.
Chapter 4.
Chapter 5. Maintenance and Troubleshooting Alarm Log Entries Telephony Services Administration allows for the logging and displaying of messages from a Telephony Services driver. Panadrvr takes advantage of this service. Note that the actual messages logged, displayed, etc., depend upon current Novell Tserver settings. Each message has the following format: Module ID: The NLM generating the message, in our case ‘Panadrvr’. Level: The importance of the alarm.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI TDILOGERROR(dname, FATAL, ALMLOC, alarmcnt++, "Driver exiting.", OurName). This alarm is generated when the CSTA network handler task has been told to shut down. It indicates that Panadrvr is no longer available for CSTA services. TDILOGERROR(dname, FATAL, ALMLOC, alarmcnt++, "Driver unloading via signal handler."). This alarm indicates an abnormal Panadrvr termination.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting TDILOGERROR(dname, CAUTION, ALMLOC, alarmcnt++, "Received unknown CSTA event (0x%0x) from DBS.", etp->sublow). The DBS has sent Panadrvr a CSTA Event that Panadrvr does not understand. This should be reported to Panasonic Technical Support. TDILOGERROR(dname, CAUTION, ALMLOC, alarmcnt++, "Received unknown conf event (0x%0x) from DBS.", bp->code). The DBS has sent Panadrvr a Confirmation Event that Panadrvr does not understand.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Unable to allocate Tserver buffer, return code = %d\n", rc). The Tserver has denied Panadrvr’s request for a memory buffer. TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Insufficient resources for newcall()."). Panadrvr could not allocate more memory from the Novell OS for additional call blocks. TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Send to server error first try (%d).", rc).
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Preceive(txrxReceivePort) fail.");TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Preceive(txrxThreadPort) fail.") TDILOGERROR(dname, ERROR, ALMLOC, alarmcnt++, "Preceive(appl_RX_Port) fail.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI TDILOGERROR(dname, AUDIT_TRAIL, ALMLOC, alarmcnt++, "Send Multiple Diverted Events setting changed to %s", (cfp>multipledivertedevents == 0) ? "disabled" : "enabled") TDILOGERROR(dname, AUDIT_TRAIL, ALMLOC, alarmcnt++, "Trace level changed to %s", tl) TDILOGERROR(dname, AUDIT_TRAIL, ALMLOC, alarmcnt++, "DBS is now online."). The DBS has positively responded to Panadrvr’s startup sequence.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting The Panadrvr Menu System The Panadvr Novell Telephony Services NLM comes equipped with a menu that provides maintenance and troubleshooting information and control as described in the following pages. Caution: Because many of these items affect the real-time performance of Panadrvr, use of some menus during heavy traffic periods may cause problems with Panadrvr, client applications, or the server itself.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI Item 1: Display Extension to Port Tables This selection displays the DBS extension/DBS port/DBS phone type information as sent to Panadrvr by the DBS. The items are sorted on extension value. A sample screen is shown below. Note that port values are 0based.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting 2: Display Error Counters This selection brings up a real time (updated once per second) screen which displays the values of various error counters in the Panadrvr. These counts are reset by pressing ‘C’.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI DBS rx data timeouts Panadrvr’s inter-character timer expired while receiving a transmission from the DBS. Answer Requests to DBS If the DBS does not respond to a transmission, Panadrvr sends an answer request. DBS packets Nakd by PC Panadrvr detected a transmission error while receiving a transmission. Panadrvr requested a resend. Driver selected, DBS no send data timeouts The DBS requested and was granted Panadrvr’s attention.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting GetBuf Fails Panadrvr’s internal buffer manager returned a failure code to a request. WatchDog Timeouts Once per minute, Panadrvr asks the DBS if it is OK. The DBS is given 30 seconds to respond to this question. If it does not, this counter is incremented. Port Reconfigurations Received The number of times a port extension information packet is received from the DBS.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI Packets Received The total count of information packets received from the DBS. Commands Sent The total count of command type packets sent to the DBS. This will usually be the same as the count for Packet Sent. Commands Received The count of individual command type packets received from the DBS. Bytes Sent Total of all bytes sent to the DBS. Bytes Received Total of all bytes received from the DBS.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting 4: Display Resource Info This memu item displays information used by Panasonic Technical Support. This is a real-time screen. 5: Display ACS Info This menu displays information CSTA ACS stream operations. This is a realtime screen.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI Stream Other Requests The number of miscellaneous client stream requests received (i.e., other than open, close, or abort). Stream Open Confirms The number of client stream open requests granted by Panadrvr. Stream Open Denies The number of client stream open requests denied by Panadrvr. Peak Opened Streams The maximum number of active streams with Panadrvr. Invalid Requests The number of unsupported ACS requests received by Panadrvr.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting 6: Display CSTA Stats/Info This selection displays miscellaneous counters involving CSTA-type information processed between the DBS and Panadrvr and the network and Panadrvr. This is a real-time screen.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI Lost Positive Confs CSTA positive confirmations received by Panadrvr from the DBS for which Panadrvr could not find the client owner. Lost Negative Confs CSTA negative confirmations received by Panadrvr from the DBS for which Panadrvr could not find the client owner. Lost Query Confirmations CSTA query confirmations received by Panadrvr from the DBS for which Panadrvr could not find the client owner.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting Query FWD Total CSTA Query Call Forwarding requests received from client applications. Query LNR Total CSTA Query Last Number Redial requests received from client applications. Retr. Call Total CSTA Retrieve Call requests received from client applications. Set MWI Total CSTA Set Message Waiting Indicator requests received from client applications. Set DND Total CSTA Set DoNotDisturb requests received from client applications.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI 7: Display DBS Status/Info This menu displays information about types of CSTA packets received from the DBS. This is a real-time screen.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting 8: N/A Menu not available. 9: ShutDown This menu selection allows the user to shut down Panadrvr. If selected, Panadrvr will inform the user of any non-idle conditions existing in the system and then request confirmation to unload. Note: This is the only way to effectively unload Panadrvr - attempts to ‘unload’ Panadrvr from the console will fail (Panadrvr intercepts these requests and denies them).
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI b: Display Driver Queues This screens displays Panadrvr’s resource usage with the Novell Tserver. This is a real-time screen. This screen is for field support use only.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting d: Change Max Call Time Value Specifies the maximum time in hours that Panadrvr considers a call to be valid. Should this timer expire, the call is removed from Panadrvr and call cleared events sent to all the applications monitoring the affected extensions. Note, this has no effect on the actual DBS call. The default is 12 hours. e: Call Processing Toggles This menu selection allows modification of certain CSTA event sequences.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI f: Display API Control Signals This is a real-time display of the API<->PC port control signals. The ‘-’ character represents an active level while the ‘_’ character represents an inactive level. The 3 signals represented are Data Carrier Detect, Data Set Ready, and Carrier Detect Signal.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting Present Active Calls The count of active calls that Panadrvr is currently processing. A call involves 1 to 4 parties (trunks or extensions). Present Active Connections The count of active connections that Panadrvr is controlling. A connection is the occurrence of a monitored extension within an active call block. Peak Active Calls The maximum active calls Panadrvr has handled so far.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI h: N/A Menu not available. i: Set Debug Trace Level This selection is only available in the debug version of Panadrvr. It allows the operator to select the level of status reporting to the system console (and log file if active) by Panadrvr. Present setting 1 0: Tracing Off 1: Trace 2: Debug 3: Caution 4: Error Enter 0-4 (ESCape to exit)... 0: Tracing Off Disables all trace messages. 1. Trace Enables the most verbose reporting by Panadrvr.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting k: Change MWI Activator Specifies the activator extension of a CSTA set message waiting indicator request. This is normally supplied through private data, however, most applications are not written to support this option for Panasonic. This option allows the command to be honored by the driver and passed to the DBS. If not set, and private data not supplied, the command is rejected. This value is normally disabled (-1).
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI CallID: The call id assigned by Panadrvr to this call block Type: The type of port associated with this connection. ‘Int’ indicates internal, ‘Trk’ indicates external while ‘---’ indicates the slot is empty. Port: The 0 (zero) based DBS port value involved in this connection. Note: Add 1 to the port number shown on this screen to determine the actual port on the DBS. State: The CSTA state of this connection as assigned by Panadrvr.
Section 520 - TSAPI Chapter 5. Maintenance and Troubleshooting q: Display Monitor IDs This selection is intended for Panasonic Technical Support use only. r: Display Conference Tables This selection is intended for Panasonic Technical Support use only. s: Display Runtime Config Structure This selection displays Panadrvr’s internal switches as set by command line load switches or menu toggle selections.
Chapter 5. Maintenance and Troubleshooting Section 520 - TSAPI u: Display Call Times This selection displays the accumulated time for each current call.
Index A F ACS Info, displaying . . . . . . . . . . . . . . . . . 31 Active Call List, displaying . . . . . . . . . . . . 43 Alarm Log Entries . . . . . . . . . . . . . . . . . . . 19 AUDIT TRAIL Messages . . . . . . . . . . . 23 CAUTION Messages . . . . . . . . . . . . . . . 20 ERROR Messages . . . . . . . . . . . . . . . . . 21 FATAL Messages . . . . . . . . . . . . . . . . . 19 WARNING Messages . . . . . . . . . . . . . . 20 API Circuit Card, installing . . . . . . . . . . . . .
Index Section 520-TSAPI Port Monitor Info, displaying . . . . . . . . . . 38 Programming the DBS . . . . . . . . . . . . . . . . . 8 R Requirements . . . . . . . . . . . . . . . . . . . . . . . . 5 Resource Info, displaying . . . . . . . . . . . . . 31 Resource Names/IDS, displaying . . . . . . . 37 Runtime Config Structure, displaying . . . . 45 S Setting the Debug Trace Level . . . . . . . . . 42 Setting up Telephony Services users . . . . . 14 Shutting down Panadrvr . . . . . . . . . . . . . . .
