Program Interface (PI) 16 [for Tadiran Coral IPx/FlexiCom ... · 4 February 1996 Includes Software...

Program InterfaceDatabase Reference Manual

(Version 16)

Eliezer KatzensteinIsrael

Creating a new world of IPportunities

.

Document Edition 25

Eliezer Katzenstein

Copyright by TADIRAN TELECOM (TTL) L.P., 1993-2012. 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.

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 (TTL) L.P.'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.

Foreword

Welcome 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 400 (with HDC controller), 5000, 6000; Coral IPx Office; Coral IPx 500, 800, 3000, 4000; CDRS 200E, 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. Issue Date Brief Description Entered by:

25 Mar 2012 Includes Software Version 16.03.00The following features, hardware and products were added: Silent Monitoring enabled for SIP Phones

(such as: P-Series, T300 Series, and Sea-Beam softphone)

Boss/ELA Line Keys on T300 SIP Phones Send proper ANI to Call Forward PSTN

Destination Enhancements (Route: SFE,0: SEND_ORIGINAL_ANI_TO_CFWD_DEST and SEND_INTERNAL_ORIGINAL_ANI_TO_CFWD_DEST Parameters)

IP Telephony Gateway Enhancements (Route: IP,2: ACTIVATE_RSIP parameter)

See New Developments Summary (Version 16 Edition 4) for complete list of features and changes.

Tadiran Telecom (TTL) L.P.

24 Oct 2011 Includes Software Version 16.01.16The following features, hardware and products were added: SIP Trunk Enhancements SIP Terminals Enhancements SeaMail on PC LxCMC on PC Private/Public Library Enhancement (E7) Numbering Plan (removed #1986) P-Series (such as: P-335, P-450) SIP Phones Resources Cards do not include a MODEM

(8DRCM-2, U-MR Office, IPx 500M with MSBipx Hardware Issue-0230X1003 or higher)

See New Developments Summary (Version 16 Edition 3) for complete list of features and changes.

Tadiran Telecom (TTL) L.P.

23 Feb 2011 Includes Software Version 16.01.12 Tadiran Telecom LTD.

22 Nov 2010 Includes Software Version 16.01.09 The following features, hardware and products were added: BLF Conversion to SIP Phones (Allow stan-

dard BLF for all SIP terminals) Feature Control - Enhancement (The follow-

ing features were added: load ID, Login/Logout, Released Resumed All, Wrap Up Time, Primary Login ,Message)

ELA Group Enhancements (Personal and Department ELA group with FlexAir hand-sets)

SMDR Enhancements to reports including the filtered digits that were dialed on the out-going trunk

ISDN Card (PRI/BRI) Signalig Enhance-ments (One parameter was added for Name sending on outgoing PRI calls to Telco)

T1,PRI,TBR,30T/x,2DT Synchronization T300 Series (SIP) Phones Enhancements VOIP EnhancementsSee New Developments Summary (Version 16 Edition 2) for complete list of features and changes.

Tadiran Telecom LTD.

21 May 2010 Includes Software Version 16.00.07 The following features, hardware and products were added: SIP Trunk Enhancements Partial ANI Available for Small Displays T.38 (FoIP) Fax over IP via PUGW iAPA Callback (IRSS/Freedom Enhancements) PI Terminal Enhancements New Authorization Parameters T300 Series ( T322, T328) SIP Phones 2DT Card EnhancementSee New Developments Summary (Version 16 Edition 1) for complete list of features and changes.



20 January 2010 Includes Software Version 15.85.37 See New Developments Summary (Version 15.8 Edition 6) for complete list of features and changes.


19 January 2009 Includes Software Version 15.85.16 See New Developments Summary (Version 15.8 Edition 5) for complete list of features and changes.


18 September 2008 Includes Software Version 15.85.04

The following hardware and products were added: Station Analog peripheral cards:

8/24SA, 8/16/24SAipx, 4/8/16/24SA Office Digital Trunk cards (one interface only):

2DT, 2DTipx, 2DT Office(Due to logistical requirements, the cards are labelled: "PRI-2DT", PRI-2DTipx" or "PRI-2DT Office, on the front panel)

8SMipx (Magneto for CDRS 200E) 8DTMF (replaces the 4/8DTR) Coral SeaBeam softphone Coral IPx SeaMial SIP trunk enhancements

See New Developments Summary (Version 15.8 Edition 4) for complete list of features and changes.



17 January 2008 Includes Software Version 15.68.20

The following features were added: Enhanced ACD/UCD HUNT Group Transferring O/G PRI Calls while Ringing Disabling Re-route for Net-IP Calls Zone Page by Group Call (IPx Office) Keeping RTP after 3WAY Calls Multi-UGW Hub Touch-Tone Dialing (DTMF) from:

FlexSet 121S/281S, FlexSet-IP 280S, T207M, T208M, T207M/NP, T208M/BL

Continuous Conference Enhancements

The following hardware was added: MCP-ATS (SBS-CT9) Cards CoraLINK (CLA) on MAP

See New Developments Summary (Version 15.5 Fourth Edition) for complete list of changes.



16 March 2007 Includes Software Version 15.5

The following features were added: Soft Keys Supported by System Call Log Supported by System FlexiCall and Freedom (IRSS) HELP Enhanced SMS Messaging Extension Line Appearance (ELA) TBCT US Market Touch-Tone Dialing (DTMF) from IP Phones IP Faxing SIP Re-invite SIP CLA Support IP Port Type Restrict Internal CID

The following hardware was added: T207M, T208M, T207M/NP, T208M/BL,

T207S, T208S, T207S/NP, T208S/BL, TEM (IP Telephone)

FlexSet 121S and 281S Sentinel Pro10/25/75/150(v6) Management Application Platform (MAP) Coral Navigator PEX-FS and PEX/APA-FS

See New Developments Summary (Version 15.5 First Edition) for complete list of changes.


15 December 2005 Coral Version 15See New Developments Summary (Version 15) for complete list of changes.


14 June 2005 Coral Version 14.67See New Developments Summary (Version 14.67) for complete list of changes.


13 April 2004 Coral Version 14.66See New Developments Summary (Version 14.66) 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.


12 January 2004 Includes Software Version 14.65 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 Voicemail SupportSee New Developments Summary (Version 14.65) for complete list of changes.

The following hardware was added: MCP-IPx card Coral IPx 500,800,3000,4000



11 November 2002 Includes Software Version 14.1 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/ExternalThe 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.


10 May 2002 Includes Software Version 11.10 with the following new features: Auto Set Relocate FlexiCall (Phase 1) VIP Ring Second Party Speaker StatusSee New Developments Summary (Version 11.10) for complete list of changes.


9 December 2001 Includes Software Version 11.08 Coral FlexiCom FlexSet SFT cardsSee New Developments Summary (Version 11.08) for complete list of changes.



8 September 2000 Includes Software Version 10.38. E911 - CAMA support (USA) R2MFC supported on 30TM card. VFAC on Dial Service Retain Music Sources throughout Network. IVR-ACD Voicemail 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.

ECI Telecom LTD.

7 November 1999 Includes Software Version 10.19.

No Data Connectivity to VDK,VDM and TIM

Collect Call Reject Tone, Whisper Page, Sec-ond 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

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

ECI Telecom

6 July 1997 Coral SL, 8DRCM, Malicious Call Trace, NPL Default change (add # to default dial numbers beginning with 1).Includes Software Version 9.87

Tadiran


5 November 1997 Feature Updates with Wireless Station, SLS, SKW and SDT cards, Coral ISDNet replaces Coral QNET. Includes Software Version 9.5x

Tadiran

4 February 1996 Includes Software Version 9.35 Tadiran

3 June 1995 Software Version 9.2x, Preliminary Draft 1Feature updates with CoraLINK, CoralQNET, 4VSN card, 8VSN card, APA, VDM, and Backup for large systems. Includes Version 9.2x

Tadiran

2 January 1995 Feature updates with TBR, 4TEMP, includes V8.60 and new comprehensive index

Tadiran

1 January 1994 Software Version 8.3x, Preliminary Draft 2 Tadiran

0 September 1993 Software Version 8.3x, Preliminary Draft 1 Tadiran


PI Reference Manual

Table of Contents

TOC-1

PI Reference Manual

1 IntroductionGeneral Description .............................................................................................. 1-2PI Terminal Device................................................................................................. 1-4Hardware Setup ..................................................................................................... 1-5Access to the Programming Interface .................................................................. 1-11PI Terminal Control Function Commands ............................................................ 1-14Conventions Used in this Document .................................................................... 1-17Country Codes ..................................................................................................... 1-19

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

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

TOC-2

PI Reference Manual

4 Sizes/URC/Music/Units DefinitionSizes Definition ......................................................................................................4-2Sizes Tab ............................................................................................................4-24URC-Card (IPx Office, IPx 500 and CDRS 200E) ...............................................4-33URC-Default Configuration ..................................................................................4-35URC-Current Configuration .................................................................................4-37URC-Card Database ...........................................................................................4-40System Engineering Options ...............................................................................4-41Music Sources .....................................................................................................4-44Units ....................................................................................................................4-47

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

TOC-3

PI Reference Manual

6 SystemFeature Timers ......................................................................................................6-2System Features ...................................................................................................6-7System Features - Outgoing Trunks .....................................................................6-8System Features - Incoming Trunks ...................................................................6-19System Features - Station Options .....................................................................6-20System Features - Intercept/Incomplete .............................................................6-34System Features - Call Forwarding .....................................................................6-39System Features - Camp-On ..............................................................................6-41System Features - Hotel ......................................................................................6-42System Features - Messaging .............................................................................6-44System Features - Tones ....................................................................................6-51System Features - Diagnostics ...........................................................................6-53System Features - ISDN .....................................................................................6-55System Features - Network .................................................................................6-56System Features - Wireless ................................................................................6-57Card List ..............................................................................................................6-60Port List ...............................................................................................................6-68Port List - Physical Location ................................................................................6-69Port List - Dial Numbers ......................................................................................6-74Digital Port Bus List .............................................................................................6-92Tone Plan ............................................................................................................6-96Ringers ..............................................................................................................6-103

7 Class of ServiceStation and Trunk COS .........................................................................................7-2Attendant Class of Service ..................................................................................7-33Tenant Class of Service ......................................................................................7-44

TOC-4

PI Reference Manual

8 Trunk ControlsGeneral Trunk Timers ...........................................................................................8-3Trunk Timers .........................................................................................................8-7MFR Card Database ...........................................................................................8-10General Trunk Definitions ....................................................................................8-11Trunk Group Definition ........................................................................................8-18Alternate Route ...................................................................................................8-34DID/E&M Groups .................................................................................................8-36Offset Filters ........................................................................................................8-42Power Fail Trunk Definition .................................................................................8-44LS/GS (Loop/Ground Start) Trunks .....................................................................8-464T/8T LGS Port Database ...................................................................................8-504T/8T Card Database ..........................................................................................8-524TEM - E&M Continuous .....................................................................................8-58E&M Continuous Timers .....................................................................................8-594TEM (E&M Continuous) Card Database ...........................................................8-624TEMP (E&M Pulsed) .........................................................................................8-64 ............................................................................................................................8-644TEMP (E&M Pulsed) Port Database .................................................................8-654TEMP (E&M Pulsed) Card Database ................................................................8-674TWL Trunk Card Database ...............................................................................8-84E&M Trunk Definition ..........................................................................................8-87DID Trunk Definition ............................................................................................8-908DID Card Database ...........................................................................................8-91T1 and 30T/x Card Configuration ........................................................................8-95T1, PRI, TBR, 30T/x, 2DT Synchronization ........................................................8-982DT Card Database ..........................................................................................8-1022DT Card Database: DEFAULT Configuration ..................................................8-1032DT Card Database: CURRENT Configuration ................................................8-105T1 and 30T Card Database ...............................................................................8-108T1 and 30T Port Database ................................................................................8-11130T/M Cards ......................................................................................................8-11330T/M Card Database .......................................................................................8-11430T/M DDI/DDO/BI-D Port Database ................................................................8-12030T/M DDI Port Database .................................................................................8-12230T/M Timers ....................................................................................................8-123

TOC-5

PI Reference Manual

30T/E Cards ......................................................................................................8-12430T/E Card Database ........................................................................................8-12530T/E DDI Port Database ..................................................................................8-13030T/E DDO Port Database ................................................................................8-13230T/E NonDDI Port Database ...........................................................................8-133ALS70 Cards .....................................................................................................8-135ALS70 Card Configuration ................................................................................8-136ALS70 Card Database ......................................................................................8-138ALS70 Port Database ........................................................................................8-141ALS70 Loop Start Port Database ......................................................................8-142ALS70 DID Port Database ................................................................................8-143ALS70 NonDID Port Database ..........................................................................8-144ALS70 Trunk Timers .........................................................................................8-145BID Cards ..........................................................................................................8-146BID Trunk Port Database ..................................................................................8-147BID Trunk Timers ..............................................................................................8-149GID Cards .........................................................................................................8-150GID Card Database ...........................................................................................8-151GID Port Database ............................................................................................8-155GID Timers ........................................................................................................8-157

9 Station ControlsStation Timers .......................................................................................................9-2SLT Definition ........................................................................................................9-5SLT: iDSP Card (Caller ID Type Bellcore/ETSI) Database .................................9-19SLT Card Database .............................................................................................9-20Keyset Timers .....................................................................................................9-27Keyset Ring Cadence ..........................................................................................9-29Keyset Definition .................................................................................................9-31Keyset Button - Programming .............................................................................9-76Keyset Fixed System Keys - Programming .......................................................9-102Keyset Soft Keys Idle Set ..................................................................................9-103Keyset Preference - Programming ....................................................................9-117APA, PEX/APA and APDL RS-232 Setup .........................................................9-119Wireless Stations - CoralAIR .............................................................................9-122Magneto 8SM Card Database ...........................................................................9-125

TOC-6

PI Reference Manual

10 GroupsHunt Group ..........................................................................................................10-2Boss Group .......................................................................................................10-18Pickup Group .....................................................................................................10-23Zoned Voice Page Group ..................................................................................10-24Bell/UNA Group .................................................................................................10-25Group Calls .......................................................................................................10-26ELA Group .........................................................................................................10-38

11 LibrariesPublic Library .......................................................................................................11-2Private Library .....................................................................................................11-9Serial Library .....................................................................................................11-12Large Public Library - Overview ........................................................................11-18Large Public Library Numbering Plan ................................................................11-20Large Public Library Contents ...........................................................................11-22Directory ............................................................................................................11-25Directory - Systems (Shared) Directory Entries ................................................11-26Directory - Personal Directory ...........................................................................11-29

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

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

TOC-7

PI Reference Manual

14 SMDRSMDR Control .....................................................................................................14-2Report Control ...................................................................................................14-10Format Params ..................................................................................................14-11Auto On-Line .....................................................................................................14-13Charge Table .....................................................................................................14-16

15 Routing & Cost CalculationRouting System Parameters ...............................................................................15-3Routing Access General Definitions ....................................................................15-5Routing Class of Service .....................................................................................15-9Dial Services .....................................................................................................15-11Route Elements .................................................................................................15-25Routing Numbering Plan ...................................................................................15-28Routing Translators ...........................................................................................15-31Look Ahead Routing Triggers ............................................................................15-32Cost Calculation Elements ................................................................................15-38Cost Calculation Numbering Plan .....................................................................15-40Cost Calculation Parameters .............................................................................15-41

16 Room Status/User Canned Messages

Names .................................................................................................................16-3Status/Message Select ........................................................................................16-5Status_Display/Message .....................................................................................16-6Busy Display ........................................................................................................16-7Terminal ..............................................................................................................16-8

TOC-8

PI Reference Manual

17 Service TerminalsPassword and Site Name ....................................................................................17-2Message Control .................................................................................................17-4Message Select ...................................................................................................17-6Terminal Destination ...........................................................................................17-8CoralVIEW Traffic (CVT) Terminal Destination ...................................................17-9Call Trace ..........................................................................................................17-10Terminal Setup ..................................................................................................17-11KB0 Setup Through Attendant Console - Feature .............................................17-29Terminal Reset ..................................................................................................17-30Terminal Clear ...................................................................................................17-31iVMF Remote Maintenance ...............................................................................17-32

18 FeaturesFeature Control ...................................................................................................18-2

19 Voice Transmission ControlsGains - General Description................................................................................. 19-2Gains Tables .......................................................................................................19-3Feature Control .................................................................................................19-17Personal Port Gain, Compensation: Ports ........................................................19-22Personal Port Gain, Compensation: Comp .......................................................19-23Balancing Network ............................................................................................19-24

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

21 Special System Options-

TOC-9

PI Reference Manual

Database Control& Duplication Systems

Database Control ................................................................................................21-2First Initialization ..................................................................................................21-3Backup ................................................................................................................21-4Database Control: Disk (FlexiCom 6000, IPx 4000) ...................................................21-5Save Database (FlexiCom 6000 and IPx 4000) ........................................................................21-6Load DBS (FlexiCom 6000 and IPx 4000) ..................................................................................21-7Copy Files (FlexiCom 6000 and IPx 4000) .................................................................................21-8Show Dir (FlexiCom 6000 and IPx 4000) ..................................................................................21-10Auto-Backup (FlexiCom 6000 and IPx 4000) ..........................................................................21-11Database Control: FLASH (IPx Office, FlexiCom 200,300,400,5000, IPx 500,800,3000, CDRS 200E) ............................................................................................................................................21-12

FLASH: Save (IPx Office, FlexiCom 200,300,400,5000, IPx 500,800,3000, CDRS 200E) .....21-14FLASH: LOAD DBS (IPx Office, FlexiCom 400, 5000, IPx 500, 800, 3000, CDRS 200E) ....21-15FLASH: SHOW FILE INFO (IPx Office, FlexiCom 200,300,400,5000, IPx 500,800,3000, CDRS 200E) ..................................................................................................................21-16ROOT,0,10,2,2,2 ...............................................................................................21-16FLASH: AUTO BACKUP (IPx Office, FlexiCom 400,5000, IPx 500,800,3000, CDRS 200E) 21-17FLASH: ERASE (IPx Office, FlexiCom 400,5000, IPx 500,800,3000, CDRS 200E) ..............21-18FLASH: INIT DUMP (IPx Office, FlexiCom 400,5000, IPx 500,800,3000, CDRS 200E) .......21-19Duplication (FlexiCom 5000 and IPx 3000 dual control) ..........................................................21-20HSB (FlexiCom 6000/R and IPx 4000/R redundant control) ......................................................21-25

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

TOC-10

PI Reference Manual

23 Special Port FacilitiesDVMS Port ..........................................................................................................23-2Conference ..........................................................................................................23-4Public Address/Page ...........................................................................................23-7Modem ................................................................................................................23-9Bell/UNA ............................................................................................................23-10Page_Q/Music ...................................................................................................23-11

24 VFACVerified Forced Account Code ............................................................................24-2

25 Time/Date Set and AdjustTime Set ..............................................................................................................25-2Time Adjust .........................................................................................................25-5

26 ISDNSystem Features - ISDN .....................................................................................26-2BCCOS Templates ..............................................................................................26-3BCCOS Control ...................................................................................................26-5NSF .....................................................................................................................26-6Call by Call ..........................................................................................................26-8Alternate Line ID ..................................................................................................26-9ISDN Card Signaling .........................................................................................26-11ISDN Card Signaling: Signaling Channel ..........................................................26-12ISDN Card Signaling: Card location ..................................................................26-13

TOC-11

PI Reference Manual

27 MAP, CLA and CoraLINKMAP .....................................................................................................................27-2CoraLINK .............................................................................................................27-8CoraLINK: CLA_STATUS .................................................................................27-11CoraLINK: CLA_SIZES .....................................................................................27-15CoraLINK: WAIT_QUE ......................................................................................27-16

28 ISDNetSystem Features - Network .................................................................................28-3Node NPL ..........................................................................................................28-10Node Content ....................................................................................................28-12Special Numbering Plan Functions ...................................................................28-15

TOC-12

PI Reference Manual

29 IP Voice Over IPUGW (Universal Gate Way) ................................................................................29-7UGW: Default Configuration ................................................................................29-9UGW: Current Configuration .............................................................................29-13IP Ports ..............................................................................................................29-27IP_Keyset ..........................................................................................................29-28IP_SLT ..............................................................................................................29-36IP_LGS ..............................................................................................................29-38IP_Net ...............................................................................................................29-40SIP Ports ...........................................................................................................29-41SIP Terminal ......................................................................................................29-43SIP Trunk ..........................................................................................................29-52IP: Telephony Gateway (Coral Teleport) ...........................................................29-62IP: General ........................................................................................................29-68IP: Statistics .......................................................................................................29-79IP: NET ..............................................................................................................29-80IP: ZONE ...........................................................................................................29-82IP: SIP DOMAINS .............................................................................................29-88IP: SENTINEL Pro .............................................................................................29-89Software Upgrade .............................................................................................29-93UGW Software Upgrade: Activate .....................................................................29-94UGW Software Upgrade: Cancel ......................................................................29-97IP Keyset Software Upgrade: Activate ..............................................................29-99IP Keyset Software Upgrade: Activate by Dial Number ..................................29-100IP Keyset Software Upgrade: Activate by IP Address .....................................29-102IP Keyset Software Upgrade: Cancel ..............................................................29-103IP Keyset Software Upgrade: Cancel by Dial Number ....................................29-104IP Keyset Software Upgrade: Cancel by IP Address ......................................29-105Sentinel Software Upgrade: Activate ...............................................................29-106Sentinel Software Upgrade: Activate by Index Number ..................................29-107Sentinel Software Upgrade: Activate by IP Address .......................................29-109Sentinel Software Upgrade: Cancel ................................................................29-110Sentinel Software Upgrade: Cancel by Index Number ....................................29-111Sentinel Software Upgrade: Cancel by IP Address .........................................29-112

TOC-13

PI Reference Manual

30 Coral Traffic Report (CTR)Internal Traffic: Definition ....................................................................................30-4Internal Traffic: Features and Events Control ......................................................30-6Internal Traffic: Reports: Format Parms ............................................................30-10Internal Traffic: Reports: View ...........................................................................30-14

TOC-14

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-2PI Terminal Device.......................................................................................1-4Hardware Setup ............................................................................................1-5Access to the Programming Interface ........................................................1-11PI Terminal Control Function Commands .................................................1-14Conventions Used in this Document..........................................................1-17Country Codes ............................................................................................1-19

1-1

Introduction PI Reference Manual

General Description

The 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) PC via Telnet Terminal Emulation (requires STIP, MAP or LIU)

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 IMC-8/16 or CFD flash memory cards. See Database Control: Disk (FlexiCom 6000, IPx 4000) beginning on page 21-5. See Database Control: FLASH (IPx Office, FlexiCom 200,300,400,5000, IPx 500,800,3000, CDRS 200E) 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-2/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 Coral IPx Office Main Unit the PI is connected to one RS-232E interface. One KB0 is provided at the front side of the Coral IPx Office. Additionally, the PI can be connected through an internal modem (KB4) located on the U-RMI Office or RMI Office card.

For Coral IPx Office 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/8DRCM-2 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 CDRS 200E and 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.

1-2

PI Reference Manual Introduction

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 the RMI card (RS-232C), or 8DRCM-2/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


PI Terminal Device

The 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.

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.

Table 1-1: Programming Interface Terminal Communications

Terminal Type DEC VT-100 (Default)Qume QVT-101 (or ADM-3A/5, TV1900)Standard KSR Data PrinterStandard PC (also for CVT, CVA or CVD)CID terminal (not KB0 not 8DRCM-2 and not 8DRCF)

RS-232 Data Transfer Rate 8DRCM-2, 8DRCF, 8DRCM, RMI, MEX-IP2, MCP-ATS, MCP-IPx2, MSBipx (Coral IPx 500M and CDRS 200E),MCB Office (Coral IPx Office)

9,600 bps Default Baud Rate for all systems.See BAUD RATE (page 17-26) for a detailed list when changing baud rates.

Modem Compatibility8DRCF, Coral IPx 500M and CDRS 200E (with MSBipx Hardware Issue-0220X1003 or lower),Coral IPx Office (with RMI Office or U-RMI Office)

56 Kbps (V.90 ITU-T)

Modem Compatibility8DRCM,RMI

Bell 103/212A Answer-300/1200 bpsCCITT V.21/V.22 Answer Mode-300/1200 bps

Parity None (Default), Odd, Even, Mark or Space

Data Word Length 7 or 8 (Default) bits

Stop Bits 1 bit

Format Asynchronous dataStandard ASCII character set

1-4


Hardware Setup

The PI terminal device can be connected to: Telnet Terminal Emulation via an LIU, STIP or a MAP card An RS-232 type interface on the system; KB0 in all Coral systems, and KB1,

KB2, KB3 in IPx 500 and CDRS 200E systems or to the RMI/8DRCM/8DRCF internal modem.

All features and functions are available through either connection.

Telnet Terminal Emulation via a MAP ConnectionThe MAP card (IP port 11010) offers integrated Coral system IP connectivity with:

Faster and more reliable connections than the serial RS-232 connections or even the LIU IP connections

Up to four concurrent users can connect via the same TCP/IP network socket.

In the Coral IPx Office the MAP card is embedded as a software only application on the MCB Office (main board of the Coral IPx Office).

In the Coral IPx 500 and in the CDRS 200E the MAP card is installed on the MCP-IPx2 main control processor card.

In the Coral IPx 800,3000 and FlexiCom 400,5000 the MAP card is installed on the MEX-IP2 main control processor card.

For further information about the MAP card refer to Chapter 6 of the Coral Control Cards (for CDRS 200,200E; IPx 500,800,3000 and FlexiCom 200,300,400,5000) Manual.

The MAP does not support Initialization messages, GP messages and other online Alarm messages, when used to communicate with the PI (Program Interface) over IP.

Telnet Terminal Emulation via an LIU ConnectionThe LIU card (IP port 11001) enables the MCP-IPx2 and the MEX-IP2 main control processor card to communicate with the PI via the RJ-45 LAN connector. Without this card, communication via the RJ-45 connector cannot take place, and all interaction with the PI must occur via the KB0 RS-232 port (unless a MAP card is installed. When a MAP card is installed, communication via the RJ-45 connector can take place and the LIU card is redundant).

The LIU card translates the RS-232 protocol used by the KB0 to the IP protocol. In order for the LIU to function, it is necessary to move DIP switch

1-5


#1 on the front panel of the MCP-IPx2 and the MEX-IP2 cards to the left and do one of the following. (See Figure 1-1):

To connect the RJ-45 port to the LAN, connect an ordinary cable between the RJ-45 port and the LAN outlet.

To connect the RJ-45 port directly to a workstation, connect a cross-over cable between the RJ-45 port and the workstation.

For further information about the LIU card refer to Chapter 7 of the Coral Control Cards (for CDRS 200,200E; IPx 500,800,3000 and FlexiCom 200,300,400,5000) Manual.

Telnet Terminal Emulation via a STIP module ConnectionThe STIP module enables all Coral main control processor cards to communicate with the PI via the RJ-45 LAN connector.

The STIP is a Serial RS-232 to IP translator. The STIP enables serial devices to connect to the Internet. The STIP provides transparent serial data-to-Internet protocol conversion and Internet protocol to serial conversion. Connection of the STIP to a serial device (Coral systems) and modem makes the Coral systems IP-compatible. The STIP connects with any device that has a serial RS-232 port that requires communication with an IP interface.

For further information about the STIP refer to the STIP Reference (Installation and Configuration) Manual.

On-Site RS-232 ConnectionThe PI terminal is connected to the MEX-IP2/MCP-IPx2/MCP-ATS/Coral IPx Office 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/8DRCM-2/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

1-6


manufacturers operating manual in order to determine if the selected terminal device required any status conductor to be active.

Figure 1-1. ControlCards-

Front Panel

Option Switches

SAU ResetIndicator

Lights

Reset

RESET

IMC-8 /16Release

Button

MCP-IPx2Coral IPx 4000FlexiCom 6000

Coral IPx 800, 3000FlexiCom 300, 400V, 400, 5000

IMC-8/16KB0

KB0

KB0IMC-xReleaseButton

IMC-x

Coral IPx 500FlexiCom 200CDRS 200, 200E

MCP-ATSMEX-IP2

RESET

MEX-IP2

LAN

SAU

KB0

MEX-IP2

Set DIP Switch# 1to the Right for KB0 Connections

LAN

KB0 WAN PRINTER

SYS.RESET

N.C.RESET

LANUGWCOM

2

1

4

3

6

5

8

7

MEMORY DISK

CPUUGWGCFAN

MAINT.MRC

GC ACT.POWER

Coral IPx Office

HS

OptionSwitches

RS-

232

E

IMC-4/8Release Button

IMC-4/8FMsl

Reset

KB0

Set DIP Switch# 1to the Right for KB0 Connections

MCP-IPx2

1-7


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.

Option Switches: MEX-IP2 and MCP-IPx2:Switches 1-8 Always Set to the RightSwitch 1 LEFT for PI-LAN (LIU) Connections OnlySwitch 1 RIGHT for KB0 ConnectionsSwitch 3 (MCP-IPx2) LEFT for IMC4Switch 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.

Reset Button: Forces the CORAL system to restart.CAUTION! Pressing this button will cause partial initialization and drop all calls.Additionally, all keyset call logs will be cleared.

7-Segment Display: For alarms and diagnostics.Coral IPx Office, Coral IPx 4000 and Coral FlexiCom 6000 systems: 7-segment display is not used.

SAU 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. Coral IPx Office: The SAU socket is located on the right panel.

Table 1-2: KB0 RS-232 Interface Pin Functions

Pin #*

* Pins 2, 3 and 5 are sufficient to connect the Coral system.

Signal Mnemonic Function

1 N/A ---

2 RX (Receive) Receives serial data input fro communications link

3 Tx (Transmit) Sends serial output to communications link

4 DTR Data set is ready to establish a communications link

5 GND Ground

6 DSR Data set is ready

7 RTS Indicates to data set that UART is ready to exchange data

8 CTS Data set is ready to exchange data

9 N/A ---

1-8


Figure 1-2. PI DB9Terminal to KB0

Connection

Figure 1-3. PI DB25Terminal to KB0

Connection

KB0PROGRAMMING PORT

(USE FEMALE CABLE 9 PIN CONNECTOR)

DATA TERMINAL READY - 4

6

9

CARRIER DETECT - 1

RECEIVE DATA - 2

TRANSMIT DATA - 3

SIGNAL GROUND - 5

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

4

1

2

3

5

6

9

KB0PROGRAMMING PORT

(USE FEMALE CABLE 9 PIN CONNECTOR)

13

4 - DATA TERMINAL READY

25

141

1

2 - RECEIVE DATA

3 - TRANSMIT DATA

5 - SIGNAL GROUND

DATA SET READY - 6

CLEAR TO SEND - 5

REQUEST TO SEND - 4

RECEIVE DATA - 3

TRANSMIT DATA - 2

SIGNAL GROUND - 7

PC Async. Serial Portor Async.Data Terminal

(USE FEMALE CABLE CONNECTOR)

1-9


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.

Coral IPx Office system requires the installation of a U-RMI Office or RMI Office card to accommodate remote access, or the installation of an external, customer provided modem to the KB0 interface.

Coral IPx 500 and CDRS 200E systems are 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, 8DRCM-2 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.

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-26).

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

Figure 1-4. ExternalModem to KB0

Connection 5 - Signal Ground

Signal GroundData Set Ready

Request To SendReceive DataTransmit Data

To TypicalModem Device4 - Data Terminal Ready

3 - Transmit Data2 - Receive Data

KB0 SERIAL PORT

1

(USE FEMALE CABLE9 PIN CONNECTOR)

1-10


Access to the Programming Interface

SecureMulti-level access control (Extensive rights are defined for different users).

Access 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-11


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.

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

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.

Figure 1-5.PI InterfaceRoot Menu (ROOT)

CCS 16.03.00

Copyright (c) 2001-2012 Tadiran Telecom (TTL) L.P. (Tadiran)(M) or (S)

or (Active)

NAME -

SAU # -

0-CONFIG1-DIAGN2-TABLES3-ADMIN4-ROUTING/COST5-ISDN6-DATA7-CoraLINK8-NETWORK9-IP

1-12


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.

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-13


PI Terminal Control Function Commands

The 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 Description Remarks

[CTRL] B Causes the previous field within the menu or list to be displayed.

[CTRL] C Cancels the current process; returns PI to previous menu or list.

[CTRL] D 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***

[CTRL] E 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.

[CTRL] H Defines a new Escape or Home menu;When [CTRL] H is entered the following message appears:ESC will place you in this NodeThis PI menu is now displayed whenever pressing [ESC].Note:Entering ROOT from anywhere within the PI will always place you in the Root menu.

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-14


[CTRL] O 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/8DRCM-2/RMI or KB0 master terminals as if s/he is physically located at the slave location.

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/8DRCM-2/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 5000switching terminal to slave side orswitching terminal to master side.FlexiCom 6000switching terminal to Standby side orswitching terminal to Active side.

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

[CTRL] P Ends the PI session; password entry is required to start a new PI session. Pressing [CTRL] P is recommended when exiting in order to prevent unauthorized operators from entering the PI and 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].

