Database Binary Backup PC Utility Reference Manual (Version 3.xx) DRAFT 2 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 BUSINESS SYSTEMS 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 BUSINESS SYSTEMS LTD., 2004. 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. End User Software License Agreement i
TADIRAN TELECOM BUSINESS SYSTEMS LTD. END USER SOFTWARE LICENSE AGREEMENT IMPORTANT! PLEASE READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY USING THIS SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT. 1. License Grant. Tadiran Telecom Business Systems Ltd. (Hereinafter: the "Manufacturer") hereby grants You a nontransferable, nonexclusive license to use the software (the "Licensed Software") and the accompanying documentation (the Licensed Software, and the documentation are referred to in this License Agreement as the "Licensed Materials") subject to the terms and conditions of this License Agreement. You may use the Licensed Materials only in connection with the Manufacturers products purchased by You for your internal use and that are installed in your premises. The Manufacturer retains all right, title, and interest to the Licensed Materials. YOU MAY NOT USE, COPY, MODIFY, RESELL, OR TRANSFER THE LICENSED MATERIALS, IN WHOLE OR IN PART, EXCEPT AS PROVIDED IN THIS AGREEMENT. Any upgrades to the Licensed Software may only be used in conjunction with this License Agreeement. Distributors, Dealers, Technicians, and Communication Advisors specifically authorized by the Manufacturer in writing, are also allowed to use the Licensed Materials for the purposes of providing support, maintenance, and pre-sale services in connection with products of the Manufacturer purchased and/or used by third parties. 2. Term; Termination. This License Agreement is effective from the date on which You install the Licensed Software until the end of the License Term or termination by either party. You may terminate this License at any time by destroying the Licensed Software, related documentation and all copies thereof. This License will terminate immediately, without notice from the Manufacturer, if you fail to comply with any provision of this License. Upon termination, you must destroy the Licensed Software, related documentation and all copies thereof. 3. Ownership. The Licensed Materials are the sole and exclusive property of the Manufacturer. 4. Copy Restrictions. (a) You may install the Licensed Software only on one computer or workstation and make only one copy of the Licensed Software in machine-readable form for backup purposes only, and for your own use only. You must reproduce on such copy, or partial copy, the Manufacturers copyright notice and any other proprietary legends that were on the original copy of the Licensed Materials. (b) In no event does the copying permitted under this License Agreement include the right to decompile, reverse engineer, disassemble or otherwise reduce the Licensed Software to a humanperceivable form, modify, network, rent, lend, loan, distribute or create derivative works based upon the Licensed Software, in whole or in part, electronically transmit the Licensed Software from one computer to another or over a network, or to translate the Licensed Materials into another computer language. (c) You may make one printed copy of the manual for your own use only. (d) You may not remove any proprietary notices, labels, or marks from the Licensed Materials. ii End User Software License Agreement
5. Protection and Security. You agree to use your best efforts and take all reasonable steps to safeguard the Licensed Materials to ensure that no unauthorized person shall have access thereto and that no unauthorized copy, publication, disclosure or distribution, in whole or in part, in any form shall be made. You acknowledge that the Licensed Materials contain valuable, confidential information and trade secrets and that unauthorized use and/or copying are harmful to the Manufacturer. You further agree to maintain in confidence Your User Identification Number (Serial Number) and/or Password. 6. WARRANTY DISCLAIMERS; LIABILITY LIMITATIONS. (a) The Manufacturer warrants that for a period of ninety (90) days from the date of sale of the Licensed Software to you, the media on which the Licensed Software is furnished will, under normal use, be free from defects. (b) You are exclusively liable to prevent unauthorized access to the Licensed Software, and the Manufacturer advises You to install security devices in order to prevent such unauthorized access, especially in cases where the Licensed Software is connected to a computer network. (C) THE MANUFACTURER'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY UNDER THIS WARRANTY (WHICH IS SUBJECT TO YOU RETURNING THE LICENSED MATERIALS TO THE MANUFACTURER) WILL BE, AT THE MANUFACTURER'S OPTION, TO REPLACE THE MEDIA OR TO REFUND THE PURCHASE PRICE AND TERMINATE THIS AGREEMENT. EXCEPT FOR THESE EXPRESS LIMITED WARRANTIES, THE MANUFACTURER MAKES, AND YOU RECEIVE, NO WARRANTIES OR CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND THE MANUFACTURER SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. THE MANUFACTURER DOES NOT WARRANT THAT THE LICENSED SOFTWARE WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE LICENSED SOFTWARE WILL BE UNINTERRUPTED OR ERROR FREE. YOU ASSUME THE RESPONSIBILITY FOR THE SELECTION OF YOUR REQUIREMENTS, SOFTWARE, AND HARDWARE TO ACHIEVE YOUR INTENDED RESULTS: FOR INSTALLATION, FOR USE, AND THAT THE OPERATIONS OF THE LICENSED SOFTWARE WILL BE UNINTERRUPTED OR ERROR FREE. (d) THE MANUFACTURER'S LIABILITY ARISING OUT OF THIS AGREEMENT SHALL NOT EXCEED THE AMOUNTS PAID BY YOU TO OBTAIN THE LICENSED SOFTWARE. IN NO EVENT WILL THE MANUFACTURER BE LIABLE FOR ANY LOSS OF DATA, LOST OPPORTUNITY OF PROFITS, COST OF COVER, OR SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR INDIRECT DAMAGES ARISING FROM THE USE OF THE LICENSED SOFTWARE IN THIS AGREEMENT, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY. THESE LIMITATIONS WILL APPLY EVEN IF THE MANUFACTURER OR AN AUTHORIZED DEALER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE, AND NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. YOU ACKNOWLEDGE THAT THE AMOUNT PAID FOR THE LICENSED SOFTWARE REFLECTS THIS ALLOCATION OF RISK. 7. General. (a) If any provision or portion of a provision of this License Agreement is determined to be invalid or unenforceable, it shall be deemed omitted and the remaining provisions of this License Agreement shall remain in full force and effect. End User Software License Agreement iii
(b) You agree that you will not export or re-export the Licensed Material in any form without the appropriate United States and foreign government licenses, and the Manufacturers written approval. Your failure to comply with this provision is a material breach of this License Agreement. (c) This License Agreement is governed by the laws of the State of Israel without reference to conflict of laws principles. All disputes arising out of this License Agreement shall be subject to the exclusive jurisdiction of the courts located in Tel Aviv, Israel. If the Licensed Material was purchased within the United States of America, then this License Agreement will be governed by the laws of the State of New York without reference to conflict of laws principles, and all disputes arising out of this License Agreement shall be subject to the exclusive jurisdiction of the courts located in the city of New York, NY. (d) This License Agreement constitutes the entire agreement between the parties with respect to the subject matter hereof, and all such prior agreements, representations, statements and undertakings are hereby expressly cancelled. (e) Should you have any questions regarding this License Agreement, you may contact the Manufacturer at 18 Hasivim St., Petach Tikva, Israel. If you are in the United States of America you may contact the Manufacturer s subsidiary: Tadiran Telecom Inc. 4 Tri Harbor Court, Port Washington, NY 11050 iv End User Software License Agreement
Table of Contents 1. Introduction... 1 1.1. Overview... 1 1.2. About This Manual... 1 1.3. Conventions Used in this Manual... 2 1.4. Disclaimer... 2 1.5. Related Documentation... 2 1.6. Minimum System Requirements... 2 1.6.1 Software 2 1.6.2 Hardware 2 2. Installation and Setup... 3 2.1. Software Installation... 3 2.2. Connecting the the PC to the Coral System via KB0... 6 2.3. Configuring the Terminal Settings... 7 3. Startup and Operations... 9 3.1. Starting the Application... 9 3.1.1 Menu Bar 10 3.1.2 Tool Bar Buttons 10 3.1.3 Task Bar Fields 10 3.2. Backup... 11 3.3. Restore... 14 4. Troubleshooting... 17 v
vi
1. Introduction 1.1. Overview This reference manual describes how to install and use the Coral Database Binary Backup utility. The Coral Database Binary Backup utility allows you to backup the Coral database onto a PC and to restore the database from a saved file. Binary Backup is used along with the Coral application-programming interface and other advanced Coral telephony products. Saving the database results in a file that contains all of the customer-specific information. This file may be used at any time for restoring the Coral system database to its original contents. The Save (Backup) procedure is recommended as the final installation step and also whenever a major redefinition or configuration change is done. It is recommended to generate a new file any time that the Save procedure is performed, and that you save the old files for reference at the customer s site and at technical support centers. The database memory power is backed by a lithium battery in order to retain its contents during power failures or system shutdowns. The battery will retain its contents for as long as four months if subject to continual system shutdown. The battery shelf life (nonpowered) is ten years. Database backups may consist of binary backup files, ASCII type database files, log files and hardcopy listings and/or database ordering form copies. The most important and highly recommended types of database backups are the binary file backup and the FLASH memory backup. This manual deals with the binary type of database backups. If total loss of database occurs due to a battery failure, the FLASH memory will be used, restoring the original contents of the system s database (provided the system database was previously saved to the FLASH memory. The FLASH memory does not require any battery backup and retains its contents indefinitely. This manual does not describe the Flash memory Save and Restore features. Refer to Chapter 4 of the relevant Coral Installation and Hardware Reference Manual and to Chapter 21 of the Program Interface and Database Reference Manual. This product is designed for Coral software versions 11.xx and later. 1.2. About This Manual This document includes the following chapters: Chapter 1 Chapter 2 Chapter 3 Chapter 4 Introduction presents an overview of this document. Installation and Setup includes instructions for installing the software, connecting the Coral system to the PC, and configuring the terminal settings. Startup and Operations describes how to activate the Binary Backup Utility and how to use the application. Troubleshooting includes a description of system errors and how to troubleshoot them. 1
Introduction Coral Database Binary Backup Utility Reference Manual 1.3. Conventions Used in this Manual The following typographical conventions have been used throughout this guide. Menu options Menu options are displayed in Italics type. The > sign denotes a menu heading. For example: Operations > Restore opens the Binary Restore Browse dialog box. Fields Fields are displayed in italics type. Buttons Control buttons are displayed in bold type. 1.4. Disclaimer The illustrations and other views, telephone displays or screen captures appearing in this manual are examples used to explain more clearly, how the features and controls are used. Therefore, what appears on the display or screen capture in the illustrations may differ from what appears on the actual equipment, and some of the illustrations may represent something impossible in actual operation. The functions that can be used and the information that can be displayed will differ depending on the telephony state and external equipment being connected. The names of companies, products, people, characters, and/or data mentioned herein are fictitious and are in no way intended to represent any real individual, company, product, or event, unless otherwise noted. 1.5. Related Documentation Refer to the Program Interface Reference Manual as required during the Setup procedure. 1.6. Minimum System Requirements Before proceeding with the software installation, verify that the following minimum system requirements exist. 1.6.1 Software Coral software version 11.xx Windows NT 4.0 with Service Pack 4 and higher, Windows 2000, and Windows XP (If Custom installation is selected, make sure to install the HyperTerminal option.) Internet Explorer 4.0 or higher Microsoft Word 97 or higher 1.6.2 Hardware Pentium II 200 MHz 64 MB RAM 5 MB free hard disk space CD ROM drive for installing the application, only Free serial COM port 2
2. Installation and Setup Preparing the Binary Backup Utility for operation includes the following steps: Software installation onto the PC. This is done when you install the Binary Backup application onto your PC. Connecting the PC to the KB0 connector on the Coral system. This is done every time that you use the Binary Backup application. Configuring the terminal settings in the PI (Program Interface) and the Binary Backup application 2.1. Software Installation 1. Close all other applications that may be running in the background. 2. Insert the software installation CD in the CD drive of the computer. 3. To run the setup program, double-click the Setup.exe file. The Setup dialog box appears. 4. Click OK; the next setup dialog box appears, prompting you to specify the destined setup directory. 3
Installation and Setup Coral Database Binary Backup Utility Reference Manual 5. Do one of the following: If required, click Change Directory; the Change Directory dialog box appears, prompting you to select or enter the destination directory. Enter the path of the designated directory and click OK. Skip to the following step. 6. Click the icon on the Binary Backup Setup dialog box; the Choose Program Group dialog box appears. 4
Coral Database Binary Backup Utility Reference Manual Installation and Setup 7. Select Binary Backup and then click Continue; the Setup process runs. When the Setup process is complete, the following message box appears. 8. Click OK; the message box closes. 9. Double-click on the Binarybackup.reg file; the following message box appears. 10. Click Yes; the software installation process finishes and the following window appears. 11. Click OK; the window closes. 5
Installation and Setup Coral Database Binary Backup Utility Reference Manual 2.2. Connecting the PC to the Coral System via KB0 The connection between the PC and the Coral serial port (KB0 only) permits database transfer via the Coral system via an RS-232 cable. KB0 RS-232 Coral System PC with Database Binary Backup Utility Figure 1: Coral-PC Connection To connect the PC to the Coral system: 1. Verify that the RS-232 cable includes one DB-9 female plug and that the other DB-9 plug is suitable for the KB0 connection on the main control card. See table below. Control Card MCP-IPsl MEX MCP-IPx MEX-IP MEX-IP2 MCP-IPx2 MCP-ATS Cable Connection Male/Female Female/Female 2. Connect the female DB-9 plug to the COM socket located on the PC. 9 8 7 6 5 4 3 2 1 Signal Ground Data Terminal Ready Transmit Data Receive Data 5 4 3 2 1 9 6 KB0 Serial Data Port PC COM Serial Port 9 pin connector 9 pin connector Figure 2: Cable Pinout of Coral KB0 - PC COM Connection 3. Route the RS-232 cable from the COM socket located on the PC to the KB0 connector on the main control card. 4. Connect the DB-9 plug on the other end of the RS-232 cable to the Coral KB0 connector. WARNING: The ground connection to the PC should be the same ground connection supplied to the Coral system whenever possible. 6
Coral Database Binary Backup Utility Reference Manual Installation and Setup 2.3. Configuring the Terminal Settings 1. Do one of the following: Open the Terminal Emulation application and log on to the PI with your password (route: Term>Setup>Update). Enter the Attendant Console (feature code #1996). 2. Verify that the following RS-232 KB0 Terminal Setup parameters are configured according to Coral system card type, as displayed in the following table. Refer to Chapter 17 in the Program Interface Database Reference Manual. NOTE: If any of the parameters are different, do one of the following: Write down the parameters that appears in the PI so that you can reconfigure the PI to the original setting later. Write down the paramters supplied by the customer. Control Card Terminal Setting Max. Recommended Baud Rate FlexiCom 200 Coral IPx 500 FlexiCom 300, 400, 5000 Coral IPx 800, 3000 FlexiCom 6000 Coral IPx 4000 19200 38400 57600 Data Bits 8 Parity N Stop Bits 1 3. Exit the terminal emulation application. 4. Open the Binary Backup application. See Startup and Operations on page 9. 5. In the main application window of the Binary Backup application, click or select Operations > Terminal Settings; the Terminal Settings dialog box appears. 7
Installation and Setup Coral Database Binary Backup Utility Reference Manual 6. Select the parameters that you entered in step 2. 7. Select the COM port in use. 8. Click OK; the Terminal Settings window closes. 8
3. Startup and Operations The Binary Backup application allows you to backup the Coral system database manually onto an external file and restore the database from an external file. During normal operation, the database is automatically backed up periodically onto a separate file within the system. Manual database backup is required before removing power from the Coral system, before and after performing a major job on the system, or for a number of other reasons. 3.1. Starting the Application Click and select Programs > Binary Backup > Binary Backup, or double-click on the desktop shortcut; the Binary Backup application main window appears. Menu Bar Tool Bar Task Bar Application Status Process Start Time Process End Time File Name Terminal Setting 9
Startup and Operations Coral Database Binary Backup Utility Reference Manual 3.1.1 Menu Bar The Menu bar includes the following commands: Backup Restore Terminal Setting Exit This command opens up the Backup window, enabling you to backup the database to a file. See page 11. This command opens up the Restore window, enabling you to restore the database from a file. See page 14. This command opens the Terminal Setting window, enabling you to set the baud rate and the COM port. See page 7. This command closes the application. 3.1.2 Tool Bar Buttons The tool bar includes the following buttons: Toolbar 3.1.3 Task Bar Fields The Backup button opens up the Backup window, enabling you to backup the database to a file. See page 11. The Restore button opens up the Restore window, enabling you to restore the database from a file. See page 14. The Terminal Settings button opens the Terminal Setting window, enabling you to set the baud rate and the COM port. See page 7. The task bar includes the following fields: Task Bar Application Process Process Starting Time Process End Time File Name Terminal Settings Application Process Process Starting Time Process End Time File Name Terminal Settings This field displays the process either Backup or Restore. This field displays the time that the process began. This field displays the time that the process ended. This field displays the name of the backed up or restored file. This field displays the COM port, baud rate, parity, data bits, and the number of stop bits. See page 7. 10
Coral Database Binary Backup Utility Reference Manual Startup and Operations 3.2. Backup This option copies the current Coral system database to the PC file. 1. From the main window, click or select Operations > Backup; the Binary Backup dialog box appears. 2. Click the Browse button; the Backup Browse window appears, prompting you to select the desired path and file you want the database to be saved in. 3. Enter the filename and the path of the database. 11
Startup and Operations Coral Database Binary Backup Utility Reference Manual 4. Click Save; the Backup Browse window closes. In the Binary Backup window, the destination path and file appear in the field and a Start button is enabled. 5. Click Start; a progress indicator bar appears, indicating the database is being backed up. At the end of the backup process, a message box appears indicating that the process was successful. 12
Coral Database Binary Backup Utility Reference Manual Startup and Operations 6. Click OK and close the Binary Backup Progress dialog box. 7. Exit the Binary Backup application. 8. Restore the KB0 parameters to their original value recorded in step 2 of paragraph 2.3 on page 7. 13
Startup and Operations Coral Database Binary Backup Utility Reference Manual 3.3. Restore This option loads (restores) the backup database from the PC file to the Coral system memory by loading the stored backup database with system restart. 1. From the main window, click or select Operations > Restore; the Binary Restore Browse dialog box appears. 2. Click the Browse button; the Backup Browse window appears, prompting you to select the filename from which the database is to be restored. 3. Enter the filename and the path of the database. 14
Coral Database Binary Backup Utility Reference Manual Startup and Operations 4. Click Open; the Restore Browse window closes. In the Binary Restore window, the destination path and file appear in the field and the Start button is enabled. 5. Click Start; a progress indicator bar appears, indicating the database is being restored. At the end of the restoration process, a message box appears indicating that the restoration process was successful. 6. Click OK and close the Binary Restore Progress dialog box. 15
Startup and Operations Coral Database Binary Backup Utility Reference Manual NOTE: Database restoration will suspend all system activities. Users will not be able to resume any routine operations of the Coral system. When the Restore procedure is complete, the Coral system automatically initializes with the new database contents. 7. Exit the Binary Backup application. 8. Restore the KB0 parameters to their original value recorded in step 2 of paragraph 2.3 on page 7. NOTE: It is the technician s responsibility to ensure that the correct files and parameters have been supplied. 16
4. Troubleshooting The following error messages may appear while attempting backup or restore: Error Message Problem Solution CCS error, check password, cable or COM setings Port Is Already Open CSS error, didn t accept Version Header Can t Restore, Versions don t match CCS error, didn t accept Def table Header CCS error, can t transfer DB Header CSS error can t restore sector 1 because of too many Binary Backup protocol errors. Connection failed No Database Incorrect password Cable not connected Incorrect baud rate Or Incorrect COM port COM port is being used by another application. Binary Backup could not read the Coral software version number. Existing Coral software does not match the software of the saved file. Binary Backup could not read the Coral system definition table header. Binary Backup could not transfer the Coral system database header. Restore action failed due to excess of errors during restoration. Database file is corrupted and cannot be restored. Check: Password RS-232 cable connection Baud rate definition in Terminal Settings And COM port in Terminal Settings See page 7. Exit the other application and connect to the Binary Backup application as described in steps 1 through 4 on page 7. Try again or contact customer support. If applicable, update the Coral software to the same version as the saved file. Try again or contact customer support. Try again or contact customer support. Try again or contact customer support. Try to restore a different file or contact customer support. 17
International Headquarters Tadiran Telecom Business Systems Ltd. 18 Hasivim Street P.O.Box 450 Petach Tikva 49105 Israel Tel. +972-3-9262000, Fax. +972-3-9262310 USA Headquarters Tadiran Telecom, Inc. 4 Tri Harbor Court Port Washington, NY 11050 Tel. +1-516-632-7200, Fax. +1-516-632-7210 Visit us at our website http://www.tadirantele.com Email: coral@tadirantele.com TM Coral DatabaseBinaryBackupPC Utility(V3.xx) ReferenceManual 1st Edition2004