ISIP gateway INSTALLATION AND OPERATIONS GUIDE

Transcription

1 ISIP gateway is the ISDN to SIP converter that enables SIP trunk resellers to cost effectively provide voice services to legacy PBXs. The product set includes the BRI converter (ISIP 8 ), the PRI converter (ISIP 30 ) and access to the ISIP Management Portal. ISIP gateway INSTALLATION AND OPERATIONS GUIDE The ISIP gateway units are set-up and maintained from the ISIP cloud based Management Portal which also provides you with real time performance monitoring of all your installed ISIP gateways. This document provides the set up and operational management guidance to facilitate cost effective installation, monitoring and support of these products. V1.2 December 2016

2 INTRODUCTION... 3 ISIP - THE ISDN TO SIP CONVERTER BRI/PRI... 3 ISIP GATEWAY LAYOUT... 5 ISIP 8 - THE ISDN TO SIP CONVERTER FOR BASIC RATE ISDN (BRI)... 5 ISIP 30 - THE ISDN TO SIP CONVERTER FOR PRIMARY RATE ISDN (PRI)... 5 ISIP GATEWAY INSTALLATION PROCESS... 6 ISIP MANAGEMENT PORTAL LOGGING ON ISIP MANAGEMENT PORTAL MAIN PAGE... 8 CREATING A NEW ORGANISATION OR CUSTOMER... 9 SELECTING A NEW CUSTOMER OR ORGANISATION DEVICE LIST DEVICE LIST - ADDING A DEVICE DEVICE LIST - ACTIONS INSTALLATION WITHOUT THE MANAGEMENT PORTAL APPENDICES SIP FROM FIELD SIP PAI FIELD GATEWAY SERIAL NUMBERS FIREWALL PORTS FACTORY RESET (NOT ADVISED WITHOUT SPECIFIC AUTHORISATION) TESTED PBX S SIP SUPPLIERS

3 INTRODUCTION ISIP - The ISDN to SIP Converter BRI/PRI The Basic Rate ISDN to SIP Converter (ISIP 8 ) is delivered with 4 x BRI Ports, supporting 4 x Basic Rate ISDN connections from a PBX. It also presents 1 x SIP port, which can support up to 8 x trunk channels (2 per BRI). The Primary Rate ISDN to SIP Converter (ISIP 30 ) is delivered with 1 x PRI Port, supporting 1 x Primary Rate ISDN connection. It also presents 1 x SIP port which can support up to 30 x SIP channels. Simple Installation Comprehensive Performance Monitoring Simple, Controlled Serviceability To facilitate the installation you will require the following hardware and configuration information: 3

4 Network Connection to a network capable of supplying a DHCP address and POE connectivity to a Class One specification. ISDN PBX with either a BRI or PRI interface installed. BRI or PRI Cross-over cables. (Supplied with the ISIP gateway) SIP SIP Trunk details supplied by the provider, typically: IP address of SIP trunk. User name and password if not using IP authentication. Ports to be used for signalling and RTP. NAT Address if being used. Number presentation IE 4, 6 or all digits being sent. Other Network cables for connection between the network ports network and BRI/PRI ports on the gateway. These are standard Ethernet cables. 4

5 ISIP Installation and Operations Guide V1.2 December 2016 ISIP gateway Layout ISIP8 - The ISDN to SIP Converter for Basic Rate ISDN (BRI) The Basic Rate ISDN to SIP Converter (ISIP8) is delivered with 4 x BRI Ports, and a single Network Port that can support up to 8 x SIP Trunk channels (2 per BRI). ISIP8 ISIP8 Connections Network BRI BRI POE 2 4 Port BRI BRI 3 1 ISIP30 - The ISDN to SIP Converter for Primary Rate ISDN (PRI) The Primary Rate ISDN to SIP Converter (ISIP30) is delivered with 1 x PRI Port supporting 1 x Primary Rate ISDN connection and 1 x Network Port that can support up to 30 x SIP Trunk channels. ISIP30 ISIP30 Connections Network POE Port PRI 30 NOTE: The ISIP gateway requires a Class 1, POE (Power Over Ethernet) supply. 5

