vGATE Reference Manual Software version 17.1 vGATE Reference Manual TELES AG | HEADQUARTERS Ernst-Reuter-Platz 8 10587 Berlin GERMANY Phone +49 30 399 28-066 Fax +49 30 399 28-051 E-mail sales@teles.com http www.teles.com Software version: 17.1 Revised:14 May 2013 © Copyright 2010 TELES AG Informationstechnologien. All rights reserved. TELES®, IntraSTAR®, Intra*®, iGATE®, and iSWITCH® are registered trademarks of TELES AG Informationstechnologien. All other trademarks used are the property of their respective owners. The supplied hardware/software systems are protected by copyright and can be used solely by their lawful owners. All text and figures in this publication have been compiled with great attention to detail. Nonetheless, inaccuracies and typographical errors cannot be entirely avoided. TELES AG Informationstechnologien provides this document 'as is' without warranty of any kind, expressed or implied. TELES AG Informationstechnologien reserves the right to make changes in product design or specifications without notice. vGATE 17.1 Table of contents Table of contents 1 About this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.1 1.2 1.3 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Safety symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 2 Safety and security precautions . . . . . . . . . . . . . . . . . . . . . . . . 9 2.1 2.2 2.3 2.3.1 2.3.2 2.3.3 2.4 2.5 Safety measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Tips for EMC protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 System security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Servicing the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Replacing components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Protecting the operating system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 CDR files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 Network security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 3 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.1 3.2 3.3 3.4 3.4.1 3.4.2 3.4.3 3.4.4 What’s new in version 17.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 How vGATE works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 How the hosted vGATE solution works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Possible renting models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 User groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Access rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 4 vGATE installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 4.1 4.2 4.2.1 4.2.2 4.2.3 4.3 Network and firewall requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23 Secure vGATE Web GUI access with HTTPS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23 Creating an SSL certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24 Self-signing a certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing the certificate and enabling SSL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 vGATE SIM Unit hardware installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 5 The vGATE Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 5.1 5.2 5.3 The SIM 60 Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 Installing additional vGATE boards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 vGATE board LEDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 6 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 6.1 6.1.1 6.1.2 6.1.3 6.1.4 6.2 6.2.1 6.2.2 6.3 Configuration of the vGATE SIM Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Editing the IP address using the netconfig tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Editing the IP address using vi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 Configuring a DNS server to work with dynamic IP addresses . . . . . . . . . . . . . . . . . .36 Setting a password for connection from vGATECtrl to the vGATE SIM Unit. . . . . . .37 Configuration of the vGATE Control Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 vGATE Control Unit hardware installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37 vGateConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 Managing customer and user profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 vGATE 17.1 Page 3 Table of contents 6.3.1 6.3.2 6.3.3 6.3.4 6.4 6.5 Adding customer and user profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Assigning SIM 60 carriers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Editing customer and user profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Deleting customer and user profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Handling new default gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 Configuration of mobile gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 7 vGATEDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 7.1 7.2 7.3 7.4 7.4.1 7.4.2 7.4.3 7.5 7.5.1 7.5.2 7.5.3 7.6 7.7 7.7.1 7.7.2 7.7.3 7.8 7.9 7.9.1 7.9.1.1 7.9.1.2 7.9.2 7.9.2.1 7.9.2.2 7.9.2.3 7.9.3 7.9.4 7.9.5 7.9.5.1 7.9.5.2 7.9.6 7.9.6.1 7.9.6.2 7.9.6.3 7.10 7.11 7.11.1 7.11.2 7.11.3 7.11.4 7.11.5 7.12 7.12.1 7.12.2 Automatic mobile gateway registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Setting up mobile gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Setting up groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Setting up timezones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Editing and copying timezones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 Setting holidays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54 Setting different rates for timezones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54 Assigning SIMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Reserving SIMs to inactive timezones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Assigning SIMs to active timezones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Copying SIM assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Setting time limits and pauses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Setting dynamic SIM pauses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Setting the coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64 Entering the coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64 Setting the time/distance ratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Setting carriers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Configuring prepaid SIMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 Configuration in the mobile gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Settings in the route.cfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Settings in the pabx.cfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Defining prepaid SIMs on the vGATEDesktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75 Finding the balance parse string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75 Calculating the balance factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75 Defining the maximum number of allowed balance checks after assign . . . . . . . . .76 Setting a change limit for prepaid SIMs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 Entering autorecharge vouchers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77 Recharge via USSD menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 Settings in the pabx.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 Settings in the route.cfg file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 SIM card balance transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80 Configuring master carrier and master SIM cards . . . . . . . . . . . . . . . . . . . . . . . . . . . .80 Configuring production carrier and production SIM cards. . . . . . . . . . . . . . . . . . . . .81 Transfer script example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82 Automatic mobile gateway configuration via vGATEDesktop . . . . . . . . . . . . . . . . .82 SMS and call options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 Sending SMS and calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 Receiving SMS and calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86 Defining SMS messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86 Sending external SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87 Retrieving a SIM’s own number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 Special services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89 Script commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90 Script example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 vGATE 17.1 Page 4 Table of contents 7.13 7.14 7.15 7.16 7.17 7.17.1 7.17.2 7.17.3 Defining the SIM’s protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 Decommissioning SIM cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 Editing mobile gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104 SIM card history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107 vGATE statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109 SIM card statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110 Call statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111 Call charts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112 8 Summary of vGATEDesktop user interface . . . . . . . . . . . . . 113 8.1 8.2 8.3 8.4 8.5 What the information on the vGATEDesktop means. . . . . . . . . . . . . . . . . . . . . . . .114 vGATEDesktop icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117 vGATEDesktop menu bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 vGATEDesktop toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120 Context menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121 9 vGATECtrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 9.1 9.2 9.3 9.4 Logging activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 Sending error messages via e-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130 Tearing down connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130 vGATECtrl Options menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131 10 vGATEWatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 11 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 11.1 11.2 11.3 11.4 11.5 11.6 Starting the Windows2003 control unit without logon. . . . . . . . . . . . . . . . . . . . . .136 Remote access to the vGATE Control Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136 Updating the simserverdb database (MySQL only) . . . . . . . . . . . . . . . . . . . . . . . . .137 Creating a backup of the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 Supported mobile gateways . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140 vGATE 17.1 Page 5 1 About this manual 1 About this manual Congratulations on the purchase of your new vGATE! This manual is set up to guide you through the step-by-step installation of your vGATE, so that you can follow it through from the front to the back. Make sure you familiarize yourself thoroughly with the safety and security precautions detailed in Chapter 2 Safety and security precautions before you begin to install your vGATE. TELES is not liable for any damage or injury resulting from a failure to follow these safety and security instructions! 1.1 Organization This manual is organized into the following chapters. Chapter 1, “About this manual” introduces the vGATE Systems Manual and how it is set up. Chapter 2, “Safety and security precautions” contains information about security issues relevant to connection with the IP network. Chapter 3, “Overview” briefly describes the vGATE and its implementation scenarios. Chapter 4, “vGATE installation” contains information on how to connect and configure the system so that it is ready for operation. Chapter 5, “The vGATE Module” describes the vGATE Module, which consists of the vGATE Board and the SIM 60 Carrier. Chapter 6, “Configuration” describes the vGATE’s individual configuration files and parameters. Chapter 7, “vGATEDesktop” describes the frontend application used for administration of the vGATE. Chapter 8, “Summary of vGATEDesktop user interface” list all elements of the vGATEDesktop userinterface. Chapter 9, “vGATECtrl” describes the vGATE Control Unit’s background server. Chapter 10, “vGATEWatch” describes the watchdog function that causes vGATECtrl and/or the database to restart if they shut down improperly. Chapter 11, “Appendix” contains additional information that may be useful to you. 1.2 Conventions This document uses the following typographic conventions: Bold – items from the GUI menu. Code – file names, variables and constants in configuration files or commands in body text. Chapter 1.2 Conventions – cross-references can be accessed in the PDF files by a single mouse click. vGATE 17.1 Page 7 1 1.3 About this manual Safety symbols The following symbols are used to indicate important information and to describe levels of possible danger. i Note ! Attention ! Warning Useful information with no safety implications. Information that must be adhered to as it is necessary to ensure that the system functions correctly and to avoid material damage. Danger. Could cause personal injury or damage to the system. Dangerous voltage Could cause injury by high voltage and/or damage the system. Electrostatic discharge Components at risk of discharge must be grounded before being touched. vGATE 17.1 Page 8 2 Safety and security precautions 2 Safety and security precautions Please be sure and take time to read this section to ensure your personal safety and proper operation of your TELES Infrastructure System. To avoid personal injury or damage to the system, please follow all safety instructions before you begin working on your TELES Infrastructure System. TELES Infrastructure Systems are CE certified and fulfill all relevant security requirements. The manufacturer assumes no liability for consequential damages or for damages resulting from unauthorized changes. This chapter applies for all TELES Access Gateways. Information that applies only for individual systems specifies the system for which it applies. 2.1 Safety measures Danger of electric shock - the power supplies run on 230 V. Unplug the TELES Infrastructure System from its power source before working on the power supply or extension socket. Make sure to install the system near the power source and that the power source is easily accessible. Bear in mind that telephone and WAN lines are also energized and can cause electric shocks. Wire your system using only the cables included in the package contents. Use only proper ISDN and Ethernet cables. Do not insert foreign objects into openings in the device. Conductible objects can cause short circuits that result in fire, electric shock or damage to the device. Do not open the TELES Infrastructure System except to install an additional TELES.Component. Changes in the device are not permitted. Be sure to respect country-specific regulations, standards or guidelines for accident prevention. 2.2 Tips for EMC protection Use shielded cables. Do not remove any housing components. They provide EMC protection. 2.3 System security This section describes all points crucial to the TELES Infrastructure System’s system security. The system’s location must support normal operation of TELES Infrastructure Systems according to EN ETS 300 386. ! Location: Make sure you install the system in a clean, dry, dust-free location. If possible, the site is to be air-conditioned. The site must be free of strong electrical or magnetic fields, which cause disrupted signals and, in extreme cases, system failure. vGATE 17.1 Page 10 2 Safety and security precautions Temperature: The site must maintain a temperature between 0 and 45°C. Be sure to guard against temperature fluctuations. Resulting condensation can cause short circuiting. The humidity level may not exceed 80%. To avoid overheating the system, make sure the site provides adequate ventilation. ! Power: The site must contain a central emergency switch for the entire power source. The site’s fuses must be calculated to provide adequate system security. The electrical facilities must comply with applicable regulations. The operating voltage and frequency may not exceed or fall below what is stated on the label. Antenna: iGATE contains no provision or protective device against power surges or lightning strikes. The installation of the antenna must fulfill all necessary safety requirements. Employ the services of a professional antenna installer. 2.3.1 Servicing the system Regular servicing ensures that your system runs trouble-free. Servicing also includes looking after the room in which the system is set up. Ensure that the air-conditioning and its filter system are regularly checked and that the premises are cleaned on a regular basis. ! To avoid damage to the vGATE SIM Unit, transport it only in the original packaging. 2.3.2 Replacing components If your system contains any of the following components, replace them according to the following table: Table 2.1 2.3.3 Component Life Span Component Life span Filter pads 6 months CPU fan (systems without TELES.iLCR Base Board only) 5 years Power adapter incl. 3.3 V Adapter 5 years Fan 5 years Hard disk (IDE) (systems without TELES.iLCR Base Board only) 3 years Protecting the operating system Changing configuration data and/or SIM card positions may lead to malfunctions and/or misrouting, as well as possible consequential damage. Make changes at your own risk. TELES is not liable for any possible damage resulting from or in relation to such changes. Please thoroughly check any changes you or a third party have made to your configuration! Make sure your hard disk or flash disk contains enough storage space. Downloading the log files and deleting them from the system on a regular basis will ensure your system’s reliability. vGATE 17.1 Page 11 2 Safety and security precautions Be careful when deleting files that you do not delete any files necessary for system operation. Do not use the Task Manager to shut down vGATEDesktop or vGATECtrl. Do not perform queries on the database. This can result in damages to the database. Do not use any MySQL tools, such as MySQL-Front or PostgreSQL tools, such as pgAdmin to make changes in or perform tests on the database. ! 2.4 CDR files Call Detail Records are intended for analysis of the system’s activity only. They are not designed to be used for billing purposes, as it may occur that the times they record are not exact. i Inaccuracies in the generation of CDRs may occur for active connections if traffic is flowing on the system while modifications in configuration or routing files are activated. 2.5 Network security Every day hackers develop new ways to break into systems through the Internet. While TELES takes great care to ensure the security of its systems, any system with access through the Internet is only as secure as its user makes it. Therefore, to avoid unwanted security breaches and resulting system malfunctions, you must take the following steps to secure your TELES.System if you connect it to the Internet: Use an application gateway or a packet firewall. To limit access to the system to secure remote devices, delete the default route and add individual secure network segments. Access to the system via Telnet, SSH, FTP, HTTP, GATE Manager or remote vGATEDesktop must be password protected. Do not use obvious passwords (anything from sesame to your mother-in-laws maiden name). Remember: the password that is easiest to remember is also likely to be easiest to crack. The firewall must support the following features: Protection against IP spoofing Automatic recognition of security breaches Logging of all attempts to access the system The firewall must be able to check the following information and only allow trusted users to access the TELES.System: IP source address IP destination address Protocol (whether the packet is TCP, UDP, or ICMP) TCP or UDP source port TCP or UDP destination port ICMP message type vGATE 17.1 Page 12 2 Safety and security precautions For operation and remote administration of your TELES.System, open only the following ports only when the indicated services are used: Table 2.2 Default Ports Used for Specific Services Service Protocol Port FTP TCP 21 SSH TCP 22 SMTP TCP 25 DNS forward UDP 53 HTTP TCP 80 (default, can be set) SNTP UDP 123 GATE Manager TCP 4445 (default, can be set) vGATE tunneling to iGATE or ECOTEL GSM TCP 4446 iGATE or ECOTEL GSM to iMNP TCP 9003 PostgreSQL database TCP 5432 iGATE or ECOTEL GSM to vGATE TCP 57342 TCP 57343 Remote vGATEDesktop TCP 57344 Remote vGATEDesktop (read only) TCP 57345 TCP 51500 Radius authentication UDP 1812 Radius accounting UDP 1813 For vGATE Control Unit and iMNP vGATE Control Unit For vGATE SIM Unit vGATE Control Unit plus iGATE or ECOTEL GSM For vGATE Call Manager i Connection from a vGATE Control Unit to a iGATE requires ICMP access. The TCP filters listed above are activated in the default configuration of the vGATE Control Unit or the NMS server. vGATE 17.1 Page 13 3 Overview 3 Overview The vGATE is a system that enables more convenient management of a network of iGATE and ECOTEL GSM or ECOTEL 3G systems (referred to as mobile gateways). For details on the requirements of the mobile gateways, see Chapter 11.6 Supported mobile gateways. Figure 3.1 vGATE in a network A vGATE consists of the following machines and processes: a number of vGATE SIM Units containing the SIM cards on so called SIM 60 Carriers. The SIM cards are installed on SIM 60 carrier boards. Up to ten SIM 60 Carriers can be installed on a vGATE SIM Unit. It is also possibel that the SIM 60 Carrier are installed on iGATEs. In this case the iGATE supports a special LSIM server process that provides the SIM cards to the vGATE. one vGATECtrl unit as the main server process with the following configuration tools: – vGateConfig: used for the main configuration of the vGATE and – Customer Manager: used for the user configuration of the hosted solution. a database PostgreSQL usually installed with the vGATECtrl on the same machine. The MySQL database that was formerly used is also supported. vGATEDesktop: the native GUI of the vGATECtrl. vGATE Web GUI: the new web-based frontend of vGATECtrl. The Web GUI enables hosted solutions, so that different customers are able to use their own virtual vGATE as a part of the real vGATE. The following optional modules are also available: – vGATE Routing Manager for database-driven call routing from VoIP to mobile. – iMMP: a database application for Mobile Number Portability (MNP), acess control lists (ACL), and estimated call routing. – SMPP (Short Message Peer to Peer) server frontend for sending bulk SMS All SIM cards in the network will be managed by the vGATE, so that it is no longer necessary to install SIM cards in each mobile gateway. The vGATE makes it possible to assign SIMs virtually to random ports and various times without physically removing the SIMs from the SIM 60 carrier. Virtual SIM allocation provides extra savings and security. Centralized SIM storage prevents theft of unattended SIMs and reduces costs incurred by maintaining and assigning SIMs at individual mobile gateways. i The term mobile gateway covers the products iGATE, ECOTEL GSM, and ECOTEL 3G and is used throughout this manual. vGATE 17.1 Page 15 3 3.1 Overview What’s new in version 17.1 Since version 17.1 the vGATE comes as a hosted solution for all customers. A user license for one customer is included. In addition there is a default customer with the ID 0 available. After installation, a new customer can be added with the customer manager and a new group created for this customer (see Chapter 3.4 on page 19). UTF8 is supported for SMS/USSD parsing operations snf balance check. The database strings are changed from ANSI to UTF8 (see balance parse string in Table 7.2 on page 68). Support for a central server which provides carrier settings (see Chapter 6.2.2 on page 38 and Chapter 7.8 on page 65). With new commands for the special action scripts (PARSE_STRING_TO_BUFFER, START_EXTERNAL) it is possible to send MMS to Email. Supports the operating system Windows Server 2012. Global carrier settings server available via WebGUI that holds the settings for multiple carrier and countries. Support for mobile gateways using NAT in the local network. Improvements on the vGATEDesktop: – a Start/Stop special action for multiple controllers is added to the CTRLsView. – Stop Special Service for multiple controllers is added to the CTRLsView. – Stop Recharge for multiple controllers is added to the CTRLsView. – New entries in the context menu Release SIM, Block SIM, Remove Linkage, and Immediately Release SIM were added to the CTRLsView. 3.2 Features Handles up to 600 SIMs per vGATE SIM Unit; up to twenty vGATE SIM Units (12,000 SIMs) can be attached to a vGATE Control Unit No need to travel to individual mobile gateways to replace SIM cards. Cyclical use of multiple SIMs can occur on a single mobile channel. Mobile channels in the mobile gateways can easily be assigned to different mobile networks. Groups of mobile gateways can be defined and managed individually Time frames can be defined for individual groups: SIMs can be assigned for specific times on specific controllers or mobile gateways Priority levels can be set for individual SIMs Supports generation of SIM reports Limits and pauses can be defined for how long a SIM card is to be active or inactive More than one vGATEDesktop can be used Supports and automatically recharges prepaid SIMs (USSD, DTMF, or SMS) Can send and receive SMS and calls Shows statistic values Activation of Special Services for prepaid SIMs using automatic USSD, DTMF or SMS transmission Time-controlled USSD or DTMF transmission Random assign pause activation for individual SIMs following change of Timezones, boot indication and Reset Maintenance Color-coded routing Possible to deactivate SIMs when Timezone changes Special scripting interface for advanced options Supports dynamic IP addresses of mobile gateways Supports GSM, UMTS, and dual (UMTS/GSM) SIMs (as of vGATE SIM Unit Version 29) Supports call prioritization Call and SMS limits for SIMs vGATE 17.1 Page 16 3 Overview Possible to allow SIMs to be used once per day and gateway Supports different rates for Timezones with new protocol Password-protected connection between the vGATE and the vGATE SIM Unit Remote tunneling for connection to the mobile gateways Supports 3G SIMs on 2G controllers Balance verification check for prepaid SIMs possible Can set dynamic time/distance pauses between mobile gateways Possible to retrieve a SIM’s call number based on its IMSI Can run special scripts automatically for new SIMs Additional receiver groups for calls and SMS can be defined Possible to define a maximum number of calls per day on one SIM Supports special parse actions Possible to log passive balance checks Can define worst-case charges Can define user registration information Can copy holiday definitions from one group to another Additional limits (A-C) definable for individual prefixes Weekday specific maximum call duration possible Supports multiple limits in relation to balance check of prepaid SIMs Balance verification with tolerance in percentage and/or units possible Supports balance checks for time values in answer to USSD or SMS balance checks Mandatory or preferred advanced limits configurable for each controller Can set SIM active release after maximum number of call attempts Human behavior: – Pause before SIM release – Pause before first call – Too many announcements detection – Configurable recharge timeframe – Configurable call generation timeframe Can set a date to decommission SIM permanently User Info can now be set for individual gateways Get CDR retries limited to three attempts every six hours Now possible to reset prepaid SIM limits to 0 on a definable day Can prioritize prepaid SIMs with 0 limit for assignment Can set SIMs to receive lower priority when limit falls below definable amount SIMView columns can be freely configured on the vGATEDesktop to ensure faster readin of SIMView data vGATE 17.1 Page 17 3 3.3 Overview How vGATE works You maintain control over when each SIM is assigned to which port on which mobile gateway and for how long. Figure 3.2 Timezones and limits Figure 3.2 shows how SIMs can be assigned to various iGATEs at different times. You determine when a SIM is active on a specific iGATE. For example, you can assign a carrier’s SIM to an iGATE during a particularly inexpensive tariff and to another when traffic to that carrier is particularly heavy. You can also set time limits and pauses for individual SIMs. After a SIM has been used for the amount of time set, it will be moved to another port or permanently released from the vGATE. If you set a pause, the SIM take a break for the amount of time set after each use. Figure 3.3 shows how you can distribute SIM activity so that SIMs from each carrier are distributed to different ports on the same mobile gateway. For example, you may distribute traffic from one carrier through the first ten ports on each iGATE, traffic from another through the next ten ports and traffic from a third through the next ten ports . Figure 3.3 Carrier distribution The vGATE is designed to provide you with optimal flexibility and your SIMs with optimal mobility. vGATE 17.1 Page 18 3 3.4 Overview How the hosted vGATE solution works A vGATE that has been enabled for hosting can be rented out to customers to manage the SIM cards in the customer’s network of iGATE, ECOTEL GSM, or ECOTEL 3G systems. In the following document, people offering hosted vGATE solutions are referrred to as main adminstrators. People renting hosted vGATE solutions are called customers. People working for customers are called customer administrators. 3.4.1 Components Each vGATE consists of the following: One vGATE Control Unit: Contains the vGATE’s database and administration software. The vGATE Control Unit is at the main administrator’s premises. Only he has access to it. At least – one vGATE SIM Unit: Contains all of the SIM cards in the vGATE The vGATE SIM Unit contains up to ten SIM 60 carriers. Up to 60 SIM cards can be inserted into one SIM 60 carrier. No SIM cards are required in the individual mobile gateways. or – one SIM 60 Carrier installed on a iGATE with an LSIM server running. The vGATE SIM Unit or SIM 60 Carrier installed on a iGATE can be managed by the customer at the customer’s premises or by the main administrator at the main administrator’s site. At least one iGATE, ECOTEL GSM, or ECOTEL 3G: Routes GSM traffic The gateways route the customer’s mobile traffic. Customers gain access to their gateways and other components using the vGATE Web GUI. Main administrators access these resources using the vGATEDesktop. One hosting licence: The hosting licence enables main administrators to offer hosted vGATE solutions to their customers. Every vGATE contains one license for one customer user. Each licence is valid for a limited number of customer users, the number of customers is not limited. Administrators can create as many customers as they have user licenses, with each customer having one user. Customers don’t need extra licenses to use the hosted solution. 3.4.2 Possible renting models The minimum requirement is that customers rent access to the vGATE via the vGATE Web GUI to manage their SIM cards. They can in addition rent vGATE SIM 60 Carriers or complete vGATE SIM Units to hold their SIM cards. They could even rent the mobile gateways that they want to use in their networks and of course rent managed services. Customers manage their gateways, gateway groups, carriers, vouchers, SIM cards, and timeframes using the vGATE Web GUI. Via the vGATE Web GUI they have access to their partition on the vGATE solely. They have no direct access to the vGATE Control Unit. Main administrators offering hosted solutions to their customers are responsible for the customer’s user management and initial setup. They have direct access to the vGATE Control Unit. They can also offer managed services to run customer setups. 3.4.3 User groups There are three different user groups with different access rights to the vGATE. vGATE 17.1 Page 19 3 Overview Main administrator: The main administrator offers hosted vGATE services to his customers. He has direct access to all resources on the vGATE server. He uses the vGATECustomerManager for creating customer profiles and the administration of customer settings. He uses the vGATEDesktop to manage carriers, gateway groups, gateways, SIM cards and timeframes for his customers. In detail, the main administrator is responsible for the following user management tasks: He creates profiles for customer administrators and customer users. He edits customer and user profiles. He deletes customer and user profiles. The main administrator allocates vGATE resources to his customers: He assigns vGATE SIM 60 Carriers to his customers. The vGATE SIM 60 Carriers can be on different vGATE SIM Units. They are exclusively configured for one single customer and cannot be used for other customers. He equips the vGATE SIM 60 Carriers with SIM cards if the SIM Unit is at his site. He creates a root directory for each customer to store scripts, cdr files, and message log files. Table 3.1 shows an example of the customer resources on using a hosted vGATE. Table 3.1 Example of resource usage on a hoted vGATE Resources Customer A Customer B vGATE SIM 60 Carrier 1, 2, and 4 of SIM Unit 1 7 and 8 of SIM Unit 2 Script directory f:\vGATE\data\custA f:\vGATE\data\custB Directroy for message log files and CDR files f:\vGATE\data\custA f:\vGATE\data\custB The main administrator is also responsible for the initial setup and fulfils customer specific tasks: He shifts new gateways which were automatically assigned to the default gateway group to a specific customer group. He can pre-configure customer specific vGATE setups. Customer administrators: Customers can appoint one or more administrators to administer their vGATE partition. Customer administrators log on to the vGATE Web GUI to access the vGATE Control Unit. They have no direct access to the vGATE. Customer administrator profiles are added to the customer setup by the main administrator. Customer users: Customers appoint one or more users responsible for running the hosted vGATE solution. Customer users are responsible for the daily business tasks on the hosted vGATE resources. They use the vGATE Web GUI for vGATE access. Users profiles are added to the customer setup by the main administrator. vGATE 17.1 Page 20 3 3.4.4 Overview Access rights Main administrators have unlimited access to the vGATE itself via the vGATEDesktop. Administrators at the customer premises are allowed to administer and run their hosted vGATE partition via the vGATE Web GUI. Customer users have viewing rights to their hosted partition and limited administration rights via the vGATE Web GUI. All rights are listed in the table below. Table 3.2 Access rights Resource Task Main administrator Customer administrator user1 vGATE Control Unit Start, restart, major settings, database management A X X vGATECustomerManager User management A X X vGATEDesktop Carrier management A X X SIM card profiles A X X SIM card assignment A X X SIM card release A X X SIM card routing A X X Gateway default group A X X Gateway customer groups A X X SMS management A X X Script handling A X X Error handling A X X History handling A X X Carrier management A AL V SIM card profiles A AL V SIM card assignment A AL AL SIM card release A AL AL SIM card routing A AL V Gateway default group A X X vGATE Web GUI Gateway customer groups A AL V SMS management A AL AL Script handling A AL AL Error handling A AL AL History handling A AL AL A: all actions allowed for complete vGATE AL: all actions allowed for customer partition V: view only for customer partition X: access not allowed Footnotes 1. Customer user access rights have not yet been implemented in the 17.1 implementation. Everyone with a customer user profile has the same rights as the customer administrator. vGATE 17.1 Page 21 4 vGATE installation 4 vGATE installation This section contains information on basic installation and configuration of your vGATE. Implementation of individual scenarios requires adjustments to the appropriate interfaces. Tips for basic settings are described here. Links to relevant chapters are provided for more specific configuration changes. i Use a UPS to avoid possible damage resulting from power interruptions. i The vGATE SIM Unit Version 29 is compatible only with vGATE Version 12.0 or higher. 4.1 Network and firewall requirements Before installing your vGATE, make sure you can fulfill the following network and firewall requirements: A PING must be possible from the vGATE Control Unit to all mobile gateways and vGATE SIM Units. Message round-trip time must be less than 500 ms. You can use PING to measure the round-trip time. No components (mobile gateways, vGATE Control Unit, vGATE SIM Units) may be behind a PAT (Port Address Translation) firewall, as ports 51500, 57342, 57343, 57344, 57345 and 3306 may not be changed. Connection setup must be possible in both directions at all times. The autohangup timer of a router or dial-up connection must be greater than 20 seconds. If you configure the parameter LimitWOdisc=On in the pabx.cfg, you must switch off the autohangup function. We recommend that you install the vGATE Control Unit and vGATE SIM Units in the same location, connected with a bandwidth of 100 MBit/s. If they are not installed in the same location, the bandwidth between them must be at least 2MBit/s in both directions. 4.2 Secure vGATE Web GUI access with HTTPS In the default setting, access to the vGATE via the vGATE Web GUI is granted using HTTP. HTTP is unsecured and is subject to man-in-the-middle and eavesdropping attacks, which can let attackers gain access to passwords and other sensitive information. HTTPS (SSL encrypted HTTP) is designed to withstand such attacks and increases security against such attacks. You as the main administrator can enable HTTPS for access to your vGATE through the vGATE Web GUI. We strongly recommend that you do that. To set up HTTPS access, you need to create an SSL certificate matching the IP address or domain name of your vGATE server machine. You can let this certificate be signed by a certificate authority against payment. Alternatively, you can create a self-signed certificate that is free of charge. vGATE 17.1 Page 23 4 vGATE installation Please note that a self-signed certificate will display warnings on all browsers such as Internet Explorer or Firefox, saying that the certificate is not trusted. Your customers will have to add an exception for this certificate in their browser. The connection will still be encrypted and secure! 4.2.1 Creating an SSL certificate To create an SSL certificate, open the ssl folder on your vGATE’s desktop and double-click create certificate. The following window opens. Figure 4.1 Create certificate screen Enter the following information: Country Name (2 letter code) [AU]: The 2 letter code of the country where your company is located. US for United States of America, DE for Germany, etc. State or Province Name (full name) [Some State]: The state where your company is located. e.g. California. Locality Name (e.g. city) []: The city where your company is located, e.g. Los Angeles. Organization Name (e.g. company) [Internet Widgits Pty Ltd]: Your company name. Organizational Unit Name (e.g. section) []: The department of your company that requires the certificate, e.g. IT department. Common Name (e.g. YOUR name) []: This is the most important field. Enter the domain name of your server (e.g. www.example.com) or - if you do not have a domain configured for your server - the server’s public IP address. This is the IP address that your customers use to access the vGATE through the vGATE Web GUI, e.g.142.32.45.12. Email Address []: Enter a contact e-mail address. vGATE 17.1 Page 24 4 vGATE installation You are then prompted for 2 more attributes. You can leave the attributes blank by pressing the Return key twice. Figure 4.2 Certificate creation complete 2 files are created and saved in the ssl folder: The server.key file: This is your private key and should be kept secure. No one apart from you should get access to this key. Make a backup of it in case it gets lost. The server.csr file: This file contains your certificate signing request. Take this file to a certificate authority such as Thawte or Verisign to get it signed. Alternatively, you can self-sign the certificate. 4.2.2 Self-signing a certificate To self-sign a certificate, go to the ssl folder on your vGATE’s desktop and double-click self sign certificate. The following window opens. Figure 4.3 Self-sign certificate screen Enter the number of days the certificate should be valid starting with the current day. Repeat this step after expiry of the certificate. vGATE 17.1 Page 25 4 4.2.3 vGATE installation Installing the certificate and enabling SSL Once you have your certificate signed, either from a certificate authority or by self-signing it, you will have to install it and enable SSL. If your certificate has been signed by a certificate authority, you should have gotten a *.crt file back. Put this file into the ssl folder and change its name to server.crt. If you self-signed your certificate, use the server.crt file that you created as described under Chapter 4.2.2 Self-signing a certificate on page 25. To use the certificate, go to the ssl folder on your vGATE’s desktop again and follow these two final steps: Install the certificate by double-clicking on install certificate. The following windows opens. Figure 4.4 Install certificate Enable SSL. To do so, double-click the activate ssl file. The window that opens looks like this. Figure 4.5 Enable SSL The unencrypted access to your vGATE via http://your.domain.com has now been deactivated. Your customers will have to enter https://your.domain.com or https://IP-address to gain access to your vGATE through the vGATE Web GUI. vGATE 17.1 Page 26 4 4.3 vGATE installation vGATE SIM Unit hardware installation The vGATE SIM Unit holds up to 10 vGATE Modules. At up to 60 SIM cards per SIM 60 Carrier, a single vGATE SIM Unit contains up to 600 SIM cards. As shown in Figure 4.6, the first three slots are empty and the vGATE Modules are inserted from left to right. Figure 4.6 vGATE: Rear View Table 4.1 describes the numbered arrows shown in Figure 4.6. Table 4.1 vGATE SIM Unit: Assembly Number Description 1. Connect the vGATE SIM Unit to the Ethernet here. 2. Each vGATE Board has a slot for a SIM 60 Carrier. Insert the SIMs in the SIM 60 Carrier and then insert the SIM 60 Carrier here (see Chapter 5 The vGATE Module on page 28). The hardware addresses for the vGATE Boards start with D000 on the left and go to D900 in ascending order. NOTE: The PIN for all SIMs must be 0000. 3. Plug the power cord in here. 4. Plug your keyboard into one of these two outlets. 5. Plug your monitor in here. vGATE 17.1 Page 27 5 The vGATE Module 5 The vGATE Module Each vGATE SIM Unit consist of up to ten vGATE Modules. Each vGATE Module consists of one vGATE Board and one SIM 60 Carrier, which can be inserted into and removed from the back of the vGATE Board during operation. The SIM 60 Carrier contains the SIM cards for the individual mobile channels. Up to 60 SIM cards can be assigned to individual mobile channels at random. 5.1 The SIM 60 Carrier SIM cards are mounted on the front and back of the SIM 60 Carrier. As a guide to help you distinguish top from bottom, the SIMs are numbered at the top and bottom near the center of the SIM 60 Carrier. You can select the SIM cards you would like to use via the vGATEDesktop. When the SIM 60 Carrier is properly inserted, the second LED from the bottom will flash quickly for 5 seconds and then slowly. If the LED remains off or does not stop flashing quickly, insert the SIM 60 Carrier more firmly. Figure 5.1 i SIM 60 Carrier – Front and Rear View Insert ONLY the SIM 60 Carrier into the vGATE Board! Make sure all SIMs are clean and grease free and that their mounts are properly closed. 5.2 Installing additional vGATE boards The system is only to be installed, replaced or maintained by properly trained technicians. Before installation, the following information must be read and understood. vGATE 17.1 Page 29 5 The vGATE Module The vGATE Board contain components which are vulnerable to electrostatic (ESD -Electrostatic discharge Sensitive Devices, also known as EGB). Electrical discharge can cause malfunctions or complete system failure. You must therefore observe the following guidelines: Wear an ESD wristband as protection from electrostatic discharge. Connect it to the “ESD bonding point” (system earth). Discharge equipment, instruments or metal objects, which come in contact with the vGATE Boards so that they are earthed. Avoid contact between the vGATE Boards and your clothing. Do not wear synthetic clothing or shoes with plastic soles. Avoid strong electrical constant fields, such as cathode ray indicators, monitors, etc. To install an additional vGATE Board, attach a keyboard and monitor the vGATE SIM Unit and use the keyboard to logon to the vGATE SIM Unit as root with the password beamup. Exit the vGATE SIM Unit’s software by entering shutdown -h now in the command line. Turn off the system’s power when the message Power down appears. ! You must shut down the system’s power when the message Power down appears before installing any new hardware. Failure to do so will result in damage to the system’s hardware and software. Danger of electric shock. The mains adapter is loaded with 230 V. You must detach the vGATE SIM Unit from the power supply before you open the housing. Unscrew and remove the vGATE SIM Unit’s lid and the bracket on top of the boards. Set the memory range on each new vGATE Board you install. Boards are numbered D000 to D900 from left to right in ascending order when looking at the rear of the system, as shown in Figure 5.2. Figure 5.2 vGATE Board: Memory Range Settings vGATE 17.1 Page 30 5 The vGATE Module Turn the dials in the right-hand corner of each vGATE Board until the arrows point to the corresponding letter and number. In Figure 5.3, the dials have been set at D and 1, for a hardware address of D100. This card will appear in the second slot in the vGATE SIM Unit. Bear in mind that each vGATE Board must have a different address. Figure 5.3 How to Set the Memory Range Make sure the new vGATE Board does not contain a SIM 60 Carrier. Not following the correct procedure to replace the vGATE Board can result in damage to the contacts or conductors. Insert the vGATE Board in the next available slot and screw it into place. Replace and secure the bracket and lid. Reconnect the power supply and turn on the vGATE SIM Unit. The software will automatically recognize the new hardware within five minutes. vGATE 17.1 Page 31 5 5.3 The vGATE Module vGATE board LEDs Each vGATE Board has eight LEDs that provide a quick overview of the vGATE Board’s operational status. Figure 5.4 vGATE Board LEDs Each of the upper six LEDs shows the status of ten of the SIMs inserted in the vGATE Board. The second LED from the bottom shows the status of the database connection. The bottom LED shows whether any of the SIMs are currently being accessed. Table 5.1 provides an overview of what the individual LEDs mean. Table 5.1 vGATE Board LEDs LED Meaning SIM states: Upper six LEDs On All ten SIMs are operational. Slowly flashing At least one, but not all, of the ten SIMs is operational. Quickly flashing At least one of the ten SIMs has an error. Off All ten SIM positions are empty. Database connection: Second LED from the bottom On The vGATE Board is connected to the database. Off The vGATE Board is not connected to the database. Flashing: 5 seconds quickly, then slowly The SIM 60 Carrier is initializing. SIM access: bottom LED On At least one of the SIMs in the vGATE Board is being accessed. Off None of the SIMs in the vGATE Board are being accessed. vGATE 17.1 Page 32 6 Configuration 6 Configuration Operation of the vGATE depends on the following configuration entries: 6.1 Configuration of the vGATE SIM Unit The vGATE SIM Unit is a Linux system that makes use of an Ethernet interface. The eth0 interface enables the vGATE SIM Unit to communicate with the connected mobile gateways and the vGATE Control Unit. Settings for this interface can be adjusted to adapt with the needs of individual networks. After you have installed your vGATE SIM Unit as described in Chapter 4.3 vGATE SIM Unit hardware installation, log onto the vGATE SIM Unit as root and enter beamup at the password prompt. If your vGATE SIM Unit is accessible from the Internet, make sure the password for root is secure. You can change the password using the passwd command. Delete the vgate user with the following command: userdel -r vgate and set up a different, secure user and password with: adduser i Support for UMTS SIMs occurs only with vGATE SIM Unit software version 28 or higher. If your vGATE SIM Unit is running an older version, the software must be updated. The vGATE SIM Unit Version 29 is compatible only with vGATE Version 12.0 or higher. 6.1.1 Editing the IP address using the netconfig tool To edit the IP address with the netconfig tool, log on as a superuser with the username root and the password beamup. Enter netconfig and hit Enter. Answer the queries in the dialog boxes that appear. Table 6.1 contains a description of the queries and the appropriate responses. When you have finished, restart the system by enterin reboot-n. Table 6.1 netconfig Dialog Boxes Dialog Box Information ENTER HOSTNAME Enter the vGATE SIM Unit’s hostname (e.g. simunit1) ENTER DOMAINNAME FOR Enter the domain name (e.g. teles.de). SETUP IP ADDRESS FOR Select the Static IP Address option to assign a static IP address or the Use a DHCP Server to configure ethernet option to assign a dynamic IP address to the vGATE SIM Unit. SET DHCP HOSTNAME Enter the DHCP hostname (dynamic IP addresses only). ENTER IP ADDRESS FOR Enter the IP address, if you selected the Static IP Address option. ENTER NETMASK FOR LOCAL NETWORK Enter the netmask (static IP addresses only). ENTER GATEWAY ADDRESS Enter the gateway’s IP address (static IP addresses only). vGATE 17.1 Page 34 6 Table 6.1 6.1.2 Configuration netconfig Dialog Boxes Dialog Box Information USE A NAMESERVER? If you select Yes, enter the name server’s IP address (static IP addresses only). CONFIRM NETWORK SETUP Make sure you check all of your entries! To make changes, select Restart. If you are satisfied, select Accept. Confirm your accepted settings by hitting Enter. Editing the IP address using vi To make any necessary changes to the configuration of the IP address for the network card (eth0), open the rc.inet1.conf file in the /etc/rc.d folder. Adjust your settings as required: Example 6.1 Editing the IP address using vi (static IP address) # # # # # /etc/rc.d/rc.inet1.conf This file contains the configuration settings for network interfaces. If USE_DHCP[interface] is set to "yes", this overrides any other settings. If you don't have an interface, leave the settings null (""). # Config information for eth0: IPADDR[0]="172.20.25.130" NETMASK[0]="255.255.0.0" USE_DHCP[0]="" DHCP_HOSTNAME[0]="" # Config information for eth1: IPADDR[1]="" NETMASK[1]="" USE_DHCP[1]="" DHCP_HOSTNAME[1]="" # Config information for eth2: IPADDR[2]="" NETMASK[2]="" USE_DHCP[2]="" DHCP_HOSTNAME[2]="" # Config information for eth3: IPADDR[3]="" NETMASK[3]="" USE_DHCP[3]="" DHCP_HOSTNAME[3]="" # Default gateway IP address: GATEWAY="172.20.0.1" # Change this to "yes" for debugging output to stdout. Unfortunately, # /sbin/hotplug seems to disable stdout so you'll only see debugging output # when rc.inet1 is called directly. DEBUG_ETH_UP="no" vGATE 17.1 Page 35 6 Example 6.2 Configuration Editing the IP address using vi (dynamic IP address) # /etc/rc.d/rc.inet1.conf # # This file contains the configuration settings for network interfaces. # If USE_DHCP[interface] is set to "yes", this overrides any other settings. # If you don't have an interface, leave the settings null (""). # Config information for eth0: IPADDR[0]="" NETMASK[0]="" USE_DHCP[0]="yes" DHCP_HOSTNAME[0]="" # Config information for eth1: IPADDR[1]="" NETMASK[1]="" USE_DHCP[1]="" DHCP_HOSTNAME[1]="" # Config information for eth2: IPADDR[2]="" NETMASK[2]="" USE_DHCP[2]="" DHCP_HOSTNAME[2]="" # Config information for eth3: IPADDR[3]="" NETMASK[3]="" USE_DHCP[3]="" DHCP_HOSTNAME[3]="" # Default gateway IP address: GATEWAY="" # Change this to "yes" for debugging output to stdout. Unfortunately, # /sbin/hotplug seems to disable stdout so you'll only see debugging output # when rc.inet1 is called directly. DEBUG_ETH_UP="no" For those unfamiliar with the vi editor, follow these steps: Enter cd /etc/rc.d and press the return key. Enter vi rc.inet1.conf and press the return key. Use the arrow keys to move the cursor to the IP address following the open quotation mark and delete the old IP address using the delete key. Press the i key to enter insert mode and insert the new IP address. Delete and enter any other information you would like to change. Press the escape key to exit insert mode. Enter :wq to save and exit and then restart the computer with reboot -n. 6.1.3 Configuring a DNS server to work with dynamic IP addresses To ensure that a vGATE SIM Unit that uses dynamic IP addresses can be reached under a single domain name, you need to set up a DNS server.If you need assistance with that, please contact TELES service. vGATE 17.1 Page 36 6 6.1.4 Configuration Setting a password for connection from vGATECtrl to the vGATE SIM Unit To set a password to connect with the vGATE SIM Unit from the vGATECtrl, you must first stop the SIM-server process with stopvgate. Using the vi editor, follow these steps: Enter cd /usr/local/bin and press the return key. Enter vi startvgate and press the return key. Use the arrow keys to move the cursor to the space in front of the & sign. Enter the incrypted password as it appears in vGateConfig as follows: Press the i key to enter insert mode and insert -w <encryption>. Bear in mind that this entry is case sensitive. Press the escape key to exit insert mode. Enter :wq to save and exit. Restart the SIM-server process with startvgate and press the return key. We want to set the password test. In vGateConfig, we enter the password test for the vGATE SIM Unit. It appears as SGVU. We set the password in the startvgate script as follows: Example 6.3 Setting a password #!/bin/sh echo “starting simser...” /usr/local/bin/simser -p /usr/local/bin/vgate_isa.bit -c /usr/local/bin/vgate_carrier.bit -l /var/log/vgate.log -w SGVU & 6.2 Configuration of the vGATE Control Unit Administration of the vGATE is done through the vGATE Control Unit, which is a 1HU, 19” or 2HU 19” PC. The vGATE Control Unit includes the following: vGateConfig is a configuration tool with a graphical interface used to configure the vGATE Control Unit. vGATEDesktop is a frontend application used for controller assignment and SIM administration. vGATECtrl is a background server process with an attached database that communicates with the vGATE SIM Unit and the mobile gateways. MySQL V. 5.1.43 or PostgreSQL 9.1 database contains information on all SIMs in the vGATE. The user name and password to log onto the vGATE Control Unit are simdbuser and simdb, respectively. vGATE Control Unit 17.1 is compatible with mobile gateway systems running software version 14.6 or higher, and requires MySQL Version 5.1.43 or PostgreSQL 9.1. Do not use or mix with lower versions. 6.2.1 vGATE Control Unit hardware installation The vGATE Control Unit is available as base system and base system redundant. Please insert the plugs as described in the documentation that is included with the hardware. Please note that as of version 17.0, a dongle is mandatory for vGATE operation. The dongle is a software protection USB device that you insert in the vGATE Control Unit before configuration. It needs to be plugged in all time for the vGATE to run. vGATE 17.1 Page 37 6 Configuration The vGATE periodically checks if the dongle is still inserted. If the dongle is not inserted or broken, an error message window pops up. Reinsert the dongle and restart the vGATE Control Unit. If the problem persists, contact TELES Service to get the dongle replaced. Please note that the vGATE license must be replaced as well since a new dongle only works with a new license. 6.2.2 vGateConfig The configuration tool vGateConfig is used to configure the vGATE Control Unit. To open it, use the icon from the desktop. Figure 6.1 i vGateConfig. You must restart vGATECtrl following any changes made after the initial configuration. vGATE 17.1 Page 38 6 Configuration Database The default Name of the database is simserverdb and do not chang the name. Do not change the User name simdbuser or the Password simdb. Enter its Host address. 3306 is the default Port for MySQL, 5432 for PostgreSQL. If you change this port, you must also enter the new port number here. Frontend server The frontend server is the vGATE Control Unit. The default Host is localhost. Do not change the default Port. Enter a Password and a Password (read only) if you would like to have password-protected access. For information on how to set up a remote vGATEDesktop, see Chapter 11.2 Remote access to the vGATE Control Unit. SIM Unit Double-click to edit entries. Enter the vGATE SIM Unit’s IP address in the Host box. Do not change the default Port. Up to 20 vGATE SIM Units can be defined. Use the context menu to edit, add or delete vGATE SIM Units from the list. Check or uncheck the check box to select or deselect vGATE SIM Units. If you use a NAT firewall to translate the vGATE SIM Units’ private IP addresses into public addresses, you must also enter the vGATE SIM Units’ public IP address at Public Host and Public Port. The connection from vGATECtrl to the vGATE SIM Unit is password protected when you enter a Password. You must also enter the password in the vGATE SIM Unit (Chapter 6.1.4 Setting a password for connection from vGATECtrl to the vGATE SIM Unit on page 37) Gateways Do not change the default Port. Default PIN The PIN entered here will apply for all of the SIMs. The default PIN for all SIMs is 0000 and cannot be changed. Synchronize Carrier Settings It is possible to hold a list of central carrier information?? (see Chapter 7.8 on page 65) on a dedicated server. Activate the option Synchronize Carrier Settings to get this information in addition to the local Carrier List. Fill in the given URL, User name and Password to access the carrier information database. Only one vGATEDesktop can be open at a time. Activate If new desktop tries to connect, close connection to old desktop to close an open vGATEDesktop when another vGATEDesktop tries to open. A dialog will appear on the old vGATEDesktop, from which you can choose to leave the vGATEDesktop open with read-only rights or close the vGATEDesktop. If this box is not checked, any second vGATEDesktop will only be able to start with read-only rights or not at all. 6.3 Managing customer and user profiles Since a hosted platform is integrated into the vGATE, a customer account must first be added with the Customer Manager. Then add a user name for the customer with the Role Administrator. Before the operation starts, assign all?? SIM Carrier to the customer. vGATE 17.1 Page 39 6 Configuration Select Start | All Programs | TELES.vGATE | vGATECustomerManager. Figure 6.2 The vGATECustomerManager In the vGATECustomerManager you can: Add, edit, and delete customer profiles in the Customer section. Assign users to customers, edit user profiles, or remove them from customers in the User section. Attribute SIM 60 carriers to customers or release them from customers in the SIM Carrier section. 6.3.1 Adding customer and user profiles Select Add from the Customer section. The Add Customer page opens. Figure 6.3 Add Customer vGATE 17.1 Page 40 6 Configuration Table 6.2 list the menu items of the Add Customer dialog. Table 6.2 Items on the Add Customer page Item Description Customer Enter the name of the customer here. Path Enter the path to the root directory. Customer scripts, cdr files, and message log files are stored in this directory. Customers can create subfolders to store their data. Please ensure that you use this root directory for one customer only. Mail Settings Click this button to open the Mail Settings page. Add the e-mail settings next. E-mails to your customers, such as notifications about new users and user passwords, or new gateways that you assigned to a customer gateway group, are sent using the settings from this page. Figure 6.4 Table 6.3 Mail Settings Items on the Mail Settings page Item Description Send Mail Check this box if you want to send e-mails to your customer. To Enter your customer’s e-mail address. The customer receives notifications about new users and user passwords, or information about new gateways in his customer gateway group at this e-mail address. SMTP Server Enter the IP address or domain name of the SMTP server from which you send the e-mails. SMTP Originator Enter the e-mail address of the sender (the main administrator). The address must comply with the SMTP server. Logon Check this box if your SMTP server requires logon. User Enter your user name for logon to the SMTP server. vGATE 17.1 Page 41 6 Table 6.3 i Configuration Items on the Mail Settings page (continued) Item Description Password Enter your password for logon to the SMTP server. Base 64 Encoding Check this box if the SMTP server requires the password to be encoded using Base 64 encoding. Filter Set this filter to define which kind of e-mails you want to send to your customers: critical notifications, major notifications, minor notifications, and / or warnings. The e-mail settings can also be changed using the vGATECtrl. Access the Options menu, go to Mail Settings, and select the customer to see the same page. On the Mail Settings page, click OK to open the Add User page. Alternatively, you can add user profiles by right-clicking into the Add User section and selecting Add... from the menu. Customers receive notifications about new users only if the the Send Mail box has been checked. Figure 6.5 Table 6.4 Add User Items on the Add User page Item Description User Enter the name of the user. The user name is required for logon to the vGATE Web GUI. Role Select the user role. The user role defines the access rights a user has. For access rights please refer to Chapter 3.4.4 Access rights. Password Enter or generate the user’s password for logon to the vGATE Web GUI. Confirm Passwords that you entered manually need to be confirmed by re-entering them in this field. When you generate a password you will not see this field. vGATE 17.1 Page 42 6 6.3.2 Configuration Assigning SIM 60 carriers The SIM Carrier section lists all SIM 60 carrier that are available. The SIM Carrier column shows all SIM units with their SIM 60 carriers. The Customer column tells you which carriers are assigned to which customers. Use the drop-down in the Customer section menu to navigate between the customers. Use the check boxes in the SIM Carrier section to select or unselect SIM 60 carriers for customers. To shift a SIM 60 carrier from customer A to customer B, first select Customer A from the customer drop-down menu and uncheck the carrier. Then select Customer B from the drop-down menu and check the carrier. 6.3.3 Editing customer and user profiles To edit existing customer profiles, select the customer from the drop-down menu in the Customer section and click the Edit button. The Edit Customer page opens. Refer to Chapter 6.3.1 Adding customer and user profiles for an explanation of the contents of this page. To edit existing user profiles, select the customer from the customer drop-down menu to display the list of users. Right-click the user in the User section and select Edit.... The Edit User page opens. Go to Chapter 6.3.1 Adding customer and user profiles for details about the contents of this page. 6.3.4 Deleting customer and user profiles To delete a customer profile, click the Delete button on the customer section of the vGATECustomerManager. Confirm the message box. Figure 6.6 Confirm delete The following customer settings on the vGATE are deleted: Carriers Gateway groups Timeframes and holidays SIM card profiles SIM card messages in the database Vouchers: Make sure that you or the customer save unused vouchers before deleting the customer profile. Otherwise all voucher information is lost to the system. The following settings are released or set to default values: Customer gateways: The customer gateways are moved into the the default gateway group. SIM 60 carriers: The SIM 60 carriers can now be allocated to other customers. SIM card settings: The SIM card settings are changed to default values. The following resources remain unchanged: Files in the customer’s root directory and all subfolders: Files in the customer folders and the folder structure remain unchanged. vGATE 17.1 Page 43 6 Configuration To delete a user profile, select the customer from the list of customers in the Customer section and right-click the user profile in the User section. Select Delete... from the menu. 6.4 Handling new default gateways Customers can configure new gateways in two ways: They create a gateway together with the right gateway group using the vGATE Web GUI. Then they configure the gateway’s pabx.cfg file to register the gateway at the vGATE. On registration, the gateway is included in the right gateway group. No further action needs to be taken by the main administrator. They skip step one and only configure the gateway’s pabx.cfg file for registration at the vGATE. The gateway is shifted on registration into the default gateway group. The main administrator needs to assign the gateway to the right customer gateway group. If a gateway needs to be moved to a customer gateway group, do the following: Go to the vGATEDesktop. If not done yet, create the customer gateway group in the gateway group section in the upper left hand corner. Drag and drop the customer gateway from the default gateway group to the customer gateway group. 6.5 Configuration of mobile gateways The following configuration entries must be made in each mobile gateway in the network. ! Do not configure SIMs in the vGATE and mobile gateway simultaneously. This can lead to database failures. Be sure to remove the SIM-card carrier from the mobile gateways used with the vGATE. Configuration in the pabx.cfg The SIMS parameter allows you to connect the system to a vGATE. The first SIM must be defined in the appropriate mobile controller Subscriber line. i This parameter cannot be used with the following parameters: <SIM24>, <SIMV> and <SIM+>. The following example is for iGATE GSM only. Example 6.4 Configuration of the pabx.cfg for iGATE GSM ... Subscriber00=TRANSPARENT NEXT Subscriber01=TRANSPARENT Subscriber02=TRANSPARENT Subscriber03=TRANSPARENT ... vGATE 17.1 ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM Page 44 6 Configuration The following example is for ECOTEL GSM only. Example 6.5 Configuration of the pabx.cfg for ECOTEL GSM ... Subscriber04=TRANSPARENT NEXT Subscriber05=TRANSPARENT Subscriber06=TRANSPARENT Subscriber07=TRANSPARENT ... ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM ROUTER GSM[0000,00000,+000000,1,1,1,SIMS] CHADDR ALARM The following example is for iGATE 3G only. Example 6.6 Configuration of the pabx.cfg for iGATE 3G ... Subscriber00 CHADDR ALARM Subscriber01 CHADDR ALARM Subscriber02 CHADDR ALARM Subscriber03 CHADDR ALARM ... = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] NEXT = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] The following example is for ECOTEL 3G only. Example 6.7 Configuration of the pabx.cfg for ECOTEL 3G ... Subscriber04 CHADDR ALARM Subscriber05 CHADDR ALARM Subscriber06 CHADDR ALARM Subscriber07 CHADDR ALARM ... = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] NEXT = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] = TRANSPARENT ROUTER UMTS[0000,00000,+00000,1,1,1,SIMS,BAND(1)] The vGATE Control Unit’s IP address must appear in the category IP Configuration in the [System] section of the mobile gateway’s pabx.cfg file: SimCtrlUnitAddress=<ip addr> Configure an additional controller in the last position for DTMF functionality as follows: Example 6.8 DTMF controller (pabx.cfg) Controller36=41DTMF vGATE 17.1 Page 45 6 Configuration The corresponding Subscriber line will look like this: Example 6.9 Subscriber entry for DTMF controller (pabx.cfg) Subscriber36=TRANSPARENT i ROUTER DTMF[60] CHMAX[5] Do not use GSM SIMs on UMTS iGATEs or vice versa. vGATE 17.1 Page 46 7 vGATEDesktop 7 vGATEDesktop The vGATEDesktop is a frontend application used for administration of the vGATE. All SIMs and mobile gateways can be maintained from a central location using this application. i The vGATECtrl application must be started before the vGATEDesktop. Do not open a second vGATEDesktop if one is already open, as this will cause the first to close. Make sure you set the clock on the vGATE Control Unit accordingly! The vGATEDesktop allows you to group mobile gateways together for a targeted overview of activity. SIMs can be assigned to any mobile gateway connected to the vGATE SIM Unit at any time of day, making it easy to move SIM activity from one location to another. The vGATEDesktop contains four windows, from which SIMs can be assigned to specific mobile gateway controllers for specific times. The columns in each window can be rearranged by drop and drag and renamed by right-clicking the column headings. Figure 7.1 shows the contents of each window as follows: groups: Lists groups of mobile gateways. mobile gateways: Lists all mobile gateways in the selected group. controllers: Lists all mobile ports on the selected mobile gateway. SIMs: All or filtered list of SIMs in the vGATE. Show Positions: The first drop-down list allows you to filter the SIMs displayed based on SIM positions. The second allows you to filter based on SIM activity and assignment. timezones: Shows the times when SIMs are active on specific controllers. groups Show Positions timezones filters SIMs mobile gateways Figure 7.1 controllers (ports) vGATEDesktop vGATE 17.1 Page 48 7 7.1 Figure 7.2 vGATEDesktop Automatic mobile gateway registration iGATE registration As soon as mobile gateways have been configured and connected to the vGATE, they must be restarted for automatic registration. The respective windows shown in Figure 7.2 will then automatically list the connected mobile gateways and their empty controllers. The inset shows what the icons will look like in the case of an iGATE 3G. As soon as a mobile gateway is configured as part of the vGATE, it is automatically assigned to the Default Group. The following sections will guide you through a step-by-step example of how to set up your vGATEDesktop. 7.2 Setting up mobile gateways To be able to distinguish one mobile gateway from another, it is useful to give it a meaningful Figure 7.3 Context menu name. To rename mobile gateways, right-click the mobile gateway you want to rename and select Edit from the context menu. Enter the new Name in the window that appears. Click OK to activate changes. vGATE 17.1 Page 49 7 vGATEDesktop If dynamic IP-address allocation is used on the mobile gateway, you must set the following entry in the pabx.cfg: SimCtrlUnitCheckInterval=<sec> We recommend defining 60 seconds for this parameter. i For a detailed description of all of the entries in this dialog, see Chapter 7.15 Editing mobile gateways 7.3 Setting up groups Once you have named your mobile gateways, you may want to assign them to groups that will provide you with a more targeted overview of the mobile gateways in your network. In our example, we have four iGATEs, which we have named Berlin, Chicago, Munich and New York. All iGATEs are assigned to the Default Group at installation. To define the default group, select Default Group for New GWs from the context menu. First we want to give the default group a meaningful name. To rename a group, right-click the group, select Edit Group and enter the new name in the pop-up dialog. Figure 7.4 Setting groups For our example, we have renamed the default group Germany. To create new groups, rightclick in the window and select Create Group. Enter the name of the new group in the popup dialog. We have named our new group USA. Ignore the rest of the dialog for now. Now we have two groups and four iGATEs. All four iGATEs belong to the group named Germany. vGATE 17.1 Page 50 7 vGATEDesktop We want the iGATEs Berlin and Munich to remain in the Germany group and the Chicago and New York iGATEs to move to the USA group. Figure 7.5 Setting groups To move iGATEs to another group, right-click the name of the iGATE and select Change Group from the context menu. Choose the group from the drop-down list and click OK. When we click either one of our groups, only the iGATEs in that group will appear in the list of iGATEs. i You can also use drag and drop to assign mobile gateways to groups. 7.4 Figure 7.6 Setting up timezones Setting timezones 1 Using the slide control at the top of the vGATEDesktop, you can easily set the times, called timezones, when SIMs are active for individual controllers. The SIMs in a particular timezone will automatically activate and deactivate at the times set. This function allows you to move SIM activity from one time and place to another. vGATE 17.1 Page 51 7 vGATEDesktop For our example, we will first set timezones for one group. We click the Germany group to activate its timezones. We want to set a timezone from Tuesday at 6:00 p.m. to Wednesday at 8:00 a.m. To add a marker to the slide control, we press Ctrl and left-click the mouse approximately where the new marker is to appear. Then we use the mouse to slide the marker to 8:00. Figure 7.7 Setting timezones 2 After we have added the second marker, we will use another method to set it: we right-click the new marker and set the time using the arrows in the pop-up dialog that appears. If Use SIMs started on same GW is active, the same SIMs used at the beginning of the day will be assigned for this timezone if they are available. Using either of these two methods, you can set timezones for each group. The timezones will be the same for each mobile gateway in the group, but the SIMs assigned to each timezone may differ, depending on your individual setup. i The total number of timezones for all groups may not exceed 85. vGATE 17.1 Page 52 7 7.4.1 vGATEDesktop Editing and copying timezones You can also edit timezones by selecting Timezones List from the View menu. A dialog listing all of your timezones appears. Right-click a timezone or an empty space to Edit, Add or Delete a timezone. Figure 7.8 Copying timezones Drag and drop with the right mouse button to copy the contents of one timezones into another for one or all mobile gateways in the group. To copy the contents of all timezones from one mobile gateway to another in the same group, go to the mobile gateway view and right-click the mobile gateway to copy. Select Copy Timezone Configuration to GW. Select the mobile gateway to which you want to copy from the drop-down menu and click OK. To copy the contents of an entire timezone into another, open the Timezones List and rightclick the timezone to be copied. Drag the cursor to the timezone you want to copy into. Select Copy Timezone Configuration from the pop-up menu and follow the directions that appear. To copy only differing rates from one timezone to another, select Copy Differing Rates from the pop-up menu. Only carriers with differing rates will be copied, but all previous carrier entries in the new timezone will be deleted. For more information about different rates, see Chapter 7.4.3 Setting different rates for timezones. To prevent inadvertent timezone changes, activate Inhibit Modification of Timezones in the vGATEDesktop’s Options menu. This will lock all timezones into place so that they cannot be changed. Make sure this option is inactive before attempting to edit the timezones. vGATE 17.1 Page 53 7 7.4.2 vGATEDesktop Setting holidays Using the Holiday slide control to the right, you can also set special times for holidays. Click the icon (shown there) in the toolbar or select Holidays List from the View menu. Select Add or Edit from the context menu and use the drop-down calendar to set a Date. Enter a Name for the holiday and click OK. Figure 7.9 Setting holidays The vGATEDesktop’s date and clock are set according to the clock on the vGATE Control Unit, which appears in the bottom right-hand corner of the vGATEDesktop. Timezones are set and change according to this clock and not according to the clock on the PC on which the vGATEDesktop is installed. Make sure you set the clock on the vGATE Control Unit accordingly! i 7.4.3 Setting different rates for timezones You can set different call charges for various carriers within the same timezone and copy them from one timezone to another. This applies for all carriers entered in the carrier list. Figure 7.10 Timezones rate list Select Edit Differing Rates from the Timezones List to open the Timezones Rates List. Open the Edit Different Rates dialog by selecting Edit, Add or Delete rates from the context menu. Select a Carrier from the drop-down list. Enter the cost of a minute in the Currency Unit/ Minute box as a decimal number number with a dot as the decimal sign. If, for instance, a minute costs 20 cent, enter 0.2. vGATE 17.1 Page 54 7 vGATEDesktop Charging calls works in the folllowing way: At the beginning of each call there can be a number of seconds that are free of charge. Enter that number in Initial Free Seconds. After the free seconds have passed, define how many units you want to charge each call at the beginning of the next time period. Enter the number of units in Charge Units and add the length of the time period in seconds in per 1st Billing Time (sec). Finally, each call is charged one unit each number of seconds that you define with Following Billing Time/Unit (sec/unit) (was Charge Unit Generate until version 16.2). Charging is done at the beginning of the time period. In the Remaining Balance box, enter the number of currency units that are to remain on the SIM card. The Balance Factor shows how many units make up a major currency unit (such as 1 Euro). It is calculated automatically from the entries in Following Billing Time/Unit (sec/unit) (was Charge Unit Generate until version 16.2) and Currency Unit/Minute. As of Version 14.6 of all mobile gateways, up to two decimal places will be calculated. In the following example, a minute costs 20 cent. For each call, the first 60 seconds are free of charge. At the beginning of the following 60 seconds, 5 units are charged. Following that and every 10 seconds another unit is charged. The balance factor a calculated as follows: every 10 seconds a unit is charged which makes 6 units per minute A minute costs 20 cent which means 6 units cost 20 cent which means 30 units cost 1 Euro (= balance factor). Figure 7.11 Edit different rates For a description of how to copy the rates from one timezone to another, see Chapter 7.4.1 Editing and copying timezones. i To set or copy different rates, you must first activate the New Protocol checkbox in the edit window. After activating the New Protocol checkbox, you must select Reinit or Set Maintenance Mode from the mobile gateway’s context menu to activate this feature. If you deactivate the checkbox, you must restart the mobile gateway. vGATE 17.1 Page 55 7 vGATEDesktop 7.5 Assigning SIMs Once you have set a group’s timezones, you can begin to assign SIMs for each controller and its timezones. i With the corresponding iGATE license, 3G SIMs are supported for 2G controllers as of vGATE SIM Unit Version 36 and iGATE Version 14.3. The timezones are color-coded as follows: green means the timezone is currently active, white means it is inactive and blue means it is currently being edited. SIMs that are currently active appear in the Active Position list. SIMs that are not active but have been reserved to timezones appear in the Limit 1 Reserved Positions and/or Limit 2 Reserved Positions lists (for more on limits, see Chapter 7.6 Setting time limits and pauses). i For an overview of SIMs that were once, but are no longer, inserted in the vGATE SIM Unit, select Show SIMs not in Simserver from the View menu. The allocation of one or more SIM cards to one or more mobile controllers is a process called “assigning SIMs”. Before you start, select a customer group, a mobile gateway and the controller from the controller list. There are different ways to do this: per drag and drop: all selected SIMs to the selected controller (mobile port), or all selected SIMs to all selected controllers. per context menu: Add SIM: Add to selected Ctrls, Add to balanced Ctrls, Add Color to selected Ctrls. per key code: Ctrl+ A, Ctrl+ B, Ctrl + Alt + A The contents of the controller list is summarized in Table 8.1 on page 114. The context menu is described in Table 8.5 on page 121. vGATE 17.1 Page 56 7 7.5.1 vGATEDesktop Reserving SIMs to inactive timezones For our example, we will reserve SIMs 1.001.01-1.001.04 with Max Limit 1 to controller 0 on the Berlin iGATE in the Germany group: Figure 7.12 Assigning SIMs to selected controllers 1. We click Germany in the groups window. 2. Then we click Berlin in the list of iGATEs. 3. Next, we click the white space between the markers set at 8:00 and 18:00. Now the space is blue and SIMs can be reserved for this timezone. 4. We select the controller 0 to which we would like to assign SIMs. 5. We mark the SIMs to be reserved to controller 0, in this case SIMs 1.001.011.001.04. 6. We right-click the SIMs we have marked and select Add to Selected Ctrls or we can simply drag the SIMs to the corresponding controller while holding down the left mouse button. 7. A pop-up dialog appears, from which we select Limit 1 and click OK. 8. SIMs 1.001.01-1.001.04 appear in the Limit 1 Reserved Positions column (for a description of limits, see Chapter 7.6 Setting time limits and pauses). The SIMs appear in the Limit 1 Reserved Positions list. When this timezone becomes active, the SIMs will be assigned automatically to the Active Position and the lamp icon will be yellow. Now we want to assign SIMs 1.001.06-1.001.10 with Max Limit 2 to consecutive controllers 1 to 5: 1. 2. 3. 4. 5. We follow steps 1 through 3 above. We mark controller 1. We mark SIMs 1.001.06-1.001.10. We select Add Balanced to Ctrls. A pop-up dialog appears, from which we select Limit 2 and click OK. vGATE 17.1 Page 57 7 vGATEDesktop 6. SIMs 1.001.06-1.001.10 appear in the Limit 2 Reserved Positions column. 7. SIMs 1.001.06-1.001.10 are now reserved to controllers 1-5 for this timezone (for a description of limits, see Chapter 7.6 Setting time limits and pauses). The SIMs appear in the Limit 2 Reserved Positions list. When this timezone becomes active, the SIMs will be assigned automatically to the Active Position and the lamp icon will be yellow. The same steps can be followed to assign SIMs to an active timezone. 7.5.2 Assigning SIMs to active timezones To assign SIMs to a timezone that is currently active, follow the same steps outlined above, but make sure all inactive timezones are white in the timezone slide control by clicking the green timezone. The SIMs will appear in the Active Position and Limit 1 Reserved Positions or Limit 2 Reserved Positions column. 7.5.3 Copying SIM assignment You can also copy the contents of one timezone into another for one or all mobile gateways in the group by left-clicking the timezone to be copied and dragging the curser into another timezone. You cannot copy into the timezone that is currently active. However, it is possible to copy the currently-active timezone into another one. 7.6 Setting time limits and pauses You can limit the number of time units a SIM is used before the mobile gateway switches to the next SIM or before a SIM is permanently deactivated. The mobile gateway’s default configuration sets these time units at 10 seconds each. Right-click the SIM(s) for which you would like to set or change a limit and select Change Limits from the context menu. vGATE 17.1 Page 58 7 vGATEDesktop If a SIM switches to a new timezone where it has a different limit (Limit 1 to Limit 2), the SIM will be released unless it is reserved to the same controller in the new timezone. If you want to release the SIM regardless of where it is reserved, activate Release All SIMs if Timezone Changes in the vGATECtrl Options menu. If a SIM switches limits during a call, the time will be deducted from the limit that was active when the SIM was assigned. Figure 7.13 Settings time limits and pauses vGATE 17.1 Page 59 7 vGATEDesktop Table 7.1 list the entries of the limit dialog. Table 7.1 Setting time limits and pauses (page 1 of 4) Entry Description Prepaid SIM If the SIM is prepaid, check Prepaid SIM. Since the SIM’s limit is predefined, you must not set a limit for prepaid SIMs. However, if you would like to set a change limit for prepaid SIMs, go to the vGATECtrl application and select Use Change Limit for Prepaid SIMs from the Options menu. For a detailed description of this feature, see Chapter 7.9.3 Setting a change limit for prepaid SIMs. Auto Recharge If you check Auto Recharge, the SIM will recharge automatically (see Chapter 7.9 Configuring prepaid SIMs). To limit the number of times a SIM can be recharged per month, enter a value in the Max. Upgrades per Month box. The SIM will no longer be assigned when the value entered is reached and the line will turn yellow. Unsuccessful recharge attempts will also be counted toward the value entered. The counter is reset at the beginning of each new month. To limit the number of times a SIM can be recharged per month, week or day, enter a value in the Max. Upgrades: per Month per Week or per Day box. The SIM will no longer be assigned when the value entered is reached and the line will turn yellow. Unsuccessful recharge attempts will also be counted toward the value entered. The counter is reset at midnight on Sunday of each new week. If you do not want to limit the number of recharges, click No Limit (default). No Limit Check No Limit if you prefer not to set a limit (default setting). To change the SIM after a certain amount of 10-second units, deactivate the No Limit checkbox. Random To set a random limit, check the Random box and set two values Between 1 and 65534. The first value must be less than the second value. If the first value is greater than the second, a fixed limit will be set at the first value. Random limits will change with every SIM release. Max. Limit 1 / Max. Limit 2 Do the same under Max. Limit 1 and Max. Limit 2 to permanently deactivate a SIM after a certain number of units has passed. If No Limit has been checked under Change Limit, you can enter a value here between 1 and 65534. Otherwise, you can enter a value between 1 and 2147483646. Bear in mind that balance verification and expected amount settings will apply only for Max. Limit 1. You can set a second max. limit under Max. Limit 2. When assigning the SIM to timezones, choose one of these two limits for each timezone (see Chapter 7.5 Assigning SIMs). Bear in mind that balance verification and expected amount settings will apply only for Max. Limit 1. Max Call Duration To set a maximum call duration, activate the Max Call Duration checkbox and enter a range of seconds between 1 and 65533. After a random limit within the range has passed, the call will automatically be disconnected. Adv. Limit A / Adv. Limit B / Adv. Limit C Additional Adv. Limits are displayed here. Use the Carrier List (see Chapter 7.8 Setting carriers) to set the limits there. Bear in mind that balance verification and expected amount settings will apply only for Max. Limit 1. Max. SMS Enter the maximum number of SMS messages that can be sent via the SIM card until the SIM card is blocked. Check No Limit if this limit does not apply (default setting). vGATE 17.1 Page 60 7 Table 7.1 vGATEDesktop Setting time limits and pauses (page 2 of 4) Entry Description Reset Limits Visible for postpaid SIM cards only (the Prepaid SIM checkbox has not been checked). To Reset Limits once a month, check Day of Month and enter a date. The limit will reset automatically to the original amount at midnight on the date entered. To reset the limit once a week, check Day of Week and the reset day. The limit will reset automatically to its original amount at midnight on the day checked. Change Limits to 0 (force balance check) Visible only if the Prepaid SIM checkbox has been checked. In the Change Limits to 0 group box, set a day of the month or a day of the week to change the limit to 0 and force a balance check. If a day is set and the prepaid SIM card is blocked, it is automatically reset to 0 and thereby unblocked. Only if Limit Reached If you check Only if Limit Reached, the maximum limit will reset to its original amount on the day entered only if the limit has been reached. Cumulate Limits If you check Cumulate Limits, instead of resetting the SIM card limit, the new limit will be added to the remaining limit. Maximum Call Duration Per Day If you activate the checkbox Maximum Call Duration Per Day, the SIM will be blocked as soon as the number of minutes has been reached that is entered in the Between and And Minutes fields regardless of any other limits that have been set. Activate Use Daymask and click the Daymask button to set different maximum durations for different days. Minimum Remaining Minimum Remaining refers to a number of minutes that are left in the maximum daily duration. The SIM will be blocked for the rest of the day at the end of any call that crosses this threshhold without reaching the maximum daily duration. The maximum daily duration counter is reset every day at midnight. You must set a Timezone change at 11:50 p.m. Bear in mind that a time offset may be necessary. Maximum Calls Per Day You can set an interval for a SIM’s Maximum Calls Per Day by activating the corresponding checkbox and entering two values. Every day a random value between the two values entered will be apply for the SIM. You must set a Timezone change at 11:50 p.m. Bear in mind that a time offset may be necessary. Maximum Registered Assigns Per Day Activate the checkbox Maximum Registered Assign Per Day and enter how often the SIM card is allowed to be registered at the gateway until it is blocked. Enter in both Between ...And ... Assigns fields the same value to set an exact upper limit. Enter a range of values to select a random value from this range. Time Offset You can set a Time Offset to reset limits. The limits will be reset up to 14 hours ahead or 12 hours behind the time on the vGATE Control Unit. This is useful for mobile gateways located in different time zones. Make sure to reset limits only when SIMs are inactive. If you reset them while they are active, the settings in the database will no longer correspond with those in the mobile gateway. vGATE 17.1 Page 61 7 Table 7.1 vGATEDesktop Setting time limits and pauses (page 3 of 4) Entry Description Minimum Pause after Last Use To set an amount of time a SIM is to remain idle between uses, enter a value in Minimum Pause after Last Use. To set a random pause, set two values Between 0 and 99.99 hours. The first value must be less than the second value. If the first value is greater than the second, a fixed pause will be set at the first value. Be sure to use a period and NOT a comma when setting unrounded values. Ignore On Same Gateway If you activate the checkbox Ignore On Same Gateway, the minimum pause will be ignored if the SIM is reassigned to the same gateway. Ignore if Minimum Remaining Available If you activate the checkbox Ignore if Minimum Remaining Available, the minimum pause will be ignored if the Maximum Call Duration per Day option is active. You can shorten the pause set here by configuring a distance between gateways. Maximum Usage (Assigns) Per TZ When the checkbox Maximum Usage (Assigns) per TZ is activated, the SIM will be blocked after it has been assigned the number of times entered within the same Timezone. You can define this value for Limit 1 and Limit 2. A brown icon will then appear. When the Timezone changes, the counter will be reset and the SIM can be assigned again. Active Release When Active Release is checked and the Active SIM Release option has been set in the vGATECtrl, the active SIMs will be released when the number of Minutes, Succesful Calls, SMS entered has passed or the number of Incoming Calls or Call Attempts has been reached. Values between 2 and 9999 minutes or an unlimited number of calls or SMS are possible. SIMs in the reserved position will become active. If no SIMs are reserved, the same SIM will be reassigned (see Chapter 9.4 vGATECtrl Options menu). Check Random and the SIM will be released following a random number of minutes between the figures entered. Check Block if Reached (next to Successful Calls) and the SIM will be blocked when the number of succesful calls entered is reached. If you check Don't Release, Generate Incoming Call, a call from a random SIM of the same carrier in the vGATE will be sent to the SIM that reached the sucessful call limitation. Check Block if Reached (next to SMS) to block the SIM card when the number of SMS messages has been reached. If Maximum Calls Per Day is active, the remaining value there will apply if it is less than the value entered here. As of version 17.0, all options can be combined with each other. You must first activate the New Protocol checkbox in the edit window to release calls or SMS after assigning them. After activating the New Protocol checkbox, you must select Set Maintenance Mode from the mobile gateway’s context menu to activate this feature. If you deactivate the checkbox, you must restart the mobile gateway. Delay SIM Assignment On TZ Change, Reset Maintenance, Boot Indication vGATE 17.1 To delay SIM assignment, activate Delay SIM Assignment On TZ Change, Reset Maintenance, Boot Indication and enter two figures: the first between 0 and 600, and the second between 0 and 1200. The SIM will be assigned a random number of seconds between those entered following a Timezone change, a maintenance mode reset or a boot indication received from the mobile gateway. Page 62 7 Table 7.1 7.7 vGATEDesktop Setting time limits and pauses (page 4 of 4) Entry Description Block SIM On Low ACD Activate the checkbox Block SIM On Low ACD to block SIMs with short calls. Enter the number of times the ACD can fall below the seconds set before it is to be blocked. Choose whether the values entered are to be calculated within a 24 hour period (In 24 Hours) or consecutively (In a Row) before it is to be blocked. The ACD is checked every time a SIM is released. Lower Priority If you activate Lower Priority and enter a figure On Limit Below, the SIM will automatically receive lower priority when its limit falls below the amount entered. Activate Reset Priority If Limit is Upgraded and the SIM will receive its configured priority when the limit goes above the amount entered. Use SIM On Alternating Gateways Activate Use SIM On Alternating Gateways to alternate the gateways on which the SIM will be used. Use SIM On Alternating Locations Activate Use SIM On Alternating Locations to alternate the locations on which the SIM will be used. Use SIM Only Once Per Day And Gateway If you activate the checkbox Use SIM Only Once per Day and Gateway, the SIM will be used only once for each gateway to which it is assigned on any given day. Release SIM Immediately After TZ Change When the checkbox Release SIM Immediately after TZ Change is active, the SIM will be released when the Timezone changes and any calls will be disconnected. If Release All SIMs if Timezone Changes has not been set in the vGATECtrl Options menu and the SIM is reserved for the next Timezone at the same controller, it will not be released when the Timezone changes (see Chapter 9.4 vGATECtrl Options menu). If LimitWODISC=ON has been set in the mobile gateway’s pabx.cfg, the call will continue into the next Timezone if the limit is reached before the end of the current Timezone. Setting dynamic SIM pauses To shorten the pause set in the Limits dialog, you can configure a pause based on the distance between two mobile gateways within a group. The vGATE calculates the pause based on coordinates that you enter for each mobile gateway. If no other SIMs are available, these shorter pauses will override the static pause set for the SIM. vGATE 17.1 Page 63 7 7.7.1 Figure 7.14 vGATEDesktop Setting the coordinates iGATE coordinates To calculate the coordinates for the mobile gateways in a group, place them on a Cartesian grid as shown in Figure 7.14, where 0 is the center of the group and the increments on the X and Y axes are units of distance. You can define the units of distance and the increments freely as you choose. 7.7.2 Entering the coordinates To set the coordinates you have calculated on your grid, open the edit window by doubleclicking the name of the mobile gateway. Enter the mobile gateway’s Position as shown in Figure 7.15. Figure 7.15 iGATE position vGATE 17.1 Page 64 7 7.7.3 vGATEDesktop Setting the time/distance ratio Once you have set the coordinates for your mobile gateways, you can define the amount of time it takes to travel between two mobile gateways in a group. Figure 7.16 Dynamic SIM pauses Double-click the name of the group to open the group editor. Activate the Dynamic SIM Pause checkbox and enter a Minimum Pause in minutes that is to be applied to all SIMs for the group, regardless of the pause calculated for the distance between any two mobile gateways. In the Minutes Per Distance Unit box, enter the average amount of time it takes to travel one increment of distance on your grid. In Figure 7.16, each unit of distance is equal to three minutes. For times when travel occurs faster or slower, you can set two Pause Deviances. The example in Figure 7.16 reflects slower travel between 7:00 a.m. and 7:00 p.m., and faster travel between midnight and 6:00 a.m. Click OK. The vGATE will calculate the dynamic pause between mobile gateways automatically. 7.8 Setting carriers To set carriers, select Carrier List from the View menu or click the icon (shown there) in the toolbar. The Carrier List window will appear. Right-click an empty line or an entry and select Edit, Add or Delete from the context menu. Figure 7.17 Carrier list If you select Edit or Add, the carrier list editor will appear. From here you can define new carriers or edit existing ones. vGATE 17.1 Page 65 7 vGATEDesktop If the option Synchonize Carrier Settings is active in the vGateConfig (see Chapter 6.2.2 on page 38) it is possible to download the settings. To do so select the countries whose settings are to be loaded first. Open the menu Options | Configure Load Carrier Settings. Choose the customer profile and confirm with OK. The following dialog box opens. Select the countries whose carrier settings will be imported and confirm with OK. As shown in the screenshot, all settings located on the remote server (T-Online, Vodafone) will be shown with a gray background. These entries are not editable. To adopt settings from these entries, click an entry and select new from context menu. All settings will be taken from the original entry. Enter a new Name. vGATE 17.1 Page 66 7 vGATEDesktop The information entered here will also be sent to the mobile gateway for automatic configuration of SIMs and SMS service if New Protocol is activated in the edit window of the mobile gateway: Figure 7.18 Carrier editor vGATE 17.1 Page 67 7 Table 7.2 vGATEDesktop Carrier editor (page 1 of 6) Entry Description Name Enter the carrier’s name. Prefix Enter all of the carrier’s prefixes that are to be sent to the mobile gateway when Limit Outgoing Calls to Prefix is active. Separate multiple prefixes with a semi-colon. Limit Outgoing Calls to Prefix Activate this checkbox to route only those calls beginning with the Prefix entered. LAIN Enter the carrier’s LAIN. Carrier Sub ID You can assign a sub ID (default 1) for individual SIMs (for example, if a carrier uses different recharge numbers for its SIMs). Mapping Character Enter the mapping character you configured for the carrier in the route.cfg. Prepaid Recharge: DTMF Check here if the carrier uses DTMF to recharge SIM cards. Prepaid Recharge: SMS Check here if the carrier uses SMS messages to recharge SIMs. Recharge by SMS requires the following mapping entry in the mobile gateway’s route.cfg: MapAllSMS??=<LAIN>*??01: DATA ;Recharge via SMS ;-------------------------------------------------MapAllSMS??=11111*??01: DATA MapAllSMS??=22222*??01: DATA MapAllSMS??=33333*??01: DATA MapAllSMS??=44444*??01: DATA NOTE: Recharge by SMS requires mobile gateway version 14.3 or higher. Prepaid Recharge: USSD Code Check the box and enter the USSD code used to recharge SIM cards. The entry must contain the code that you need to access the USSD menu, the pauses that you need to wait and the menu entries that you need to select. In the following example, the USSD code *100# is entered followed by a 5 second pause, the menu entry 1, and a 10 second pause: *100#&p5m1p10 If your entry plus voucher code, additional pauses, and menu entries exceed 22 characters, enter a placeholder instead. In this case, you need to configure the pabx.cfg and route.cfg. For a detailed description please see Chapter 7.9.5 Recharge via USSD menu. NOTE: Balance check by USSD code requires mobile gateway version 14.3 or higher. Prepaid Balance Check: USSD Code Check the box and enter the USSD code for retrieving the SIM card’s balance. To get the available balance via USSD menu, enter the USSD code followed by the pauses and menu entries that you need to access the balance check option. In the following example, the USSD code *100# is entered followed by a 5 second pause and the menu entry 1: *100#&p5m1 NOTE: Balance check by USSD code requires mobile gateway version 14.3 or higher. vGATE 17.1 Page 68 7 Table 7.2 vGATEDesktop Carrier editor (page 2 of 6) Entry Description Prepaid Balance Check: SMS To Check this box if the carrier uses SMS for balance check and enter the destination number into the field to the right of the check box. In addition, you need to enter the SMS text into the Message field. Prepaid Balance Check: Message To receive the balance by SMS message, enter the SMS text into this field. Balance check by SMS requires the following mapping entry in the mobile gateway’s route.cfg: MapAllSMS??=<LAIN>*??01: DATA ;Balance Check via SMS ;-------------------------------------------------MapAllSMS??=11111*??01: DATA MapAllSMS??=22222*??01: DATA MapAllSMS??=33333*??01: DATA MapAllSMS??=44444*??01: DATA NOTE: Balance check by SMS requires mobile gateway version 14.3 or higher. Service Center Number Enter the carrier’s service center number. SMSC Number Enter the carrier’s SMS service number. Balance Parse String Enter a search string for the prepaid SIM’s balance. As of version 14.6 of all mobile gateways, you can set two strings by entering an & sign between them. The two resulting values will be added together and calculated with the balance factor (BF) to form the prepaid limit. If no second value exists, only the first will be calcultated. If no first value exists, there will be no result. Enter a pipe (|) to search for either value. You can enter a < sign in front of each search string to parse the balance before the search string. You can also parse any limits you have set by including them in curly brackets in front of the parse string as follows: {0}<string>=Major limit {1}<string>=Advanced limit A {2}<string>=Advanced limit B {3}<string>=Advanced limit C You can also parse remaining times as follows: {A}<string>=Time in minutes {B}<string>=Time in seconds or hour:minute:second EXAMPLE: {0}balance & {1}bonus. NOTE: Bear in mind that limits and times cannot be combined in the same string. Version 17.1 and up use the UTF button to insert UTF8 strings. Confirm the input with OK. Use ’.’ As Decimal Separator Activate this checkbox when a carrier uses periods as decimal separator. Leave it empty if the carrier uses a comma. Currency Unit/Minute Enter the cost of a call per minute. BF This value is calculated automatically. As of version 14.6 of all mobile gateways, up to two decimal places will be calculated. Remaining Balance (units) Enter the minimum balance in units that is to remain on the SIM card. If the balance has been reached the SIM card is blocked and a limit notification sent to the vGATE. vGATE 17.1 Page 69 7 Table 7.2 vGATEDesktop Carrier editor (page 3 of 6) Entry Description Initial Free Seconds At the beginning of each call there can be a number of seconds that are free of charge. Enter that number in Initial Free Seconds. Charge Units After the free seconds have passed, define how many units you want to charge each call at the beginning of the next time period. Enter the number of units in Charge Units. per 1st Billing Time (sec) Add the length of the time period in seconds in per 1st Billing Time (sec). Following Billing Time/Unit (sec/ unit) Finally, each call is charged one unit each number of seconds that you define with Following Billing Time/Unit (sec/unit). Charging is done at the beginning of the time period. Was Charge Unit Generate until version 16.2. Worst Case Charge (sec/unit) Enter the highest possible fee a carrier may charge. Advanced Limit Charges This button is green when limits have been set and gray when nothing has been entered. Click this button to open the Advanced Limit Charges window. You must enter all prefixes for which the limit is to apply. These limits will not apply if no prefixes are entered. Enter the charge information for limit A, B, or C. Charging calls works in the folllowing way: At the beginning of each call there can be a number of seconds that are free of charge. Enter that number in Initial Free Seconds. After the free seconds have passed, define how many units you want to charge each call at the beginning of the next time period. Enter the number of units in Charge Units and add the length of the time period in seconds in per 1st Billing Time (sec). Finally, each call is charged one unit each number of seconds that you define with Following Billing Time/Unit (sec/ unit). Charging is done at the beginning of the time period. Click the Daymask button to set the times for which the limit is to apply. For postpaid SIMs, limits will all apply simultaneously unless you activate Use Limits One By One and the limits. For prepaid cards, the limits will all apply one after the other. Special Parse Actions Click here to enter a string from an information message that the carrier may send to the SIM and the path to a special script that will run when this string is received. This button is green when a string has been set and gray when nothing has been entered. vGATE 17.1 Page 70 7 Table 7.2 vGATEDesktop Carrier editor (page 4 of 6) Entry Description Info Parse String Click this button to enter strings in Parse Info 1 and / or Parse Info 2 from an information message that the carrier may send to the SIM card. As of version 17.0, Parse Info 1 and Parse Info 2 can contain more than one string. Strings are combined with a pipe symbol, no blanks are allowed, for example: string1|string2|string3. If more than one string matches, the first match is taken. If an entry in Parse Info 1 matches, Parse Info 2 is ignored. The matching string is entered in the Info 1, Info 2 or Error column. The icon appears in front of the SIM cards IMSI. If Release SIM on Info is active, The SIM will be released after receiving an info parse string. If Block is also active, the SIM will be released and blocked. The Info Parse String button is green when a string has been set and gray when nothing has been entered. Loudness PCM Set the PCM volume level between 0 (lowest volume) and 7 (highest volume). The default setting is 4. Loudness Mobile Set the mobile volume level between 0 (highest volume) and 3 (lowest volume). The default setting is 1. Echo Cancelation Check this box to activate echo cancelation. No PP Balance Check if Limit Available When this checkbox is active, no balance check occurs after prepaid SIM cards with Max Limit 1 are assigned. No Cyclic PP Balance Check Activate this checkbox to switch off the automatic balance check that normally takes place at 12:00 AM and 12:00 PM on the mobile gateway. No PP Balance Check After Recharge When this checkbox is active, no balance check of the prepaid SIM cards occurs after the SIM has been recharged. A balance check will occur the next time the SIM is assigned. PP Passive Balance Check When this checkbox is active, automatic balance checks that come via SMS are entered in the database. This is useful for SIMs that do not allow active balance checks. Don’t Release After Recharge Activate this checkbox to ensure that a SIM card is not deactivated after recharge. Block SIM After Succesful Recharge Check this box to block the SIM card directly after recharge. The SIM card needs to be unblocked manually. Reset Too Many Announcements If Actual Minutes Below Worst Case Activate this checkbox to reset the counter for too many announcements to reflect the worst case configuration. vGATE 17.1 Page 71 7 Table 7.2 vGATEDesktop Carrier editor (page 5 of 6) Entry Description Too Many Announcements Check The mobile port is blocked when the value defined for calls that result in recorded messages is reached. When this feature is activated, the vGATE will automatically assign the SIM again and a balance check will occur. Activate Reassign and Test With One Call Attempt to allow just one call over this SIM. After this call the SIM will be released again. If the call is successfully connected, the error will be removed and the SIM will be used in normal service again. If the call is not connected or the setup results in another recorded message, the SIM will be blocked. If you activate Verify Balance, a balance check will occur. Specify how often by entering the number of balance checks in the Times Per Day and Times Per Month boxes. If the SIM card has a positive balance that is within the value entered in Balance Verification Tolerance, the error will be removed and the SIM will be used in normal service again. If the error occurs again, the vGATE will allow just one call over this SIM. After this call the SIM will be released again. If the call is successfully connected, the error will be removed and the SIM will be used in normal service again. If the call is not connected or the setup results in another recorded message, the SIM will be blocked. If the SIM does not have a balance that is within the Balance Verification Tolerance, the SIM will be released and blocked with a balance verification error. Bear in mind that the value defined for Too many announcements in theedit window of the mobile gateway must be set at 1 or higher. The parameter STOP[<val1>,<val2>] must be set on the mobile gateway for this feature to work (please refer to your iGATE, ECOTEL GSM, or ECOTEL 3G manuals for an explanation of this parameter). Random Balance Verification To ensure that the vGATE calculation of limits is correct and the carrier’s rates have not changed since the last time the SIM was recharged, two additional random balance checks can be started. After the Random Balance Verification has occurred, a new limit is calculated for the SIM. If this limit differs from the limit that the vGATE calculated before the balance check, and the difference is smaller than the Tolerance, the SIM will be released and blocked, and an error message will be generated. Random Balance Verification works only for prepaid SIM cards with an automatic recharge configuration. Activate Day Based to initiate a random balance check within the timeframe entered. Balance Verification Tolerance This feature is for autorecharge prepaid SIMs. You can enter a percentage, a number of units, or both if both are to apply. Please see the descriptions in the entries for Too many announcements check and Random Balance Verification above. Reset Too Many Announcements After Positive Balance Verification Activate this checkbox to reset the counter for too many announcements following a balance check with a positive result. Ignore If Balance Check Is Out Of Service Activate this checkbox to ignore unsuccessful balance checks. Enter in Maximum Ignored Balance Checks how many balance checks you want to ignore. Recharge Time Frame Activate this checkbox and set one or two timeframes during which a SIM is to recharge. vGATE 17.1 Page 72 7 Table 7.2 vGATEDesktop Carrier editor (page 6 of 6) Entry Description Master Carrier for Balance Transfer This checkbox is needed for prepaid SIM cards in a balance transfer scenario. Check this box to define a carrier as master and select a balance transfer script into the Transfer Script box. For more details on balance transfer please see Chapter 7.9.6 SIM card balance transfer. Recharge Via Balance Transfer This checkbox is needed for prepaid SIM cards in a balance transfer scenario. Check this box to define a carrier as production carrier and select a master carrier from the drop-down menu. For more details on balance transfer please see Chapter 7.9.6 SIM card balance transfer. Recharge Via Special Service Check this box and select a script to recharge SIM cards using special service scripting commands. You can use this feature to enforce a balance check before recharging SIM cards or to do any other verifications in your recharging process. Use the following special service scripting commands: RECHARGE_IF_LIMIT_BELOW_WOREL RECHARGE_IF_LIMIT_BELOW SET_MAX_LIMIT CHANGE_MAX_LIMIT For an explanation of these scripting commands, please refer to Chapter 7.12.1 Script commands. 7.9 Use External Web Recharge API This feature is planned for a future release. Use E Recharge For special external recharge functionality. Pause Before Release SIM Activate this checkbox and enter a range of minutes for a pause to occur before a SIM is released after its last call. Pause Between Assign And First Call Activate this checkbox and enter a range of minutes for a pause to occur after a carrier’s SIMs have been assigned before the first call is sent. Initial Limit of New SIMs Activate this checkbox and enter a limit value for the first time a new SIM from this carrier is used. This is useful for prepaid SIMs that require a call to retrieve balance information. Call/SMS Generation Timeframes Allows you to set a Preferred timeframe when you want to send calls and SMS messages and/or a Forbidden timeframe, in which you don’t want to send them. Until version 16.2, this option was included in the vGATECtrl Options menu in the Call/SMS Generation option. Configuring prepaid SIMs To set prepaid SIMs, you must activate New Protocol in the edit window of the mobile gateway. Remote tuneling is required for automatic recharge when a remote connection to the mobile gateway exists. Only one SIM can be recharged on a mobile gateway at any one time. Up to two SIMs can be recharged simultaneously if they are assigned two different mobile gateways. vGATE 17.1 Page 73 7 7.9.1 vGATEDesktop Configuration in the mobile gateway To define prepaid SIMs, you must make the following settings on the mobile gateway. 7.9.1.1 Settings in the route.cfg The following entries must appear in the route.cfg to save the necessary USSD or SMS messages into a file. For USSD messages: Restrict<LAIN>=@FILE 06 For SMS messages: Restrict<LAIN>=@FILE 05 To automatically recharge prepaid SIMs, the following entries must be made in the mobile gateway’s route.cfg: A mapping character must also be defined for each carrier as follows: MapAll<mapping character>??=<LAIN>*??01: MapAllDTMF=41DTMF i To avoid mapping conflicts, we recommend that you use the last letters in the alphabet as mapping characters. In the following example, the carrier with the LAIN 11111 is assigned the mapping character Z, the carrier with the LAIN 22222 is assigned the mapping character Y, the carrier with the LAIN 33333 is assigned the mapping character X, the carrier with the LAIN 44444 is assigned the mapping character W. Example 7.1 Carrier specific mapping character MapAllDTMF=41DTMF MapAllZ??=11111*??01: MapAllY??=22222*??01: MapAllX??=33333*??01: MapAllW??=44444*??01: 7.9.1.2 Settings in the pabx.cfg Make the following settings in the mobile gateway’s pabx.cfg: MsgLog=/data/msg.log <saved> <size> <number> or if no compact flash is included in the system: MsgLog=/boot/msg.log <saved> <size> <number> i We strongly recommend using a compact flash, as the available storage space is limited and may fill up quickly, causing the system to fail. The CDR license includes the compact flash. vGATE 17.1 Page 74 7 7.9.2 vGATEDesktop Defining prepaid SIMs on the vGATEDesktop Once you have inserted a prepaid SIM into the vGATE, you must define it as prepaid in the vGATEDesktop in one of the following ways: Right-click the SIM and select Define as Prepaid SIM. Right-click the SIM and select Change Limits. Activate the Prepaid SIM checkbox. If the SIM recharges automatically, activate the Auto Recharge checkbox. The following icons in the SIM window show that the SIM has been defined as prepaid: Table 7.3 Prepaid SIMs icons Icon Description The SIM in this position is prepaid. The prepaid SIM in this position recharges automatically. To deactivate the SIM position’s prepaid status, right-click the SIM and select Change Limits. Deactivate the Prepaid SIM checkbox. The SIM’s prepaid limit will always appear in the Max Limit 1 column. 7.9.2.1 Finding the balance parse string The balance parse string is the reference term used to access the carrier’s recorded message. On the vGATEDesktop, set one of the carrier’s SIMs as prepaid and assign it to a controller that has been defined as prepaid for this carrier. After 2 minutes, establish a GATE Manager connection to the mobile gateway. Open the logfile defined in the configuration. The text will appear here in front of the currency entry. Now you can enter the text in the carrier configuration (cf. Chapter 7.8 Setting carriers). After you send the balance code, the following string appears: your available balance: 10.20€ An appropriate balance parse string would be balance. 7.9.2.2 Calculating the balance factor The Balance Factor shows how many units make up a major currency unit (such as 1 Euro). It is calculated automatically from the entries in Following Billing Time/Unit (sec/unit) (was Charge Unit Generate until version 16.2) and Currency Unit/Minute. As of Version 14.6 of all mobile gateways, up to two decimal places will be calculated. In the following example, a minute costs 20 cent. For each call, the first 60 seconds are free of charge. At the beginning of the following 60 seconds, 5 units are charged. Following that and every 10 seconds another unit is charged. The balance factor a calculated as follows: every 10 seconds a unit is charged which makes 6 units per minute A minute costs 20 cent which means 6 units cost 20 cent which means 30 units cost 1 Euro (= balance factor). vGATE 17.1 Page 75 7 7.9.2.3 vGATEDesktop Defining the maximum number of allowed balance checks after assign For Prepaid SIM cards, the maximum number of allowed balance checks after assigning a SIM card can be limited in the SIM Options dialog. Check the Maximum Balance Checks After Assign box and enter the number of maximum allowed checks in the field below. In case the balance check after assignment fails and an entry exists in this field, balance checks are repeated until the limit has been reached or a balance check has been successful. Figure 7.19 7.9.3 Maximum balance checks after assign Setting a change limit for prepaid SIMs To activate this feature, go to the vGATECtrl application and select Use Change Limit for Prepaid SIMs from the Options menu. Setting a Change Limit for prepaid SIMs brings the following advantages: A balance query will no longer occur every time the SIM is assigned. Automatic balance queries from the mobile gateway will no longer occur at noon and midnight mobile gateway time. SIMs can be switched when the Change Limit is reached and do not have to be active until the prepaid limit (Max Limit 1) is reached. A Change Limit on prepaid SIMs works like this: Define the SIM as a prepaid SIM and set the change limit. After you assign the SIM, the prepaid limit is queried. As soon as the prepaid limit arrives at the vGATE, it is set in the database as Max Limit 1 and the change limit is activated in the mobile gateway. That means the SIMs prepaid status is no longer transmitted as such to the mobile gateway. The mobile gateway will recognize the Change Limit as long as Max Limit 1 (prepaid limit) is less than the Change Limit. When the Change Limit reaches Max Limit 1, a balance query will occur. i This feature is available only as of version 14.6 of all mobile gateways. vGATE 17.1 Page 76 7 7.9.4 vGATEDesktop Entering autorecharge vouchers Once you have set up the Carrier List (cf. Chapter 7.8 Setting carriers), you can set the automatic recharge. Select Prepaid Recharge List from the View menu or click the icon (shown there) in the toolbar. The prepaid recharge list will appear. If you select Edit or Add, the prepaid recharge list editor will appear. From here you can define recharge numbers or edit existing ones. Figure 7.20 Prepaid recharge list In the dialog that appears, use the drop-down menu to select the SIM’s Carrier. Figure 7.21 Prepaid recharge editor Enter the Recharge String as follows: If you are using USSD, simply enter the digits in the code. If the carrier recharges SIMs using DTMF tones, you must first enter DTMF: followed by the string. The carrier’s service center recording will include various menu options and queries, which generally require that you configure pauses into the recharge string. Enter a p for a 1second pause and a P for a 10-second pause. You may have to call the service center number and time the recording, so that you know how long the pauses are to be. If the recharge process takes longer than 240 seconds, the call will be disconnected. A comment can be added about the specific recharge code in the User Info dialog. In Figure 7.21, the Recharge String is DTMF:P1PPppp010943667175#PP. That means the carrier uses DTMF tones to recharge SIMs. The string begins with a pause of 10 seconds followed by a 1. Then comes a pause of 3 seconds followed by 010943667175#. A pause of 20 seconds occurs before the call is disconnected. vGATE 17.1 Page 77 7 vGATEDesktop If you are recharching your SIM card by SMS, you must first enter SMS: followed by the voucher code provided by your carrier. Enter the total Expected Amount. The Primary Amount is the amount on the voucher and the Bonus Amount refers to any additional amount that will be added. Bear in mind that the figure entered here multiplied by the balance factor must be greater than the remaining balance set in the carrier editor. You can enter any useful User Info in the corresponding dialog box. Make sure the Type is set at 0. i If an error occurs during recharge, the SIM card that is being recharged is blocked with the ”no recharge number found” error message. Once you enter a new voucher, the SIM card is automatically unblocked. Use the context menu to perform the following additional functions: Delete: Removes the entry from the list. Reset: Resets the process to run again. Select SIM: Marks the SIM in the vGATEDesktop’s SIM view if the recharge number has been used. Export: Exports the list to a text file. Each file entry will look like this: <carrier id>, <recharge number>. Import: Imports the list to a text file. Each file entry will look like this: <carrier id>, <recharge number>,,<expected amount (optional)>. Example: 1,DTMF:Pppp2ppp012345678#ppp,,450 The Prepaid Recharge List includes the following icons: Table 7.4 Prepaid recharge list icons Icon Description The voucher code has not yet been used and is still available. The voucher code has been used and is no longer available. An error occurred in the recharge process. The voucher code has been used with no result. The voucher is currently being used to recharge a SIM. Recharging failed due to problems with the voucher code (default: 3 attempts). A warning occurred in the recharge process. Recharging has been interrupted before the voucher has been sent. Voucher can be reused. As of version 17.0. Voucher has been used for recharging. A subsequent balance check remains unanswered. vGATE 17.1 Page 78 7 7.9.5 vGATEDesktop Recharge via USSD menu To recharge prepaid SIMs via the USSD menu, enter the USSD menu code in the USSD Recharge Code box in the carrier editor. Due to protocol limitations, this string plus voucher code, additional pauses, and menu entries must not exceed 22 digits. If it does, enter a placeholder instead. In this case you have to adjust the pabx.cfg and route.cfg files, as described in the sections that follow. 7.9.5.1 Settings in the pabx.cfg file The following new entry must appear in the [system] section of the pabx.cfg file. GSM<number>=<LAIN> MAP[<mapping character>??<placeholder>~><mapping character>??<USSD menu>~<pause in seconds><USSD menu entry>] You can create up to four different GSM<number> entries. The number parameter denotes the different entries. Enter the MCC/MNC combination (the LAIN parameter) to uniquely identify the carrier. The mapping character is used to group carrier SIMs with the same settings. It is taken from the Mapping Character box in the vGATE’s carrier editor. The ?? are used to dynamically locate the port. The placeholder parameter comes from the USSD Recharge Code box in the vGATE’S carrier editor. The ~ is replaced with the voucher code sent from the vGATE. The > separates the left from the right side. The USSD menu parameter contains the command that you need to access the carrier’s USSD menu. Both the pause in seconds and the USSD menu entry parameters are used to navigate through the USSD menu. They need to be entered as often as it takes to get to the right menu for recharge. In the following example, a SIM card is recharged using the USSD menu. The MCC/MNC combination to uniquely identify the mobile operator is 26212. In the vGATE’s carrier editor, the mapping character to identify all of the mobile operator’s SIM cards which are recharged via USSD menu is V, the place holder for the USSD menu entry is B. In the pabx.cfg, B is replaced by *100#~&p5m1p10m2 which is the USSD menu entry *100#, the voucher code coming from the vGATE, a 5 second pause to enter menu 1, and a 10 second pause to enter menu 2. Example 7.2 Recharge via USSD menu GSM1=26212 MAP[V??B~>V??*100#~&p5m1p10m2] Figure 7.22 7.9.5.2 Recharge via USSD menu Settings in the route.cfg file Change the MapAll entry in the route.cfg to include the settings for USSD menu recharge. Search for the matching MapAll command and extend it as follows: vGATE 17.1 Page 79 7 vGATEDesktop MapAll<mapping character>??<place holder>=<LAIN>*??01:<USSD menu> Example 7.3 Settings for USSD menu recharge (route.cfg) MapAllV??B=26212*??01:*100# For an explanation of how to define prepaid SIMs in the route.cfg, please refer to Chapter 7.9.1 Configuration in the mobile gateway. 7.9.6 SIM card balance transfer This feature is used to transfer a balance from one or more master SIM cards to different production SIM cards. When a production SIM card needs to be recharged, the vGATE control unit chooses a master SIM card from the defined master carrier and starts a transfer script to transfer the balance from the master SIM card to the production SIM card. After a successful balance transfer, the production SIM card is informed about the new balance via the passive balance check functionality. 7.9.6.1 Configuring master carrier and master SIM cards From the carrier list, select the carrier that you want to define as master carrier. Right-click the carrier and select Edit. In the edit window, activate the Master Carrier for Balance Transfer checkbox and enter a transfer script. Figure 7.23 Master carrier: transfer script settings Make sure that SIM cards from this master carrier will not be used for production purposes by entering a prefix in the Prefix field that is not used for a real carrier and by checking Limit Outgoing Calls to Prefix. Figure 7.24 Master carrier: prefix settings To connect a master SIM card with the master carrier, right-click the SIM card and select Change SIM Options... from the shortcut menu. Select the master carrier’s carrier name and sub ID from the Carrier Name (Sub ID) drop-down menu. Figure 7.25 Master SIM card: selection of master carrier vGATE 17.1 Page 80 7 7.9.6.2 vGATEDesktop Configuring production carrier and production SIM cards In the production carrier’s edit window, check Recharge Via Balance Transfer and select the name of the master carrier from the drop-down menu. Figure 7.26 Production carrier: selection of master carrier for balance transfer If the new balance is automatically communicated by the carrier, check the PP Passsive Balance Check box from the production carrier’s edit window to ensure that the vGATE knows about the new balance. Figure 7.27 Production carrier:prepaid passive balance check Production SIM cards must have their own number entered in the SIM Options window, which you open by right-clicking a production SIM card and selecting Change SIM Options... . Figure 7.28 Production SIM card: own number In the same window, ensure that the production SIM card is linked to the production carrier by selecting this carrier from the Carrier Name (Sub ID) drop-down menu. Figure 7.29 Production SIM card: selection of production carrier vGATE 17.1 Page 81 7 7.9.6.3 vGATEDesktop Transfer script example The following transfer script example sends a USSD message including the number of the production SIM card to the carrier of the master SIM card. It parses and handles the USSD answer including the strings below: successful: unblock the port of the master SIM card and end the script. successfully: unblock the port of the master SIM card and end the script. unsuccessful: write an error string and an error value (10) to the database entry of the production SIM, release the production SIM (which will be blocked because of the error value) and end the job. _TIMEOUT_: On job timeout, write an error string and an error value (11) to the database entry of the production SIM, release the production SIM (which will be blocked because of the error value) and end the job. Example 7.4 Transfer script SEND_USSD_WAIT(*444*1*<RECEIVE_NUMBER>*150*0716#,successful,sucessfully,unsucces sful, _TIMEOUT_,2) { UNBLOCK_PORT END_JOB } { UNBLOCK_PORT END_JOB } { CHANGE_RECEIVER_DB_STRING(sError, balance transfer unsuccessful) CHANGE_RECEIVER_DB_INT(iError, 10) RELEASE_RECEIVER_SIM END_JOB } { CHANGE_RECEIVER_DB_STRING(sError, balance transfer timeout) CHANGE_RECEIVER_DB_INT(iError, 11) RELEASE_RECEIVER_SIM END_JOB } 7.10 Automatic mobile gateway configuration via vGATEDesktop This option applies only for mobile gateways versions 15.0 and higher. All previous versions require configuration in the mobile gateway’s pabx.cfg for each carrier (see Chapter 7.9.1.2 Settings in the pabx.cfg). vGATE 17.1 Page 82 7 vGATEDesktop Double-click the name of the mobile gateway or select Edit from the context menu to open the edit window. When you activate the New Protocol checkbox, the following information is sent to the mobile gateway: Figure 7.30 Setting new protocol SMS center number USSD balance code Balance parse string Balance factor Remaining balance Route priority Charge unit first Charge unit generate Loudness PCM Loudness mobile Calls after assign SMS after assign Maximum call duration per day Maximum balance checks after assign No cyclic prepaid balance check Too many announcements check Suppress quality indications Maximum calls per day Pause between assign and first call Carrier sub ID Use of decimal point as separator Incoming calls Echo cancelation Prepaid passive balance check Automatic transmission of SIMs’ own number Pause between assign and first call Adv. limit charges (prefixes, charge unit first, charge unit generate) Advanced limits Call attempts i After activating the New Protocol checkbox, you must select Set Maintenance Mode from the mobile gateway’s context menu to activate this feature. If you deactivate the checkbox, you must restart the mobile gateway. vGATE 17.1 Page 83 7 7.11 vGATEDesktop SMS and call options You can configure individual SIMs to transmit and receive calls and SMS, so that traffic flows in both directions. Each SIM can send and/or receive up to 99 SMS and 99 calls per day or month or receiver group. i 7.11.1 Only active SIMs can send and/or receive calls and/or SMS. No calls or SMS can be sent when a remote connection to the mobile gateway exists. Remote tuneling is required when a remote connection to the mobile gateway exists. Sending SMS and calls To define call and/or SMS sending, you must define a mapping character for each carrier you use for SMS and/or call sending (see Chapter 7.9.4 Entering autorecharge vouchers). Figure 7.31 SIM options To open the SIM Options dialog, select Change SIM Options from the context menu in the SIMs view. vGATE 17.1 Page 84 7 vGATEDesktop If you want to send calls and SMS daily, activate the appropriate checkboxes. Otherwise they will be sent monthly. You can send one call and/or SMS immediately for test purposes by checking the corresponding boxes. Activate Check Only Successful Calls if you do not want unsuccessful connections to be applied to your settings. Enter the number of calls and/or SMS that are to be sent to the Destination SIM Cards. Activate the appropriate checkbox(es) to send all calls and SMS to mobile gateways in the same group or SIMs with the same color. If no calls or SMS are to be sent from the selected SIM, enter 0. You can also define up to three Receiver Groups to which the number of calls and/or SMS entered are to be sent. For more information on defining receiver groups, please see Chapter 7.11.2 Receiving SMS and calls. Enter a value for the Preferred Receive Numbers Count to send most of the calls to a limited number of receivers. If the SIM is to receive calls and SMS originating from the vGATE, enter the SIM’s call number in the Own Number box and activate the appropriate checkboxes. If you do not want the selected SIM to receive calls or SMS, leave this box blank. To send calls and/or SMS messages, the following entries in the route.cfg are also required to define a mapping character for each carrier that doesn’t already have one: MapAll<mapping character>??=<LAIN>*??01: Example 7.5 Mapping character to send calls and/or SMS messages MapAllZ??=26201*??01: MapAllY??=26202*??01: MapAllX??=26203*??01: MapAllW??=26207*??01: To send SMS, you must also enter SMS as follows: MapAllSMS<mapping character>??=<LAIN>*??01: DATA Example 7.6 Mapping character to send SMS messages MapAllSMSZ??=26201*??01: MapAllSMSY??=26202*??01: MapAllSMSX??=26203*??01: MapAllSMSW??=26207*??01: DATA DATA DATA DATA You must also set carriers on the vGATEDesktop as described under Chapter 7.8 Setting carriers. If you are not using a carrier’s prepaid SIMs, fill in only the Name, LAIN and Character for Mapping spaces and leave the others blank. vGATE 17.1 Page 85 7 7.11.2 Figure 7.32 vGATEDesktop Receiving SMS and calls Receive numbers list You can also create a list of numbers that are to receive SMS and/or calls and assign them to groups. Select SMS/Call Receiver from the View menu or click the button in the toolbar. The Receiver Groups window appears. All is the default group that means all messages are initially placed in one group. To add a new group, right-click in the window and select Add and enter a name for the new group in the dialog that appears. To rename a group, select Edit; to delete, select Delete. To open the list, right-click a specific group and select Explore.... The Receive Numbers list will appear. Now you can select Add or Edit from the Receive Numbers context menu and fill in the SIMs Number. Use the drop-down menu to select a group from which the SMS or call is to come, or select All if you prefer not to limit calls and/or SMS to one group. The Receiver Group you have selected will appear next. Enter a number of Calls per Month and/or SMS per Month that the SIM is to receive calls and/or SMS. Up to 9999 are possible. Calls and SMS will be set randomly to numbers in this list and to SIMs defined to receive SMS and calls (see Chapter 7.11.1 Sending SMS and calls). Generated calls last between 15 and 60 seconds (default). To receive calls at defined mobile gateways, enter the following settings in the mobile gateway’s route.cfg: Restrict<LAIN>=41DTMF_ 01 To receive SMS at defined mobile gateways, enter the following settings in the mobile gateway’s route.cfg: Restrict<LAIN>=@FILE 05 7.11.3 Defining SMS messages To send an SMS, you must, of course, first define what the text contains. Each SMS can contain no more than 160 characters. Figure 7.33 SMS list vGATE 17.1 Page 86 7 vGATEDesktop Select SMS Message List from the View menu or from the toolbar. The Receiver Groups window appears. Double-click the receiver group whose SMS message list you want to open. A table containing all defined SMS messages appears. Right-click and select Edit to edit an existing message, Add to add a new message, Delete to delete an existing message and Import from File to browse for a text file containing SMS. Each line in the text file contains one SMS of up to 160 characters. The contents of the file will be imported to the SMS Messages table. Each SMS Message can be moved to another receiver group. For more information on defining receiver groups, please see Chapter 7.11.2 Receiving SMS and calls. 7.11.4 Sending external SMS To send targeted external SMS messages to specific defined numbers, activate the Use group for sending external SMS checkbox in the group view editor and activate Send External SMS in the vGATECtrl Options menu. Figure 7.34 Sending external SMS The default configuration saves SMS files in the folder F:\vGATE\SMS. You can configure another path in the registry under \\HKEY_CURRENT_USER\Software\TELES\vGATECtrl\SMSPath. The file extension must be .sms. The content of the files must have the following syntax: To:<num> Msg:<message> The commands To: and Msg: must appear at the beginning of the line, but more than one message can be sent to each recipient In the following example, the message Test1 is sent to both recipients 017112345678 and 017212345678. The messages Test2 and Test 3 are sent only to 017212345678.. Example 7.7 Sending external SMS messages To:017112345678 Msg:Test1 To:017212345678 Msg:Test1 Msg:Test2 Msg:Test3 vGATE 17.1 Page 87 7 vGATEDesktop vGATECtrl checks the configured folder once per minute. If new .msg files are in the folder, the SMS will be sent. Once they have been sent, they are automatically renamed with the extension .old and an entry appears in a .log file that is saved into the same folder. 7.11.5 i Retrieving a SIM’s own number This feature requires special service scripting. For more information on special services and script commands, please refer to Chapter 7.12 Special services. For SIM’s for which you have an IMSI but no telephone number, you can retrieve the number by following these steps: Create a special action script for sending an SMS with the IMSI to a SIM in the vGATE. In the following special script example, the SIM card’s IMSI is 123456. An SMS with the message IMSI=123456 is sent to the SIM with the number +490179456456. Example 7.8 Retrieving a SIM card’s own number SEND_SMS(+490179456456, IMSI=123456) END_JOB Open the SIM Options dialog for the SIM sending the message. Activate the appropriate checkbox, and enter the path for the special script as shown in Figure 7.35. You can also start the script manually by selecting Start Special Service from the context menu in the Controller view. Figure 7.35 Send own IMSI Create another script to save the OAD for the SIM with the IMSI sent. The where part of the SQL query comes from the parse result. In the following special script example, the telephone number for the SIM with the IMSI 123456 is entered in the SIM’s OwnNumber column. The 1 is a flag to indicate that the contents of the SMS received (IMSI=123456) is to be the where part of the SQL query. Example 7.9 Entry in SIM’s OwnNumber column SAVE_OAD_IN(OwnNumber, 1) END_JOB vGATE 17.1 Page 88 7 vGATEDesktop To perform this function, vGATE must parse incoming SMS messages for the string IMSI=. To set up the parse configuration, open the Carrier List. Double-click or right-click the carrier’s name to open the carrier editor. Click the Special Parse Actions button to open the Parse String Action dialog. Figure 7.36 Parse string action Under Parse String enter IMSI=. Under Action enter the path for a special service script to save the own number. Click OK to start the special script. 7.12 Special services The Special Service group box in the SIM Options dialog (select Change SIM Options from the context menu in the SIMs view) allows you to define special services offered for a SIM, such as special tariffs or discount offers. These services can then be automatically activated with this function. Figure 7.37 Special service The commands for this function are defined by scripts that are entered in defined .ini files. vGATE 17.1 Page 89 7 vGATEDesktop These commands can be carried out automatically by activating any or all of the following checkboxes: After Assign will start the script whenever the SIM is assigned. Activate Once per Day if this is to occur only once on any given day. Change Limit Reached will start the script whenever the SIM’s change limit is reached. This option is also possible with SIMs that are not prepaid. Each Limit Ind. (PP) will start the script whenever the prepaid SIM’s limit is reached. New SIM will run the script once every time a new SIM is entered. Between will start the script daily or on defined days of the month at a random time between those entered (be sure to enter times based on a 24-hour clock, e.g. 5:00 pm must be entered as 17). You must enter times on the hour. No decimals are allowed. You can select whether you would like to activate the commands Daily, Monthly on the day specified or Weekly on the day or days specified. At intervals of ... Minutes will start the script every entered number of minutes. The .ini file containing the script is saved on the vGATE Control Unit and its path is defined under Command File in the Special Service group box. i 7.12.1 If you do not use remote tunneling, make sure the GATE Manager is not connected to the mobile gateway before you run any scripts. One remote channel is active for special services. Script commands The commands must be entered in the .ini file as follows. Please refer to Chapter 7.12.2 Script example, which is intended as a detailed description of format and syntax: Table 7.5 Special service script commands (page 1 of 11) Commands ADD_MAX_LIMIT Adds a calculated limit (integer value) to the SIM card’s Max. Limit 1 field. For prepaid SIM cards only. BLOCK_DISC_PORT The port is blocked. If a call is active, it is disconnected. The port’s link status is checked. If the link status is not idle, the script command is stopped and will be carried out later. BLOCK_PORT The port will be blocked as soon as it is idle. CANCEL_JOB_BLOCKING Cancels blocking the SIM or controller. The job will continue to be executed. CHANGE_DB_INT(<column>,<int>) The set integer will be entered in the defined SIM column in the database (e.g. Priority, SIMCounter or SIMCounter2). CHANGE_DB_STRING(<column>,<string>) The set string will be entered in the defined SIM column in the database (e.g. Userinfo1 or Userinfo2). vGATE 17.1 Page 90 7 Table 7.5 vGATEDesktop Special service script commands (page 2 of 11) Commands CHANGE_LIMIT Writes a fixed calculated limit (integer value) in the SIM card’s Change Limit field. For prepaid SIM cards only. CHANGE_LIMIT_ZERO Can be set as a wait parameter. If the calculated change limit is 0, another command can be carried out. CHANGE_MAXLIMIT Writes a calculated limit (integer value) in the SIM card’s Max. limit 1 field. Can also be combined with SET_MAX_LIMIT. For prepaid SIM cards only. CHANGE_MSISDN_LIMIT(<MSISDN>,<limit>) Changes the limit for the SIM with the telephone number entered. CHANGE_SMSLIMIT Writes the content of the internal limit variable (that has been filled for instance with the Parse_String_TO_LIMIT command) into the SMS limit field. Corresponds with the Max. SMS field on the SIM card’s Limit dialog. DONT_CARE_SIMSTATUS The SIM’s current status (registered, etc.) will be ignored. END_JOB Ends the job. END_JOB_IF_VALUE_IS(<column>,<value>) Ends the job if the value in the simcards column is a given value. NOTE: This command must always be used before the BLOCK_PORT command. END_JOB_IF_VALUE_IS_ABOVE(<column>,<int>) Ends the job if the value in the simcards column is above a given integer value. NOTE: This command must always be used before the BLOCK_PORT command. END_JOB_IF_VALUE_IS_BELOW(<column>,<int>) Ends the job if the value in the simcards column is below a given integer value. NOTE: This command must always be used before the BLOCK_PORT command. END_JOB_IF_VALUE_IS_NOT(<column>,<value>) Ends the job if the value in the simcards column is not a given value. NOTE: This command must always be used before the BLOCK_PORT command. LIMIT_FAKTOR_M(<num>) Defines the factor for calculating a limit from a wait parameter based on money values. The factor must always be entered as a float value in decimal notation (e.g. 6.0). Example: For the following example, the entry ChargeUnitGenerate=1 (default is 10) is entered in the mobile gateway’s pabx.cfg. The carrier sends a balance of €10.0. A call costs €0.24 per minute. Enter the result of (€0.24 x 100) / 60 = 0.4. Enter LIMIT_FAKTOR_M(0.4). To calculate LIMIT_FAKTOR_M using the balance factor (BF), enter LIMIT_FAKTOR_M=100/BF. LIMIT_FAKTOR_T(<num>) Defines the factor for calculating a limit from a wait parameter based on time values. The factor must always be entered as a float value in decimal notation (e.g. 6.0). Example: For the following example, the entry ChargeUnitGenerate=1 is entered in the mobile gateway’s pabx.cfg. The carrier sends a balance of 24 minutes and 10 seconds. To convert this figure into seconds, enter LIMIT_FAKTOR_T(60.0). vGATE 17.1 Page 91 7 Table 7.5 vGATEDesktop Special service script commands (page 3 of 11) Commands PARSE_STRING_TO_BUFFER Parses an incoming SMS or USSD message to an internal buffer PARSE_BUFFER. PARSE_BUFFER is a placeholder that can be used in a subsequent START_EXTERNAL command. The incoming message is: You have an MMS from 491775016082. Demand within 14 days with www.mms.t-mobile.de with your phone no and password G4KB5A7N PARSE_STRING_TO_BUFFER(password [S%s]) The parse result PARSE_BUFFER will be filled with 'G4KB5A7N'. PARSE_STRING_TO_LIMIT(<string>) Parses an incoming SMS or USSD message to the internal limit value (in units). That value can be further processed by other limit commands, such as CHANGE_MAX_LIMIT or ADD_MAXLIMIT. Not for Advanced limits.Example: PARSE_STRING_TO_LIMIT(balance is [M%d.%d]) searches for the string “balance is” and parses the limit based on the monetary value found behind “balance is”. PARSE_TO_SIMCUSTOM_STRING(<bOverwrite>,<value count>,<parse Param1>,<name of param1 in DB>, <parseParam2>,<name of param2 in DB>,…) Parses an incoming SMS detected via Special Parse Actions in the vGATE carrier settings and saves the result in the database: bOverwrite: 0 or 1, 1 means old values in database are deleted before saving the new values. value count: Count of value pairs (Param, Name in DB) parseParam: Parse string. The syntax is the same as for wait parameters. Only string parameter (S) are allowed. name of param in DB: Name of the value in the database. PAUSE(<millisec>) If this command is used, the current job pauses while other jobs waiting in the thread are handled. RECHARGE_IF_LIMIT_ABOVE(<int>) Recharge is initiated if the calculated limit is higher than the limit entered. RECHARGE_IF_LIMIT_ABOVE_WOREL(<int>) Recharge is initiated if the calculated limit is higher than the limit entered. The SIM is not released following the recharge process. RECHARGE_IF_LIMIT_BELOW(<count>) Initiates SIM recharge and closes job if the current prepaid limit is less than the value entered. RECHARGE_IF_LIMIT_BELOW_WOREL(<int>) Recharge is initiated if the calculated limit is lower than the limit entered. The SIM is not released following the recharge process. RECHARGE_SIM SIM is recharged after script has ended. It is best to enter this command at the end of a script to avoid overlapping remote access. RECHARGE_SIM_WOREL SIM recharge is initiated and the SIM is not released following recharge. RELEASE_RECEIVER_SIM Releases the production SIM card in a balance transfer scenario. For instance, use this command to release a production SIM card if a balance transfer from the master to the production SIM card failed. For more details on balance transfer, please refer to Chapter 7.9.6 SIM card balance transfer vGATE 17.1 Page 92 7 Table 7.5 vGATEDesktop Special service script commands (page 4 of 11) Commands RELEASE_SIM SIM is released at the end of the script. If possible, a new SIM will then be assigned. It is best to enter this command at the end or branching point of a script. RELEASEBLOCK_IF_LIMIT_ABOVE(<int>) The SIM will be released and blocked if its balance is above the value entered. RELEASEBLOCK_IF_LIMIT_BELOW(<int>) The SIM will be released and blocked if its balance is below the value entered. RELEASEBLOCK_SIM The SIM will be released and blocked. RESTART_PORT Restarts the current port. SAVE_OAD_IN(<column>,<flag> Saves the OAD of a SIM from which an SMS with IMSI=<IMSI> has been sent. Set the flag at 1 to save the number in the SIM’s OwnNumber column. SEND_DTMF(<string>) The DTMF string is sent to the service center number. For pauses between DTMF tones, enter a p for a pause of one second and a P for a pause of 10 seconds. NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg . SEND_DTMF_IF_LIMIT_ABOVE(<limit>,<string>) If the limit goes above the value entered, a connection is set up to the service center and the defined USSD code is sent. The service center number must be entered in the carrier list. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_IF_LIMIT_BELOW(<limit>,<string>) If the limit falls below the value entered, a connection is set up to the service center and the defined DTMF string is sent. The service center number must be entered in the carrier list. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_NUM(<num>,<string>) The DTMF string is sent to the defined number (<num>). For pauses between DTMF tones, enter a p for a pause of one second and a P for a pause of 10 seconds. SEND_DTMF_NUM_IF_LIMIT_ABOVE(<num>,<limit>,<string>) If the limit goes above the value entered, a connection is set up to the defined number (<num>) and the defined DTMF string is sent. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_NUM_IF_LIMIT_BELOW(<num>,<limit>,<string>) If the limit falls below the value entered, a connection is set up to the defined number (<num>) and the defined DTMF string is sent. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. vGATE 17.1 Page 93 7 Table 7.5 vGATEDesktop Special service script commands (page 5 of 11) Commands SEND_DTMF_NUM_WAIT(<num>,<string>,<waitParam1>,<waitParam2>,...,<timeout>) The DTMF code is sent to the defined <num>. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Example of a time value: Parsed string: 10:25:32 in hr:min:sec Wait parameter: [T%d:%d:%d] (enter [T%d:%d] for min:sec or [T%d] for sec). Calculation: Limit = hr x 60 x limit factor + min x limit factor + sec x limit factor / 60 Example of a money value: Parsed string: 11.55 in €.cent Wait parameter: [M%d.%d] As of version 16.2, thousand separators can be included. Use [M%d,%d.%d] to parse 1,000.00 or [M%d.%d,%d] to parse 1.000,00. Calculation: Limit = (€ x 100 + cent) / limit factor Example of a string: Parsed string: The number 1234567890 Wait parameter: the number.[S%s] Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_NUM_WAIT_IF_LIMIT_ABOVE(<num>,<limit>,<string>,<waitParam1>,<waitParam2>,..., _ELSE_,<timeout>) If the limit goes above the value entered, a defined DTMF string is sent to the defined number (<num>) and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. If the limit does not rise above the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_NUM_WAIT_IF_LIMIT_BELOW(<num>,<limit>,<string>,<waitParam1>,<waitParam2>,..., _ELSE_,<timeout>) If the limit falls below the value entered, a defined DTMF string is sent to the defined number (<num>) and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. If the limit does not fall below the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. vGATE 17.1 Page 94 7 Table 7.5 vGATEDesktop Special service script commands (page 6 of 11) Commands SEND_DTMF_WAIT(<string>,<waitParam1>,<waitParam2>,...,<timeout>) The DTMF code is sent to the service center number. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Example of a time value: Parsed string: 10:25:32 in hr:min:sec Wait parameter: [T%d:%d:%d] (enter [T%d:%d] for min:sec or [T%d] for sec). Calculation: Limit = hr x 60 x limit factor + min x limit factor + sec x limit factor / 60 Example of a money value: Parsed string: 11.55 in €.cent Wait parameter: [M%d.%d] As of version 16.2, thousand separators can be included. Use [M%d,%d.%d] to parse 1,000.00 or [M%d.%d,%d] to parse 1.000,00. Calculation: Limit = (€ x 100 + cent) / limit factor Example of a string: Parsed string: The number 1234567890 Wait parameter: the number.[S%s] NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_DTMF_WAIT_IF_LIMIT_ABOVE(<limit>,<string>,<waitParam1>,<waitParam2>,..., _ELSE_,<timeout>) If the limit goes above the value entered, a defined DTMF string is sent to the service center and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. The service center number must be entered in the carrier list. If the limit does not rise above the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_DTMF_WAIT. SEND_DTMF_WAIT_IF_LIMIT_BELOW(<limit>,<string>,<waitParam1>,<waitParam2>,..., _ELSE_,<timeout>) If the limit falls below the value entered, a defined DTMF string is sent to the service center and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. The service center number must be entered in the carrier list. If the limit does not fall below the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_DTMF_WAIT. SEND_RNDREC_SMS(<recipientcount>,<recipient1>,<recipient2>,...,<message>) Sends an SMS message to a random recipient out of up to 16 recipients. In recipientcount, enter the number of recipients. SEND_RNDREC_SMS_WAIT(<recipientcount>,<recipient1>,<recipient2>,...,<message>,<waitParam1>, <waitParam2>,...,<timeout>) Sends an SMS message to a random recipient out of up to 16 recipients and waits for a defined response. In recipientcount, enter the number of recipients. For the proper syntax of the wait parameters, see the entry for SEND_USSD_WAIT. vGATE 17.1 Page 95 7 Table 7.5 vGATEDesktop Special service script commands (page 7 of 11) Commands SEND_SMS(<to>,<msg>) Sends a defined SMS (<msg>) to a defined recipient (<to>). If you enter OAD as the recipient, the SMS will be sent to the origination number of a previously received SMS. You can also use this command to retrieve a SIM’s own number (see Chapter 7.11.5 Retrieving a SIM’s own number). NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg. SMS service numbers must appear in the pabx.cfg. SEND_SMS_IF_LIMIT_ABOVE(<limit>,<to>,<msg>) A defined SMS is sent to the number entered if the limit goes above the value entered. SEND_SMS_IF_LIMIT_BELOW(<limit>,<to>,<msg>) A defined SMS is sent to the number entered if the limit falls below the value entered. SEND_SMS_WAIT(<to>,<msg>,<waitParam1>,<waitParam2>,...,<timeout>) Sends a defined SMS and waits for a defined response. If you enter OAD as the recipient, the SMS will be sent to the origination number of a previously received SMS. You can also use this command to retrieve a SIM’s own number (cf. Chapter 7.11.5 Retrieving a SIM’s own number). This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Example of a time value: Parsed string: 10:25:32 in hr:min:sec Wait parameter: [T%d:%d:%d] (enter [T%d:%d] for min:sec or [T%d] for sec). Calculation: Limit = hr x 60 x limit factor + min x limit factor + sec x limit factor / 60 Example of a money value: Parsed string: 11.55 in €.cent Wait parameter: [M%d.%d] As of version 16.2, thousand separators can be included. Use [M%d,%d.%d] to parse 1,000.00 or [M%d.%d,%d] to parse 1.000,00. Calculation: Limit = (€ x 100 + cent) / limit factor Example of a string: Parsed string: The number 1234567890 Wait parameter: the number.[S%s] NOTE: The service center number and mapping character must appear in the Carrier List and the mapping entries must exist in the route.cfg (see Chapter 7.9.4 Entering autorecharge vouchers). Example: In the following example, the SMS ’send number’ is sent to the number 017234567890 and the system waits for the string ’the number’ and the number that follows will be entered in the vGATEDesktop SIM View Own Number column. SEND_SMS_WAIT(017234567890, send number, the number.[S%s], 3) { SET_DB_STRING(OwnNumber) UNBLOCK_PORT END_JOB } NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg. SMS service numbers must appear in the pabx.cfg. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. vGATE 17.1 Page 96 7 Table 7.5 vGATEDesktop Special service script commands (page 8 of 11) Commands SEND_SMS_WAIT_IF_LIMIT_ABOVE(<limit>,<to>,<msg>,<waitParam1>,<waitParam2>,..., _ELSE_<timeout>) If the limit goes above the value entered, a defined SMS is sent to the number entered and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. If the limit does not rise above the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_SMS_WAIT_IF_LIMIT_BELOW(<limit>,<to>,<msg>,<waitParam1>,<waitParam2>,..., _ELSE_<timeout>) If the limit falls below the value entered, a defined SMS is sent to the number entered and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. If the limit does not fall below the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_USSD(<code>) The USSD code is sent to the service center number. The service center number and mapping character must appear in the Carrier List. NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg. SEND_USSD_IF_LIMIT_ABOVE(<limit>,<string>) If the limit goes above the value entered, a connection is set up to the service center and the defined USSD code is sent. The service center number must be entered in the carrier list. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. SEND_USSD_IF_LIMIT_BELOW(<limit>,<string>) If the limit falls below the value entered, a connection is set up to the service center and the defined USSD code is sent. The service center number must be entered in the carrier list. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. vGATE 17.1 Page 97 7 Table 7.5 vGATEDesktop Special service script commands (page 9 of 11) Commands SEND_USSD_WAIT(<code>,<waitParam1>,<waitParam2>,...,_TIMEOUT_,<timeout>) The USSD code is sent to the service center number. This string sets a wait for defined query response messages. You must set the limit parsing definition[T%d:%d:%d], [M%d.%d] or [S%s] if a limit is to be parsed based on a string (S) and/or calculated based on time (T) or money (M). The entry LIMIT_FAKTOR_M or LIMIT_FAKTOR_T must also be set in this case. Wait parameters must be separated by a comma. Two time entries can appear separated by a pipe (|). For example, [T%d:%d:%d | %d:%d]. You can set two strings together by entering an & sign between them. For example, balance: [M%d.%d:%d] & bonus: [M%d.%d]. The two resulting values will be added together and calculated with the balance factor to form the limit. If no second value exists, only the first will be calcultated. If no first value exists, there will be no result. The job is closed if no answer is recognized in the number of minutes set for a timeout. Each wait parameter requires a branch, defined by {...}. If the timeout is set at 0, no timeout will be used. If you enter _TIMEOUT_, in front of a defined <timeout>, a new command will be carried out if a response does not occur for a wait parameter in the allotted time. Each_TIMEOUT_ requires a branch for the alternative command, defined by {...}. Each final set of brackets must end with the command END_JOB. Example of a time value: Parsed string: 10:25:32 in hr:min:sec Wait parameter: [T%d:%d:%d] (enter [T%d:%d] for min:sec or [T%d] for sec). Calculation: Limit = hr x 60 x limit factor + min x limit factor + sec x limit factor / 60 Example of a money value: Parsed string: 11.55 in €.cent Wait parameter: [M%d.%d] As of version 16.2, thousand separators can be included. Use [M%d,%d.%d] to parse 1,000.00 or [M%d.%d,%d] to parse 1.000,00. Calculation: Limit = (€ x 100 + cent) / limit factor NOTE: The service center number and mapping character must appear in the Carrier List (see Chapter 7.9.4 Entering autorecharge vouchers) and the mapping entries must exist in the route.cfg. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. This applies for all commands with wait parameters. SEND_USSD_WAIT_IF_LIMIT_ABOVE(<limit>,<string>,<waitParam1>,<waitParam2>,.., _ELSE_,<timeout>) If the limit goes above the value entered, a defined USSD code is sent to the service center and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. The service center number must be entered in the carrier list. If the limit does not rise above the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. SEND_USSD_WAIT_IF_LIMIT_BELOW(<limit>,<string>,<waitParam1>,<waitParam2>,...,_ELSE_,<timeout>) If the limit falls below the value entered, a defined USSD code is sent to the service center and the system waits for a response defined using the wait parameters as long as the timeout value entered. If the response comes before the timeout, other commands can be carried out. If the timeout is set at 0, no timeout will be used. The service center number must be entered in the carrier list. If the limit does not fall below the value entered, the command defined by _ELSE_ will be carried out. Please note that _ELSE_ must be defined. Enter a ^ sign in front of each wait parameter to parse the value before the query response message. This string sets a wait for defined query response messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. vGATE 17.1 Page 98 7 Table 7.5 vGATEDesktop Special service script commands (page 10 of 11) Commands SET_DB_STRING(<column>) If a string was parsed in a previous response message, this string will be entered in the defined SIM column in the database. SET_DB_STRING_PARSE(<parseparam>,<column>) If a string was parsed in a previous response message or if the script was started by carrier-specific actions, this SMS or string will be parsed according to the parse parameter and entered in the defined SIM column in the database. EXAMPLE: SET_DB_STRING_PARSE(balance [S%s] , UserInfo2) SET_DB_TIMEVAL(DBField) The current timestamp appears in the DBFIELD in the database. SET_DB_USEREG_STRING(<column>) Saves a parse result string into the defined column of the user registration table in the database. SET_MAX_LIMIT(<val x>,<val y>) Changes the CHANGE_LIMIT to val y if the calculated limit is greater than val x. If the calculated limit is less than val x, the calculated limit will be used. CHANGE_LIMIT must be set for this command to be carried out. SET_MIN_LIMIT(<val x>,<val y>) Changes the CHANGE_LIMIT to val y if the calculated limit is greater than 0 and less than val x. This command must appear before the WAIT commands. SET_SIM_BK_COLOR(<r,g,b>) Enter RGB values, separated with commas, to change the SIM background colors. SET_TIMEOUT(<count>) A number of minutes can be entered here to set a timeout for scripts without a WAIT function. Only whole numbers are allowed. SLEEP(<millisec>) Blocks the script for the here entered number of milliseconds. If this parameter is set, all waiting scripts in this thread are also blocked. Use this command for short pauses (<3 seconds) only. For longer pauses use the PAUSE command. START_EXTERNAL(<application>, <command line>, SHOW) Starts an external application/executable <application> with the optional parameter <command line>. The SHOW is optional setting for debug reasons. The application window is usually hidden. The following parameters are available for the command line: <IMSI>, <OWN_NUMBER>, <PARSE_BUFFER>, <RECEIVE_NUMBER>. If the application is executable it will be closed after running. EXAMPLE: To start the application PHP with the script name and other additional command line parameters. START_EXTERNAL(D:\ApachePHPBundle\PHP\php.exe, X:\path\to\script\mms-2-email.php --username=<OWN_NUMBER> --password=<PARSE_BUFFER> --d_imsi=<IMSI>) TARIFF_LIMIT_FAKTOR(<major currency unit/minute>,<ChargeUnitGenerate>) The limit factor is aturomatically calculated based on the values entered. Eliminated the need to calculate LIMIT_FAKTOR_M. EXAMPLE: For charges of €0.25/minute and a ChargeUnitGenerate of 1, the entry would look like this: TARIFF_LIMIT_FAKTOR(0.25, 1) NOTE: This entry cannot be used in conjunction with LIMIT_FAKTOR_T or LIMIT_FAKTOR_M vGATE 17.1 Page 99 7 Table 7.5 vGATEDesktop Special service script commands (page 11 of 11) Commands UNBLOCK_PORT The port is unblocked. WAIT_MSG(<waitparam1>,<waitParam2>,...,<timeout>) Sets a wait for defined messages. This string sets a wait for defined messages. For the proper syntax of wait parameters, see the entry for SEND_USSD_WAIT. Example of a time value: Parsed string: 10:25:32 in hr:min:sec Wait parameter: [T%d:%d:%d] (enter [T%d:%d] for min:sec or [T%d] for sec). Calculation: Limit = hr x 60 x limit factor + min x limit factor + sec x limit factor / 60 Example of a money value: Parsed string: 11.55 in €.cent Wait parameter: [M%d.%d] As of version 16.2, thousand separators can be included. Use [M%d,%d.%d] to parse 1,000.00 or [M%d.%d,%d] to parse 1.000,00. Calculation: Limit = (€ x 100 + cent) / limit factor NOTE: Enter a ^ sign in front of each wait parameter to parse the value before the query response message. Table 7.6 Special service variables Variables <OWN_NUMBER> This variable is used as a placeholder in special service commands for sending SMS or USSD messages. During script run, the variable is replaced by the SIM card’s own number. If no own number can be found, the script is cancelled with an error message. A SIM card’s own number can be set if you right-click the SIM card, select Change SIM Options... and enter the number in the Own Number field. <RECHARGE_CODE> This variable is used in a Send command as a place holder within the <code> or <string> parameters. During script run, the variable is replaced by the the SIM card’s recharge code which is taken from the recharge list. If no code can be found, the script is cancelled with an error message. <RECEIVER_NUMBER> This variable is used in a Send command as a place holder within the <code>, <string>, or <to> parameters. During script run, the variable is replaced by the the receiving (production) SIM card’s own number. Use this variable in a balance transfer scenario. For an example, please see Chapter 7.9.6.3 Transfer script example. 7.12.2 Script example The following example shows a limit factor (LIMIT_FAKTOR_M) based on money, with a calculating factor of 0.4 and a limit factor based on time (LIMIT_FAKTOR_T), whereby the factor is 60. If the calculated limit is greater than 0 and less than 9, the limit will be set at 10 (SET_MIN_LIMIT(9,10)). The port will be blocked through the remote interface (BLOCK_PORT). A pause of five seconds will occur before the USSD code is sent (SLEEP(5000)). The entry SEND_USSD_WAIT contains one wait parameter and a timeout of five minutes ((*100#, account status: [M%d.%d], 5)). The USSD code *100# (acount-status query) is sent an the system waits for a response containing the words account status and a monetary value ([M%d.%d]). If the response comes within five minutes, the account status is cal- vGATE 17.1 Page 100 7 vGATEDesktop culated using the value entered in LIMIT_FAKTOR_M and the SIM will be recharged if the limit is below that set in RECHARGE_IF_LIMIT_BELOW (2000). If SIM recharge is to be initialized, the job will end here. If not, USSD code *123*12*01# (activation of special service, e.g. special rate) is sent, with the wait parameters is active (wait parameter 1) and has been activated (wait parameter 2) and a timeout of five minutes. If wait parameter 1 (is active) comes within five minutes, the port will be blocked and USSD code *125# for special rate time status is sent (SEND_USSD_WAIT(*125#, special rate: [T%d:%d], 5)). If the response comes before the timeout of five minutes, the time for the special raite is calculated using the LIMIT_FAKTOR_T(60.0). The port is blocked through the remote interface. The calculated limit is set on the mobile gateway and the vGATEDesktop with the command CHANGE_LIMIT. The port is unblocked and the job is ended. If the calculated value is greater than 0 and less than 9, a limit of 10 is set on the mobile gateway. If wait parameter 2 (has been activated) comes within five minutes, the port will be blocked and USSD code *125# for special rate time status is sent (SEND_USSD_WAIT(*125#, special rate: [T%d:%d], 5)). If the response comes before the timeout of five minutes, the time for the special raite is calculated using the LIMIT_FAKTOR_T(60.0). The port is blocked through the remote interface. The calculated limit is set on the mobile gateway and the vGATEDesktop with the entry CHANGE_LIMIT. The port is unblocked and the job is ended. If the calculated value is greater than 0 and less than 9, a limit of 10 is set on the mobile gateway. vGATE 17.1 Page 101 7 vGATEDesktop If the wait string account status does not occur within five minutes, the command entered for _TIMEOUT_ will be carried out: The CHANGE_DB_STRING account status not received will appear in the UserInfo1 field of the database. The SIM will be released and blocked. Example 7.10 Script example LIMIT_FAKTOR_M(0.4) LIMIT_FAKTOR_T(60.00) SET_MIN_LIMIT(9,10) BLOCK_PORT SLEEP(5000) SEND_USSD_WAIT(*100#,account status: [M%d.%d], _TIMEOUT_, 5) { RECHARGE_IF_LIMIT_BELOW(2000) SEND_USSD_WAIT(*123*12*01#, is active, has been activated, 5) { BLOCK_PORT SEND_USSD_WAIT(*125#, special rate: [T%d:%d], 5) { BLOCK_PORT CHANGE_LIMIT UNBLOCK_PORT END_JOB } } { BLOCK_PORT SEND_USSD_WAIT(*125#, special rate: [T%d:%d], 5) { BLOCK_PORT CHANGE_LIMIT UNBLOCK_PORT END_JOB } } } { } 7.13 CHANGE_DB_STRING(UserInfo1, account status not received) RELEASEBLOCK_SIM END_JOB Defining the SIM’s protocol Near the bottom of the left side of the SIM Options dialog, you can select which protocol will be used for dual SIMs. If you select Automatic (default), the vGATE will set the protocol based on that of the mobile gateway. If the mobile gateway is UMTS, the SIM will be assigned as a UMTS SIM; if the mobile gateway is GSM, the SIM will be assigned as a GSM SIM. Figure 7.38 SIM protocol vGATE 17.1 Page 102 7 vGATEDesktop If you select UMTS, the SIM will be assigned as a UMTS SIM, regardless of the protocol on the mobile gateway. If you select GSM, the SIM will be assigned as a GSM SIM, regardless of the mobile gateway’s protocol. If you try to assign a UMTS SIM to a GSM iGATE or vice versa, a confirmation dialog will appear. i This option is only possible with vGATE SIM Unit Version 29 or higher. The vGATE SIM Unit Version 29 is compatible only with vGATE Version 12.0 or higher. 7.14 Decommissioning SIM cards To take a SIM card permanently out of commission, select Change SIM Options from the SIM’s context menu to open the SIM Optionsdialog. Activate the checkbox Terminate SIM after and use the drop-down menu to set a termination date. The SIM will be taken out of commission at the end of that day. Assigned SIMs will not be automatically released after reaching the decommission date. Decommissioned SIMs will never be assigned again. The priority assigned to a SIM card can be changed automatically before termination. Check the Change SIM Priority to box and select a priority level from the drop-down menu. Figure 7.39 Decommissioning SIM cards vGATE 17.1 Page 103 7 7.15 vGATEDesktop Editing mobile gateways In the list of gateways, right-click the gateway which you want to edit and select Edit. Figure 7.40 Edit window To set up a mobile gateway and assign it to a group, please follow the instructions in Chapter 7.1 Automatic mobile gateway registration. You may want to include additional options for mobile gateways, which can be entered into the edit window. Here is a description of the information that can be entered: i These settings must correspond with the settings on the individual mobile gateway. We recommend that you do not change the default port number. vGATE 17.1 Page 104 7 Table 7.7 vGATEDesktop Edit window (page 1 of 3) Entry Description iGate This part of the window is for basic setup information. Name Enter a meaningful name for the mobile gateway here. IP Address Enter the mobile gateway’s IP address here. Port To lookup the mobile gateway’s port number. Number of CTRLs Select a number of controllers for this mobile gateway in increments of four. Coordinates Enter the X and Y coordinates you have calculated for the mobile gateway’s position. Serial # The serial number appears automatically. Group Use the drop-down menu to assign a mobile gateway to a group (only possible when adding a new mobile gateway). Type The system type appears automatically. Use Remote Tunnel Activate this checkbox to reserve port 4446 for tunneling. This ensures that the connection between the vGATE and the mobile gateways remains unobstructed when the GATE Manager is connected to the mobile gateway. The vGATE uses this port to generated calls and SMS and for SIM recharging and special scripting. The following entry must be made in the mobile gateway’s pabx.cfg: MoipPort2=4446 The mobile gateway must be restarted to activate this function. Always Use local SIM Unit Address If the local IP address and the public host address are entered in the vGateConfig, you can set this flag to send the vGATE SIM Unit’s local IP address to the mobile gateway. This is useful when the mobile gateway can reach the vGATE SIM Unit at its local IP address or if both devices are in the same location. New Protocol Activate this checkbox to send the settings from the carrier list to the mobile gateways (version 14.6 or higher). See Chapter 7.10 Automatic mobile gateway configuration via vGATEDesktop. <V14.6 Activate this checkbox to send the settings from the carrier list to the mobile gateways which have a version older than 14.6. Telit 3G Modules Activate this checkbox if the mobile gateway contains Telit 3G modules. No UTF8 messages Check this box for all mobile gateways with a software version before 17.1. Remote Access Enter the following information if you want to alter or secure remote access to the mobile gateway using GATE Manager. Port Enter the port for GATE Manager access. Leave this space empty to use the default port. Password For added security, enter a password for GATE Manager access. Use FTP for file transfer Activate the checkbox to transfer files in GATE Manager via FTP. User Enter the user name configured to transfer files in GATE Manager via FTP. Password Enter the password configured to transfer files in GATE Manager via FTP. vGATE 17.1 Page 105 7 Table 7.7 vGATEDesktop Edit window (page 2 of 3) Entry Description Port Enter the port for using the GATE Manager to transfer files via FTP. Default 21. Remote State Actions This section is for setting the number of registration retries before a SIM is blocked. ASR low If you select Single, an error message will be entered in the database if the port’s ASR (answer seizure ratio) falls below a certain percentage (per default 30% per 40 calls). If you select Multiple, an error message will be entered in the database if the port’s ASR falls below that percentage 3 times. If you set log only (recommended), the SIM card will be released and reassigned after the ASR low event occured one or three times, as defined above. If you set a number, the SIM will be blocked after that number of ASR low events has occured. The answer seizure ratio is the ratio of connected calls sent out via a port to all calls sent out via this port. In your mobile gateway’s pabx.cfg’s [System] section, use the GSM(or UMTS)=ASR[<limit>,<calls>] parameter to change the default ASR low setting from 30% per 40 calls to any other setting. Too many announcements Depending on the settings on the individual mobile gateway, an error message will be sent when a certain number of calls result in a recorded announcement. The SIM card will be blocked and reassigned. If you set log only, an error message will be entered in the database when the amount set in the mobile gateway is reached. If you set a number (1 is recommended), the SIM card will be blocked after that number of Too many announcements events has occured. Requires that the GSM(or UMTS)=STOP[<val1>,<val2>] parameter is set in the individual mobile gateway. SIM blocked (GSM) When a SIM is blocked, an error message is automatically entered in the database. This setting cannot be changed. CTRL restart timeout If a port had to restart the number of times selected it will be blocked. In any case, an error message will be entered in the database. SIM barred (GSM) Enter the number of times SIM registration is to be allowed to fail (4 is recommended) before the SIM and its port are blocked (only occurs when Block former SIM is activated). Block former SIM When this box is checked, SIMs will be blocked after the number of SIM barred occurrences entered. Release SIM if RSSI low occures Check this box to release SIM cards from a gateway controller that has been blocked due to low RSSI. The SIM cards can then be used on an alternating controller or gateway. Get Files Activate the checkbox to retrieve the corresponding log file(s) at the time entered. Get File 1 For second generation mobile gateways enter the following: /data/cdr%date:ymd-1%0.log. Files will be generated each day. -1 means that they will be retrieved for the day before today (today minus one). A folder containing the files for each mobile gateway is created here: F:\vGATE\CDR\iGATE-<name>. For mobile gateways that do not contain a compact flash, enter the following: /boot/cdr%date:ymd-1%0.log. vGATE 17.1 Page 106 7 Table 7.7 7.16 vGATEDesktop Edit window (page 3 of 3) Entry Description Get File 2 You can enter settings for retrieving other log files here. For example, to retrieve CDRs from 3 days ago, enter the following: /data/cdr%date:ymd-3%0.log. For mobile gateways that do not contain a compact flash, enter the following: /boot/cdr%date:ymd-1%0.log. To retrieve a failed log, enter: /boot/failed%date:ymd-1%0.log Start Time (for Get File 1) Enter the time at which CDRs Filename 1 are to be retrieved daily. Three unssuccessful retrieval attempts will result in a retrieval pause of six hours, after which a new attempt is made. Start Time (for Get File 2) Enter the retrieval time for CDR Filename 2 here. Limit Call/SMS Generation This group box allows you to set a limit for generation of calls and/or SMS. Maximum simultaneous calls This option allows you to set a maximum number of calls that can be started simultaneously from different mobile gateways. Enter the maximum number or check No limit if you do not want to set a limit. Maximum simultaneous SMS This option allows you to set a maximum number of SMS that can be started simultaneously from different mobile gateways. Enter the maximum number or check No limit if you do not want to set a limit. User Information You can enter two user information strings, which will then appear in the User Info 1 and User Info 2 columns. If you activate Save Maintenance Actions in User Info in the Options menu, an entry will appear in the defined user info column every time maintenance mode is set or reset. Remove SIMs of Unreachable iGATE Check this option and select a number of minutes in steps of five to remove SIM cards from a mobile gateway that could not be reached from the vGATE for the entered number of minutes. Use this option carefully. Corresponds with the Free SIMs of dead iGATE option that can be selected by right-clicking on the mobile gateway to manually free SIM cards from an unreachable gateway. SIM card history Right-click a SIM card and select SIM History from the Reports submenu to call up a window containing information about that SIM card’s activity. Figure 7.41 SIM card history vGATE 17.1 Page 107 7 vGATEDesktop Entries are color-coded as follows: Green=OK Yellow=Warning Orange=Minor Red=Major Pink=Critical For a list of error messages and their respective levels of importance, please see Table 7.8. The following messages correspond with these warning levels: Table 7.8 SIM card warning messages Warning Message Warning Maximum limit reached Prepaid SIM recharge finally failed, SIM blocked Prepaid SIM: Error in upgrade, SIM blocked Daily duration limit reached, SIM blocked Prepaid SIM limit reached, SIM blocked Prepaid SIM: maximum upgrade count reached Prepaid SIM: No recharge number found Remote client GW xxx: link on Ctrl xxx active Minor SIM broken (TCP connection) occurred SIM broken occurred Balance check failed, maximum retries used Error in special recharge job. Prepaid SIM limit reached, SIM blocked. (e.g. maximum upgrade count reached) SIM blocked by script Recharge SIM: Error while sending recharge call Sending recharge call (OK), cannot start wait timer, no limit indication after approximately xxx minutes. Recharge Number xxx was used with code xxx for GW xxx, Addr xxx, IMSI xxx Error while sending balance call. Recharge Number xxx was used with code xxx for GW xxx, Addr xxx, IMSI xxx Major Too many CTRL sleep occurred Balance verification failed. New Balance is xxx smaller than maximum vGATE limit Error in special job GW:[xx] Ctrl:[xx] SIM blocked after announce check, remoteStatus:[Port blocked (too many announcements)] occurred 2 times Too many announce check failed, count = 0 GW:[xxx] Ctrl:[xxx] RemoteStatus:[SIM barred (GSM)] Release SIM Remote client GW xxx: Recharge SIM xxx error: [Counter<=1] CTRL: SIM broken (TCP connection) occurred CTRL: SIM brocken occurred No SMS sending of error on CTRL CTRL was incorrectly configured (pabx.cfg) Critical Select the Export to File from the context menu to export the report to a .txt, .xls or .slk file vGATE 17.1 Page 108 7 vGATEDesktop The window contains the following information: Table 7.9 SIM card history Column Description Timestamp Time at which the action described in the status message occurred. Position The SIM’s position in the vGATE SIM Unit. Gateway The mobile gateway to which the SIM is assigned. Ctrl # The controller number to which the SIM is assigned. Status The SIM’s status. Category Status category: 0=status OK, 1=Warning, 2=Minor, 3=Major, 4=Critical. The following icons appear in the upper left-hand corner of the window: Table 7.10 SIM card history icons Icon Description Click this icon to actualize the information displayed in the history. All new information will be retrieved from the database. Click this icon to call up a dialog to set filters. Check the filters you would like to set and enter the corresponding information. Click OK to activate the filters. Only the information you have selected will be displayed. Click this icon to deactivate the filters you have set for this SIM. All available information will be displayed in this SIM’s history if you click this icon. 7.17 vGATE statistics You can call up SIM statistics and call statistics for SIMs, controllers, mobile gateways and for groups. The vGATEDesktop can also display line charts with various statistical information for mobile gateways and for groups. Values are calculated serially every 5 to 60 seconds, depending on the number of controllers. Statistics from the current and previous months are saved in the database. The following values appear in at least one of the various statistic windows: Table 7.11 vGATEDesktop statistics Statistic Definition ACD The Average Call Duration is the average length of calls on the SIM. ASR1 The Answer Seizure Ratio is the percentage of calls that result in a connection. ASR1 does not regard connection attempts aborted by the A subscriber as aborted connections. vGATE 17.1 Page 109 7 Table 7.11 7.17.1 vGATEDesktop vGATEDesktop statistics (continued) Statistic Definition ASR2 The Answer Seizure Ratio is the percentage of calls that result in a connection. ASR2 regards connection attempts aborted by the A subscriber as aborted connections. Assign Time Shows the amount of time the SIM was assigned. Carrier Shows the name of the carrier. Connected Calls Shows the number of successfully connected calls placed using the SIM. Ctrl Shows the controller on which the SIM was active. Dur/Asn Shows the percentage of the Assign Time that the card was connected. Duration Shows the amount of time the SIM was connected while it was assigned. Gateway Shows the name of the mobile gateway on which the SIM was active. Incoming Calls Shows the number of incoming calls placed using the SIM. Outgoing Calls Shows the number of outgoing calls placed using the SIM. Position Shows the SIMs position number. Remote Busy Shows the number of calls that resulted in a busy signal. Timestamp Shows the time when the SIM was released. IMSI Shows the SIM’s IMSI. Own Number Shows the call number for the SIM. Disconnected Shows the number of disconnected calls. SIM card statistics You can access averaged SIM statistics for marked SIMs, controllers and mobile gateways clicking the corresponding icon (shown there) in the toolbar and use the drop-down menu to select beginning and ending dates for the statistics displayed. Figure 7.42 SIM card statistics vGATE 17.1 Page 110 7 vGATEDesktop You can also access averaged SIM statistics for marked SIMs, controllers, mobile gateways and groups through the context menu in the respective view: SIM view: select SIM Statistics from the Reports submenu in the context menu. controller view: select Show SIM Statistics from the context menu or from the context menu in the Show Call Statistics window (see Chapter 7.17.2 Call statistics). mobile gateway view: select Show SIM Statistics from the context menu in the Show Call Statistics window (see Chapter 7.17.2 Call statistics). group view: select Show SIM Statistics from the context menu in the Show Call Statistics window (see Chapter 7.17.2 Call statistics). 7.17.2 Call statistics You can access averaged call statistics for mobile gateways or groups by clicking the icon in the toolbar. Figure 7.43 Call statistics Select Show Call Statistics from the context menu in the controller, mobile gateway or group view to display statistics for the marked element. Using the drop-down menu, you can set filters in the dialog that appears. Select a Carrier to display call statistics only for one carrier. Use the drop-down calendar in Begin and End to limit the statistics to calls for a specific time frame. To display call statistics for a specific Timezone, select a Timezone from the list. vGATE 17.1 Page 111 7 7.17.3 vGATEDesktop Call charts You can access a line chart with averaged call statistics by clicking the icon in the toolbar or by selecting Show Call Chart in the mobile gateway or group view. Figure 7.44 Call chart Using the drop-down menu, you can set filters in the dialog that appears. Select a Carrier to display call statistics only for one carrier. To limit the statistics to calls for a specific Week, select daily for the current day, current for the current week, current - 1 for last week, current - 2 for two weeks ago, and so on. Figure 7.45 Call chart filter vGATE 17.1 Page 112 8 Summary of vGATEDesktop user interface 8 Summary of vGATEDesktop user interface This chapter summarized all elements of the vGATEDesktop user interface. 8.1 What the information on the vGATEDesktop means The windows listing mobile gateways, controllers and SIMs appear in table form. Each window contains information listed in columns. You can change the position of the columns by left-clicking the column heading and dragging it to the desired position. You can reverse the order of the rows in each window by clicking the heading with the arrow. This is what the columns means: Table 8.1 vGATEDesktop columns (page 1 of 4) Column Description Mobile Gateways Name Lists the mobile gateways in the selected group by name. Address Shows the IP address for the corresponding mobile gateway. Status Contains status messages and the serial number. Serial# Shows the mobile gateway’s serial number (second generation mobile gateway’s only). System Type Lists the type of system in the vGATE. User Info 1 Contains the maintenance information if Save Maintenance Actions in User Info ... from the Options menu has been selected for Gateway User Information 1. Can also be used for manual entries. User Info 2 Contains the maintenance information if Save Maintenance Actions in User Info ... from the Options menu has been selected for Gateway User Information 2. Can also be used for manual entries. Controllers CTRL Lists the controller numbers. Active Position Lists the SIMs that are currently active at the corresponding port. Limit 1 Reserved Positions Refers to the position of all SIMs reserved with Max Limit 1 to the controller. Limit 2 Reserved Positions Refers to the position of all SIMs reserved with Max Limit 2 to the controller. Limit Choice Lists which settings have been defined in Advanced Limit Choice (see context menu Table 8.5). All is the default setting. Current Limit Shows which limit is currently being used. Remote State Contains status messages for the controller sent by the mobile gateway . CTRL Info Shows comments you have entered for this controller. Action Lists actions currently being carried out. Possibilities are Release and Search and Assign. SIM Info 1 Shows Info 1 comments you have entered for the SIM that is currently active. vGATE 17.1 Page 114 8 Table 8.1 Summary of vGATEDesktop user interface vGATEDesktop columns (page 2 of 4) Column Description Error Lists errors that occur at the corresponding port (UMTS). Status Lists the controller’s status: 0 = Okay 1 = Waiting for an action UMTS If an X appears in this column, the controller is a UMTS controller. RSSI Lists the RSSI values for the controllers. ASR1 Lists the ASR1 values for the controllers ASR2 Lists the ASR2 values for the controllers ACD Lists the ACD values for the controllers SIMs Position Lists SIM cards by their positions in the SIM 60 Carrier. The syntax for the position numbers is <vGATE SIM Unit>.<vGATE Module>.<SIM position>. The list is color-coded, so that all the positions listed on the same background color represent one vGATE Module. Color Lists the colors that have been set to mark individual SIMs, e.g. according to carrier. IMSI Lists the SIMs’ International Mobile Subscriber Identity number. Change SIM Limit Shows the limit (in 10-second time units) at which the mobile gateway will change to the next SIM. Max Limit 1 Shows the number of 10-second units after which the SIM will no longer be used for timezones to which it has been assigned with Max Limit 1. Count (L1) Shows the Max Limit 1 units that have been used. Max Limit 2 Shows the number of 10-second units after which the SIM will no longer be used for timezones to which it has been assigned with Max Limit 2. Count (L2) Shows the Max Limit 2 units that have been used. Limit A/B/C Shows the advanced limits that have been set for this SIM. Count A/B/C Shows the number of advanced limit units that have been used for this SIM. Last Use Shows when the SIM was last active. Status Lists the SIMs status: 0=OK 1=database error Pause Shows the length of the pause set for this SIM after each release. Priority Lists the SIMs’ defined priority. Error Shows error messages. The line also appears highlighted in red or yellow. Count (L1) Yesterday If Reset SIM Counter Daily is set in the vGATECtrl, this column shows the Max Limit 1 units used on the previous day. vGATE 17.1 Page 115 8 Table 8.1 Summary of vGATEDesktop user interface vGATEDesktop columns (page 3 of 4) Column Description Count (L2) Yesterday If Reset SIM Counter Daily is set in the vGATECtrl, this column shows the Max Limit 2 units used on the previous day. Current Count Shows the number of units used in the current call. Own Number Shows the SIM’s call number. SMS Count Shows the ratio of the number of SMS that have been sent to the number configured to be sent. Next SMS Shows when the SIM will send the next SMS. Call Count Shows the ratio of the number of outgoing calls that have been sent to the number configured to be sent. Next Call Shows when the SIM will make the next outgoing call. Info 1 Shows comments you have entered for this SIM. Info 2 Shows comments you have entered for this SIM. Active Release Shows the number of minutes you have defined that a SIM will be active before it is released. Max Call Duration Shows the number of seconds after which calls will be disconnected. Call/SMS Flags Shows any flags that have been set for sending and receiving SMS. The following are possible: RC Receive calls RS Receive SMS CoS Count only successful calls Grp Send only to same group Col Send only to same color Special Service Flags Shows any flags that have been set for special services. The following are possible: A After Assign L On Change Limit Reached D Daily between the defined times E On Each Limit Ind. (PP) Assign Offset Shows a random number of seconds between those defined in the Limits dialog (see Chapter 7.6 Setting time limits and pauses). Used per TZ Lists how often the SIM has been assigned . Upgrades/Week Lists how often a SIM has been recharged in the current week/how many recharges per Week have been set. Upgrades/Month Lists how often a SIM has been recharged in the current month/how many recharges per month have been set. Carrier Sub ID Lists the carrier’s sub identification. Default 1. Route Priority Lists the priority set for calls over this SIM. Route priority is available in versions 14.6 or higher and is set between 1 and 10, with 10 being the highest priority (default 5). NOTE: Route priority is only active if New Protocol has been set in the edit window. Serial Number Lists serial numbers entered for SIMs using the Change Serial Number function in the context menu. If no serial number has been entered, none will appear. vGATE 17.1 Page 116 8 Table 8.1 8.2 Summary of vGATEDesktop user interface vGATEDesktop columns (page 4 of 4) Column Description Known Since Shows when the SIM entered the system. PPCount SLR Prepaid Count Since Last Recharge shows the number of 10-second units that have been used since the last time the SIM was recharged. The counter is reset after the SIM has been recharged. Max Daily Duration Shows the number of minutes the SIM will be used on any given day before it is blocked. vGATEDesktop icons Table 8.2 lists the icons that appear on the vGATEDesktop and their meanings. Table 8.2 vGATEDesktop icons Icon Definition Groups No errors exist on the mobile gateways in this group. An error exists on at least one mobile gateway in the group. A mobile gateway in this group is currently in maintenance mode. Select Reset Maintenance Mode from the context menu to reactivate the group’s mobile gateway. A light-blue line around the icon signifies that the groups has been defined as the default group. Mobile Gateways No errors exist on this mobile gateway. This mobile gateway is not available. This mobile gateway is currently in maintenance mode. Select Reset Maintenance Mode from the context menu to reactivate the mobile gateway. This mobile gateway has been improperly configured. Check the configuration and, if necessary, install the proper driver for vGATE implementation. Controllers A SIM has been assigned to this port. No SIM has been assigned to this port. This port is in the process of carrying out an action. vGATE 17.1 Page 117 8 Table 8.2 Summary of vGATEDesktop user interface vGATEDesktop icons (continued) Icon Definition This is a UMTS port from a iGATE 3G. SIMs This GSM SIM is currently assigned to a port. This GSM SIM is not currently assigned to a port. This GSM position is empty. No SIM is inserted. A previously set pause is currently active on this GSM SIM or the value set for Maximum Usage per TZ has been reached. This SIM is a UMTS SIM. This icon also appears in all of the above colors, depending on the SIM’s status. This icon indicates a dual SIM. This icon also appears in all of the above colors, depending on the SIM’s status. A gray U on the icon indicates that the SIM has been set to GSM, a gray G indicates it has been set to UMTS. If neither the U nor the G are gray, the SIM has been set to automatic. Signifies a prepaid SIM that does not recharge automatically. Signifies a prepaid SIM that recharges automatically. Indicate SIMs that have been blocked. Only inactive SIMs can be blocked manually. Indicates that the SIM has been decommissioned. Decommissioned SIMs will never be assigned again. An assigned SIM will not automatically be released after reaching the decommission date. 8.3 vGATEDesktop menu bar The following table describes the commands you can carry out from the vGATEDesktop menu bar: Table 8.3 vGATEDesktop menu bar Command Definition File Menu Exit Closes the vGATEDesktop. View Menu Timezones List vGATE 17.1 Click here to open a list containing an overview of timezones for the selected group. Page 118 8 Table 8.3 Summary of vGATEDesktop user interface vGATEDesktop menu bar (continued) Command Definition Carrier List Click here to open and edit a list of carriers. Prepaid Recharge List Click here to open and edit a table containing information about prepaid recharge numbers. SMS Message List Click here to open and edit a table containing SMS messages sent by the system. SMS/Call Receiver Click here to open receiver groups and edit a table containing numbers that are to receive calls and/or SMS. Holidays List Click here to open the list of holidays set in the Holidays timezone. Status Bar Click here to hide or display the status bar. The number of SIMs and SIM 60 Carriers is displayed in the middle of the status bar and the time and date of the vGATE Control Unit is on the right. Toolbar Click here to hide or display the toolbar. Split Click here for a resize cursor to adjust the size of the windows on the vGATEDesktop. Refresh Click here to update the information displayed. SIMs not in SIM Unit Click here to call up a list of SIMs once in the vGATE SIM Unit that have been removed. Right-click a SIM to Delete from Database. SIMCarrier Status Calls up a window containing the status of the SIM 60 Carriers in the vGATE SIM Unit. Custom Colors Call up a color palette, from which you can color-code SIM cards, e.g. by carrier. The color selected appears in the Color column, the Active Position column of the controller window and in the SIM Route window. Please note that as of version 17.0 the color combination black (0,0,0) can no longer be used since it cannot be handled in the SIM card routing. Options Menu Inhibit Modification of Timezones Click here to lock timezones in their current position. To deactivate this option, click here again. Save Maintenance Actions in User Info... Click here to open a dialog box where you can choose where to store the maintenance information. Configure SIMView... Click here to open the list of columns that are available for the SIMView. Choose from this list which columns you want to display. As of version 17.0, background colors can be switched off by deselecting the Show Background Color option. Help About vGATEDesktop vGATE 17.1 Click here to view version information for the vGATEDesktop and vGATECtrl installed. Page 119 8 8.4 Summary of vGATEDesktop user interface vGATEDesktop toolbar The vGATEDesktop toolbar facilitates quick access to the following functions and information: Table 8.4 vGATEDesktop toolbar buttons (page 1 of 2) Icon Function Click here to open a list of all Timezones for the selected group. Click here to open the list of holidays set for the Holiday Timezone. Click here to call up a window containing the status of the SIM 60 Carriers in the vGATE SIM Unit. Click here to open and edit the list of carriers. Click here to open and edit a table containing information about prepaid recharge numbers. Click here to open and edit a list of SMS sent by the system. Click here to open and edit a list of SIMs receiving SMS and calls. Call up a color palette, from which you can color-code SIM cards, e.g. by carrier. The color selected appears in the Color column, the Active Position column of the controller window and in the SIM Route window. Click here to open the GATE Manager. This button is active only when a mobile gateway is selected. Click here to open a table containing information about the SIM route for the selected mobile gateway. Click here to open a table containing information about the SIM route for the selected controller. Click here to open a table containing information pertaining to the selected SIM’s configuration. Click here to open a table containing information about the selected SIM’s implementation schedule. Click here to open a table containing information on the selected SIM’s implementation history. Click here to call up a record averaged statistics for the marked SIMs, controllers or mobile gateways, depending on which of these icons you click. Click here to open a table containing information on how much and when selected SIMs have been used. Click here to open a table containing information about when the selected SIMs were last released. Click here to call up a table containing information on SIM’s released below a defined count. Click here to call up a table containing information on SIM’s that have reached their defined change limit. vGATE 17.1 Page 120 8 Table 8.4 Summary of vGATEDesktop user interface vGATEDesktop toolbar buttons (page 2 of 2) Icon Function Click here to call up a table containing information on SIM’s that have reached their defined maximum limit. Click here to call up a table containing information on SIM errors that have occurred. Click here to call up a table containing call statistics for the selected mobile gateway or group. Click here to call up a line chart of call statistics for the selected mobile gateway or group. Click here to refresh the vGATEDesktop. Click here to view version information pertaining to the vGATEDesktop and vGATECtrl. 8.5 Context menus The following table describes the commands you can carry out with the context menus on the vGATEDesktop: Table 8.5 vGATEDesktop context menus (page 1 of 7) Command Definition Groups Create Group Click here to add a new group and to set dynamic pauses. Edit Group Click here to change the name or dynamic pauses for an existing group. Delete Group Click here to delete a group. Show Call Statistics Contains a record of the averaged statistics for all calls that have gone through this group. Show Call Chart Contains statistic charts for all calls that have gone through this group. Copy Holidays to Group Opens a dialog into which you can select a group to which you can import the holiday settings for the group marked. Activate the checkbox Delete Destination to delete the current settings in the destination group. If this checkbox is not active, the new settings will be added to the old ones. Default Group For New GWs Click here to define the marked group as the default group. New gateways will automatically be added to this group. mobile gateways Add New Click here to call up the edit window (cf. Chapter 7.15 Editing mobile gateways). Use the edit window to add a new mobile gateway. We recommend that you use automatic mobile gateway registration to add new mobile gateways (cf. Chapter 7.1 Automatic mobile gateway registration). Delete Click here to remove a mobile gateway from the vGATE. Edit Click here to call up the edit window (cf. Chapter 7.15 Editing mobile gateways). Use the edit window to change an existing mobile gateway. vGATE 17.1 Page 121 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 2 of 7) Command Definition Copy Timezone Configuration to GW Use the drop-down list box to select a mobile gateway and click OK. The timezone configuration for the marked mobile gateway will be copied into the mobile gateway you select from the list. Change Group Use the drop-down list box that appears to switch this mobile gateway to another group. Free SIMs of dead iGate When an interruption occurs in the connection between the vGATE Control Unit and the mobile gateways, traffic continues but the SIMs are locked, so that they don’t log onto another mobile gateway. Click here to allow other mobile gateways access to these SIMs. NOTE: Select this option only if you are sure that the SIM will not log on twice, as SIMs registered with more than one mobile gateway can alert a GSM carrier to block the SIM. If you use this command, be sure to look for and eliminate the problem that caused the interruption. Set Maintenance Mode Causes the mobile gateway to release all of its SIMs immediately. All calls will be torn down. If you have activated Save Maintenance Actions in User Info in the mobile gateway’s Options menu, a dialog will appear where you can edit the information that will appear in the defined user info column every time maintenance mode is set or reset. Reset Maintenance Mode Reconnects the SIMs released when Set Maintenance Mode was selected. If you have activated Save Maintenance Actions in User Info in the mobile gateway’s Options menu, a dialog will appear where you can edit the information that will appear in the defined user info column every time maintenance mode is set or reset. Reinit Initiates a check of the mobile gateway’s status against the database. Inconsistencies will correct themselves automatically. Wherever possible, SIMs will be assigned to empty controllers. Start Remote Opens GATE Manager for remote access. A folder with the name Remote is automatically created in the vGateControl directory the first time you start GATE Manager. Sub-folders for each mobile gateway selected will also be created automatically. Show Gateway History Calls up a table containing an overview of the gateway’s status changes. The following status information is possible: gateway stopped: the mobile gateway can no longer be accessed from the vGate gateway running: the mobile gateway is accessible again set maintenance: the mobile gateway is in maintenance mode reset maintenance: the mobile gateway is no longer in maintenance mode. The info column displays the details of each status. Once a week, the information that is older than a week is automatically removed from this table and written into the GW_History_YYYYMM_Week.txt file. This file is then stored in the vGate’s logfiles folder. Show SIM Route Calls up a table containing an overview of reserved positions. Right-click to refresh the window. Show SIM Statistics Contains a record of the averaged statistics for all SIMs used by this mobile gateway. Show Call Statistics Contains a record of the averaged statistics for all calls that have gone through this mobile gateway. vGATE 17.1 Page 122 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 3 of 7) Command Definition Show Call Charts Contains statistic charts for all calls that have gone through this mobile gateway. Default Configuration For New GWs Select this option to use the configuration for this mobile gateway as the default configuration for all new gateways. The following configuration settings apply: Use Remote Tunnel Always Use Local SIM Unit Address Remote Access Use FTP for File Transfer Remote State Actions Occurrence Before Reassign SIM Get Files (Get CDR, Failed Log) Controllers Release SIM Click here or press Ctrl+R to deactivate a SIM. Release SIM and Block The SIM will be released and the controller will be blocked. Release SIM Immediately Click here or press Ctrl+I to release the SIM immediately, even if traffic is running on it. Release SIM Immediately and Block The SIM will be released immediately, even if traffic is running on it, and the controller will be blocked. Assign SIM Click here or press Ctrl+A to activate a reserved SIM. If multiple SIMs are reserved, the one that has the highest assign priority will be activated. If no assign priority has been set, or if SIM’s share the same assign priority, the SIM that has the highest route priority will be used. Route priority is available in versions 14.6 or higher and is set between 1 and 10, with 10 being the highest priority (default 5). NOTE: Route priority is only active if New Protocol has been set in the edit window. Reassign SIM Click here or press Ctrl+S to release and reassign the SIM or SIMs. This is useful when an active SIMs parameters (e.g. limits) have been changed. Stop Recharging Click here to cancel the recharge process running. It is possible to select more than one controller for this command. Stop Assigning Click here to interrupt the assign phase for the marked controller(s). This is useful when a SIM has been assigned to two controllers simultaneously, blocking one controller. This function will unblock the controller. Start Special Service Opens a browser to allow manual selection of special service (see Chapter 7.12 Special services). Stop Special Service Special service is stopped and the SIM is released. It is possible to select more than one controller for this command. Edit Advanced Limit Choice Click here to open a dialog where you can define which SIM limits will be assigned to this controller. Set Preferred to use SIMs with different limits if the set limits are not available. Set Mandatory if only SIMs with the defined limits are to be used. Major refers to max limits and limits A, B, and C are advanced limits. Bear in mind that no prepaid SIMs will be assigned to controllers where Mandatory has been set here. Postpaid SIMs will be assigned only if Use Limits One By One is active in the Carrier List Advanced Limit Charges. vGATE 17.1 Page 123 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 4 of 7) Command Definition Edit CTRL Info Click here to edit the information that appears in the CTRL Info column. Edit SIM Linkage Click here to call up a dialog from which you can add or delete individual SIMs from their reserved Limit 1 and/or Limit 2 positions. Remove SIM Linkage Use the submenu to remove SIMs from All, Limit 1 or Limit 2 reserved positions on the marked controller(s). SIMs that are currently active cannot be removed. Block CTRL Click here to block the controller. Reset Error/Unblock CTRL Click here to remove error entries from and unblock this controller. After the message has been removed, the SIM can be reassigned. Show SIM Route Calls up a table containing an overview of reserved positions. Right-click to refresh the window. Show SIM Statistics Contains a record of the averaged statistics for SIMs that have been active at this controller. Show Call Statistics Contains a record of the averaged statistics for all calls that have gone through this controller. SIMs Change Limits Click here or press Ctrl+L to call up a dialog that allows you to set and change a SIM’s settings, such as limits and pauses. Bear in mind that you must reassign the SIM after you change a SIM’s limit (see Chapter 7.6 Setting time limits and pauses). Change Priority Calls up a drop-down list box from which you can define the SIM’s Assign Priority and Route Priority. If multiple SIMs are reserved, the one that has the highest assign priority will be activated. If no assign priority has been set, or if SIM’s share the same assign priority, the SIM that has been idle longest will be used. Route priority sets a priority for calls over the SIM. The assigned SIM with the highest route priority will be used to terminate calls. Route priority is available in versions 14.6 or higher and is set between 1 and 10, with 10 being the highest priority (default 5). NOTE: New Protocol must be active in the edit window. Change SIM Options Calls up a dialog in which you can enter and edit the number of SMS or calls sent per month, information that will appear in the Info 1 and Info 2 and the SIMs own number. Special services can also be activated here. Change Color in Sim Route View Click here to call up a color palette, from which you can color-code SIMs, e.g. by carrier. The color selected appears in the Color column, the Active Position column of the controller window and in the SIM Route window. Change Serial Number Click here to enter or change a SIM’s serial number. The number will appear in the Serial Number column. Define as Prepaid SIM Click here to designate a SIM as prepaid. Change PIN All PINs in the vGATE are set at 0000. If a SIM has a different PIN, select this option to change the PIN to 0000. This option is active only when the selected SIM’s PIN is not set at 0000. Edit User Registration Data Click here to open a dialog into which you can enter user registration for the selected SIM. vGATE 17.1 Page 124 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 5 of 7) Command Definition Add SIM(s) The following options are possible: Add to Selected Ctrls: Click here or press Ctrl+A to assign the marked SIMs to the selected controllers Add Balanced to Ctrls: Click here or press Ctrl+B to reserve the marked SIMs individually to consecutive controllers, beginning with the selected controller. Add Color to Selected Ctrls: Click here or press Ctrl+Alt+A to reserve all SIMs in this color to the selected controllers. The SIM that has been idle longest will be used first. Only one color can be reserved at a time to each controller for each Limit (1 or 2). If you reserve a new color where one already exists, the old color setting will be deleted. Color-based routing and position-based routing may not be used simultaneously. Reserve SIM Like: Click here to call up a dialog where you can enter a SIM number. The marked SIM will then adopt the same reservation properties as the SIM you enter. Check Limit 1 and/or Limit 2 and the marked SIM will also adopt the entered SIM’s limits. Remove SIM(s) The following options are possible: Remove SIM(s) from all Routes: All selected SIM(s) will be removed from their Reserved Positions. Active SIM(s) and color routings will not be removed. Remove SIM Color Group from All Routes: All SIM(s) in the selected color group will be removed from their Reserved Positions. Active SIM(s) will not be removed. Remove SIM(s) from Currently Edited TZ: Click here to remove all SIM(s) from the Timezone you are currently editing. Active SIM(s) will not be removed. Remove SIM Color Group from Currently Edited TZ: Click here to remove all SIM(s) in the selected color group from the Timezone you are currently editing. Active SIM(s) will not be removed. vGATE 17.1 Page 125 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 6 of 7) Command Definition Color Template The following options are possible: Apply Template Settings To Selected SIM: The individual color template settings will by applied to all selected SIMs. Apply Template Settings To All SIMs With Current Color: The template settings will be applied to all SIMs with the same color as the SIM marked. Save Settings as Template For Current Color: The settings for the marked SIM will be saved as the template for that color. A will appear in the Status column of any SIMs to which the color template settings have been applied. The color template applies for the following settings: Maximum Call Duration Maximum Call Duration Per Day Minimum Remaining Maximum Calls Per Day Minimum Pause after Last Use Active Release: o Calls After Assign o SMS After Assign o Incoming Calls o Call Attempts Delay SIM Assignment on TZ Change Reset Maintenance Boot Indication Block SIM On Low ACD Use SIM on Alternating Gateways SIM Opeions Dialog: o Call/SMS generation parameters o Special Services parameters Priority: o Assign Priority o Route Priority Reset vGATE 17.1 The following options are possible: Reset Count: Resets the Count column at 0. Reset Limits: Click here to reset Max. Limits manually to their configured maximum limit. Reset Daily Call Duration: Click here to reset the Daily Call Duration counter manually to its configured value. Reset Daily Calls: Click here to reset the Daily Call counter manually to its configured value. Reset Error/Unblock SIM: Click here to remove error entries from or unblock this SIM. After the message has been removed, the SIM can be reassigned. Reset TZ Change Counter: Resets the Timezone counter (see Chapter 7.6 Setting time limits and pauses: Maximum Usage per TZ). Reset Recharge Counter: Click here to reset the number of recharges used in this month to zero. Reset Prepaid Block: Click here to reset SIMs that have been blocked as a result of mistakes during the recharge procedure. Reset Info Flag and User Info: Click here to clear the text from the Info 1 or Info 2 field. Reset Info Flag and Error String: Click here to clear the Error field. Set Last Special Service Runtime: Click here to manipulate the special service runtime. Reset Last Special Service Runtime: Click here to rerun a script on a new SIM the next time it is assigned. Page 126 8 Table 8.5 Summary of vGATEDesktop user interface vGATEDesktop context menus (page 7 of 7) Command Definition Block SIM Click here to manually block this SIM. Only inactive SIMs can be blocked manually. Stop Pause Deactivates Minimum Pause after Last Use one time. The pause will be reactivated following the next release. Select CTRL Marks the controller where the selected SIM is currently active. Select Last Used Prepaid Recharge Number Click here to select the prepaid recharge number that was used last. NOTE: This feature applies only for auto-recharge SIMs. Show SIM Route Calls up a table containing an overview of reserved positions. Right-click to refresh the window. Reports Use the submenu to call up one of the following tables: Sim History: contains information about the activity of the selected SIM (see Chapter 7.16 SIM card history). SIM Usage: contains a record of the SIM’s assignment. SIM Statistics: contains a record of the SIM’s averaged statistics. SIM Statistics of SIM Color Group: contains a record of averaged statistics for SIMs in the same color group. Last Released: contains information about when the SIM was last released. Released with Count Below: contains a record of SIMs released below a defined count within a defined number of days. Check Report SIMs only once per day and each SIM will be entered only once on any given day. Change Limit Reached: contains a record of SIMs released after a limit was reached. Use the drop-down menu to select the number of days the report contains. Maximum Limit Reached: contains a record of SIMs permanently removed from traffic after their maximum limit was reached. Use the dropdown menu to select the number of days the report contains. SIM Errors: contains a record of errors occurring on the SIM. Use the drop-down menu to select the number of days the report contains. All reports can be exported and saved to a .txt, .xls or .slk files. SIM Information Click here to call up a table containing all of the information pertaining to the SIM’s vGATE configuration. Incoming Messages... Click here to open a browser which shows all messages that have been received for the selected SIM card and the current day. Make sure that Save Incoming SMS/USSD in Database is checked in the vGATECtrl’s Options menu. Export to File Click here to open a browser into which you can save a text file containing the current status of all SIMs. Any filters set will apply. Export User Registration to File Click here to open a browser into which you can save a text file containing the SIM’s user registration. Import User Registration from File Click here to open a browser from which you can select a text file to implort the SIM’s user registration. vGATE 17.1 Page 127 9 vGATECtrl 9 vGATECtrl The vGATECtrl application is the vGATE Control Unit’s background server. You can use it to record and display a log of activity, send email error messages, and to perform a variety of functions on vGATE connections. Open the vGATECtrl by doubleclicking the button in the bottom right-hand corner of the taskbar. Figure 9.1 i vGATECtrl You must select Exit from the File menu or from the context menu in the taskbar to close vGATECtrl. Using the Windows Task Manager to close vGATECtrl can cause database failure! 9.1 Logging activity The current logs describing all activity at the vGATE Control Unit are shown on the screen. All entries are written to the log file, which is generated every day at midnight. This file is saved in the logfiles folder in the vGATECtrl directory. vGATE 17.1 Page 129 9 9.2 vGATECtrl Sending error messages via e-mail To send error messages via e-mail, select Mail Settings from the Options menu. In the popup dialog, activate Send Mail and enter the recipient’s e-mail address, the SMTP Server and the name of the sender in SMTP Originator. To secure access to the mail server, activate Logon and enter a Username and Password. Activate Base64 Encoding to encode logon. Check one or more of the Filters to select the errors for which messages are to be sent. Figure 9.2 9.3 Mail settings Tearing down connections To tear down all connections to the vGATE, select Exit from the File menu or right-click the vGATECtrl icon on the right-hand side of the taskbar. The SIMs will disconnect as soon as any calls are terminated. If you select Exit Immediately, all SIMs disconnect immediately, regardless of whether or not a call is in progress. If you select Exit without releasing SIMs the mobile gateways will not be informed that the connection to the vGATE is torn down. This option is recommended for updates to the vGATECtrl when you don’t want to lose your network connections. Use that option carefully. Confirm the close confirmation dialog with OK. vGATE 17.1 Page 130 9 9.4 vGATECtrl vGATECtrl Options menu The Options menu allows you to perform a variety of tasks in regard to connections on the vGATE: Table 9.1 vGATECtrl options (page 1 of 2) Command Description Check SIM Status The vGATE SIM Unit’s SIM status is checked automatically every 5 minutes. The cycle time can be configured in the registry. Access HKEY_CURRENT_USER\Software\TELES\vGATECtrl\Settings\GetSIMStatusCycle to set the cycle time in micro seconds. Remove Controller Warnings... Calls up a dialog where you can enter a number of minutes between 10 and 3600. Warning messages will remain on the vGATEDesktop for the number of minutes entered. Check Never if you would like error messages to remain indefinitely (default). Activate Also Remove Errors to include major and minor error messages. Export SIM Settings Exports the SIM settings and their current status to a text file. Disconnect all Desktops All remote vGATEDesktops will shut down. Log Settings Allows you to select what kind of log entries you would like. Default settings are Error and Debug. Select Detail to receive detailed entries. Mail Settings... Allows you to send error messages via e-mail (see Chapter 9.2 Sending error messages via e-mail). Reset History Select from the list that opens how often you want to reset the history tables CdrFailedLog, CustomSIMData, GW_History, GW_Usage, SIMHistory, SIMHistory2, SIMStatistic, and IncomingMessages. Contents from these table are saved in a text file each and stored in the log folder. Resetting the history tables is recommended to prevent the database from getting to full which could be disadvantageous for performance. Script File Settings... Allows you to select and run an API script. For details on API scripts and a complete list of all API scripting commands, please refer to the vGATE API manual. Call/SMS Generation Settings... You can set a maximum number of calls or SMS messages that can be sent simultaneously from the system. Enter the maximum number in the dialog that appears or check No limit if you do not want to set a limit. To set different limits for individual iGATEs, see Chapter 7.15 Editing mobile gateways. The setting in vGATECtrl will take priority over limits set for any individual iGATEs. Automatically Delete SIMs Not in SIMUnit... Allows you to determine when SIMs that are no longer in the SIMunit can be deleted from the database. Additional SIM Search Strategy Use this option to define one or two search strategies which the vGATECtrl uses to assign a SIM card to a controller. Allows you to Prefer Prepaid SIMs with No Limit, Prefer SIMs with Highest Maximum Limit, or Prefer SIMs with Lowest Count. Set the first flag to use a prepaid SIM card with no limit whenever it is available. If you set the second flag, the assigned SIM card with the highest maximum limit will be used whenever it is available. If you set the third flag, the SIM card with the lowest count will be used whenever it is available. You can combine the first with the second or the first with the third option. In such a combination, Prefer Prepaid SIMs with No Limit always has the highest priority. vGATE 17.1 Page 131 9 Table 9.1 i vGATECtrl vGATECtrl options (page 2 of 2) Command Description Active SIM Release When this option has been set and Active Release is checked in the Limits dialog of the vGATEDesktop, the active SIMs will be released when the number of minutes entered in the Limits dialog of the vGATEDesktop has passed. (cf. Chapter 7.6 Setting time limits and pauses.) Release All SIMs if Timezone Changes Click here for all SIMs to be released at the beginning of a new timezone. The next reserved SIM will be activated or the released SIM will be immediately reactivated if there are no other SIMs reserved. Reset SIM Counter Daily The limit 1 and limit 2 counters will be reset at zero every day at midnight. The vGATEDesktop Count (L1) Yesterday and Count (L2) Yesterday columns will show the Max Limit 1 or Max Limit 2 units used on the previous day. Initially Block New SIMs New SIMs that are inserted in the vGATE SIM Unit will be blocked following initialization. Suppress Quality Indications The Received Signal Strength Indication (RSSI) status will not be sent to the vGATE. Bear in mind that that New Protocol must be set in the mobile gateway’s edit window for this feature to work. Reset Gateway Port Statistic on SIM Change New statistics will be logged for a controller when a new SIM is assigned. Old statistics for the previous SIM are sent to the vGATE. Use vGATEWatch Sets the watchdog function. If vGATECtrl or the database shut down improperly, they will automatically restart following one minute. Send External SMS vGATECtrl will check once a minute whether you have entered external SMS to send. If you do not wish to send external SMS, deactivate this function. Use Change Limit For Prepaid SIMs The change limit is applied to prepaid SIMs. You must restart the vGATEDesktop to activate the feature. Use External Recharge This feature will be available in a future version. Use Impersonator This functionality is currently not being used. Save Incoming SMS/USSD in Database Incoming SMS and USSD messages will be saved in the database. Save Incoming SMS/USSD in Logfiles Incoming SMS and USSD messages will be saved in a logfile named ReceiveMSG_date_number.log in the data folder in the SMS subfolder. A logfile is created every six hours. Each entry contains the time, IP address of the sending gateway, controller number, IMSI, OAD, and message. Save CDR/Failed Logfile in Database CDR and failed logfiles will be saved in the database. If you are using a dial-up connection, wait at least twenty seconds following your last command before you disconnect. vGATE 17.1 Page 132 10 vGATEWatch 10 vGATEWatch The vGATEWatch is a watchdog function that causes vGATECtrl, the database, iMNP, and/or the vGATERoutingManager to restart if they shut down improperly. Figure 10.1 vGATEWatch window To activate vGATEWatch, select Use vGATEWatch from the Options menu in the vGATECtrl application (default setting). Now vGATEWatch will start up automatically when vGATECtrl starts up, and the icon will appear in the taskbar’s right-hand corner. If you select Stop Watching from the context menu, the icon will appear in the taskbar and the watchdog function will shut down. Click Restart Watching to restart the function. Double-click the icon or select Restore from its context menu to open vGATEWatch. From the Options menu, you can turn sound on or off, so that an alarm sounds when vGATECtrl or the database shuts down. Select which application you want to watch. Select Reboot if Database Not Running and the computer will restart whenever the database shuts down. Select Watch Database Service to check if the database is still running. If it is not running, the database is restarted or, if Reboot if Database Not Running is checked, the computer rebooted. Finally, select Set Database Service Name ... to enter the service name of your database. vGATE 17.1 Page 134 11 Appendix 11 11.1 Appendix Starting the Windows2003 control unit without logon To start up the Windows2003 Control Unit without logging on, for example in the case of power failure, click the RegTool AutoLogon.reg. Bear in mind that if the user name: simdbuser and password: simdb have been changed, you must also change AutoLogon.reg accordingly. ClearAutoLog.reg deactivates startup without logon. 11.2 Remote access to the vGATE Control Unit To install a remote client, simply start the versions setup program and select Remote in the Setup Type dialog. You will find the program on the vGATE Control Unit: E:\vGate_Version. The following programs are required for remote access to the vGATE Control Unit: vGATEDesktop.exe vGateConfigRemote.exe libmySQL.dll i The remote PC must be connected to the vGATE Control Unit with an Ethernet connection of at least 10 MB. Configuration for remote access The configuration tool vGateConfigRemote is used to configure the vGATE for remote access . Figure 11.1 Configuration for remote access Use the desktop shortcut to start the program vGateConfigRemote.exe. Answer all queries with OK. In the Database section, leave the default Name as simserverdb. Enter the vGATE Control Unit’s IP address in the Host space and the Port. Enter the User name simdbuser and the Password simdb. vGATE 17.1 Page 136 11 Appendix In the Frontend Server section, enter the vGATE Control Unit’s IP address again in the Host space and do not change the Port. Click Apply or OK. You can now open the vGATEDesktop for remote access to the vGATE Control Unit. Enter the password configured or check Read Only and enter the password configured for readonly access if one has been set (see Chapter 6.2.2 vGateConfig). i Bear in mind that only one vGATEDesktop can be open at a time, regardless of its location. 11.3 Updating the simserverdb database (MySQL only) To update the database simserverdb, you must first close the programs vGATECtrl.exe and vGateDesktop.exe. The following instructions are for updating the MySQL database only. They update vGATE version 15.0.0 to 17.1.0. If you are updating to or from another version, enter the relevant version numbers in the appropriate places. Updating the PostgreSQL database will become relevant with the next vGATE version.. i vGATE version 17.1 is compatible only with MySQL Version 5.1.43. Check your MySQL version before updating the vGATE. If you have an older version, we recommend updating to MySQL version 5.1.43. If you have trouble, please contact TELES service for your update. vGATE 17.1 Page 137 11 Appendix Start the MSDOS command prompt at Start | Programs | Accessories | Command Prompt. Enter D: and press Return. Enter cd mysql\bin and press Return. Enter mysql -u simdbuser -p and press Return. Enter the password simdb and press Return. Enter the command \. (backslash period space) and the path to the script (in this example, on the E: drive): \. E:\vGATE_Version\V17.1\Disk1\DatabaseScripts\DIFF_V1500_V1700.sql Press the Return key. Enter exit to exit mysql. Restart the MySQL service by going to Start | Programs | Administrative Tools | Services, selecting the MySQL service from the list of services, right-clicking on it, and selecting Restart. Uninstall the old version. Start the setup.exe from the folder E:\vGATE_Version\V17.1\Disk1. Select Install. Click Next when the TELES logo appears. When the setup wizard opens, click Next. To select an installation folder, click Browse and choose D:\vGATEControl. Click Next. The default setup type is Control Unit. Click Next. Click Next again to confirm installation. Click Close when installation is complete. Open and confirm all queries with Yes. If necessary, reenter any settings in the shortcuts’ Properties. You can now start vGATECtrl.exe and vGATEDesktop.exe. 11.4 Creating a backup of the database To secure your database, we strongly recommend that you create a backup. Creating a MySQL backup To create a backup of the MySQL database, execute the batch file SimBD-Dump.bat, which you will find in the folder E:\Backup-Database . The file simdbdump.sql will be created and saved in the folder E:\Backup-Database. To restore the database with the backup file, please contact TELES service. Creating a PostgreSQL backup To create a backup of the PostgreSQL database, execute the batch file backup_simserverdb.bat, which you will find in the PostgreSQL installation folder. The file simserverdb_date.backup will be created and saved in the PostgreSQL installation folder. To restore the database with the backup file, please enter the name of the backup file that you want to restore in restore_simserverdb.bat, save the batch file and excute it. The batch file can be found in the PostgreSQL installation folder. If you need any help, please contact TELES service. vGATE 17.1 Page 138 11 11.5 Appendix Troubleshooting Table 11.1 contains a list of problems you may incur and how to solve them. Table 11.1 Troubleshooting Error Cause Solution vGATEDesktop Status Missing IMSI SIM card is missing or defective. Dust or contact problems on the SIM or in the SIM 60 Carrier. SIM card line is red. Registration process failed repeatedly. TCP/IP connection from the iGATE to the vGATE SIM Unit is inadequate or unavailable. Check the TCP/IP connection between the iGATE and the vGATE SIM Unit. SIM card and controller lines are red. Entry in the controller line’s Remote State column. GSM network is overloaded. Missing TCP/IP connection to the vGATE SIM Unit. SIM card has been blocked. Replace the SIM card after the third failed registration attempt. SIM card and controller lines are red. Entry in the controller line’s Remote State column. SIM Broken SIM Blocked Insert another SIM card at this position. Clean the contacts on the SIM and the SIM 60 Carrier with alcohol. Ping Timeout Missing TCP/IP connection to the iGATE. Check the TCP/IP connection between the vGATE Control Unit and the iGATE. Group and iGATE lines are red. Connection refused iGATE cannot be reached. Group and iGATE lines are red. Check the TCP/IP connection. Check the status of the iGATE. Improperly configured Missing vGATE driver on the iGATE. Check the iGATE’s vGATE driver. Group and iGATE lines are red. SIM 60 Carrier not recognized by vGATE SIM Unit Hardware or software failure on the vGATE Module. Inform TELES NetService. SIM positions do not appear in the SIM window of the vGATEDesktop. vGATE 17.1 Page 139 11 Table 11.1 Appendix Troubleshooting (continued) Error Cause Solution vGATEDesktop Status SIM barred Restart the corresponding mobile port manually. Check the TCP/IP connection between the iGATE and the vGATE SIM Unit. Replace the SIM card. Check vGATE configuration in the iGATE. Entry in the controller line’s Remote State column. Change the PIN. All SIM cards in the vGATE must have the same PIN. Reassign the SIM card. Entry in the controller line’s Remote State column. Registration process unsuccessful. SIM card is blocked. Wrong PIN SIM’s PIN is incorrect or different from that of the other SIMs. CTRL incorrectly configured Controller has not been defined as prepaid. Assign SIM to a correctly configured controller or configure controller as prepaid. Entry in the controller line’s Error column and controller line appears in red. No recharge number found Recharge number missing from recharge list. Enter a recharge number in the list. SIM line highlighted in yellow and entry appears in the Error column. Sending recharge call (OK), no answer, no limit indication after 2 minutes. Carrier does not respond to recharge call within 2 minutes. Wrong recharge number. Try again with the same SIM. SIM line highlighted in yellow and entry appears in the Error column. Scripting error. No answer to USSD query. SIM line highlighted in red and entry appears in the Error column. Job timeout during wait. 11.6 Check script for mistakes. Try again. Supported mobile gateways Table 11.2 contains information about the gateways supported by the vGATE and their compatibility requirements. A vGATE license is required for each mobile gateway. Table 11.2 Supported mobile gateways Hardware vGATE License As of Version iGATE GSM SIM 14.6 iGATE 3G SIM 14.6 ECOTEL GSM SIM 14.6 ECOTEL 3G SIM 14.6 vGATE 17.1 Page 140 TELES AG | HEADQUARTERS Ernst-Reuter-Platz 8 10587 Berlin GERMANY Phone +49 30 399 28 066 Fax +49 30 399 28 051 E-mail sales@teles.com http www.teles.com