There is an automatic logout upon inactive terminal (see AUTO_LOGOUT and AUTO_LOGOUT_TIME on page 17-25).

[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 Shows the current menu path from the Root Menu.Utilized by KB0 only.

[CTRL] S Causes the display to stop scrolling.

[CTRL] T 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.

[CTRL] U Causes the previous menu or list to be displayed.



1-15


[CTRL] V Terminates the display of stimuli code messages. Same as entering MSG,2,0,N.

[CTRL] W 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.).

RESTART[CTRL] Y

Begins a RESTART procedure. This command is used when the PI is not properly responding. Type RESTART in upper case.

ESC 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.



1-16


Conventions Used in this Document

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

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:

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.

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

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-9No: COS 10-15

Explanation: The range is Yes or No. For COS 0-9 the default is Yes. For COS 10-15 the default is No.

Installation ROOT [0,0,0,0]

Feature Timers FE.T [0,0,1,0]

1-17


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 ParametersParameters 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..60

Database FormsA 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-18


Country Codes

The Coral incorporates two different system types. System Type 0 and System Type 2.

System Type 0, designated as CC (Contry Code), is used for most countries. 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 generally used for European countries. The countries that use System Type 2, but with slightly different ranges and/or defaults are listed as Eun, where n indicates the specific country.

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.

