OneStream Programming Guide Version 5
OneStream Programming Guide Document Control Date Oct 2006 Jan 2007 May 2007 Jan 2008 Feb 2008 Document Version Draft 1 Draft 2 3 4 5 Change Authority First Draft Release of Document Added Status web page Added Flexible / Failover Routing Added OneStream Versions Added Virtual Extensions / s routing EC Declaration of Conformity EC Declaration Of Conformity to R &TTE Directive 1999/5/EC Manufacturer: TelecomFM Development Ltd 895 Plymouth Road Slough Berks SL1 4LP UK Product/Apparatus: Onestream Typ
OneStream Programming Guide CONTENTS 1. INTRODUCTION ...................................................................................................... 5 2. NETWORK SETTINGS .............................................................................................. 5 3. FINDING THE IP ADDRESS OF THE ONESTREAM UNIT ............................................. 6 3.1 3.2 4. INSTALLING THE ONESTREAM SCANNER APPLICATION........................................
OneStream Programming Guide 4.10.3 Bootloader Update ..................................................................................... 4.10.4 FPGA Update.............................................................................................. 4.11 DIAGNOSTICS ................................................................................................. 4.11.1 Runtime Log .............................................................................................. 4.11.2 Startup Log.............
OneStream Programming Guide 1. Introduction Please refer to the OneStream Hardware Installation Guide for instructions on the physical installation of the unit. In order to program the OneStream unit it must be connected to a 10Mb/s or 100Mb/s Local Area Network and you must have access to a PC connected to the same network. If no Local Area Network is available the OneStream unit can be configured by connecting it to a PC via a standard Ethernet Crossover cable.
OneStream Programming Guide 3. Finding the IP Address of the OneStream unit If the OneStream has been assigned an IP Address automatically from a DHCP Server or if a static IP Address has already been set then the IP Address of the unit can be found using the OneStream Scanner application, which is available to download from the Support section of the TelecomFM website, www.telecomfm.co.uk. 3.1 6 Installing the OneStream Scanner Application a. Double-click the “OneStream Scanner Setup.exe”.
OneStream Programming Guide d. To install to the Default folder location click the Icon of a computer. The following dialog will be displayed: e. Click the Continue button to start the installation. When the installation has finished the following dialog will be displayed: f. Click the OK button to exit the installer. The OneStream Scanner is now installed and ready to use.
OneStream Programming Guide 3.2 Using the OneStream Scanner Application a. Click on the Start menu, All Programs, OneStream Scanner, OneStream Scanner to start the application. The following window will appear: b. To scan the network that your PC is connected to for OneStream units using the default program options click the Start Search button. This will scan the Class C network subnet that the PC is in. For example, if the IP Address of the PC was 192.168.100.
OneStream Programming Guide c. Click on the IP Address of the unit you wish to configure and the Web Configuration Utility will be launched. d. Using Advanced Options: To search an alternative range of IP Addresses to the default subnet click the Advanced button.
OneStream Programming Guide To specify a range of IP addresses to scan select the Manual option and enter the Start and End IP Addresses of the range. For example, to scan the range 192.168.50.10 – 192.168.51.80 the dialog would look as follows: Click the OK button to return to the Main program window and then click the Start Search button to scan the new range of IP Addresses: To return to the Automatic Search option click the Advanced button again. Select the Automatic option and click OK.
OneStream Programming Guide 4. The Web Configuration Utility The Web Configuration Utility is used to configure all of the options for the OneStream unit, including Networking, Interfaces, Routing, Security and Audio settings. In order to access the Web Configuration Utility the IP Address of the OneStream must be known. If the IP Address is not known refer to Section 3 above for instructions on finding the address. 4.1 Starting the Web Configuration Utility a.
OneStream Programming Guide c. Enter the Password for the OneStream unit and click the Login button. The default password is 12345678. If the password entered is correct you will be taken to the Welcome (Home) page d. You can now select from the Links on the left of the Page to configure the OneStream unit. The options are as follows: Home Return to the Welcome (Home) Page. Groups Configure the Physical Interfaces (GSM Modules, FXO and FXS Ports) and Virtual Interfaces (IP Connections).
OneStream Programming Guide 4.2 Welcome (Home) Page From the Welcome Page you can see the following information: 4.2.1 System Information 1. 2. 3. 4. 5. 6. 7. 8.
OneStream Programming Guide 4.2.2 SIP Networks The SIP Networks section displays the current status of all SIP network registrations that have been setup on the OneStream unit. This will show whether the unit has registered successfully or whether there is a problem that is preventing registration, such as the wrong password being entered in the Group or if a firewall is blocking the port being used for registration.
OneStream Programming Guide 4.3 Groups The Groups Page allows you to setup groups of physical interfaces and configure IP connections. These Groups are then used later to setup call routing options. There are 7 different types of Group (the available Groups will depend on the version of OneStream purchased): GSM (OneStream G / GFX / GBRI only) Group containing 1 or both of the OneStream’ s GSM Modules. By default, the unit has 1 GSM Group (named GSM) that contains both GSM modules.
OneStream Programming Guide DISA (Direct Inward System Access) (All OneStream versions) Group used to allow incoming calls to be answered and a secondary dialtone to be offered, allowing the caller to dial a new number and be routed accordingly. By default, the unit has no DISA Groups. 4.3.1 Adding a Group To add a new group, use the following procedure: a. Click the Groups link from the left hand menu. b. Click the Add Group button. The following screen will be displayed: c.
OneStream Programming Guide 4.3.2 Editing an Existing Group To edit an existing group, use the following procedure: a. Click the Groups link from the left hand menu. b. icon next to the Group that you wish to modify. The following screen Click the Edit will be displayed: c. Make any changes that are required – the options are described for each interface below. d. Click the Save button to apply the changes to the Group. Click the Cancel button to undo any changes made to the Group.
OneStream Programming Guide 4.3.3 Deleting a Group To delete an existing group, use the following procedure: a. Click the Groups link from the left hand menu. b. icon next to the Group that you wish to remove. The following Click the Delete screen will be displayed: c. To delete the Group click the Delete button. To return to the Groups page without deleting the Group click the Cancel button. Note that once a Group has been Deleted it cannot be recovered.
OneStream Programming Guide 4.3.4 Group Options The following are the Group options available for each of the different interface types: 4.3.4.1 GSM (OneStream G / GFX / GBRI only) Name Enter a Name to identify this group. You cannot have 2 groups with the same name. Select Interfaces Place a tick in the checkbox next to each of the interfaces you wish to be used by this group. Note that each interface can only be selected in 1 Group. CLI Controls CLI Presentation for Outgoing GSM Calls.
OneStream Programming Guide 4.3.4.2 Analogue FXS (PBX) (OneStream GFX only) Name Enter a Name to identify this group. You cannot have 2 groups with the same name. Select Interfaces Place a tick in the checkbox next to each of the interfaces you wish to be used by this group. Note that each interface can only be selected in 1 Group.
OneStream Programming Guide Hunting Select the hunting type required – this controls in which order interfaces are selected to send calls to. Options are: a. b. c. Sequential (Low First) Calls are sent to the lowest available interface. Sequential (High First) Calls are sent to the highest available interface. Cyclic Calls are sent to interfaces in turn (i.e. A “Round Robin” setup). Outgoing Options Select the Supervision options for Outgoing calls from the following: a. b. c.
OneStream Programming Guide 4.3.4.3 Analogue FXO (PTT) (OneStream GFX only) Name Enter a Name to identify this group. You cannot have 2 groups with the same name. Select Interfaces Place a tick in the checkbox next to each of the interfaces you wish to be used by this group. Note that each interface can only be selected in 1 Group.
OneStream Programming Guide Hunting Select the hunting type required – this controls in which order interfaces are selected to send calls to. Options are: a. b. c. Sequential (Low First) Calls are sent to the lowest available interface. Sequential (High First) Calls are sent to the highest available interface. Cyclic Calls are sent to interfaces in turn (i.e. A “Round Robin” setup). Connect Options Select the Supervision options for calls from the following: a. b.
OneStream Programming Guide 4.3.4.4 SIP Network Name Enter a Name to identify this group. You cannot have 2 groups with the same name. SIP Proxy Enter the fully qualified domain name or IP Address of the SIP Proxy Server or SIP PBX that the calls should be routed to. SIP Port Enter the SIP Port that is used by the SIP Proxy / PBX. The default SIP Port is 5060. Domain (Optional) Enter the Domain Name of the SIP Proxy / PBX, if required.
OneStream Programming Guide Registration Required Place a tick in this checkbox if the SIP Proxy / PBX requires that the OneStream register and login. Username (Optional) Enter the Username required by the SIP Proxy / PBX. Password (Optional) Enter the Password required by the SIP Proxy / PBX. Contact (Optional) Enter the contact extension that will be used by the remote SIP Proxy to send calls to OneStream.
OneStream Programming Guide 4.3.4.5 SIP Extension Name Enter a Name to identify this group. You cannot have 2 groups with the same name. Username Enter the Username that will be required for the SIP device to register with the OneStream. Password Enter the Password that will be required for the SIP device to register with the OneStream.
OneStream Programming Guide 4.3.4.6 H.323 Name Enter a Name to identify this group. You cannot have 2 groups with the same name. H.323 Gatekeeper Enter the IP Address of the H.323 Gatekeeper or H.323 PBX that the calls should be routed to. H.323 Port Enter the H.323 Port that is used by the H.323 Gatekeeper / PBX. The default H.323 Port is 1720. Registration Required Place a tick in this checkbox if the H.323 Gatekeeper / PBX requires that the OneStream register and login.
OneStream Programming Guide 4.3.4.7 DISA (Direct Inward System Access) Name Enter a Name to identify this group. You cannot have 2 groups with the same name. Password Enter the Password that callers will be required to enter to access the system. This may be left blank (IMPORTANT: If the password is left blank then all routes to the DISA Group should be restricted using an “Originating Number” otherwise the system would left open to any callers).
OneStream Programming Guide 4.4 Routes The Routes Page allows you to configure how the OneStream routes calls between Groups. Groups must already have been configured before the Routing can be setup (see the previous section for instructions on setting up Groups).
OneStream Programming Guide 4.4.1 Adding a Route To add a new Route, use the following procedure: 30 a. Click the Routes link from the left hand menu. b. Click the Add Route button.
OneStream Programming Guide c. Fill in all of the required options. Depending on the Groups selected some options will not be available – these options will be greyed out. Options are as follows: Name (Required) Enter a Name to describe the Route. From Section The following 3 options apply to origin of the call: From Group (Required) Select the Group that the Calls will originate from in the drop-down list. Dialled Numbers (Required) A list of dial prefix’s to match. Enter 1 dial prefix on each line.
OneStream Programming Guide To Section The following 3 options apply to the destination of the call: To Group (Required) The Group that calls will be sent to when this Route is matched. Modified Number (Optional) If left blank, the number will be called exactly as dialled. If a number is entered here this number will be called in place of the dialled number. Strip digits (Optional) Select the number of dialled digits to be removed from the beginning of the dialled number.
OneStream Programming Guide 4.4.2 Editing An Existing Route To edit an existing route, use the following procedure: a. Click the Routes link from the left hand menu. b. icon next to the Route that you wish to modify. The following Click the Edit screen will be displayed: c. Make any changes that are required to the Route – see the section on Adding a Route (above) for a description of all of the available options. d. Click the Save button to apply the changes to the Route.
OneStream Programming Guide 4.4.3 Deleting A Route To delete an existing route, use the following procedure: a. Click the Routes link from the left hand menu. b. icon next to the Route that you wish to remove. The following Click the Delete screen will be displayed: c. To delete the Route click the Delete button. To return to the Routes page without deleting the Route click the Cancel button. Note that once a Route has been Deleted it cannot be recovered.
OneStream Programming Guide 4.5 Audio The Audio Page is divided into 3 sections as follows: 4.5.1 Basic Audio Settings Tone Selection Select the country that the OneStream unit is being installed into from the drop-down list. This will set the various tones the system generates (e.g. Dialtone) to emulate those of the local Telephone providers.
OneStream Programming Guide Volumes Listed here will be all of the groups containing physical interfaces that have been set up on the Groups page. Each of these groups has a separate Receive (RX) and Transmit (TX) Volume control. Each volume control is adjustable from Level 1 (Quiet) to Level 5 (Loud). The default setting for all volumes is Level 3. It is recommended that you do not adjust the volume levels of any of the groups unless you are specifically experiencing a problem with sound levels.
OneStream Programming Guide 4.5.3 Call Transfer Settings First Digit Timeout Sets the number of seconds that the OneStream will wait for a digit to be dialled after a * has been pressed to enter call transfer. The default is 6 seconds. An entry is 0 will wait indefinitely for the first digit to be dialled. Inter-Digit Timeout Sets the number of seconds that the OneStream will wait for more digits to be dialled during call transfer before attempting to connect the call. The default is 3 seconds.
OneStream Programming Guide 4.6 Security The Security Page allows you to change the password required to access the web interface and to control SIM and Phone locking for the two GSM Modules (OneStream G / GFX / GBRI only). Options are as follows: 4.6.1 Change Web Interface Password Change the Password that is used to access the Web Configuration Utility. Enter the Old Password (the default password is 12345678), the New Password and confirm the New Password in the Reenter New Password box.
OneStream Programming Guide 4.5.4 GSM Module 1 and GSM Module 2 Locks (OneStream G / GFX / GBRI only) Controls the SIM Lock and Phone Lock for Module 1 and Module 2 respectively. The Locks are explained overleaf. Select only the options that you wish to change and click the Save button to apply all of the selected options (e.g. If SIM Lock for Module 1 is already turned on and you now wish to turn on SIM Lock for Module 2 there is no need to select the Module 1 SIM Lock again).
OneStream Programming Guide 4.6.1.1 SIM Lock (OneStream G / GFX / GBRI only) When SIM Lock is turned ON you will be required to enter the SIM PIN every time the OneStream unit is turned on - until the SIM PIN has been entered no calls will be allowed on the GSM module. a. Turn SIM Lock ON Select the On option and enter the current SIM PIN in the Enter SIM PIN box as shown below (the actual PIN will not be displayed on screen).
OneStream Programming Guide b. Turn SIM Lock OFF Select the Off option and enter the current SIM PIN in the Enter SIM PIN box as shown below (the actual PIN will not be displayed on screen). The SIM Lock will be turned Off when the Save button is clicked (if the entered PIN is correct).
OneStream Programming Guide c. Change the SIM PIN Select the Change SIM PIN option. Enter the current SIM PIN in the Enter Old PIN box. Enter the required New SIM PIN (must be between 4 and 8 digits) in both the Enter New PIN and Re-Enter New PIN boxes as shown below (the PINs will not be displayed on screen). The SIM PIN will be changed when the Save button is clicked (if the Old PIN that was entered is correct).
OneStream Programming Guide 4.6.1.2 Phone Lock (OneStream G / GFX / GBRI only) When Phone Lock is turned ON the GSM Module will be locked to the SIM that is currently inserted. If you wish to use a different SIM with the module you will be first required to enter the Phone Lock Code – until the Code is entered no calls will be allowed on this module. a.
OneStream Programming Guide b. Turn Phone Lock OFF Select the Off option and enter the Phone Lock Code in the Enter Phone Lock Code box as shown below (the actual Code will not be displayed on screen). The default Phone Lock Code is 12345678. The Phone Lock will be turned Off when the Save button is clicked (if the entered Code is correct).
OneStream Programming Guide c. Change the Phone Lock Code Select the Change Phone Lock Code option. Enter the current Phone Lock Code in the Enter Old Phone Lock Code box (the default code is 12345678). Enter the required New Phone Lock Code (must be between 4 and 8 digits) in both the Enter New Phone Lock Code and Re-Enter New Phone Lock Code boxes as shown below (the Codes will not be displayed on screen).
OneStream Programming Guide 4.7 LAN Settings The LAN Settings Page allows you to configure the OneStream unit to use either Automatic or Static networking and to enter all required network settings when using Static networking. Options are as follows: Address Type a. DHCP Select this option if the network the OneStream is connected to has a DHCP Server that assigns IP Addresses automatically. When this option is selected no further information needs to be entered on the Network Page.
OneStream Programming Guide Primary DNS (Static Address Type only) Enter the IP Address of the Primary DNS Server for the network. Secondary DNS (Static Address Type only) (Optional) Enter the IP Address of the Secondary DNS Server for the network. Domain (Static Address Type only) Enter the default Domain for the network. Hostname (Static Address Type only) Enter the Hostname that should be used by the OneStream unit on the network.
OneStream Programming Guide 4.8 Time / Date The Time / Date Page allows you to perform the following operations: 4.8.1 Set Date & Time The current date and time can be set here. For the date, the Day is entered, the Month is selected from the drop-down list and then the year is entered in full e.g. 2006. For the time, the hour is entered and then the minutes. The time is in 24-hour format only. The date and time can be automatically updated via an NTP server.
OneStream Programming Guide 4.9 Load/Save Config The Load/Save Config Page allows you to Backup the configuration of the OneStream unit, Restore a previously saved configuration or restore the unit to a Factory Default configuration. 4.9.1 Load To Load a previously saved configuration: a. Click the Browse button b. Select the .tfm configuration file and click the Open button c. Click the Load Config button to load the configuration.
OneStream Programming Guide 4.9.2 Save To Save the current configuration to a file: a. Click the Save Config button. The following dialog should be displayed: b. Click the Save button c. Select a folder to Save the file to and enter a Filename. Click the Save button. You should see the following dialog: d. Click the Close button. The configuration has now been saved. 4.9.3 Factory Reset To restore the OneStream unit to a Factory Default configuration click the Factory Reset button.
OneStream Programming Guide WARNING: Running a Factory Reset will lose all Groups, Routes and other configuration options set on the OneStream unit. It is recommended that the current configuration is backed up using the “Save” option before running the Factory Reset.
OneStream Programming Guide 4.10 Update Firmware The Update Firmware page allows you to update the system software in the OneStream Unit. DO NOT ATTEMPT TO UPDATE THE FIRMWARE UNLESS SPECIFICALLY INSTRUCTED TO DO SO BY THE MANUFACTURER OR PROVIDER OF THE UNIT.
OneStream Programming Guide 4.10.1 Local Update This will update the main system firmware of the OneStream unit from a file. a. Click the Browse button. b. Select the firmware file that has been provided to you. c. Click the Open button. d. Click the Local Update button. e. When the update completes restart the OneStream unit. 4.10.2 Remote Update This will update the main system firmware of the OneStream unit remotely. a.
OneStream Programming Guide 4.10.4 FPGA Update This will update the FPGA firmware of the OneStream unit locally from a file. 54 f. Click the Browse button. g. Select the FPGA firmware file that has been provided to you. h. Click the Open button. i. Click the FPGA Update button. j. When the update completes restart the OneStream unit.
OneStream Programming Guide 4.11 Diagnostics The Diagnostics Page can be used to gather trace on problems, send the Log Files to TelecomFM and to test Network connectivity. Note: Do Not Adjust the Log settings unless you have been advised to by the Manufacturer or Provider of the Unit. 4.11.1 Runtime Log To start collecting a Runtime log set the trace levels that have been advised to you and click the Start Logging button. All system activity will then be recorded in a log file.
OneStream Programming Guide 4.11.2 Startup Log A Log of all Startup Activities is generated automatically each time the OneStream unit is powered on. To send this file to TelecomFM for troubleshooting click the Send Startup Log to TelecomFM button (a LAN connection must be connected which offers a connection to the Internet for this function to work). 4.11.3 Ping Host To test LAN functionality or DNS it is possible to ping a remote host and view the response.
OneStream Programming Guide 4.12 Restart The unit can be reinitialised from the Restart Page. Click the Restart button to restart – the unit will restart automatically and you will be returned to the Home page after 60 seconds. If the Home Page does not reappear after 60 seconds click the Refresh button on your Internet Browser. (Note that if the IP Address of the OneStream unit has been changed the new IP Address must be entered in the Address Bar of the Internet Browser).
OneStream Programming Guide 4.13 Logout When all configuration options have been set click the Logout link to exit from the Web Configuration Utility.
OneStream Programming Guide 5. 5.1 Additional Features Virtual Extensions The Virtual Extensions feature allows a remote worker to be able to place calls on hold or transfer calls in a similar way that they would when in the office. This feature can be enabled on all types of interface by ticking the “Allow Call Transfer” check box when setting up Routes. A user can place a call on hold by pressing the * key. Pressing the * key a second time will take the original call off hold.
OneStream Programming Guide There are 2 routes required for this setup as follows: The “Fred GSM” route enables any extension on the IP PBX to dial 301 to call Fred on his mobile. The “GSM Call Transfer” route enables Fred to transfer the call from his mobile to any extension on the IP PBX starting with 2. Note that both Routes have the “Allow Call Transfer” option ticked. • Bob is in the office and he dials 301 from the extension phone on his desk.
OneStream Programming Guide A DISA Group is now added (no password is required because it will be restricted to Bob’s mobile CLI): There are 2 more routes required as follows: The “Fred to DISA” route will send all calls received from Fred’s mobile phone into DISA. The “DISA to IP PBX” route will allow any calls dialled from DISA starting with a 2 to the IP PBX. Note that all routes have the “Allow Call Transfer” option ticked.
OneStream Programming Guide • • 62 Fred is out of the office and he wants to speak to Mary. From his mobile he dials the GSM number for one of the SIMs that is in the OneStream. This call is received by the OneStream and sent into DISA. Fred now hears a secondary dialtone. Fred dials 202 on his mobile. Mary’s extension phone now rings. Mary answers her phone and now Fred is talking to Mary. • Mary now dials * on her extension phone to put Fred on hold.
