Standard SIP Terminal IP Phone ITX-1615 Phone Manager User Guide

Transcription

1 Standard SIP Terminal IP Phone ITX-1615 Phone Manager User Guide Before using this product and document, please read the following document carefully. Also, please keep this document to the place where you can see any time. GVT Issue 1.3 June, 2018

2 Table of Content INTRODUCTION... 2 OVERVIEW OF FUNCTIONS AND UI... 3 BASIC FUNCTIONS...3 BASIC INTERFACE...3 TUTORIAL OF FUNCTIONS... 4 INSTALLATION...4 MAKE CONFIGURATION DATA...8 NEW FILE...9 CREATE BY ORDER...13 EDIT...17 SEARCH...19 IMPORT...20 EXPORT...21 DELETE ALL...22 HTTPD SERVICE...23 PNP FEATURE...25 LANGUAGE OPTIONS...26 OPTIONS...27 BOOT AUTO START...27 RECOVERY DATA...28 AUTO HTTPD...29 CONFIGURE HTTPD PORT...30 LIMITATION

3 INTRODUCTION Phone Manager is a powerful deployment tool for ITX-1615 phone. It configures and generates configuration file(s) for one or more ITX-1615 phone(s). This tool will help the phones administrator to deploy phones with simpler operations in less time. This User Guide describes how to use ITX-1615 Management Tool to configure ITX-1615 phones. To learn more about ITX-1615 phone provisioning features, please refer to ITX-1615 User Guide (GVT ) and ITX-1615 Administration Guide (GVT ). Warning: NEC Corporation is not responsible for any solely economic loss such as damages due to a loss of communication caused by any failure/error/trouble of this product or any external factor in power outage. Warning: Reproduction or transmittal of the entire or any part, in any form or by any means, electronic or print, for any purpose without the express written permission of NEC Corporation is not permitted. 2

4 OVERVIEW OF FUNCTIONS AND UI Users use its straightforward and intuitive interface to configure ITX-1615 phones. Phone Manager must be installed on Windows platform. BASIC FUNCTIONS Configure a new configuration file Create configuration files by order Import.CSV configuration file Export.CSV configuration file Start HTTPD service Languages options Options BASIC INTERFACE Open the directory where Phone Manager is installed and double click Phone Manager. The main screen is shown below: *Microsoft, Windows, and the Windows logo are trademarks, or registered trademarks of Microsoft Corporation in the United States and/or other countries. 3

5 TUTORIAL OF FUNCTIONS INSTALLATION To Install Phone Manager, you will need to use the installer-file PhoneManager_setup.exe. Please make a copy of this file to Windows desktop screen or other folder on your PC. 1) When executed, the screen below will display. Please click [Yes] button. 2) Select language and click [Next] button. 4

6 3) Display Preparing Setup window, Click the [Next] button. 4) Set destination location where set up this program, then click [Next] button. Note: If installed under\program Files, you will need to run tool as Administrator or some features will not be available. 5

7 5) To start installation, click [Install] button. 6) Once the install is complete, click the [Next] button. 6

8 7) After the installation, the shortcut icon of Phone Manger will be appear on your Desktop screen. 7

9 MAKE CONFIGURATION DATA There are two ways for setting the configuration data of ITX-1615 terminal. If making a Single configuration file then use New File, if you need to make multiple configuration files then use Create by order. 8

10 NEW FILE The New File option is used to create a new configuration file for a specified ITX Users need to fill in the MAC address, Account settings, and other advanced settings on the new phone interface. Once the configuration is done, users should click Save to store this configuration information on Your Device List. The New File option is shown below: 9

11 Click Show Advanced Settings will open the window below. 10

