pi 15.20 draft

924
Program Interface Database Reference Manual (Version 15.20.xx) The flexible way to communicate Preliminary Draft

Upload: srishyn

Post on 22-Feb-2015

261 views

Category:

Documents


15 download

TRANSCRIPT

Preliminary Draft

Program Interface

Database Reference Manual(Version 15.20.xx)

The flexible way to communicate

The information contained in this document is proprietary and is subject to all relevant copyright, patent and other laws protecting intellectual property, as well as any specific agreement protecting TADIRAN TELECOM LTD.'s (herein referred to as the Manufacturer) rights in the aforesaid information. Neither this document nor the information contained herein may be published, reproduced or disclosed to third parties, in whole or in part, without the express, prior, written permission of the Manufacturer. In addition, any use of this document or the information contained herein for any purposes other than those for which it was disclosed is strictly forbidden. The Manufacturer reserves the right, without prior notice or liability, to make changes in equipment design or specifications. Information supplied by the Manufacturer is believed to be accurate and reliable. However, no responsibility is assumed by the Manufacturer for the use thereof nor for the rights of third parties which may be effected in any way by the use thereof. Any representation(s) in this document concerning performance of the Manufacturer's product(s) are for informational purposes only and are not warranties of future performance, either express or implied. The Manufacturer's standard limited warranty, stated in its sales contract or order confirmation form, is the only warranty offered by the Manufacturer in relation thereto. This document may contain flaws, omissions or typesetting errors; no warranty is granted nor liability assumed in relation thereto unless specifically undertaken in the Manufacturer's sales contract or order confirmation. Information contained herein is periodically updated and changes will be incorporated into subsequent editions. If you have encountered an error, please notify the Manufacturer. All specifications are subject to change without prior notice.

Copyright by TADIRAN TELECOM LTD., 1993-2005. All rights reserved worldwide. Protected by U.S. Patents 6,594,255; 6,598,098; 6,608,895; 6,615,404 All trademarks contained herein are the property of their respective holders.

ForewordWelcome to the Coral system Program Interface and Database Reference Manual. Flexibility is one of the great strengths of the Coral Systems. This manual is a highly detailed explanation of the core of the Coral FlexiCom 300, 400, 5000, 6000 and Coral IPx 500, 800, 3000, 4000, as well as all previous Coral SL, I, II, III ISBX Telephone systems, the Program Interface (PI). By means of the PI, virtually all present and future communication needs can be customized for each site or location. The Program Interface is an integral part of the Coral product and is designed to allow you to serve your client creatively.