6 ISIP gateway Installation Process Logon as user Add Device Details Plug in Device Configure Network Connect ISDN to PBX Check Network and Device Details No SIP and ISDN in Service? Make Test Calls 6

7 ISIP Management Portal Logging on. To access or create any customers and Devices you will first have to login to the ISIP Management Portal. Your Portal details will have been passed to you with your first order. Your login details will be your address and a temporary password. It is essential that you change this temporary password as soon as possible. Enter your address Enter your password and click Login NOTE: Please change your password after logging on for the first time. When attempting to login, if you enter an incorrect user or password you will be warned by the following pop up messages. Incorrect user Incorrect password Successful logon 7

8 ISIP Management Portal Main Page After successfully logging on you will see the Main configuration page, this page shows you your Customers and Resellers as well as well as any Devices that belong to your organisation, The third section shows you the users (your colleagues) that are configured and allowed to make changes within your organisation. Select:- Add to create a new Customer or Reseller. Edit to, edit an existing Customer or Reseller. Details to show the Customer or Resellers Select:- Add to create a new Device. Edit, to edit an existing Device. Select All, to select all Devices to modify. Clear Selection, to clear the current selection. Action, to perform actions on the selected Devices. Select:- Add, to create a new user. Edit, to edit a selected user. 8

9 Creating a new Organisation or Customer The new organisation page lets you enter the details for a new Organisation or Customer. The Management Portal is structured such that each Organisation has the ability to add more organisations (sub-resellers or customers) to their estate. Once the new details have been entered click Save to enter them into the Management Portal. Select Cancel, to discard the entry. Save, to Save the new Customer or Reseller 9

10 Selecting a new Customer or Organisation Once you have created your new Customer or Reseller you can use the Orange chevron to drill down into the Devices and users page. Click the Orange chevron to drop down a level to see those Reseller Devices. After clicking on the chevron, you can see the Customers /Resellers Devices. GB Limited is the Main Organisation One Resale Ltd, is a Reseller of GB Limited Devices of One Resale Ltd 10

11 Adding users Adding a user for an Organisation will allow that user to create other users, sub-resellers and customers. You may use this capability to assign specific customers or parts of your estate to individual colleagues. Your top-level users will always have access to all your Devices. Once entered the new user is shown against the organisation. Use a strong password List of configured users for your Organisation 11

12 Device List The Device list shows the details and current state of each ISIP gateway in the selected organisation. You can now Add Devices or select an existing Device or Devices to Edit the selected Device or apply Actions against several Devices, e.g. Upgrade or reboot. Last Update shows the last time the Portal received a status update. If a status is missed this will be Red Licence Status Green = In Service Red =Out of Service ISDN Status Green = In Service Red = Out of Service SIP Trunk Status Green = In Service Red = Out of Service 12

13 Device List - Adding a Device While the ISIP gateways are associated with the customer specific software before leaving the factory, the reseller is the entity who knows their customers specific configurations. As such the reseller is responsible for adding/amending and configuring each customer Device. When you add a Device you have 3 sections to fill out on the Management Portal to make the Device active. Device Settings Serial Number This is the MAC address / serial number of the ISIP Device. Description A free form description for the Device e.g Tesco Watford main Licence Key The licence keys are generated and associated with the MAC address of the SIP module for that customer. Capacity This is the number of Licenced SIP Channels for this Device NAT Mode Use if Network Address translation is required, if you are using a public NAT server or there is one supplied by the SIP provider. NAT Port This is the port used by NAT, generally 5060 is used. Server Port The port used by the SIP trunk for Signalling purposes, normally set to

14 SIP Trunk Settings Trunk Name Registration Username Registration Password Presentation Number A Descriptive name for the Trunk. If not IP authenticated, enter the Registration user name here. Enter the password for the above. This is the number that will be presented to the called party if no other is specified. Local Area Prefix Enter the local STD code here to enable local numbers (eg: 01923) to be called without having to enter the STD code. International Prefix Sets the prefix used to incoming International calls, Default =00 Country Prefix Digits to ISDN Country Prefix, used to determine the county specific code IE UK=44 Sets the maximum number of incoming DDI digits to present to the PBX, If left as 0 then the full number will be sent. 14