12 The setting items are shown below. Setting item Description MAC MAC address of the setting target. Product Model Set IP Phone Account count Set 1 Account Active Checked SIP Server The URL or IP address and port of the SIP server. This is provided by your VoIP service provider (ITSP). Secondary SIP Server The URL or IP address and port of the SIP server. This will be used when the primary SIP server fails. OutBound Proxy IP address or Domain name of the Primary Outbound Proxy, Media Gateway, or Session Border Controller. It s used by the phone for Firewall or NAT penetration in different network environments. If a symmetric NAT is detected, STUN will not work and ONLY an Outbound Proxy can provide a solution. SIP User ID User account information, provided by your VoIP service provider (ITSP). It s usually in the form of digits similar to phone number or actually a phone number. Account Name The name associated with each account to be displayed on the LCD. SIP Authentication ID SIP service subscriber s Authenticate ID used for authentication. It can be identical to or different from the SIP User ID. SIP Authentication The account password required for the phone to authenticate with the ITSP Password (SIP) server before the account can be registered. After it is saved, this will appear as hidden for security purpose. Display Name The SIP server subscriber s name (optional) that will be used for Caller ID display. Primary Coding 1 / Primary Coding 2 Language Random Port Keep-Alive IP Subnet Gateway IP Enterprise Phonebook Path This setting is reflected to the following item. [Web GUI] Account 1 -> General Settings -> Name 4 different vocoder types are supported on the phone, including G.711 U- law (PCMU), G.711 A-law (PCMA), G.729A and G.722 (wide band). Users can configure vocoders in a preference list that is included with the same preference order in SDP message. Note: G.723.1, G726-32, GSM, and L are not supported. This setting is reflected to the following item. [Web GUI] Account 1 -> Audio Settings -> Preferred Vocoder choice 1 / 2 Displaying language setting. Please select desired language. This setting is reflected to the following item. [Web GUI] Maintenance -> Language -> Display Language When set to Yes, this parameter will force random generation of both the local SIP and RTP ports. This is usually necessary when multiple phones are behind the same full cone NAT. The default setting is No (This parameter must be set to No for Direct IP Calling to work). This setting is reflected to the following item. [Web GUI] General setting -> Use Random Port This setting is not reflected to ITX Enter the IP address when static IP is used. Enter the Subnet Mask when static IP is used for IPv4. Enter the Default Gateway when static IP is used for IPv4. Configures the server path to download the phonebook XML. This field could be IP address or URL, with up to 256 characters. This setting is reflected to the following item. [Web GUI] Phonebook -> Phonebook Management -> Phonebook XML Server Path 11

13 Dial Plan City Company Department A dial plan establishes the expected number and pattern of digits for a telephone number. This parameter configures the allowed dial plan for the phone. Dial Plan Rules: 1 Accepted Digits: 1,2,3,4,5,6,7,8,9,0, *, #, A,a,B,b,C,c,D,d; 2 Grammar: x any digit from 0-9; 3 Grammar: X any character from 0-9, a-z, A-Z. a) xx+ - at least 2 digit numbers b) xx only 2 digit numbers c) XX two characters (AA, Ab, 1C, f5, 68, ) d) \t\e\s\t : only string test will pass the dial plan check e) ^ - exclude f) [3-5] any digit of 3, 4, or 5 g) [147] any digit of 1, 4, or 7 h) <2=011> - replace digit 2 with 011 when dialing i) - the OR operand Example 1: {[369] xxxxxxx} Allow 311, 611, and 911 or any 11 digit numbers with leading digits 1617; Example 2: {^1900x+ <=1617>xxxxxxx} Block any number of leading digits 1900 or add prefix 1617 for any dialed 7 digit numbers; Example 3: {1xxx[2-9]xxxxxx <2=011>x+} Allows any number with leading digit 1 followed by a 3-digit number, followed by any number between 2 and 9, followed by any 7-digit number OR Allows any length of numbers with leading digit 2, replacing the 2 with 011 when dialed. Example of a simple dial plan used in a Home/Office in the US: { ^1900x. <=1617>[2-9]xxxxxx 1[2-9]xx[2-9]xxxxxx 011[2-9]x. [3469]11 } Explanation of example rule (reading from left to right): ^1900x. prevents dialing any number started with 1900; <=1617>[2-9]xxxxxx allows dialing to local area code (617) numbers by dialing7 numbers and 1617 area code will be added automatically; 1[2-9]xx[2-9]xxxxxx - allows dialing to any US/Canada Number with 11digits length; 011[2-9]x allows international calls starting with 011; [3469]11 allows dialing special and emergency numbers 311, 411, 611 and 911. Note: In some cases, where the user wishes to dial strings such as *123 to activate voice mail or other applications provided by their service provider, the * should be predefined inside the dial plan feature. An example dial plan will be: { *x+ } which allows the user to dial * followed by any length of numbers. This setting is reflected by the next item. [Web GUI] Account 1 -> Call Settings -> Dial Plan Not supported Not supported Not supported 12