Table 1-4: Country Codes

System Type Country Code Country

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

CC0 USA

CC1 Israel

CC2 Mexico

CC3 Brazil

CC4 Venezuela

CC5 Argentina

CC6 China

CC7 Poland

CC8 India

CC9 ROW (Rest Of World), i.e. all other countries not included in this list.)

CC10 Russia

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

Eu European systems

Eu0 Netherlands

Eu1 Belgium

Eu2 Germany

Eu3 Spain

Eu4 Hungary

Eu5 Greece

Eu6 Australia

Eu7 New Zealand

Eu8 Czech Republic

Eu9 Italy

Eu10 Caribbean Islands

1-19


1-20

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

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 Coral 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.

Programming Requirements PI Reference Manual

Default System

The configuration of the Common Control cards determines the default database that is installed upon First Initialization, as shown below.

Coral IPx Office, Coral FlexiCom 400, 5000, 6000 as well as the CDRS 200E, 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.

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 Programming

Depending 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/URC/Music/System Engineering/Units Definition (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, 30T/E, 30T/M), 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, P-335, P-450, T207M, T208M, T207M/NP, T208M/BL, T207S, T208S, T207S/NP, T208S/BL, T322, T328, FlexIP SoftPhone, SeaBeam softphone, and third-party 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


Additional Programming