15 SIP Service Settings Protocol This lets you choose between UDP and TCP, based on the SIP providers specification. Server Address This is the IP address or Domain name used by the SIP provider. Server Port UDP or TCP port used by the SIP provider, normally set to Registrar Address If user Authentication is being used, enter the Domain or IP address as provided by the SIP Supplier. Incoming Prepend Pre-pend a number to the incoming CLI if + is not found. If + or 44 is found then the National prefix is used. Outgoing Prepend Pre-pend a number to the outgoing number dialled. From Field Use this to customise the FROM field of the SIP INVITE to match the SIP providers requirements. See section 6 notes for further details. P-Asserted-Identity Field Use this to customise the P-Asserted-Identity Field to match the SIP provider s requirements: See section 6 notes for further details. Called-Party-ID Disable Disable the called Party ID field in the INVITE. P-Time Use this to specify an RTP Packet time of 30ms or 20ms. Dial Min Digits Specify the minimum number of digits to be sent to the SIP supplier. Dial Timeout (ms) Use this to set the inter-digit timeout before sending the call to the SIP Provider. Withhold CLI Prefix Enter the code used by your region to withhold sending of the CLI. Disable Options Ping Disable the sending of OPTIONS packets to see if the SIP trunk is available. Disable Progress Stop session progress messages being sent to the SIP Trunk. Special Numbers Comma separated list of special numbers that should be sent to the SIP Supplier immediately they have been matched, IE 999, 121 etc 15

16 Update Settings Once you have added your customer details or made any changes, you have the option to apply these in four different ways:- Next power cycle Selecting Next power cycle will make the ISIP gateway request any setting changes made and initiate a power cycle to install them. Next update Selecting Next update will provide the setting changes to the ISIP gateway during the next poll from it. When free Selecting When free will provide the setting changes to the ISIP gateway during the next poll from it, however, if there are any calls currently in progress the ISIP gateway will not complete the upgrade until there are no live calls. Specific Time Selecting Specific Time will provide the setting changes to the ISIP gateway during the next the next poll from it and complete the upgrade at the time specified below. 16

17 Device List - Actions After choosing a Device; clicking on Action gives you a drop down list of three options, Reboot, Upgrade and Disable. Enter the time Select in 24H one Format several Devices to perform an action on. Once selected, click the Red Action button. Reboot Selecting Reboot pops a window allowing you to choose from 3 Reboot options - Click the dropdown menu to choose the reboot option. Next status poll. This option will reboot the unit after receiving the next status poll (initiated approximately every 15 minutes) from the selected Device, regardless of if there are calls in progress or not. When free after next status poll. This option will trigger the reboot after receiving the next status poll, however the Device will wait for calls to finish before it reboots. NOTE: If the site is busy you may decide to select another method of rebooting. The new method selected will take over from the previous method selected after the next Device poll. Specific time. This option allows you to specify a day, hour and minute to reboot the Device. Select the day for the reboot from the drop down list of days, then enter the hour in 24h format followed by the minute. The following example would reboot the Device on Sunday morning at 2am. 17

18 Software Upgrade From time to time, a new software release may be issued for one or more of the ISIP gateway products. Should you choose to you can upgrade one, a selection, or all of the Devices in your estate by selecting the Devices from your organisation s Device list and selecting the Upgrade action from the red Action button. You will see a pop up window similar to the Reboot window. Select the version of software to use from the drop down list Select the method to apply the upgrade From here you have the same options to perform the upgrade as After software download The selected Device(s) will get the new software form the Management Portal software download area and then reboot.. When free after software download The selected Device(s) will get the new software form the Management Portal software download area and then reboot when there are no active calls on the Device. Specific time This option enables you to specify a day, hour and minute to upgrade the software and reboot the Device(s). Select the day for the reboot from the drop down list of days, then enter the hour in 24h format followed by the minute. The following example would reboot the Device(s) on Sunday morning at 2am. 18

19 Disabling a Device It might be necessary to disable for administrative purposes, doing this will stop any calls from being passed through the converter. When disabling a Device you will be prompted for a reason for doing so. This is a mandatory field providing an audit trail of critical operational changes. After disabling the Device, its wording will be struck through and have a status of Disabled. 19