14 CREATE BY ORDER The Create by Order option is used to create two or more configuration files for ITX Users not only need to fill the MAC address, Account settings, codec configurations and other necessary settings. But need to define the quantity of devices, MAC and User ID increasing law. The device s configuration files can be generated automatically following this defined law. Once the configuration is done, users should click Save to store this configuration information on Your Device List one by one in this application. The Create by Order option is shown below: 13

15 The setting items are shown below. Setting item Product Model Quantity of devices Description Set IP Phone The quantity to create configuration file. Note: Do not make configuration data more than First MAC Start MAC address of the setting target. MAC increasing law The MAC address increases in this number using First MAC as a base point. Account count Set 1 Account Active Checked SIP Server The URL or IP address and port of the SIP server. This is provided by your VoIP service provider (ITSP). Secondary SIP Server The URL or IP address and port of the SIP server. This will be used when the primary SIP server fails. 14

16 OutBound Proxy Use ID increasing law SIP User ID SIP Authentication ID Account Name SIP Authentication Password Display Name Primary Coding 1 / Primary Coding 2 Language Random Port IP address or Domain name of the Primary Outbound Proxy, Media Gateway, or Session Border Controller. It s used by the phone for Firewall or NAT penetration in different network environments. If a symmetric NAT is detected, STUN will not work and ONLY an Outbound Proxy can provide a solution. SIP User ID, Account Name, and SIP Authentication ID increase in this number using SIP User ID as a base point. User account information, provided by your VoIP service provider (ITSP). It s usually in the form of digits similar to phone number or actually a phone number. SIP service subscriber s Authenticate ID used for authentication. It can be identical to or different from the SIP User ID. This item is copied the value of SIP User ID, so cannot input. The name associated with each account to be displayed on the LCD. This item is copied the value of SIP User ID, so cannot input. The account password required for the phone to authenticate with the ITSP (SIP) server before the account can be registered. After it is saved, this will appear as hidden for security purpose. The SIP server subscriber s name (optional) that will be used for Caller ID display. This setting is reflected to the following item. [Web GUI] Account 1 -> General Settings -> Name 4 different vocoder types are supported on the phone, including G.711 U- law (PCMU), G.711 A-law (PCMA), G.729A and G.722 (wide band). Users can configure vocoders in a preference list that is included with the same preference order in SDP message. Note: G.723.1, G726-32, GSM, and L are not supported. This setting is reflected to the following item. [Web GUI] Account 1 -> Audio Settings -> Preferred Vocoder choice 1 / 2 Displaying language setting. Please select desired language. This setting is reflected to the following item. [Web GUI] Maintenance -> Language -> Display Language When set to Yes, this parameter will force random generation of both the local SIP and RTP ports. This is usually necessary when multiple phones are behind the same full cone NAT. The default setting is No (This parameter must be set to No for Direct IP Calling to work). Keep-Alive IP Subnet Gateway IP Enterprise Phonebook Path Dial Plan This setting is reflected to the following item. [Web GUI] General setting -> Use Random Port Not Available Enter the IP address when static IP is used. Enter the Subnet Mask when static IP is used for IPv4. Enter the Default Gateway when static IP is used for IPv4. Configures the server path to download the phonebook XML. This field could be IP address or URL, with up to 256 characters. This setting is reflected to the following item. [Web GUI] Phonebook -> Phonebook Management -> Phonebook XML Server Path A dial plan establishes the expected number and pattern of digits for a telephone number. This parameter configures the allowed dial plan for the phone. Dial Plan Rules: 4 Accepted Digits: 1,2,3,4,5,6,7,8,9,0, *, #, A,a,B,b,C,c,D,d; 5 Grammar: x any digit from 0-9; 15