Depending upon site requirements, the following major options may need additional programming.

Groups (Chapter 10)Defines ACD/UCD Hunt Groups, Boss Groups, Pickup Groups, Zoned Voice Page Groups, Bell/UNA (Night Answer Groups), Group Calls and ELA Groups. DID/E&M Groups and Trunk Groups are defined in Trunks 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


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.

MAP, CLA and CoraLINK (Chapter 27)Describes the MAP and 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 PUGW/CUGW/UGW-E/UGW card as well as to IP Keysets and Sentinel Pro units may be implemented via the PI as well.

SIP entities are also covered in this chapter.

Coral Traffic Report (Chapter 30)Enables the technician to create customized internal Coral Traffic Reports f. A total of ten different report templates may be defined. Additionally, the technician decides which entities are to be monitored and for how many days.

2-5


Programming and Entering Time Units

The 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.

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.

AM Hours PM Hours

Time Enter Time Enter

Midnight 00 Noon 12

1 01 1 13

2 02 2 14

3 03 3 15

4 04 4 16

5 05 5 17

6 06 6 18

7 07 7 19

8 08 8 20

9 09 9 21

10 10 10 22

11 11 11 23

2-6


Programming Functions

The 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 Function Description

0 UPDATE Allows changing or modifying the parameter values or characteristics.