20 Installation without the Management Portal If for some reason the Management Portal is unavailable, you can setup the ISIP gateway by using the inbuilt Web Pages (Please note that when the gateway next contacts the Management Portal, all settings in it will be over-written by those stored in the Portal). Accessing the ISIP gateway Plug the gateway into a POE switch or POE power supply using the LINK connector. When the unit is ready the amber light on the Link connector will be steady. System Run Light Using a network connected PC, initiate a network search to show the PC s on the network. You will see the gateway in the list: ISIP -xxxxxx where xxxxxx are the last 6 digits of the gateway s MAC address. This can be verified against the Serial Number provided on the label on the underside of the gateway. Using a browser enter ISIP -xxxxxx.local into the search bar of your browser. The following web page will be displayed showing the Device s last status. To get an up-to-date status click the Refresh button. ISIP 30 ISIP 8 PLEASE NOTE: If passwords have been set, you will see the logon screen below, requiring the correct password to be entered in order to see the Status Page above. 20

21 Status Page The Status page shows you the uptime of the Device as well as the SIP, ISDN, Licence and Provisioned Status. NOTE: This may not mirror the status on the Management Portal as the Portal will only display the current Device state after it has received a status poll. Last Provisioned Time SIP and ISDN Status Green = Circuit in Service Red = Circuit out of service License Status Green = Valid Licence Red = Invalid Licence Device has not yet been provisioned Circuits out of service 21

22 Support Page The support page is accessed by entering ISIP-xxxxxx/support.html where xxxxxx are the last 6 digits of the gateway s MAC address. Any changes made may be overwritten once the ISIP gateway provisions to the Management Portal. 22

23 Network Configuration The Network Setting defaults to DHCP. If you wish you change from DHCP to Static, simply check the radio button in the Network Configuration Type frame and manually enter the IP Address, Netmask and default router (Router address where the SIP trunk comes in) and DNS for the ISIP gateway. 23

24 Password Configuration Use the Password Configuration frame to set the passwords for the Support page, the Network page and the Status Page. Note: The default password for both the Support and Network pages is ChangeMe. This must be changed to more complex passwords for acceptable security. Manually Entering a Licence Use the Licence frame to manually enter the customer s licence and the number of channels (Trunks) that will be used. Note: A reboot will be required after entering this. Note: This is a requirement purely for testing the gateway. Under normal operation all licences are installed in the Management Portal at source, and no inputting of licences are required. Licences entered into the Management Portal are automatically downloaded to the gateway. 24

25 Adding Special Numbers Use the special numbers section to enter any extra 3 digit numbers the customer requires beyond the standard (UK) Special Numbers provided as default (999,112,111,101) NOTE: If you enter any 2 digit numbers into the special numbers these will take precedence, i.e. the shortest pattern will match first. (e.g.) If you enter 99 you will not be able to make a 999 call as the two-digit 99 number will be called. 25

26 SIP/PBX Configuration To manually configure the SIP trunk and gateway to work, several fields have to entered correctly. Take note of the SIP settings the SIP provider has sent you and apply them to the SIP Fields. You will also have to take note of some of the existing PBX settings so that number presentation works correctly. 1. To give the trunk a descriptive name. 2. To set the main number that will be sent if no other number has been specified. 3. To specify the number of digits being sent to Line. 4. The time to wait before sending digits to line. 5. Input the maximum number of incoming DDI digits to present to the PBX. If left unticked or blank, the full number will be sent to the PBX. 6. Specify the code used to withhold outgoing CLI. 7. Enter the local STD code here to enable local numbers (eg: 01923) to be called without the STD code 8. Sets the prefix used for incoming National calls default = 0 Sets the prefix used to incoming International calls default = 00 Country Prefix, used to determine the country specific code IE UK = Pre-pend a number to the incoming CLI if + is not found. If + or 44 is found then National prefix is used 10. Pre-pend a number to the outgoing number dialled. 11. This is the IP address of the SIP provider 12. Used to specify the RTP packet time 26