17 6 Grammar: X any character from 0-9, a-z, A-Z. j) xx+ - at least 2 digit numbers k) xx only 2 digit numbers l) XX two characters (AA, Ab, 1C, f5, 68, ) m) \t\e\s\t : only string test will pass the dial plan check n) ^ - exclude o) [3-5] any digit of 3, 4, or 5 p) [147] any digit of 1, 4, or 7 q) <2=011> - replace digit 2 with 011 when dialing r) - the OR operand Example 1: {[369] xxxxxxx} Allow 311, 611, and 911 or any 11 digit numbers with leading digits 1617; Example 2: {^1900x+ <=1617>xxxxxxx} Block any number of leading digits 1900 or add prefix 1617 for any dialed 7 digit numbers; Example 3: {1xxx[2-9]xxxxxx <2=011>x+} Allows any number with leading digit 1 followed by a 3-digit number, followed by any number between 2 and 9, followed by any 7-digit number OR Allows any length of numbers with leading digit 2, replacing the 2 with 011 when dialed. Example of a simple dial plan used in a Home/Office in the US: { ^1900x. <=1617>[2-9]xxxxxx 1[2-9]xx[2-9]xxxxxx 011[2-9]x. [3469]11 } Explanation of example rule (reading from left to right): ^1900x. prevents dialing any number started with 1900; <=1617>[2-9]xxxxxx allows dialing to local area code (617) numbers by dialing7 numbers and 1617 area code will be added automatically; 1[2-9]xx[2-9]xxxxxx - allows dialing to any US/Canada Number with 11digits length; 011[2-9]x allows international calls starting with 011; [3469]11 allows dialing special and emergency numbers 311, 411, 611 and 911. Note: In some cases, where the user wishes to dial strings such as *123 to activate voice mail or other applications provided by their service provider, the * should be predefined inside the dial plan feature. An example dial plan will be: { *x+ } which allows the user to dial * followed by any length of numbers. City Company Department This setting is reflected by the next item. [Web GUI] Account 1 -> Call Settings -> Dial Plan Not supported Not supported Not supported 16

18 EDIT To edit configuration data, click View/Edit button. View/Edit button The Overwrite & Edit window will be displayed. The settings of the window are same as NEW FILE. 17

19 Note: When read the file which includes less than six account data by Import or Recovery Data feature, the number of account shows six and the un-existing account data shows with blank. 18

20 SEARCH When you want to search the relevant data from Your Device List, input the search keywords in the textbox. You can filter the list for MAC address, Product, SIP Server, Account Name or SIP User ID. Note 1: If you enter the multiple keywords, for example "MAC address" and "Product", the search is performed with the last entered keyword. The search with multiple keywords is not available. After the search result is displayed and then another keyword is entered, the searching is performed for all items. The search result filtering is not possible. Note 2: The search keyword for City, Company, and Department cannot be used. 19

21 IMPORT The Import feature allows users to import existing.csv configuration file into Phone Manager, and the configuration file could be found on Your Device List after importing. The figure above shows the users need to browse and select the CSV. Configuration file and click OK to import. ITX 1615 Clear Old list: If No is selected, the previous device configuration file will not be lost. If Yes is selected, the previous device configuration file will be overwritten. Caution: When, character is set by any parameter, Phone Manager cannot import csv file correctly. 20