1 DISPLAY Displays all parameters for any specific port or range of consecutively numbered ports.

2 ADD Instructs the system to make an addition to the existing parameter or option for a specific port.

3 REMOVE Deletes an existing parameter.

4 SNAP Similar to DISPLAY, but in real-time. Used for on-line monitoring from a single monitor only.

5 SHOW Generally used for showing Diagnostics and Numbering Plan tables.

6 DUPLICATE 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.

7 ERASE Deletes the branch database from memory while in a specific branch.

2-7


Locating Data Fields

Data 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, for example: 2,5,9 or 11 15 24 26 or 0 5 or MAX_RING, EXT.ID are all valid entries.

Field Search: Enter single field name/field number and value required for searching. (field name) = (value). For example: while in the KEY node, to identify all keysets defined as attendant, enter ATT = Y. All keysets defined with this value appear.

Two values cannot be entered in the same instance; e.g. ATT = Y, PCC = Y is not a valid entry.

Field names can be entered in any of the following methods: Full field name, e.g. MAX_RING. The least amount of letters that identify a parameter, e.g. Max for MAX_RING.

The system will always start searching from the top of the current node. Field index number, this is the number that appears in square brackets after the

field name, e.g. [0]. Field Index is always correct for the most recent Coral Version (check this handbooks front cover to determine the most recent Coral Version). In the more advanced versions, new field names are added. Changes can occur in their numbering. Compatibility cannot be guaranteed between field index numbers for different Coral Software versions.