27 SIP/PBX Configuration (Continued) 13. If the SIP trunk requires user authentication, enter the Registrar server IP address, User Name, Password provided by the SIP Provider. 14. Used to specify the port number used by the SIP supplier for signalling purposes. 15. Use if Network Address translation is required. Use a public NAT server or one supplied by the SIP provider. The address of the NAT server The NAT Server port 16. See Appendices for a full explanation of :- SIP From and SIP PAI fields 17. If the SIP circuit uses TCP instead of UDP then tick this entry. 18. Session progress messages from being sent 19. Options detect if the SIP circuit is up or not. If the gateway does not receive an OK to the OPTIONS packet, then after a while it will Assumed that the trunk is down. 20. Use this to Disable the called party ID if required. 27

28 Completing Changes After making any changes on the gateway, the changes must be saved. They are not made active until the gateway is re-booted. NOTE: Unlike the Management Portal where you can select reboot when free; selecting reboot will reboot the Device straight away and cut off any current calls. 28

29 APPENDICES SIP From Field Use this configurable from field to manipulate INVITEs. In general this can be left blank. However if the provider wishes other information in the INVITE then use this field to manipulate the data. <presentation number> <account address> the field takes text strings and we have 3 substations available: %s == Source number (e.g ) - Mapped from DDI etc.. %c == Account number (e.g ) %u == User so a blank entry is equivalent to: %s %c@<module address> Example entry in SIP From Field %s@sip.providor.com To ensure CLI number is presented. If the trunk is configured to register, then the default From URI will be the registration URI. If you set the From Field setting on the trunk, this will override the From field, and present the configured URI. For example, the following setting will present the actual source number: %s@sipgate.co.uk So, the %s is replaced by the caller number. This number will have been mapped through the DDI plan to get an external number, eg: User 421, DDI maps 421 to , From Field maps to < @sipgate.co.uk>. 29

30 SIP PAI Field If nothing is entered into the PAI field, the PAI header will be populated as it is now. eg: If the trunk is using registration username and password authentication the PAI header will be: P-Asserted-Identity: REGISTRATION_USERNAME" If the trunk is IP Authenticated the PAI header will be: P-Asserted-Identity: TRUNK_PRESENTATION_NUMBER" If the trunk is IP Authenticated and there is no entry in the trunk presentation number field the PAI header will be: P-Asserted-Identity: SOURCE_CLI" The PAI header field can be customised using: <display number> The field takes text strings and we have 3 substations available: %s == Source CLI (e.g ) %c == Registration User Name (e.g ) %u == user (e.g. Peter Piper) The %s value is the outgoing CLI to be presented for a specific user when making an external call. It is determined in the following order : 1. Dial Plan - Translate CLI To field 2. DDI Call Plan Entry 3. Trunk Presentation Number field eg: using the source CLI example above ( ) %s %s@ would display as: P-Asserted-Identity: " <sip: @ > 30

31 Gateway Serial Numbers On the front side underneath the ISIP gateway you will find the serial number, use the last 6 digits of the MAC address to gain access to the status page as described in the Installation section. Firewall Ports The following ports need to open on the customer s firewall in order for the ISIP Converter to work: SIP Signalling port normally 5060 RTP Ports 6000 to 6299 Port 443 for updates and provisioning. Factory Reset (Not advised without specific authorisation) If you need to factory reset the ISIP gateway, you can do this by unplugging the Device and gently inserting a paperclip into the reset aperture. When you feel a click, keep the paperclip pressed in and insert the Network Cable. After a short period of time the run light will flash. At this point press the reset button 4 times. After this is done the run light will flash rapidly before the Device restarts. When it comes back up all configuration will be cleared. NOTE: After the Device has rebooted it will attempt to get its configuration from the Management Portal, Please make sure that any required changes are made on the Portal before performing a factory reset. System Run Light System reset aperture 31

32 Tested PBX s The ISIP 8 and ISIP 30 gateways have both been tested against the following PBX systems.. Manufacturer Alcatel Avaya BT LG/Nortel Mitel Panasonic Samsung Siemens SpliceCom Toshiba Model Omni PCX IP Office / IP500 Versatility ipldk CX, CXI, MXE KX-NCP Office Serv HiPath Maximiser CIX / CTX SIP Suppliers The ISIP 8 and ISIP 30 Gateways have both been tested against the following SIP Providers. Gamma Telecom Talk Talk Business / tipicall Voiceflex 32

33 33