22 EXPORT The Export feature allows users to export configuration files from Phone Manager to PC as.csv file or xml file. As the figure shows above, users need to select Export type and set the path where users want to export the configuration file, and click OK to finish exporting. Export Type csv cfg Description Export devices.csv. In this csv file, all data of Phone Manager are stored. And, this file can import to Phone Manager. (refer to chapter of IMPORT) Note: The file name cannot be changed. Only the devices.csv is available. Export cfgxxxxxxxxxxxx.xml includes MAC address of each configuration data. *XXXXXXXXXXXX is MAC address of configuration data. This data can be downloaded to ITX-1615 if MAC address is matched with data. Caution: When you export a CSV file, the window below will display even if there are no existing devices.csv. If you click No the devices.csv is made as the export path. 21

23 DELETE ALL To delete all configuration data, click [Delete All] button. 22

24 HTTPD SERVICE The HTTPD service allows users to use this tool as a configuration server, and users could configure ITX-1615 to fetch the configuration file via HTTPD service. Move cursor to, and click on the white ball to activate the HTTPD service. There will be a dialog to ask users to select an available NIC for HTTPD service, as figure shows below: Then, users need to press OK to select the NIC. HTTPD service path and port number will appear on screen. Write down this information for the next step. 23

25 If HTTP port is already used, appropriate port number is acquired automatically by this tool. Then users need to configure the Config Server Path on ITX For example, users need to log into the phone s Web UI, and go to Maintenance -> Upgrade and Provisioning, fill in the HTTPD server path information into Config Server Path. When ITX-1615 phone finishes rebooting, phone will fetch the configuration file from HTTPD server. When access is successful from the ITX-1615, the access log is displayed in this window. 24

26 PNP FEATURE This feature is not available for ITX

27 LANGUAGE OPTIONS Users can choose English/Chinese language as the UI displaying language. The default UI displaying language is the one users choose the during installation process. To make the setting change effective, it is required to restart this tool. 26

28 OPTIONS BOOT AUTO START When checked Options -> Boot Auto Start, the Phone Manager will run automatically after the Windows startup. Restart the tool to make Boot Auto Start effective. 27

29 RECOVERY DATA Loads the last saved configuration on program startup. Restart the tool to make Recovery Data effective. Note: When the above screen is displayed, Total device:0 appears, which is not the actual number of devices. However, by updating the Your Device List, the correct value is displayed. 28

30 AUTO HTTPD Automatically start HTTPD server on program startup. Restart the tool to make Auto Httpd effective. This window will display automatically when Phone manager starts up if it has been enabled. 29

31 CONFIGURE HTTPD PORT Users can use the default port 80, or custom port between 5000 and As the figure shows below: When you use port 80, check Use the Default Port 80, and click OK. When a custom port is used from 5000 to 65535, clear the Use Default Port 80 and input port number to the Custom port area. 30

32 LIMITATION This tool cannot use shortcut key of [Ctrl+T] for Create by order. Do not make configuration data files over When read the file which includes less than six account data by Import or Recovery Data feature, the number of account shows six and the non-existing account data shows with blank. When you export a CSV file, the overwrite window will display even if there are no existing devices.csv. If you click No the devices.csv is made as the export path. If installed under\program Files, you will need to run tool as Administrator or some features will not be available. When using "Recovery Data feature, "Total device: 0" is appeared which is not match with actual number of device. However, by updating the "Your Device List", the correct value is displayed. The setting of Keep-Alive is not reflected to ITX PNP function is not supported on ITX When, character is set by any parameter, Phone Manager cannot import csv file correctly. Some screen image shown by clicking help menu is not match with actual screen. In this case, the actual screen is the correct one. 31

33 Standard SIP Terminal IP Phone ITX-1615 Phone Manager User Guide GVT June, 2018 Issue 1.3 NEC Corporation 32