2-8


Direct Access Abbreviations (DAA)

Certain branches and options can be directly accessed from any location in the PI tree. The entire list of these abbreviations (or mnemonics) can be displayed by either entering HELP or typing 10 on the main menu. Since HELP is also a Direct Access Abbreviation (DAA), typing the letters HELP anywhere in the PI tree, except in NAME field, will bring up the List Of Direct Access Abbreviations to the PI Tree.

The following table presents the currently available DAA features. This list is presented in alpha-numeric order, as opposed to the actual PI on-line list, which has a slightly different arrangement.

Entering ROOT anywhere in the PI returns the system to the Root (Main) Menu.

The layout and order of the Direct Access Abbreviations shown above is slightly different from the on-line version; this is for the sake of clarity only.

Branch DAA Branch DAA BRANCH DAA4T/8T CARD_DB TKDB GROUPS GROUP SMDR CONTROL SMDR

ALT ROUT TK.GROUP ROUT GROUP CALLS CALL Soft Keys Idle Set SKEY

BELL/UNA GROUP BELL HUNT GROUP HUNT STATION TIMERS ST.T

BOSS GROUP BOSS IP Ports KEYSET IPKEY SYSTEM GEN. SYSGEN

BUSY PORTS BU

Program Interface (PI) 16 [for Tadiran Coral IPx/FlexiCom ... · 4 February 1996 Includes Software...

Documents

Transcript of Program Interface (PI) 16 [for Tadiran Coral IPx/FlexiCom ... · 4 February 1996 Includes Software...