Record of ChangesIssue No. 0 1 2 Issue Date September 1993 January 1994 January 1995 Brief Description Software Version 8.3x, Preliminary Draft 1 Software Version 8.3x, Preliminary Draft 2 Feature updates with TBR, 4TEMP, includes V8.60 and new comprehensive index Software Version 9.2x, Preliminary Draft 1 Feature updates with CoraLINK, CoralQNET, 4VSN card, 8VSN card, APA, VDM, and Backup for large systems. Includes Version 9.2x Includes Software Version 9.35 Feature Updates with Wireless Station, SLS, SKW and SDT cards, Coral ISDNet replaces Coral QNET. Includes Software Version 9.5x Coral SL, 8DRCM, Malicious Call Trace, NPL Default change (add # to default dial numbers beginning with 1). Includes Software Version 9.87 Entered by: Tadiran Tadiran Tadiran

3

June 1995

Tadiran

4 5

February 1996 November 1997

Tadiran Tadiran

6

July 1997

Tadiran

Record of ChangesIssue No. 7 Issue Date November 1999 Brief Description Includes Software Version 10.19. No Data Connectivity to VDK,VDM and TIM Collect Call Reject Tone, Whisper Page, Second Ringback Tone (i.e. Call Waiting or Call Offer), Caller ID on Analog Trunks, 4TWL card GKT and Fonetasy PI Baud Rate Max: 38400 bps FLASH: MEX SVC24 replaces SVC Call Independent Signalling Connection Support Entered by: ECI Telecom

See New Developments Summary (Version 10.19) CN 7244-7121901 for complete list of changes.

Record of ChangesIssue No. 8 Issue Date September 2000 Brief Description Entered by: Includes Software Version 10.38. ECI E911 - CAMA support Telecom (USA) LTD. R2MFC supported on 30TM card. VFAC on Dial Service Retain Music Sources throughout Network. IVR-ACD Voice Mail on Keyset New Network Rerouting options 4IAA discontinued {V10.21} HDC - High Density Controller For Coral II-HT {V10.21} RSIS-HD - For Coral II-HD/ R and Coral III-HD/R {V10.21} See New Developments Summary (Version 10.21 and 10.38) for complete list of changes. Includes Software Version 11.08 Coral FlexiCom FlexSet SFT cards See New Developments Summary (Version 11.08) for complete list of changes. Includes Software Version 11.10 with the following new features: AutoSet Relocate FlexiCall (Phase 1) VIP Ring Second Party Speaker Status See New Developments Summary (Version 11.10) for complete list of changes. Tadiran Telecom Business Systems, LTD.

9

December 2001

10

May 2002

Tadiran Telecom Business Systems, LTD.

Record of ChangesIssue No. 11 Issue Date November 2002 Brief Description Includes Software Version 14.1x. The following features were added: Voice Over IP Hot Standby system Caller ID on SLTs -receiving over analog trunks (no extraneous hardware needed) Look Ahead Routing (LAR) Call Duration Limit Call Forwarding Internal/ External The following hardware was added: UGW card MG module IP Keysets (FlexSet-IP 280S) 8DRCF modem (56 Kbps) Coral FlexiCom 6000 Control Cards: MCP-ATS, FMSD, CFD, 16/32GC iCMC-200 4/8T-CID iDSP MEX-IP MCP-IPsl IPG The DX Version was cancelled. Entered by: Tadiran Telecom Business Systems, LTD.

Record of ChangesIssue No. 12 Issue Date January 2004 Brief Description Includes Software Version 14.65.xx with the following new features: Voice Over IP (Phases II) Turret Console support ALI on Trunk Groups APA Authorization Enhanced (short) calling message Priority Preemption Internal SMDR Voice Page FlexSet-IP Numbers 4TWL-Rotary Coral System Directory FlexiCall (Phases II) Individual Remote System Services (IRSS) Overlap Dialing over PRI Extended CID Extended iCMC Voice Mail Support

Entered by: Tadiran Telecom Business Systems, LTD.

See New Developments Summary (Version 14.65.xx) for complete list of changes. The following hardware was added: MCP-IPx card Coral IPx 500,800,3000,4000 13 April 2004 Coral Version 14.66.xx. See New Developments Summary (Version 14.66.xx) for complete list of changes. Italian Defaults added PS Ringer Shelf Defaults for IPx systems added various new parameters added

Tadiran Telecom Business Systems, LTD.

Record of ChangesIssue No. 14 Issue Date June 2005 Brief Description Coral Version 14.67.34. See New Developments Summary (Version 14.67.xx) for complete list of changes. Coral Verison 15.23.xx. See New Developments Summary (Version 15.20.xx) for complete list of changes. Entered by: Tadiran Telecom LTD. Tadiran Telecom LTD.

15

December 2005

List of AbbreviationsAbbrv. Meaning#s4TBR 2SD 2SK 2500 SET 3-Way 30T,30T/E 30T/M 30T/x 4ALS 4BID 4DTR 4GC 4IAA 4SH/S 4SK 4T 4T-C Two Station Data Circuit Card Two Station Key Telephone Card The basic SLT touch-tone desk telephone Three Way Party Call 30 Digital Trunk Circuit Card E1 European Standard 30 Digital Trunk Circuit Card E1 Mexican Standard 30 Digital Trunk Circuit Card E1 Standard Variations Four ALS70 Trunk Circuit Card Four Trunk Belgium Inward Dialing Circuit Card Four DTMF Receiver Circuit Card Four Circuit Group Controller Circuit Card 4 Port Integrated Automated Attendant Four Single Line Telephone Interface Card with Hotel Circuit Four Station Key Telephone Card Four Trunk Circuit Card 4 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion 4 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion for Coral IPx systems 4 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer 4TBR with a 4/8CID card in piggyback fashion 4 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion for the Coral IPx systems 4 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 4TEM 4TEMP 4TMR 4TPF 4TWL 4TWLsl 4VS 4VSN 500 SET 8ALS 8BID 8DID 8DTD 8DTR 8SD

Abbrv.

Meaning8CID card in piggyback fashion for the Coral FlexiCom 200 or SL systems Four Trunk BRI Circuit Card Four Trunk E&M Tie-Line Circuit Card Four Trunk E&M Pulsed Tie-Line Circuit Card Four Trunk with Metering Circuit Card Four Trunk Power Fail Circuit Card Four Two Way Loop Trunk Circuit Card Four Two Way Loop Trunk Circuit Card for FlexiCom 200 systems Four Digitized Voice Circuit Card No Longer Available Four Digitized Voice Circuit Card- field installable voice messages The old SLT rotary dial telephone desk Eight ALS70 Trunk Circuit Card Eight Trunk Belgium Inward Dialing Circuit Card Eight Trunk Direct Inward Dialing Circuit Card Eight Dial Tone Detector Circuit Card Eight DTMF Receiver Circuit Card Eight Station Data Circuit Card

8/16/24SDT Standard Digital 8, 16 or 24 Line Telephone Interface Card 8/16/24SFT Standard Digital 8, 16 or 24 Line Telephone (2wire) Interface Card supporting the FlexSet as well as the DKT/DST/GKT series. 8D8Ssl 8/16SDTsl 8 Digital Key and 8 Single Line Telephone interface Card for Coral FlexiCom 200 systems Standard Digital 8 or 16 Line Telephone Interface Card for Coral FlexiCom 200 systems

4T-Cipx

4T-CID

4T-CIDipx

8/16SFTipx Standard Digital 8 or 16 Line Telephone Interface Card for the Coral IPx 500 supporting the FlexSet as well as the DKT/DST/GKT series. 8/16SFTsl Standard Digital 8 or 16 Line Telephone Interface Card for the Coral FlexiCom 200 supporting the FlexSet as well as the DKT/ DST/GKT series. Eight Single Line Telephone Interface Card with Hotel Circuit

4T-CIDsl

8SH/S

Abbrv.-1

List of Abbreviations

PI Reference Manual

Abbrv.8SK 8SKD

MeaningEight Station Key Telephone Circuit Card Eight Station Key Digital Circuit Card

Abbrv.ACK ACNR ACSE AE ALI

MeaningAcknowledge Automatic Call Number Redial CoraLINK-Application: Association Control Service Element Application Entity Automatic Location Identification. This is the cross referenced location information based on the callers ID. (Abonnee Lijn Signalering 1970) Trunk Circuit Card - Netherlands Standard Additional Network Feature Automatic Number Identification Answer American National Standards Institute Application Processor Adapter For a DKT2000 Telephone Applications Processor Data Link Application Protocol Data Unit CoraLINK-Application Programming Interface AC Power Supply Automatic Route Selection American Standard Code for Information Interchange Abstract Syntax Notation One Auxiliary Service Unit Circuit Card Attendant

8/16/24SLS 8, 16 or 24 Line Standard 2-Wire Single Line Station Interface Card 8/16SLSsl 8 or 16 Line Standard 2-Wire Single Line Station Interface Card for Coral FlexiCom 200 systems Eight Magneto Telephone Circuit Card Eight Trunk Circuit Card 8 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion 8 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion for Coral IPx systems 8 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer 4TBR with a 4/8CID card in piggyback fashion 8 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion for the Coral IPx systems 8 port Loop-Start/Ground-Start trunk interface card with power failure (PF) transfer and a multi-pin connector to attach an optional 4/ 8CID card in piggyback fashion for the Coral FlexiCom 200 or SL systems Eight Trunk BRI Circuit Card Eight Trunk with four Power Fail Circuit Cards 16 Single Line Telephone Interface Card with Hotel Circuit 16 Station Key Digital Circuit Card

8SM 8T 8T-C

ALS70 ANF ANI ANS ANSI APA APDL APDU API APS ARS ASCII ASN.1 ASU ATT

8T-Cipx

8T-CID

8T-CIDipx

8T-CIDsl

8TBR 8TPF 16SH/S 16SKD

BBCS Bearer Capability Support (ISDN) Bearer Capability COS Basic Encoding Rules Bi-Directional R2MFC Protocol for use with 30T/M card version 32.xx and later Belgium Inward Dialing Busy Lamp Field Bits Per Second (RS-232 parameter)

AAA ACC ACCT ACD Automated Attendant (4IAA card) Access Account Code Automatic Call Distribution, Automatic Call Distributor

BCCOS BER BI_D BID BLF BPS

Abbrv.-2

PI Reference Manual

List of Abbreviations

Abbrv.BRI BSY BUT

MeaningBasic Rate Interface (ISDN) 2B+D (see also 4TBR, 8TBR) Busy

Abbrv.Coral FlexiCom Coral IPx

MeaningFamily of Coral FlexiCom 200, 400, 5000, 6000 systems Family of Coral IPx 500, 800, 3000, 4000 Systems for 19 and 23 rack mounting Class of Service Coral Paging Adapter Calling Party Number Control Power Supply Coral FlexiCom 200 Expansion Unit. Maximum of 2 Expansion units per Coral SL or FlexiCom 200 Base unit. Computer Supported Telecommunication Applications; OSI Layer 7 Communication between a computing network and a CoraLINK System Coral Supported Telephony Services CSTS, is a Coral protocol and is used for communication between the CCM 3 and the Coral, providing more data transfer ability and better stability. Using the CSTS, Coral includes ANI and DNIS information in the messages among other relevant data. Computer Telephony Integration

Button on a keyset

CCAMA Centralized Automatic Message Accounting (Used for USA systems only). CAMA telephony protocol detects MF tones sent by the telephony equipment and deciphers the caller ID. Computerized Attendant Position Country Code Continuous Communication Systems Coral Call Master: Coral system to run ACD applications. Card Database European Conference of Postal and Telecommunications Administration Call Forward Caller ID Call Independent Signalling Connection Circuit

COS CPA CPN CPS CSLX

CAP CC CCS CCM CDB CEPT CF CID CISC CKT CLA

CSTA

CSTS

CTI

DDB Database 1 MB Static RAM piggy-back located on the MEX-IP2 or MCP-IPx2 card for database software with battery backup (Coral Common Control) Direct Dialing Inward (same as DID) Direct Dialing Outward (same as DOD) Distinctive Dial Tone Destination Digit (0 to 9, * or #) Digital Trunk Diagnostics Telephone Dial Pad including the numbers 0 through 9 and * and #. Direct Inward Dialing (same as DDI)

CoraLINK Adaptor (piggy back) Baby card is located on the MEX-IP2 or MCP-IPx2 card for CTI applications. Calling Line Identification Calling Line Identification Presentation Calling Line Identification Restriction Card List Conference Circuit Card Conference (3way CNF and 6way meet me bridge) and synchronization card for digital trunks Central Office, Public Exchange (same as LEX) Conference

DBX

CLI CLIP CLIR CLIS CNF CNSsl

DDI DDO DDT DEST DGT DGTL DI Dial Pad DID

CO CONF

Coral Common Control Coral systems based on a MEX-IP2, MCP-IPx2 and MCP-ATS;

Abbrv.-3

List of Abbreviations

PI Reference Manual

Abbrv.DIL DIM DISA DISC DKT DLIS DND DNIS DOD DP DPC DPEM

MeaningDirect In-Line Data Interface Module Direct Inward System Access Disconnect Digital Key Telephone (Full Feature Phone), 2Wire Interface Digital List Do Not Disturb Dialed Number Identification Service Direct Outward Dialing (same as DDO) Dial Pulse Digital Protocol Converter Card Digital Programmable Expansion Module for DKT 2000 sets (FlexSet 40B for FlexSet 280 Series) Dialogue Service Element Digital Subscriber Line Display Module, 2 rows by 24 characters Display Module, 2 rows by 40 characters

Abbrv.

MeaningE

E1 E911 E&M ECMA EIS EKT EOD EOS ETSI EU EVEN EXE EXCL EXT

30 Digital Circuit Card - European Standards Emergency 911 call Tie Trunk (Ear and Mouth) European Computer Manufacturers Association EKT to SLT Interface, Special Mode Electronic Key Telephone, 4-Wire Interface End of Dial End of Selection European Telecommunications Standards Institute Europe Evening Executive (Privilege) Exclude External Call

DSE DSL DSP48 DSP80 DSS DSS1 DST DST

FDirect Station Selection Digital Subscriber Signalling no.1 Destination (used in database control) Digital Standard Telephone or Digital SingleLine Telephone, 2-Wire Interface Dial Tone Detector Data Terminal Equipment Data Terminal Ready Dial Tone Multi-Frequency Digitized Voice Message System, based on 4VS or 4VSN cards. FAC FCC FDC Forced Account Code Federal Communication Commission (USA) Discontinued High Density 3 1/2 1.44 M (2.88) Floppy Diskette Controller - (Coral Common Control) Facility Information Element Fonetasy Key Telephone Forward Discontinued 2.5 MB Flash Memory piggy-back card located on the MSX card; up to 4 FSX cards in one Coral Common Control

DTD DTE DTR DTMF DVMS DX Common Control

FIE FKT FWD FSX

GDiscontinued Coral PABX system based on the MCC card Control; generally used in very large systems providing more capabilities and operation speeds of higher traffic systems with up to 50,000 busy hour call attempts capacity. GID GFT German Inward Dialing Generic Functional Transport

Abbrv.-4

PI Reference Manual

List of Abbreviations

Abbrv.GKT GRP GS

MeaningGraphic Key Telephone Group Ground Start Trunk

Abbrv.KB1-24 KSI

MeaningKeyboard Number 1 -24 EKT to SLT Interface

LLEX Local Exchange (CO) as used in Europe Least Cost Routing Listed Directory Number (site LDN) Light Emitting Diode Loop/Ground Start Trunk Public or Private Library Loop Start Trunk

HHDLC HI HF HKFLS High Data Level Control Human Interface (same as PI) Hookflash Hookflash LCR LDN LED LGS

II/C I/O ICD iCMC ID iDSP IMC8 Incoming Call

LIB LS

MIn/Out International Code Designator Integrated Coral Message Center Identification 64 circuit FSK (Frequency Shift Keying) tone generator shared service card Integrated Memory Card with 8 Mbytes flash memory capacity for the MEX-IP2 and MCP-IPx2 Common Control Card. It contains the generic software of the Coral and is used to store the system database. Internal Call Internal Protocol Integrated Services Business Exchange Integrated Services Digital Network MEX-IP IST Industry Standard Telephone (same as SLT) MCP-IPx2 MEX MCC MCDX MCP MCP-ATS MCP-IPsl MCP-IPx Main Control Card for the DX Common Control Main Controller DX Main Control Processor Card (i.e., MEX-IP2, MCP-IPx2, MCP-ATS) MCP Card for Coral FlexiCom 6000 and Coral IPx 4000 Common Control MCP Card for Coral FlexiCom 200 Common Control in Software Versions 14.1x MCP Card for Coral IPx 500 and FlexiCom 200 Common Control in Software Versions 14.6x MCP Card for Coral IPx 500 Common Control in Software Versions 15.xx and later MCP Card for Coral Common Control in Software Versions 10.xx, 11.xx and 12.xx MCP Card for Coral FlexiCom 300, 400, 5000 and Coral IPx 800, 3000 Common Control in Software Versions 14.xx MCP Card for Coral FlexiCom 300, 400, 5000 and Coral IPx 800, 3000 Common Control in Software Versions 15.xx and later Main Distributing Frame Member Multi-Frequency Code Multi Frequency Receiver Card

INT IP ISBX ISDN

KKeyset KB KB0 FlexSet/FlexSet-IP/EKT/VDK/DKT/DST/GKT/ FKT Telephone Kilo Bytes (used for memory size) Keyboard Number 0 on Main Control Card (MCP-IPx2, MEX-IP2, MCP-ATS, MCBcsx, etc.)

MEX-IP2

MDF MEM MFC MFR

Abbrv.-5

List of Abbreviations

PI Reference Manual

Abbrv.MIC MIS MPEM MSDX MSG MSI MSN MSX

MeaningMicrophone Management Information System for Traffic Reports (old-see TAP) Multi-Programmable Expansion Module for EKT and VDK Sets Mass Storage DX Message Manufacturer Specific Information Multiply Subscriber Number Discontinued MCP Card for Coral Common Control in Software V8.xx and V9.xx

Abbrv.PC-ACD PCB PCC PCM PDB PEM PEX PF PI PICS

MeaningPersonal Computer Automatic Call Distributor Printed Circuit Board PC Console Pulse Code Modulation Port Database Programmable Expansion Module for EKT and VDK sets Peripheral Expansion for DKT sets Power Fail Program Interface (same as HI) Protocol Implementation Conformance Statement Private Integrated Services Network Private Integrated Services Network Exchange Port List Property Management System Peripheral Power Supply Preference Primary Rate Interface Card, (23B+D) 1.5 Mbps, Enables Coral subscribers to connect to the ISDN public network Primary Rate Interface Card, (30B+D) 2 Mbps, Enables Coral subscribers to connect to the ISDN public network Priority Private Library Primary Program Proceed to Send Post, Telegraph and Telephone Administration Public Library Ports Without Disconnect Supervision

NPISN N/A NA NFE NP, NPL NPID NSF NUM Not Applicable No Answer Network Facility Extension Numbering Plan Numbering Plan Identification (PRI calls) Network Specific Facility Number PINX PLIS PMS PPS PREF PRI 23

OOAI O/G OHVA ONHK Open Application Interface Outgoing Call Off-Hook Voice Announce Onhook

PRI 30

PRIO PRIV PRM PROG

PPABX PAD PB PBX PC Private Automatic Branch Exchange

PTS PTT PUB

Packet Assembly Disassembly PWDS Peripheral Buffer Circuit Card Private Branch Exchange Personal Computer RAM

RRandom Access Memory

Abbrv.-6

PI Reference Manual

List of Abbreviations

Abbrv.RBS RCV RJCT RMI RO ROSE ROW RPS RSIA RSIM RSIS RTSE RTT

MeaningRadio Base Station for Wireless Systems Receive

Abbrv.Soft Keys SPKR

MeaningProgrammable Telephone Keys relating to different telephone conditions Speaker Source (used in database control) Supplementary Service Station Start Time/Day Suspect Service and Control Circuit Card Service and Control Circuit Card - Digital Seize

Reject SRC Remote Maintenance Interface Circuit Card SS Remote Operations ST CoraLINK-Remote Operation Service Element STR Rest of the World SUSP Ringer Power Supply SVC24 Remote Shelf Interface Adaptor Card SVC-D Remote Shelf Interface Master Card SZ/SZE Remote Shelf Interface Slave Card Reliable Transfer Service Element Regie of Telegraphy and Telephone (Belgium) T1 TAP TBR

T24 Digital Trunk Circuit Card North American Standard Traffic Application Package Trunk BRI Circuit Card Trunk BRI Circuit Card with external power option Trunk Code (GID) Time Division Multiplexing Terminal Terminal Interface Module Trunk Trunk Group Trunk Number Tenant Transmit

SSAU Software Authorization Unit for controlling system software packages plugged on the 32GC, MEX-IP2, MCP-IPx2 or MCBcsx card Signalling Carriage Mechanism Secondary Dial Tone Digital Key (DKT &DST) Station Card Secondary Serial Number Service Coral Peripheral Station Cards supporting FlexSets as well as the DKT/DST/GKT series. Stop/Go Session Initiation Protocol Wireless Extension Interface Card with support for base stations Single Line Telephone (same as IST) Single Line Station Card Station Message Detail Recording

TBRP TC TDM TERM TIM TK TK-G TK-N TNNT TRX/TX

SCM SDT SDT SEC SER SERV SFT SG SIP SKW SLT SLS SMDR

UUCD UM UNA UNATT Uniform Call Distributor Universal Messaging Universal Night Answer Unattended

Abbrv.-7

List of Abbreviations

PI Reference Manual

Abbrv.

MeaningV

Abbrv.

Meaning

VAC VDK VDM VDU VFAC VIC VOL VP VSM

Verified Account Code Voice Data Keyset, 4-Wire Interface Voice Data Module for DKT 2000 Series Video Display Unit Verified Forced Account Code Vision-Impaired Console Volume Voice Page Voice Synthesizer Module for Visually Impaired operator connected to an EKT

WWST WU Wireless Station Wakeup, Wake up

XXFER Transfer

Abbrv.-8

PI Reference Manual

Table of Contents 1 IntroductionGeneral Description ............................................................................................... 1-2 PI Terminal Device................................................................................................. 1-4 Hardware Setup ..................................................................................................... 1-5 Access to the Programming Interface .................................................................. 1-10 PI Terminal Control Function Commands ............................................................ 1-13 Conventions Used in this Document .................................................................... 1-16 Country Codes ..................................................................................................... 1-18

2

Programming RequirementsDefault System....................................................................................................... 2-2 Typical Site-Specific Programming ........................................................................ 2-3 Additional Programming......................................................................................... 2-4 Programming and Entering Time Units .................................................................. 2-6 Programming Functions ......................................................................................... 2-7 Locating Data Fields .............................................................................................. 2-8 Direct Access Abbreviations (DAA)........................................................................ 2-9 Entering Yes/No and Remove.............................................................................. 2-10 General Rules for Entering Names ...................................................................... 2-11 Authorization Items .............................................................................................. 2-12

3

InstallationInstallation .............................................................................................................3-2 Feature Authorization ............................................................................................3-3

TOC-1

PI Reference Manual

4

Size DefinitionSizes Definition ......................................................................................................4-2 Sizes Tab ............................................................................................................4-18 Music Sources .....................................................................................................4-24 UNITS ..................................................................................................................4-27

5

Numbering PlanGeneral Numbering Plan .......................................................................................5-3 General Numbering Plan (Alphabetical Order) ......................................................5-7 General Numbering Plan (Field/Index Order) ......................................................5-16 Special Feature Codes ........................................................................................5-48 FlexiCall/IRSS (Freedom) Feature Codes ...........................................................5-50 SHOW TYPE of NUMBER ..................................................................................5-52

TOC-2

PI Reference Manual

6

SystemFeature Timers ......................................................................................................6-2 System Features ...................................................................................................6-7 System Features - Outgoing Trunks .....................................................................6-8 System Features - Incoming Trunks ...................................................................6-15 System Features - Station Options .....................................................................6-16 System Features - Intercept/Incomplete .............................................................6-29 System Features - Call Forwarding .....................................................................6-33 System Features - Camp-On ..............................................................................6-35 System Features - Hotel ......................................................................................6-36 System Features - Messaging .............................................................................6-38 System Features - Tones ....................................................................................6-42 System Features - Diagnostics ...........................................................................6-44 System Features - ISDN .....................................................................................6-46 System Features - Network .................................................................................6-47 System Features - Wireless ................................................................................6-48 Card List ..............................................................................................................6-51 Port List ...............................................................................................................6-58 Port List - Physical Location ................................................................................6-59 Port List - Dial Numbers ......................................................................................6-63 Digital Port Bus List .............................................................................................6-74 Tone Plan ............................................................................................................6-78 Ringers ................................................................................................................6-84 Reserved Links ....................................................................................................6-91

7

Class of ServiceStation and Trunk COS .........................................................................................7-2 Attendant Class of Service ..................................................................................7-28 Tenant Class of Service ......................................................................................7-37

TOC-3

PI Reference Manual

8

Trunk ControlsGeneral Trunk Timers ...........................................................................................8-2 Trunk Timers .........................................................................................................8-6 MFR Card Database .............................................................................................8-9 General Trunk Definitions ....................................................................................8-10 Trunk Group Definition ........................................................................................8-16 Alternate Route ...................................................................................................8-31 DID/E&M Groups .................................................................................................8-32 Offset Filters ........................................................................................................8-37 Power Fail Trunk Definition .................................................................................8-39 LS/GS (Loop/Ground Start) Trunks .....................................................................8-41 4T/8T LGS Port Database ...................................................................................8-44 4T/8T Card Database ..........................................................................................8-46 E&M Continuous Timers .....................................................................................8-52 4TEM (E&M Continuous) Card Database ...........................................................8-55 4TEMP (E&M Pulsed) Port Database .................................................................8-57 4TEMP (E&M Pulsed) Card Database ................................................................8-59 4TWL Trunk Card DB ..........................................................................................8-76 URC-Card (CSX 200 & IPx 500) .........................................................................8-79 URC-Default Configuration ..................................................................................8-81 URC-Current Configuration .................................................................................8-83 URC-Card Database ...........................................................................................8-85 E&M Trunk Definition ..........................................................................................8-86 DID Trunk Definition ............................................................................................8-89 8DID Card Database ...........................................................................................8-90 T1 and 30T/x Card Configuration ........................................................................8-94 T1, PRI, TBR, 30T/x Synchronization .................................................................8-97 T1 and 30T Card Database ...............................................................................8-100 T1 and 30T Port Database ................................................................................8-103 30T/M Card Database .......................................................................................8-105 30T/M DDI/DDO/BI-D Port Database ................................................................8-111 30T/M DDI Port Database .................................................................................8-113 30T/M Timers ....................................................................................................8-114 30T/E Card Database ........................................................................................8-115 30T/E DDI Port Database ..................................................................................8-120 30T/E DDO Port Database ................................................................................8-122

TOC-4

PI Reference Manual

30T/E NonDDI Port Database ...........................................................................8-123 ALS70 Trunks ....................................................................................................8-125 ALS70 Card Configuration ................................................................................8-126 ALS70 Card Database ......................................................................................8-128 ALS70 Port Database ........................................................................................8-131 ALS70 Loop Start Port Database ......................................................................8-132 ALS70 DID Port Database ................................................................................8-133 ALS70 NonDID Port Database ..........................................................................8-134 ALS70 Trunk Timers .........................................................................................8-135 BID Trunks ........................................................................................................8-136 BID Trunk Port Database ..................................................................................8-137 BID Trunk Timers ..............................................................................................8-139 GID Trunks ........................................................................................................8-140 GID Card Database ...........................................................................................8-141 GID Port Database ............................................................................................8-145 GID Timers ........................................................................................................8-147

9

Station ControlsStation Timers .......................................................................................................9-2 SLT Definition ........................................................................................................9-5 iDSP Card Database ...........................................................................................9-15 SLT Card Database .............................................................................................9-16 Keyset/FlexSet Timers ........................................................................................9-23 Keyset/FlexSet Ring Cadence ............................................................................9-24 Wireless Stations .................................................................................................9-26 Wireless Stations .................................................................................................9-27 Keyset/FlexSet Definition ....................................................................................9-28 Keyset/FlexSet Button Programming ..................................................................9-55 Fixed System Keys - Programming .....................................................................9-83 Keyset/FlexSet Preference Programming ...........................................................9-84 APA, PEX+APA and APDL RS-232 Setup ..........................................................9-85 Magneto 8SM Card Database .............................................................................9-87

TOC-5

PI Reference Manual

10

Groups

Hunt Group ..........................................................................................................10-2 Boss Group .......................................................................................................10-18 Pickup Group .....................................................................................................10-21 Zoned Voice Page Group ..................................................................................10-22 Bell/UNA Group .................................................................................................10-23 Group Calls .......................................................................................................10-24

11

Libraries

Public Library .......................................................................................................11-2 Private Library .....................................................................................................11-7 Serial Library .......................................................................................................11-9 Large Public Library ..........................................................................................11-14 Large Public Library Numbering Plan ................................................................11-16 Large Public Library Contents ...........................................................................11-18 Directory - Systems (Shared) Directory Entries ................................................11-20 Directory - Personal Directory ...........................................................................11-22

12

Night Service

Night Service - Timers .........................................................................................12-2 Night Service- Definition ......................................................................................12-4 Weekend Timers .................................................................................................12-5 Holiday Timers ....................................................................................................12-6

13

Toll Barriers

Toll Barrier ...........................................................................................................13-2

TOC-6

PI Reference Manual

14

SMDR

Control .................................................................................................................14-2 Report Control .....................................................................................................14-8 Format Params ....................................................................................................14-9 Auto On-Line .....................................................................................................14-11 Charge Table .....................................................................................................14-14

15

Routing & Cost Calculation

Routing System Parameters ...............................................................................15-3 Routing Access General Definitions ....................................................................15-5 Routing Class of Service .....................................................................................15-8 Dial Services .....................................................................................................15-10 Route Elements .................................................................................................15-17 Routing Numbering Plan ...................................................................................15-20 Routing Translators ...........................................................................................15-23 Look Ahead Routing Triggers ............................................................................15-24 Cost Calculation Elements ................................................................................15-30 Cost Calculation Numbering Plan .....................................................................15-32 Cost Calculation Parameters .............................................................................15-33

16

Room Status/ User Canned Messages

Names .................................................................................................................16-2 Status/Message Select ........................................................................................16-3 Status/Message_Display .....................................................................................16-4 Busy Display ........................................................................................................16-5 Terminal ..............................................................................................................16-6

TOC-7

PI Reference Manual

17

Service Terminals

Password and Site Name ....................................................................................17-2 Message Control .................................................................................................17-4 Message Select ...................................................................................................17-6 Terminal Destination ...........................................................................................17-8 CoralVIEW Traffic (CVT) Terminal Destination ...................................................17-9 Call Trace ..........................................................................................................17-10 Terminal Setup ..................................................................................................17-11 KB0 Setup Through Attendant Console - Feature .............................................17-23 Terminal Reset ..................................................................................................17-24 Terminal Clear ...................................................................................................17-25 iVMF Remote Maintenance ...............................................................................17-26

18 19

Features Voice Transmission Controls

Feature Control ...................................................................................................18-2

General Description ............................................................................................. 19-2 Gains Tables .......................................................................................................19-3 Feature Control .................................................................................................19-16 Personal Port Gain, Compensation: Ports ........................................................19-21 Personal Port Gain, Compensation: Comp .......................................................19-22 Balancing Network ............................................................................................19-23

20

Wakeup

Wakeup Control ...................................................................................................20-2 Wakeup Report ...................................................................................................20-4

21

Special System OptionsTOC-8

PI Reference Manual

Database Control & Duplication SystemsDatabase Control ................................................................................................21-2 First Initialization ..................................................................................................21-3 Backup ................................................................................................................21-4 Database Control: Disk (FlexiCom 6000, IPx 4000) ...............................................................21-5 Save Database (FlexiCom 6000 and IPx 4000) ........................................................................21-6 Load DBS (FlexiCom 6000 and IPx 4000) ..................................................................................21-7 Copy Files (FlexiCom 6000 and IPx 4000) .................................................................................21-8 Show Dir (FlexiCom 6000 and IPx 4000) ..................................................................................21-10 Auto-Backup (FlexiCom 6000 and IPx 4000) ..........................................................................21-11 Database Control: FLASH (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) ....21-12 FLASH: Save (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) ............................21-13 FLASH: LOAD DBS (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) ................21-14 FLASH: SHOW FILE INFO (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) ..21-15 FLASH: AUTO BACKUP (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) .......21-16 FLASH: ERASE (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) .......................21-17 FLASH: INIT DUMP (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) ...............21-18 Duplication (FlexiCom 5000 and IPx 3000 dual control) ..........................................................21-19 HSB (FlexiCom 6000/R and IPx 4000/R redundant control) ......................................................21-24

22

Diagnostics

Diagnostic Tests ..................................................................................................22-2 Diagnostic Alarms ...............................................................................................22-5

23

Special Port Facilities

DVMS Port ..........................................................................................................23-2 Conference ..........................................................................................................23-4 Public Address/Page ...........................................................................................23-6 Modem ................................................................................................................23-7 Bell/UNA ..............................................................................................................23-8 Page_Q/Music .....................................................................................................23-9

TOC-9

PI Reference Manual

24 25

VFAC Time/Date Set and Adjust

Verified Forced Account Code ............................................................................24-2

Time Set ..............................................................................................................25-2 Time Adjust .........................................................................................................25-4

26

ISDN

System Features - ISDN .....................................................................................26-2 BCCOS Templates ..............................................................................................26-3 BCCOS Control ...................................................................................................26-5 NSF .....................................................................................................................26-6 Call by Call ..........................................................................................................26-8 Alternate Line ID ..................................................................................................26-9 ISDN Card Signaling .........................................................................................26-11

27

CoraLINK

CLA_STATUS .....................................................................................................27-2 CLA_SIZES .........................................................................................................27-7 WAIT_QUE ..........................................................................................................27-8

28

ISDNet

System Features - Network .................................................................................28-3 Node NPL ............................................................................................................28-6 Node Content ......................................................................................................28-8 Special Numbering Plan Functions ...................................................................28-11

TOC-10

PI Reference Manual

29

VoIP - Voice over IP

UGW ....................................................................................................................29-5 UGW: Default Configuration ................................................................................29-6 UGW: Current Configuration ...............................................................................29-8 IP Ports ..............................................................................................................29-19 IP Ports: Keyset .................................................................................................29-20 IP Ports: SLT .....................................................................................................29-26 IP Ports: LGS ....................................................................................................29-28 IP Ports: Net ......................................................................................................29-30 IP: Telephony Gateway .....................................................................................29-31 IP: General ........................................................................................................29-35 IP: Statistics .......................................................................................................29-40 IP: NET ..............................................................................................................29-41 IP: ZONE ...........................................................................................................29-43 UGW Software Upgrade: Activate .....................................................................29-47 UGW Software Upgrade: Cancel ......................................................................29-50 IP Keyset Software Upgrade: Activate ..............................................................29-51 IP Keyset Software Upgrade: Cancel ................................................................29-54

TOC-11

PI Reference Manual

TOC-12

1

IntroductionThe Program Interface (PI) is a detailed, menu-driven, interface system for programming the Coral System. This chapter gives general information on how to use the Program Interface and how to set-up the PI software and hardware equipment. The PI terminal commands are listed in tabular form for easy reference. Other conventions and shorthand notations used in this manual are also listed at the end of the chapter. The chapter contents include the following: General Description ......................................................................................1-2 PI Terminal Device.......................................................................................1-4 Hardware Setup ............................................................................................1-5 Access to the Programming Interface ........................................................1-10 PI Terminal Control Function Commands .................................................1-13 Conventions Used in this Document..........................................................1-16 Country Codes ............................................................................................1-18

1-1

Introduction

PI Reference Manual

General DescriptionThe Program Interface (PI) is a detailed, menu-driven, interface system for programming the Coral System. It also provides access to the diagnostic facilities contained within the system software. The PI can be accessed through any of the following types of connecting devices: video display data terminal keyboard send/receive (KSR) printer data terminal a data terminal and modem PC with VT emulator PC with CoralVIEW Designer (CVD) PC with CoralVIEW Administrator (CVA)

An additional PI function allows saving and restoring the entire database contents to a binary disk file, using a personal computer (PC) and save/restore software. Backups are also updated to the IMC8 or CFD flash memory cards. See Database Control: Disk (FlexiCom 6000, IPx 4000) beginning on page 21-5. See Database Control: FLASH (CSX 200, FlexiCom 200,300,400,5000, IPx 500,800,3000) beginning on page 21-12. In the Coral FlexiCom 400,5000,6000 and Coral IPx 800, 3000,4000 the PI data terminal is connected to the Coral through one of the three RS-232 interfaces on the RMI card (RS-232C) or 8DRCM/ 8DRCF card (RS-232E) at the cable pinouts on the Main Distribution Frame (MDF) or through the internal modem interface on the card. One RS-232E interface is provided at the front panel of the MEX-IP2, or MCP-ATS card in the Common Control (see Figure 1-1). In the CSX 200 Main Unit the PI is connected to one RS-232E interface. One KB0 is provided at the front side of the CSX 200. Additionally, the PI can be connected through an internal modem (KB4) located on the U-RMIcsx or RMIcsx card. For CSX 200 Systems with optional IPx 800X expansion unit the PI data terminal is connected to the Coral through one of the three interfaces (KB5,6,7) on the RMI card (RS-232C), or 8DRCM/8DRCF card (RS-232E) at the cable pinouts on the Main Distribution Frame (MDF) or through the internal modem interface (KB8) on the card. In the Coral IPx 500M Main Unit the PI is connected to one of four RS-232E interfaces. One KB0 is provided at the front side of the MCP-IPx2 card. Another three interface connectors, KB1, KB2 and KB3 are provided at the upper left side at the auxiliary I/O entry of the main cage (MSBipx card). Additionally, the PI can be connected through an internal modem (KB4) located on the MSBipx card. For Coral IPx 500 Systems with optional IPx 800X expansion unit the PI data terminal is connected to the Coral through one of the three interfaces (KB5,6,7) on

1-2

PI Reference Manual

Introduction the RMI card (RS-232C), or 8DRCM/8DRCF card (RS-232E) at the cable pinouts on the Main Distribution Frame (MDF) or through the internal modem interface (KB8) on the card. Multiple but simultaneous, independent PI sessions from different monitors are possible, though this practice is not recommended. Access to the PI is restricted to trained and qualified technicians. Uncertified personnel can unknowingly cause serious damage to the communication system database. The terminal or printer displays Coral-generated prompts (questions, instructions, options, etc.) in plain English; the programmer can make an entry, skip to the next prompt, or exit the programming function. The various card functions can be accessed using a written command, e.g. NPL to jump directly to the Numbering Plan or accessed stepwise, e.g. (0,0,5). Entries are made using a standard keyboard; the keyboard DELETE (not BACKSPACE) key is used on most terminals to erase incorrect characters. Entries are displayed as they are keyed. Changes entered, take effect in real time; i.e., as soon as the ENTER key is pressed, the change is entered into the system memory, and immediately takes effect.

1-3

Introduction

PI Reference Manual

PI Terminal DeviceThe Program Interface (PI) terminal device should be either an asynchronous, ASCII video display data terminal, a Personal Computer (PC) with terminal emulator software, a KSR printer equipped with a serial interface (RS-232E), a Bell 103/212A/V.90 compatible data modem (see Table 1-1 below). Either one of two popular video display terminal emulations are supported for character attributes, cursor positioning and screen refresh. If the video display terminal connected to the Coral system does not emulate one of the two supported emulations, or a portable data printer is used instead of a video display terminal, use the Printer definition in Terminal Setup beginning on page 17-11. The Modem setup definition is described in the same branch.Table 1-1: Programming Interface Terminal CommunicationsTerminal Type DEC VT-100 (Default) Qume QVT-101 (or ADM-3A/5, TV1900) Standard KSR Data Printer Standard PC (also for CVT, CVA or CVD) CID terminal (not KB0) RS-232 Data Transfer Rate 8DRCF, 8DRCM, RMI, MEX-IP2, MCP-ATS, MCP-IPx2, MSBipx (IPx 500M), MCBcsx (CSX 200) Modem Compatibility 8DRCF, MSBipx (IPx 500M), RMIcsx, U-RMIcsx (CSX 200) Modem Compatibility 8DRCM, RMI Parity Data Word Length Stop Bits Format Bell 103/212A Answer-300/1200 bps CCITT V.21/V.22 Answer Mode-300/1200 bps None (Default), Odd, Even, Mark or Space 7 or 8 (Default) bits 1 bit Asynchronous data Standard ASCII character set 9,600 bps Default Baud Rate for all systems. See BAUD RATE (page 17-21) for a detailed list when changing baud rates.

56 Kbps (V.90 ITU-T)

r

To use the SNAP (real time display) functions available in some programming areas, the PI device must emulate a Digital Equipment Corporation VT-100 or a Qume Corporation QVT-101. This function is not essential for programming; however, it is beneficial when the PI device is also used for system diagnostics.

While the PI terminal device communication specifications may be altered, the default values listed in the above table, default upon first initialization, and must be used in order to initially enter the Coral system programming interface. Afterwards they may be changed.

1-4

PI Reference Manual

Introduction

Hardware SetupThe PI terminal device can be connected to an RS-232 type interface on the system; KB0 in all Coral systems, and KB1, KB2, KB3 in IPx 500 systems or to the RMI/8DRCM/8DRCF internal modem. All features and functions are available through either connection.

On-Site ConnectionThe PI terminal is connected to the MEX-IP2/MCP-IPx2/MCP-ATS/CSX 200 front panel DB9 connector, KB0. Note that the connector is wired as a Data Terminal Equipment (DTE) device. Verify that electrical connections between the KB0 port and PI terminal reflect a DTE to DTE or Null Modem connection. Many video display terminals require only the Transmit Data (Tx), Receive Data (Rx) and Signal Ground conductors to be connected between the PI terminal device and the KB0/KB1 or 8DRCM/8DRCF/RMI serial data port. The Qume QVT-101 terminal requires that the Clear to Send conductor be active or high (+3 to +12Vdc) to display received data. Figure 1-2 shows the connections for using a standard PC (COM1 or COM2) with the KB0 interface. Figure 1-3 shows the connections for using a VT-100 or Qume QVT-101 with the KB0 interface. Some portable data printer terminals require that one or more status conductors (e.g. Carrier Detect or Clear to Send) of the terminal be high, active, or asserted for the terminal to be on-line or in a communications mode. The Request to Send and Data Terminal Ready conductors of the KB0 connector are kept high and may be connected to conductors of the terminal device for this purpose. If the terminal device appears unresponsive after it is connected to the Coral, consult the manufacturers operating manual in order to determine if the selected terminal device required any status conductor to be active.

1-5

Introduction

PI Reference Manual

Figure 1-1. Control CardsFront Panel

MEX-IP2 MEX-IP2M C P I P x 2

Option Switches

Option Switches KB0KB0

Set DIP Switch# 1 to the Right for KB0 Connections

KB0

RESET IMC-x Release Button IMC-x RESETRESET

IMC8 Release Button IMC8 LAN SAU

RS-232 E

KB0 Set DIP Switch# 1 to the Right for KB0 Connections

LAN

SAU

RESET Indicator Lights

RESET

ALRM SPKR HDD PWR

CPV5350

MCP-IPx2 Coral IPx 500

MEX-IP2 Coral IPx 800, 3000 FlexiCom 400, 5000

MCP-ATS Coral IPx 4000 FlexiCom 6000

CSX 200GC UGW CPU

MRC GC ACT. POWER

MAINT.

FAN

KB0

UGW COM

LAN

2

4

6

8

WAN PRINTER

N.C. RESET SYS. RESET

MEMORY

DISK 1 3 5 7

IMC-x Release Button

IMC-x

KB0

RESET

1-6

PI Reference Manual

Introduction

KB0:

Data Terminal Port: RS232-E DTE Interface. Default configuration: 9600 bps, No parity, 8 data bits, 1 stop bit, VT-100. Table 1-2 describes the KB0 RS-232 pin connections to the PI terminal. MEX-IP2 and MCP-IPx2: Switches 1-8 Always Set to the Right Switch 1 LEFT for PI-LAN (LIU) Connections Only Switch 1 RIGHT for KB0 Connections Switch 3 (MCP-IPx2) LEFT for IMC4 Switch 7 should be set to OFF (RIGHT) so that the system will respond after a power failure. Coral IPx 4000 and Coral FlexiCom 6000 systems: The Option switches are located on the 32GC control card, not shown here. There are only 4 switches (0-3) and Switch 3 should be set to OFF (Right) so that the system will respond after a power failure.

Option Switches:

Reset Button:

Forces the CORAL system to restart.

WARNING! Pressing this button will cause partial initialization and drop all calls. 7-Segment Display:For alarms and diagnostics. CSX 200, Coral IPx 4000 and Coral FlexiCom 6000 systems: 7-segment display is not used. Software Authorization Unit is attached here. Coral IPx 4000 and Coral FlexiCom 6000 systems: The SAU socket is located on the 32GC control card, not shown here. CSX 200 system: The SAU socket is located on the right panel.

SAU

Table 1-2: KB0 RS-232 Interface Pin FunctionsPin 1 2 #* Signal Mnemonic N/A RX (Receive) Function --Receives serial data input fro communications link Sends serial output to communications link Data set is ready to establish a communications link Ground Data set is ready Indicates to data set that UART is ready to exchange data Data set is ready to exchange data ---

3

Tx (Transmit)

4

DTR

5 6 7

GND DSR RTS

8 9 *

CTS N/A

To connect the Coral system, pins 2, 3 and 5 are sufficient.

1-7

Introduction

PI Reference Manual

Figure 1-2. PI DB9 Terminal to KB0 Connection

5 9 4 3 2 6 1

SIGNAL GROUND - 5 9 DATA TERMINAL READY - 4 TRANSMIT DATA - 3 RECEIVE DATA - 2 CARRIER DETECT - 1

6

KB0 PROGRAMMING PORT (USE FEMALE CABLE 9 PIN CONNECTOR)

9 PIN PC ASYNC. SERIAL PORT (USE FEMALE CABLE CONNECTOR)

Figure 1-3. PI DB25 Terminal to KB0 Connection

13 25

5 - SIGNAL GROUND 4 - DATA TERMINAL READY 3 - TRANSMIT DATA 2 - RECEIVE DATA 1

SIGNAL GROUND - 7 DATA SET READY - 6 CLEAR TO SEND - 5 REQUEST TO SEND - 4 RECEIVE DATA - 3 TRANSMIT DATA - 2 1 14

KB0 PROGRAMMING PORT (USE FEMALE CABLE 9 PIN CONNECTOR)

PC Async. Serial Port or Async.Data Terminal (USE FEMALE CABLE CONNECTOR)

1-8

PI Reference Manual

Introduction

Remote ConnectionsRemote connections are made by connecting the PI terminal device to a modem and establishing a voice call from the remote terminal modem to the Coral Modem. CSX 200 system requires the installation of a U-RMIcsx or RMIcsx card to accommodate remote access, or the installation of an external, customer provided modem to the KB0 interface. Coral IPx 500 system is equipped with a built in modem. Coral FlexiCom 400, 5000, 6000 and Coral IPx 800, 3000, 4000 systems require the installation of an 8DRCM, 8DRCF or RMI card to accommodate remote access, or the installation of an external, customer provided modem to the KB0 interface. Figure 1-4 illustrates the necessary connections between the KB0 interface and a typical external modem, however, the connections to some modems may vary.

rFigure 1-4. External Modem to KB0 Connection

When an external modem is connected to KB0, before first initialization, the option switches located on the control card must be set up for the required baud rate (see BAUD RATE on page 17-21).Signal Ground Data Set Ready 5 - Signal Ground 4 - Data Terminal Ready 3 - Transmit Data 2 - Receive Data 1 Request To Send Receive Data Transmit Data To Typical Modem Device

KB0 SERIAL PORT (USE FEMALE CABLE 9 PIN CONNECTOR)

See the relevant Coral Installation Guide and Hardware Reference Manual for precise modem setup instructions.

1-9

Introduction

PI Reference Manual

Access to the Programming InterfaceAccess to the Programming Interface facility is controlled by passwords. There are four PI password levels. The programmer requires Level 2. This password is provided only for qualified personnel.

PI Software StructureThe PI software is a menu-driven and branch oriented system. The programmer can select a specific branch, which branches out into more detailed lists. In addition, the programmer is able to jump from one menu to another with no restrictions, except those demanded by specific password levels. When the PI software is first accessed, the ENTER PASSWORD prompt appears. After a valid password is entered, the Root Menu appears.

1-10

PI Reference Manual

Introduction

Root Menu VariationsThe Root Menu is the main menu in the PI structure, from which the rest of the PI issues. The PI software is part of the system software. The Root Menu reflects the installed software version by listing the available items specific to the installed software version.

rFigure 1-5. PI Interface Root Menu

Entering the word ROOT anywhere within the PI, will take you to this menu.

(ROOT) CCS V15.20 Copyright (c) 2001-2005 Tadiran Telecom Ltd. (M) or (S) or (Active) NAME -

SAU # 0-CONFIG 1-DIAGN 2-TABLES 3-ADMIN 4-ROUTING/COST 5-ISDN 6-DATA 7-CoraLINK 8-NETWORK 9-IP 10-HELP

This manual describes all of the root menu options except 1-Diagn and 2-Tables. Tables programming is reserved for the manufacturers internal use. In Coral FlexiCom 5000 and Coral IPx 3000 with Dual Control systems, the letter M (Master) or S (Slave) appearing after the version number indicates the PI side definition. In Coral FlexiCom 6000 and Coral IPx 4000 systems, the letter A (Active), S (Standby) (if feature authorization is present for duplication) or M (Maintenance) or the word Faulty appear after the version number indicating the PI side definition. SAU shows the Software Authorization Unit (SAU) unique serial number (without the leading zeros). This number is verified during system operation. When a mismatch is detected during operation, a system alarm is issued and an error message is displayed.

1-11

Introduction

PI Reference Manual

Access to Specific MenusAccess to the root menu may be done from anywhere within the PI, by entering the word ROOT. Access the menu items by keying a sequence of digits from the root menu that route the user to the required branch, such as 0,6,0 which will route to Public Libraries. An alternative method for accessing items is to type the alpha or alphanumeric code for the item, such as LIB which provides direct access to Speed Calling Libraries.

r

An advantage of using the alphanumeric code is that this method allows access to a specific branch from anywhere in the system, except from the NAME field. While the numeric digit method allows access only from the Root Menu. Alternatively, ROOT,0,6,0 routes to LIB from anywhere within the system.

1-12

PI Reference Manual

Introduction

PI Terminal Control Function CommandsThe PI terminal keyboard is used to enter data and to instruct the PI software to perform specific functions. Several special function commands are available, and executed by simultaneously pressing the [CTRL] (Control) key and a specific letter key. The commands and their functions are listed in the following table.Table 1-3: PI Control Characters and Escape Functions Code[CTRL] B [CTRL] C [CTRL] D

DescriptionCauses the previous field within the menu or list to be displayed. Cancels the current process; returns PI to previous menu or list. Often a displayed mode contains too many entries or tables to be displayed on one screen. To view a subject one entry (screen) at a time, use the [CTRL] D switch. To cancel, use [CTRL] D again as a toggle switch. While this mode is active, after displaying the first screen of entry, the PI pauses. To continue viewing the next screen of entry, press . When the [CTRL] D switch is activated, the following messages are displayed: activate: ***ENTRY BY ENTRY DISPLAY*** cancel: ***SCROLLING DISPLAY*** Causes the End-of-Table message to be shown, after the last field in Update mode. When activated End-of-Table allows the [CTRL] B switch to jump to the last field. This switch toggles between the default Normal Display and the End-Of-Table display. Defines a new Escape or Home menu; When [CTRL] H is entered the following message appears: ESC will place you in this Node This PI menu is now displayed whenever pressing [ESC]. Note: Entering ROOT from anywhere within the PI will always place you in the Root menu.

Remarks

[CTRL] E

[CTRL] H

The ASCII character code defines [CTRL] H as the BACKSPACE character. Some terminal keyboards can be configured to send a DELETE character when backspacing. When available on the terminal, select this option to avoid changing the Escape menu.

[CTRL] N

For Use by Manufacturer Only.Toggles the display of memory pools in chain order. When activated the following messages are displayed:

*** CHAIN DISPLAY *** *** NORMAL DISPLAY ***

1-13

IntroductionTable 1-3: PI Control Characters and Escape Functions Code[CTRL] O

PI Reference Manual

Description For Use by Manufacturer Only. Coral FlexiCom 5000 or IPx 3000 -Duplication only.Toggles terminal communication between the Slave and the Master side. When full duplication is invoked (i.e., in the U and U' configurations, see MASTER on page 21-20, [CTRL] O enables the technician to operate the PI from the 8DRCF/8DRCM/RMI or KB0 master terminals as if s/he is physically located at the slave location.

RemarksRecommendation: Return to the Master side before ending a PI session (with [CTRL] P).

Coral FlexiCom 6000/R or IPx 4000/R Dual Control only.Toggles terminal communication between the Standby and the Active side. See HSB on page 21-25. After connecting (or disconnecting) the terminal to (or from) the KB0/8DRCF/8DRCM/RMI Slave/Standby side or KB0 Master/Active side, one of the following messages appear: terminal connected or terminal disconnected. The following terminal status messages appear while the terminal is being connected between sides: FlexiCom 5000 switching terminal to slave side or switching terminal to master side. FlexiCom 6000 switching terminal to Standby side or switching terminal to Active side. [CTRL] P Ends the PI session; password entry is required to start a new PI There is an automatic logout upon session. Pressing [CTRL] P is recommended when exiting in inactive terminal (see AUTO_LOGOUT order to prevent unauthorized operators from entering the PI and and AUTO_LOGOUT_TIME on page 17-20). causing damage. When changes are made to systems that do not include an automatic backup, the following message appears:

CAUTION!!! Auto backup NOT available Quit Anyway (Y/N)? YTyping N(o) returns to the current PI mode. Typing Y(es) will leave the session.The default is Y(es) [CR]. [CTRL] Q Turns off the [CTRL] S command (below). [CTRL] Q and [CTRL] S functions are commonly referred to as X-On/X-Off or DC1/DC3. Some terminal keyboards include a SCROLL LOCK key, which alternately sends a [CTRL] S and [CTRL]Q to toggle scrolling.

[CRTL] R [CTRL] S [CTRL] T

Shows the current menu path from the Root Menu. Utilized by KB0 only. Causes the display to stop scrolling. Displays current system status: Installation name, current time and date, terminal number, password level, system software and card version and system type HDC/4GC/16GC/32GC, HSB & MCP-ATS, etc. Causes the previous menu or list to be displayed.

[CTRL] U

1-14

PI Reference ManualTable 1-3: PI Control Characters and Escape Functions Code[CTRL] V [CTRL] W RESTART [CTRL] Y ESC

Introduction

DescriptionTerminates the display of stimuli code messages. Toggles the 25-line scroll function on (display scrolls 25 lines and stops) and off (display scrolls to the end of the menu, list, etc.). Begins a RESTART procedure. This command is used when the PI is not properly responding. Type RESTART in upper case. Pressing the Escape key in any location returns the session to the PI Home Menu as defined by [CTRL] H. The Root Menu is the default; any menu or list may be specified by moving to the desired menu and entering [CTRL] H.

RemarksSame as entering MSG,2,0,N.

1-15

Introduction

PI Reference Manual

Conventions Used in this DocumentRoutes Branch headings (starting in Chapter 3) always show the subject and the route keyed from the Root Menu to reach that subject, for example:

Installation

W ROOT

[0,0,0,0]

Many option headings offer alternative routes; the first route given is the shortest route and may be used from any point in the PI menu structure. An example is:

Feature Timers

W FE.T

[0,0,1,0]

FE.T (also called Direct Access Abbreviation) may be keyed to access the feature timers from any location in the PI structure. FE.T cannot be accessed when in Name fields. The route shown by digits and commas is used only from the Root Menu.

r

Digits must be separated by commas or spaces. 0,0,0 and 0 0 0 are acceptable; 000 is not acceptable.

1-16

PI Reference Manual

Introduction

Ranges and DefaultsThe ranges and defaults available for a given programming option are presented immediately after the parameter name on the same line. The range default is designated with an arrow on top of default item. For example, the range for SUSPECT SEIZE TIME in Trunk Definitions can be listed as:

50..80..500 ms

or 0..80

where 80ms is the default in both cases and is designated by a pointed arrow on top of the number. When no default is designated, the default is Not Applicable. For ranges that may include more than one default, the defaults are listed separately. For example, the defaults for the PAGE parameter in Station and Trunk COS, is shown as:

Yes/No Yes: COS 0-9 No: COS 10-15Explanation: The range is Yes or No. For COS 0-9 the default is Yes. For COS 10-15 the default is No. When a system range is not relevant, None is shown as the entry. In addition, when a range specification is not applicable for a specific option, the abbreviation N/A is given instead of data. When a system default is not available or not applicable, no arrows are shown and, thereby, no default designated. Display Only Parameters Parameters which are read only options, (i.e. Display Only) appear with the following icon before the Range. The example below indicates that the parameter value may vary between 0 and 60 units. The actual value is indicated on the PI screen.

0..60Database Forms A document called Database Forms is provided for writing down the various site programming definitions that differ from the defaults presented in this manual. Database Forms provides a convenient notebook for programmers to record specific site data and information. This information can then be used in order to redefine the various PI parameters. The headers of each major option in the Database Forms mirror the titles of each Coral branch i.e., major options in this document.

1-17

Introduction

PI Reference Manual

Country CodesThe Coral incorporates two different system types. System Type 0 defines the system defaults used in North America. The countries that use System Type 0, but with slight differences for their ranges and/or default values are listed as CCn types (where n is a number). The relevant country type is listed below. System Type 2, designated as Eu, is used for European countries. The countries that use the same system type but slightly different ranges and/or defaults are listed as Eun, where n indicates the specific country (see below).Table 1-4: Country Codes USA Israel Mexico Brazil Venezuela Argentina China Poland India ROW (Rest Of World), i.e. all othercountries not included in this list.)

System Type

Country Code CC0 CC1 CC2 CC3 CC4 CC5 CC6 CC7 CC8 CC9 CC10

Country

System Type 0Country Codes: CCn (n = any number)

Russia Netherlands Belgium Germany Spain Hungary Greece Australia New Zealand Czech Republic Italy Caribbean Islands

System Type 2Country Codes: Eun (n = any number)

Eu0 Eu1 Eu2 Eu3 Eu4 Eu5 Eu6 Eu7 Eu8 Eu9 Eu10

System type and Country Code (CC) numbers are displayed during Installation or in the Install branch, see SYSTEM_TYPE and COUNTRY on page 3-2. When the word European or Eu, without a specific country, is given this means that the system parameters or specifications are general for European systems. If no country or area is indicated then the parameter is valid as presented. 30T/E, ALS70, BID & GID trunk cards are used only in European systems.

1-18

2

Programming RequirementsThis chapter describes the PI programming requirements. Basic shorthand notation used throughout the PI is also described in this chapter. Default System .............................................................................................2-2 Typical Site-Specific Programming .............................................................2-3 Additional Programming ..............................................................................2-4 Programming and Entering Time Units .......................................................2-6 Programming Functions ...............................................................................2-7 Locating Data Fields ....................................................................................2-8 Direct Access Abbreviations (DAA) ...........................................................2-9 Entering Yes/No and Remove ....................................................................2-10 General Rules for Entering Names ............................................................ 2-11 Authorization Items ....................................................................................2-12 Default System defines the default databases according to the country, system type and Common Control card type. Typical Site-Specific Programming and Additional Programming describe PI programming for all the different PI branches. Programming and Entering Time Units defines the PI time unit notation. Programming Functions describes the different PI functions available at the branches or options. Locating Data Fields and Direct Access Abbreviations will help you locate the desired parameter, data field or branch needed to program the PI. Entering Yes/No and Remove Range and General Rules for Entering Names describe the general rules for entering Yes, No, Remove and Names in the parameter range. Authorization Items list the specific features that need software authorization before they can be implemented.

2-1

Programming Requirements

PI Reference Manual

Default SystemThe configuration of the Common Control cards determines the default database that is installed upon First Initialization, as shown below. CSX 200, Coral FlexiCom 400, 5000, 6000 as well as the Coral IPx 500, 800, 3000 and 4000 systems default to a Coral system with 4GC, with authorized features defined by the SAU unit. Should a particular parameter impact upon a different option, the relation between the two is explained in the relevant description.

r

The SIZES parameters must be programmed before all other parameters. Changing the SIZES parameters causes the system to revert to the manufacturer's default program.

2-2

PI Reference Manual

Programming Requirements

Typical Site-Specific ProgrammingDepending on the site, the default database may require some programming. When it is necessary to modify the default database, this information should be entered in the Programming Forms. The programming parameters most often changed are found in the following branches: Sizes (Chapter 4) Sets the maximum number of various system services, such as ports, libraries, stations, trunks, etc. Numbering Plan (Chapter 5) Modifies the numbering plan for the specific site. System (Chapter 6) Modifies system timers, system features, system tones and identifies the hardware assigned to specific physical locations. Class of Service (Chapter 7) Defines access to system features and functions. Trunks (Chapter 8) Defines trunks and trunk groups; individual menus are provided for Central Office (loop/ground start), E&M, DID, T1, E1 (30T), TWL, PRI (PRI-23/30 and IPG), BRI (TBR), SIP trunk and power fail trunks. Stations (Chapter 9) Defines all SLT, Magneto, FlexSet, FlexSet-IP, SIP terminal and keyset requirements. Power Fail stations are identified in the database using the Power Fail Trunk form in Chapter 8 (Trunks).

2-3

Programming Requirements

PI Reference Manual

Additional ProgrammingDepending upon site requirements, the following major options may need additional programming. Groups (Chapter 10) Defines Hunt Groups, Boss Groups, Pickup Groups, Zoned Voice Page Groups, Bell/UNA (Night Answer Groups) and Group Calls. DID/E&M Groups and Trunk Groups are defined in Chapter 8. Libraries (Chapter 11) Defines public (system-wide) and private (station-related) speed call libraries as well as the parameters for the System Directory. Night Service (Chapter 12) Defines night service timers as well as incomplete and intercept call destinations. Toll Barrier (Chapter 13) Sets toll restrictions (barriers) on outgoing calls. Station Message Detail Recording (Chapter 14) Controls the systems detailed call reporting to external SMDR systems. Routing (Chapter 15) Defines Routing and Cost Calculation parameters. Room Status (Chapter 16) Controls the systems room status feature. Service Terminals (Chapter 17) Defines the various system parameters for service terminals. Features (Chapter 18) Defines port features which can be activated from either the PI terminal or the Attendant Console. Voice Transmission Controls (Chapter 19) Controls voice transmission across ports and cards. Also included in this chapter is the Network Balancing System. Wakeup (Chapter 20) Defines the Wakeup controls and Wakeup report production. Special System Options (Chapter 21) Defines those features that control the database, duplication system as well as the Hot Standby Coral Systems. Diagnostics (Chapter 22) Defines those options that perform the various diagnostic tests and check the system alarms.

2-4

PI Reference Manual

Programming Requirements Special Port Facilities (Chapter 23) Defines those special options that are available for tenant members, plus defining DVMS ports. Verified Forced Account Code (VFAC) (Chapter 24) Describes the various options that are available for VFAC. Time/Date Set and Adjust (Chapter 25) Describes the way in which the system time and date are set and adjusted. Integrated Services Digital Network (Chapter 26) Describes the various ISDN system options. CoraLINK (Chapter 27) Describes the CoraLINK database options. ISDNet (Chapter 28) Defines and allocates the Nodes and Node Contents in a Private Coral Network and also includes the special General Numbering Plan functions for the Network Nodes. Voice Over IP (Chapter 29) Manages the Coral VoIP (Voice calls over Internet Protocol) details. IP Ports are managed from the branches included in this chapter, as well as general system-wide IP parameters. Remote upgrades to the UGW card as well as to IP Keysets may be implemented via the PI as well.

2-5

Programming Requirements

PI Reference Manual

Programming and Entering Time UnitsThe following table presents the 12 hour to 24 hour conversions for programming and entering time units in the PI. Exceptions to the required 24 hour format are described below.AM HoursTime Midnight 1 2 3 4 5 6 7 8 9 10 11 Enter 00 01 02 03 04 05 06 07 08 09 10 11

PM HoursTime Noon 1 2 3 4 5 6 7 8 9 10 11 Enter 12 13 14 15 16 17 18 19 20 21 22 23

Minutes are entered as two digits (00 through 59). All time entries are hh:mm, where hh = hour (00-23) and mm = minutes (00-59). For single-digit hours, 1AM to 9 AM, a leading 0 can be added as required by the programmer; for example: 8 am can be defined either as 8:00 or 08:00. A colon (:) must be entered between the hour and minutes.

2-6

PI Reference Manual

Programming Requirements

Programming FunctionsThe following table presents the eight programming functions that can be applied to the Program Interface. Only functions relevant to a specific branch are available in that branch or option.Code 0 1 2 3 4 5 6 Function UPDATE DISPLAY ADD REMOVE SNAP SHOW DUPLICATE Description Allows changing or modifying the parameter values or characteristics. Displays all parameters for any specific port or range of consecutively numbered ports. Instructs the system to make an addition to the existing parameter or option for a specific port. Deletes an existing parameter. Similar to DISPLAY, but in real-time. Used for on-line monitoring from a single monitor only. Generally used for showing Diagnostics and Numbering Plan tables. Copies a defined feature or parameter from one port or station to another port or station. Useful for rapidly defining new stations or updating existing stations. Deletes the branch database from memory while in a specific branch.

7

ERASE

2-7

Programming Requirements

PI Reference Manual

Locating Data FieldsData fields (parameters) can be located using short-cuts. When the questionAny specific data field (type? for help)

appears, any one of several actions can be taken: All Fields: Press to display or update all fields. Single Field: Enter single field name or field number to display or update a single field. Multiple Fields: Enter up to seven field names and or field numbers to display or update multiple fields. Each field must be separated by either a space or comma