VS-IMT User Manual Vingtor-Stentofon Intercom Manager Tool TECHNICAL MANUAL A100K11619 NR

Transcription

1 VS-IMT User Manual Vingtor-Stentofon Intercom Manager Tool TECHNICAL MANUAL TECHNICAL A100K11619 NR

2 Contents 1 Basic Information Document Scope Publication Log Related Documentation Terminology VS-IMT Installation Requirements Installation procedure Getting Started Overview Main Features Main User Interface Working with Projects Project Settings Configuration Basic Intercom System Setup Planning the Installation Station Discovery and Upgrade Wizard Discover Stations PC network settings for resolving factory static IP address Identification How to Identify IP Stations Station Upgrade How to Upgrade IP Stations Station Configuration Configuration Profiles Verify Setup & Make Reports VS-IMT User Manual A100K11619

3 5 Additional Configuration About Station Settings Network Setup Settings Supported in VS-IMT Station Settings Profiling Viewing & Changing Station Settings Troubleshooting & Technical Background Discovery Factory IP Address Identification Station Upgrade Station Configuration Additional information A Intercom System Installation Planning A.1 Planning a Pulse Installation A.2 Planning a SIP Installation B VS-SDK for Pulse System Setup B.1 Preparation B.2 Discovery and basic configuration B.2.1 Server Configuration B.3 Additional Configuration B.3.1 Uploading SIP/Call/Audio/Ringlist Settings to Device B.3.2 ZAP Specific Settings B.4 Licensing C VS-IMT & Station Web Interface C.1 Standard VS-IMT Project C.2 VS-SDK for Pulse-enabled Project VS-IMT User Manual A100K11619

4 1 Basic Information 1.1 Document Scope This document is the user manual for the Intercom Manager Tool VS-IMT. VS-IMT is a software program for managing a large number of Vingtor-Stentofon IP intercoms. 1.2 Publication Log Revision Date Author Status EE/HKL Published 1.3 Related Documentation Doc. no. Documentation A100K11194 Turbine IP Intercoms Technical Manual 1.4 Terminology Acronyms Abbreviation GUI LAN Explanation Graphical User Interface Local Area Network Definitions Term Pulse ZAP Definition Vingtor-Stentofon Pulse system allows for as few as two stations and is scalable according to your needs. Based on Zenitel s IP technology, Vingtor-Stentofon Pulse offers High Definition voice quality, simple installation and ease of use. Zenitel Application Protocol used for station configuration, station control and monitoring 4 VS-IMT User Manual A100K11619

5 2 VS-IMT Installation 2.1 Requirements Recommended System Requirements Operating System Windows 7 x86/64, Windows 8 x86/64 Hardware CPU: Dual Core Intel Core or newer RAM: 4 GB Hard Drive: 40 GB or better Network Card: 100 Mbit or better 2.2 Installation procedure The VS-IMT application includes a Windows Installer package named VS-IMT_Installer.msi that will automatically install it on the PC. The installer has a Setup Wizard that will guide the user through the installation. To install VS-Client: Double-Click VS-IMT_Installer Figure 1 VS-IMT Destination Folder Once installed, the VS-IMT application will be available in the Start Menu: All Programs > Vingtor Stentofon > VS-IMT The application data is stored under the main user folder: C:\Users\username\AppData\Roaming\Vingtor Stentofon\VS-IMT VS-IMT can be uninstalled by running: All Programs > Vingtor Stentofon > Uninstall VS-IMT 5 VS-IMT User Manual A100K11619

6 3 Getting Started 3.1 Overview VS-IMT is a software tool for managing Vingtor-Stentofon IP intercoms. It is designed to be used as a tool of choice for commissioning tasks that involving a large number of IP intercoms. Key product features are intercom devices software upgrade and basic as well as advanced configuration. As not all setup scenarios and configuration settings are supported, VS-IMT should normally be used as a tool for performing basic configuration on a large number of devices, and the individual station web interface for more advanced or specialized setup. 3.2 Main Features VS-IMT includes the following main features: Support for Vingtor-Stentofon Pulse, AlphaCom and SIP clients All basic configuration tasks for setting up IP intercoms as clients are covered. Support for all Vingtor-Stentofon IP intercom types VS-IMT supports the Turbine family intercoms Turbine Compact, Turbine Industrial, Turbine Ex and also the first generation of Classic IP intercoms (INCA) Master stations, Substations, IP Dual display, IP-ARIO. Easy Vingtor-Stentofon Pulse system setup The Pulse system can be set up in less than a minute with all clients registered Projects with export/import support Work is organized around the projects that can be shared with export/import functions. Fast discovery of intercoms on the IP network IP networks are fast-scanned and up to 500 discovered intercoms can be added to the project. Resolving factory static IP address Automatic discovery and IP address assignment for intercoms with factory static IP address. Identification of intercoms on the IP network Two-way identification for a large number of intercoms on the IP network. Software Upgrade Fast and easy software upgrade for a large number of intercoms on IP network. Basic Configuration Supports configuring a large number of IP intercoms when doing basic setup. 6 VS-IMT User Manual A100K11619

7 Advanced configuration Supports more advanced setup options like Audio settings, SIP settings, Network settings, I/O, DAK keys, Firewall, etc. VS-SDK for Pulse project support Discovery and basic configuration of IP intercoms and VS-SDK for Pulse intercom applications. Also supports VS-Client configuration. 3.3 Main User Interface The VS-IMT user interface consists of two major parts: Main application window with Intercom configuration options Station Discovery and Upgrade Wizard Project overview/statistics Current open project Configuration status Device list filters Devices in project Basic information for selected station Upload / Discard configuration changes Device settings for selected station Figure 2 Main application window 7 VS-IMT User Manual A100K11619

8 Wizard step settings Wizard step main action Main status, warnings and errors Wizard Steps: 1. Discover IP Stations 2. 2-way Identification 3. Software Upgrade 4. Basic Configuration 5. Review results List of discovered intercoms Cancel wizard, go back to previous step, or proceed to next step Figure 3 Station Discovery and Upgrade Wizard 8 VS-IMT User Manual A100K11619

9 3.4 Working with Projects A project is the main functional principle of VS-IMT and is ideal for working on multiple IP intercom systems installed in different locations and different IP networks. To create a new project, in the main menu: Select Project > Create project Select project type Set project name, and other project information if available There are 2 main types of projects: Standard project Standard project lets you set up an intercom system project using standard station settings. This method will directly modify the configuration file on the station. With standard project you can easily discover, identify, upgrade and configure Vingtor-Stentofon IP intercoms. VS-SDK for Pulse enabled project (disabled by default) This project type should be used when VS-SDK for Pulse is enabled in the system. See Appendix B. 9 VS-IMT User Manual A100K11619

10 3.4.1 Project Settings To modify project settings: Select Project > Project settings Add, remove or modify credentials used for connecting to intercoms (station web interface credentials). Change order of credentials. Modify project general information Modify credentials of AlphaCom server (readonly user) Define Sites. Sites are used to group multiple intercoms in the project Figure 4 Project Settings 10 VS-IMT User Manual A100K11619

11 Choose Domain controller (Pulse server) with Pulse License Manager. Enter (paste) and Upload new License Key License key status License details showing total Number of Licenses, Currently Used and Available licenses Figure 5 Project Settings License 3.5 Configuration To define VS-IMT settings: Select Tools > Options Change default settings values used in Station Discovery and Factory Static IP address resolving Define which warning dialog-boxes are presented Enables VS-SDK for Pulse enabled project type in the Create project dialog-box Figure 6 VS-IMT options 11 VS-IMT User Manual A100K11619

12 4 Basic Intercom System Setup The procedure for deploying IP-intercom stations is: 1. Planning your system 2. Discovery of intercom devices 3. Identification of intercom devices and assigning a directory number 4. Software upgrade 5. Configuration 6. Verifying configuration A Wizard will guide you through the procedure. 4.1 Planning the Installation Plan your installation by collecting configuration data you would need to set up your system. The table below is an example of data you would need for a typical AlphaCom IP intercom installation. For examples of Pulse and SIP installations, see appendix A Intercom System Installation Planning. Parameter Station mode Value AlphaCom AlphaCom site IP gateway site IP address range site x IP network mask site AlphaCom site IP gateway site IP address range site x IP network mask site Table 1 AlphaCom system parameters Dir. No. Name Location (Site) IP configuration MAC-address * Host name Other 101 Hans B1, F1, R :13:CB:01:5F:27 Zenitel Thomas B1, F1, R :13:CB:06:01:4C Zenitel Front door B1, Main Entrance :13:CB:00:AA:38 Zenitel-103 Noisy environment 104 Back door B1, Back Door :13:CB:00:1B:CA Zenitel Emil B2, F3, R6 DHCP 00:13:CB:01:5F:28 DHCP 202 Frano B2, F3, R8 DHCP 00:13:CB:06:01:45 DHCP 203 Lab B2, Lab Entrance DHCP 00:13:CB:00:AA:39 DHCP 204 Datacenter B2, Data Center DHCP 00:13:CB:00:1B:CE DHCP Table 2 AlphaCom system intercom information * Note that you don t need to obtain all the MAC addresses upfront. The AlphaCom directory report from the Discovery Wizard Finish step has MAC addresses in the directory list. 12 VS-IMT User Manual A100K11619

13 4.2 Station Discovery and Upgrade Wizard Once the system has been planned it is time to start VS-IMT and run the Wizard. To start the Wizard: Select File > Launch Station Wizard (or press CTRL+W) The Wizard guides the user in easy steps through the initial setup procedure: Discover stations Identify stations Upgrade stations Configure stations. Review the results. 4.3 Discover Stations The first step is to discover which stations are connected to the network. This is done by scanning the network within a defined IP address range, or by discovering the stations with a factory default static IP address and assigning them a unique IP address from a defined address range. Scan IP network Define IP address range that will be scanned for intercom stations Resolve factory static IP address Resolve discovered stations with default factory static IP address to a unique address from defined IP address range Start / Stop the discovery process. Check Clean previous results box to empty previously discovered stations Factory Reset selected IP stations (optionally with DHCP) Main status, warnings and errors List of discovered intercoms Figure 7 Discover Stations Step Set Directory number or Description (used later in Configuration step) Select discovered stations for the next step and eventually be added to the project 13 VS-IMT User Manual A100K11619

14 The Status column will show OK for newly discovered stations or Already exists for stations that have been discovered before and are already part of the project. Both statuses indicate that the station is functioning and responding to VS-IMT. For other statuses, see section 6 Troubleshooting. AlphaCom servers will be listed under AlphaCom servers. The discovered servers will be available as a selection in the Configure Stations step. Figure 8 Discovered AlphaCom servers PC network settings for resolving factory static IP address The Resolve factory IP addresses function needs to have a correct network setup because the PC on which VS-IMT is running needs to be connected to the same subnet as that of the factory static IP. For further details, see section 6.2 Factory IP address. 14 VS-IMT User Manual A100K11619

15 4.4 Identification VS-IMT supports two-way identification of discovered IP stations by: playing a tone on the selected station receiving a button-press event from a station A station is considered as identified by entering its Directory number and checking the Identified box. WARNING The Identification process will put stations under the control of VS-IMT and they will be rebooted at the beginning and end of the identification process. The Stop identification button must be clicked to load the stations again with their original configuration. Stopping the process in another way will result in the stations being not configured as expected. For this reason the BACK, NEXT and CANCEL buttons are disabled while the software is in Identification mode. DO NOT terminate the program via Windows Task Manager or any other means. Identification process warning. Read carefully! Station can be connected or disconnected to Identifier Service Button press events Last button pressed event on a specific station Start / Stop Identification process. Check or uncheck Include already identified stations box Main status, warnings and errors Configuration changed (but not uploaded) indicator Figure 9 Identify stations step Identified status Set station as identiifed. Will be listed in the Identified tab Play a tone on selected station Set Directory number or Description (later used in Configuration step) Button pressed on a station Auto scroll the list to show station on which button was pressed 15 VS-IMT User Manual A100K11619

16 4.4.1 How to Identify IP Stations 1. Click the Start Identification button - Check or uncheck Include already identified stations box 2. Wait until stations are connected 3. Two-way identification Play tone Click the Play button and a sound will be emitted from the speaker of the relevant station. Button press event Press a button on the station and receive notification in VS-IMT. The last station on which a button was pressed will be marked with a green indicator in the Button pressed column, and a detailed description info in Events panel. 4. Enter Directory number or Description 5. Check the Identified box 6. Click the Stop Identification button After a directory number is set (or modified), it will be marked with a special font and the station will be marked with a yellow indicator Configuration changed, not uploaded. For uploading a configuration, see section 4.6 Station Configuration. Stations in AlphaCom mode can have their directory number set to -. Note that in that case the MAC address of the station must be programmed in AlphaPro. If a station fails to connect or disconnect to the Identifier service, or in case of any other irregular scenarios, see section 6 Troubleshooting. 4.5 Station Upgrade VS-IMT can upgrade all stations to the latest software. It is station type-aware and will use the correct image file for the upgrade. A built-in file transfer server can upgrade many stations in parallel which makes it the most efficient way to upgrade Vingtor-Stentofon IP stations (only Flowire devices will be upgraded sequentially, one-by-one). Software image files for IP intercom stations need to be downloaded to the PC and imported into VS-IMT before starting the upgrade process. The Import image feature will extract the image into the VS-IMT software repository on the local disk. 16 VS-IMT User Manual A100K11619

17 Some upgrades of Turbine IP intercoms require specific image packages sti-prod-4.x.x.x. The table below shows the correct VSF-Turbine image file upgrade path to use. Current version Desired version Image file to use What to do or earlier 3.0.x.x tsi-3.0.x.x Normal upgrade or earlier 4.2.x.x tsi and then sti-prod-4.2.x.x / x.x sti-prod-4.2.x.x 3.1.x.x / 4.1.x.x 4.2.x.x sti-4.2.x.x 4.2.x.x 4.2.x.x sti-4.2.x.x Normal upgrade Table 3 VSF-Turbine image file upgrade path First, upgrade station to and then to required 4.2.x.x Check Enable upgrades requiring boot/environment version upgrade box and then normal upgrade Check Enable upgrades requiring boot/environment version upgrade box and then normal upgrade How to Upgrade IP Stations 1. Add new software image files - Click the Import image button to load and extract the image into the VS-IMT Software repository on the local disk. 2. Review current software version for discovered stations Review the software version which is given in the station list. Stations with unsupported software versions are marked with a Required upgrade warning indicator. These stations will not be added to the next step of the Wizard unless they are upgraded, and therefore cannot be added to a project. 3. Select target software versions in the Station software images panel Select a desired software version used for the upgrade of every IP station type: Turbine, INCA, Dual-Display, and Flowire 4. Enable boot/environment upgrades - Check Enable upgrades requiring boot/environment version upgrade box Upgrades including bootloader update will be run at the end 5. Start Upgrade - Mark multiple (or all) stations and click the Upgrade button to initiate the upgrade process. 17 VS-IMT User Manual A100K11619

18 Software images Define which software images will be used for specific station type: Turbine, INCA (Classic IP station), Dual-Display, Flowire Software repository Import new image file into VS-IMT local disk, Reload the contents of repository, or Open repository location on local disk Start upgrade process for selected stations Main status, warnings and errors Figure 10 Upgrade stations step Boot/environment version Shows requried update where needed Station software info Current software and upgrade target software Enable boot/environment upgrades Upgrades including bootloader update will be run at the end NOTE Turbine firmware upgrades that require a boot/environment upgrade are by default disabled due to the fact that such upgrade is risky in case something goes wrong in the upgrade process (power outage, network down, etc.). In case of a failure, all other remaining upgrades will be stopped. DO NOT power down stations or make any network changes while the upgrade is in progress. 18 VS-IMT User Manual A100K11619

19 Required upgrade Station software current version is not supported and upgrade is mandatory. Figure 11 Station Upgrade in Progress Upgrade status Upgrade service will start with status Initiated, then Downloading, followed by Upgrading and Success Download progress Download progress bar for all transferred files If a station fails to upgrade, or in case of any other problems, see section 6 Troubleshooting. 4.6 Station Configuration All stations that have been upgraded to a software version which is recognized by VS-IMT are listed on the configuration page. Recognized software versions are the versions which were available at the time of the first release of VS-IMT and later. It is possible to set credentials, station mode, IP settings, station site, directory number and Pulse/AlphaCom server IP address. For Turbine stations it is also possible to set the Turbine frontboard model and accessory. However, performing this action is recommended only on initial station setup, when the model is not yet set. Click the APPLY button to save the changes Changes will not be uploaded until the Upload button has been clicked. Up to that point it is still possible to discard changes by clicking the DISCARD ALL or DISCARD SELECTED button. 19 VS-IMT User Manual A100K11619

20 Authentication Set Station web interface username/password, and station Offline password Frontboard / accessory It is possible to set Turbine frontboard model and accessory Settings Set station Mode, Profile, Server and Site Network Settings Set static IP address or DHCP Upload configuration changes for selected stations Main status, warnings and errors Configuration status In case some station setting has been modified, station will be marked as modified and pending for configuration upload In-table edit Some settings can be modified directly inside table: Dir.no, Description, Display text, SIP user/password, Offline password Discard Changes Discard changes for all or just selected stations. Can be done before configuration upload Figure 12 Configure station step It is possible to make changes for multiple selected stations such as set multiple stations to DHCP network address, assign static IP address from a defined range, set server, offline password, etc. When stations with static IP address are configured to DHCP, there will be a Synchronize button that can be used to discover newly assigned IP addresses. Changed station settings are displayed in a different font in the list. Stations with changed configuration that are not yet uploaded are marked with a yellow circle. Others are marked with a green circle. 20 VS-IMT User Manual A100K11619

21 To select multiple stations: Press Ctrl or Shift (Ctrl+A to select all) and click the Upload button Configuration data will be sent to the stations and they will be rebooted. VS-IMT will wait until all stations are booted up and then check whether the configuration has been successfully applied. If VS-IMT cannot communicate with a station after configuration is applied, there will be a Retry button for trying again. For further details, see Troubleshooting chapter Configuration Profiles A Profile can be selected for single or multiple stations. Station Custom : no specific profile has been selected, and the station will maintain all its settings except for the changed ones. Default : the station will get default settings for the chosen station mode. Note that Profile management is still in the technical preview phase of development in VS-IMT version 1.2. By setting Default profile and uploading the configuration, the selected stations will get factory default settings. Depending on their model type they will get either factory static IP address or an IP address from the DHCP server. 4.7 Verify Setup & Make Reports The final step provides an opportunity to review the settings which have been made in the previous steps and to print out configuration reports. Click the FINISH button to include the selected stations in the project. The AlphaCom or Pulse directory reports can be saved as either text or csv files, while the other reports are saved in text format. A csv file can be easily imported into Microsoft Excel. 21 VS-IMT User Manual A100K11619

22 Reports Complete system setup report, errors and warnings, AlphaCom/Pulse directory Identify / Upgrade / Configuration Status Indicates if station was modified on a specific step Figure 13 Review Results Step 22 VS-IMT User Manual A100K11619

23 5 Additional Configuration 5.1 About Station Settings Once a station is included in a project, it is placed on the list of stations in the main project window. When a station is selected, basic station information will be displayed in the Station info panel. The Station info panel information is read-only, but the following settings can be edited directly: Station mode: changing station mode immediately changes the list of available setting groups as they are different for every station mode Site: this setting is not applied on the station itself; it can be used to organize stations into sites from VS-IMT Description: this setting is not applied on the station itself; it can be used for a user-defined description in VS-IMT Model: Frontboard model can be changed (only for Turbine stations) Project overview / statistics Current project Configuration status Device list filters Devices in project Basic information for selected station Configuration status Upload / Discard configuration changes Device settings for selected station (setting groups) Figure 14 Main application window 23 VS-IMT User Manual A100K11619

24 Changing settings in Site, Description and Model will be immediately applied to the station. Changing Station mode requires uploading the changes to the station. Station info is not synchronized in real-time with the station, so there is an option to synchronize all basic information directly from the station by clicking the Sync button. This option is very useful for checking whether the station has been changed since the last usage of VS-IMT, without the need to go on the station web interface to see whether there are differences. However, if checking the station on its web interface is required: Double-click the IP address in the IP column to open station interface in a web browser Below Station info, there is a list of setting groups available for the selected station. Note that the list IS unique for every station type and mode. Changing the settings is the same for all setting groups. See section 5.2 Network Setup for the procedure on how to change station settings. For example, the user can change the IP address from DHCP to Static by manually entering network settings. By clicking APPLY and saving settings with the Override profile settings option, changes will be saved to the VS-IMT database. The configuration Status panel will update the number of changed stations and these will be indicated by the color yellow in the list. Click the UPLOAD button to send the changed configuration data to the station. Figure 15 Upload station configuration in progress The same procedure can be used for setting up all group settings for each station. Settings can be changed on a larger number of stations and then applied by clicking the UPLOAD button on all stations at once. In the main configuration window, all properties of all the IP stations can be set either individually or in profile groups (see section 5.4 Station Settings Profiling). The top left-hand side of the main window shows an overview of the number of stations and how many of them are in one of the 4 IP station modes: AlphaCom, Pulse, Pulse Server, SIP. 24 VS-IMT User Manual A100K11619

25 Below this overview there are filters that affect which stations are shown in the main station list. 5.2 Network Setup The Network setting group is selected by default in the station list station group menu. The following settings can be edited: Mode : if DHCP is selected, IP address, Gateway and DNS Servers are disabled IP address Gateway, DNS Servers, Hostname Read IP Address (only on Turbine stations) Use last known IP on DHCP failure (not available on Turbine stations) IGMP version (not available on Turbine stations) Figure 16 Network Settings 25 VS-IMT User Manual A100K11619

26 5.3 Settings Supported in VS-IMT VS-IMT supports the configuration of the following setting groups or Profiles, applicable for different station modes and types (I = INCA, D = Dual-Display, T = Turbine, - = Not supported): Setting groups (Profiles) AlphaCom Pulse SIP Network settings IDT IDT IDT AlphaCom settings IDT Firewall settings IDT --- IDT SIP settings --- IDT IDT Advanced SIP IDT Call settings --- IDT IDT Audio settings IDT IDT IDT Advanced audio settings --T --T --T DAK settings --- IDT IDT Ringlist settings --- IDT IDT Time settings --- IDT IDT IO settings --T --T --T Language settings --- ID- ID- All other settings are configurable by using the station web interface. 5.4 Station Settings Profiling Note that Profile management is still in the technical preview phase of development in VS-IMT version 1.2. Hence, detailed instructions on how to use the feature are not provided in this manual. All stations added to VS-IMT are by default members of the default profiles. Advanced configuration provides the possibilities to set parameter values for individual stations. The station remains a member of a default profile, but one or more of its parameters have a value different from the profile these stations have those parameters overridden. Profiling provides the possibility of implementing a predefined array of settings to multiple stations at the same time. The user can create a profile for, e.g. Ringlist settings and apply it to many stations that should have the same Ringlist configuration. Changing individual values in the profile affects all stations that are members of that profile. The profile management window can be opened by selecting Project > Profile management. 26 VS-IMT User Manual A100K11619

27 5.5 Viewing & Changing Station Settings When a station is selected it is possible to show the specific settings for that station by selecting a category from the dropdown list in the Profile Settings panel on the right. Figure 17 List of setting groups for Turbine in Pulse mode Now individual settings can be viewed and changed if required. Edit one or more parameters and accept the changes. In the dialog-box select whether the new parameters are overriding values of the original profile or whether you want to define a new profile. Figure 18 Override or create a new profile When selecting Override profile settings the parameter values will be clearly indicated by a yellow background. Click the Rollback icon to revert to the original profile value Figure 19 Rollback option If you create a new profile, give it a name and click Save. The station will now be the first member of the newly defined profile. All unchanged values are copied from the profile that the station belonged to previously. 27 VS-IMT User Manual A100K11619

28 6 Troubleshooting & Technical Background This section provides some technical background to some of the mechanisms used by VS-IMT which could be of help in solving issues that may be encountered. 6.1 Discovery Networks may not support the VS-IMT discovery method outside the subnet to which the PC running VS-IMT is connected. In this case you must connect the PC directly to any subnet to which the IP intercom stations are connected. If your system consists of different subnets it may be necessary to run the Wizard multiple times, once in each subnet. Status of discovered station in the result list: OK ALREADY EXISTS station already exists in current project AUTH. FAILED failed to download info/xml unable to authenticate ERROR failed to download info/xml other reasons 6.2 Factory IP Address Stations with a factory default IP address, i.e can be reconfigured and given a unique IP address. When VS-IMT scans the network for the default factory address, multiple stations will respond. They all report their MAC addresses. VS-IMT will communicate with the first station to respond on a lower level network protocol and change the station s IP address. It will then scan the network again. It will repeat this process until VS-IMT stops receiving a response. Setting up the Network A PC where VS-IMT is running needs to be connected to the x network so that stations with the default factory static IP address can be discovered and given unique IP addresses. The PC needs to be configured with IP address (default value, other x network address can be configured in Tools > Options). Changing the primary IP address of the PC network adapter sometimes is not a viable choice. For example, you may like to resolve all stations with IP address to the x network, so a second IP address should be configured with the address: 1. On your PC, select Control Panel > Network and Internet > Network and Sharing Center > Change adapter settings 2. Right-click Local Area Connection and select Properties 28 VS-IMT User Manual A100K11619

29 3. Select Internet Protocol Version 4 (TCP/IPv4) and click Properties 4. If your PC is set to DHCP, do the following additional steps: o Find out your PC IP address: Right-click Local Area Connection and select Status, then click Details, and note the IPv4 Address and Subnet Mask values. 29 VS-IMT User Manual A100K11619

30 5. Select Use the following IP address and enter the IP address and subnet mask obtained in the previous step 6. Click Advanced and under the tab IP Settings and panel IP addresses click Add 7. Enter and as IP address and Subnet mask respectively and click Add - You will now have added a second IP address for the PC network adapter 8. Click OK on all dialog-boxes to close them 9. When the factory addresses have been resolved you must set the PC back to its original network settings for the PC network adapter. 6.3 Identification During Identification, stations will be temporarily reconfigured to AlphaCom mode, and the AlphaCom IP address will be set to the IP address of a PC running VS-IMT. The original configuration file is temporarily stored and the station will be set back to its original configuration at the end of the process. The reason for this reconfiguration is that VS-IMT will act as a DIP server, i.e. the way in which AlphaCom communicates with IP stations. VS-IMT is then able to detect button presses, let the station play a tone and if the station is a display master station, place messages on the display. If during the period in which the station is reconfigured the station loses contact with VS-IMT, the station will remain in that configuration until it is manually reconfigured. Connection statuses for the Identifier service: Connecting, Connected, Disconnecting, Disconnected. If connection or disconnection to the Identifier service fails, a Retry button will appear so that the user can try again. The user can also choose to abort the whole process in the dialog-box that will be displayed. 6.4 Station Upgrade If the upgrade process fails on a station, the user can run the upgrade on the same station again. There is no limit to how many retries are allowed. Enable boot/environment upgrades: Upgrades including bootloader update will be run at the end. In case of failure, all others will be stopped. 30 VS-IMT User Manual A100K11619

31 6.5 Station Configuration If VS-IMT cannot communicate with a station after the configuration is applied, a Retry button will appear for the user to try again. Keep in mind that this will only try to reconnect to the station and check the configuration status it will not retry the configuration upload. In cases where a station with a static IP address is configured for DHCP, there will be a Synchronize button to scan the network and find a newly assigned dynamic IP address. 6.6 Additional information Further technical information is available on AlphaWiki. The home page is: All release notes can be found here: 31 VS-IMT User Manual A100K11619

32 A Intercom System Installation Planning This appendix provides some examples of Pulse and SIP installation planning. A.1 Planning a Pulse Installation The tables below are examples of data you would require for a typical Pulse system installation: Parameter Station mode Value Pulse Server site IP gateway site IP address range site x IP network mask site Table 4 Pulse system parameters Dir. No. Name Location (Site) IP configuration MAC-address Station Type Other 101 Reception Reception :13:cb:00:32:d0 Flush Master IP Master Station 102 John Smith 103 Peter Brink Head Office DHCP 00:13:cb:02:5d:94 Desk Master IP Desktop Station Head Office DHCP 00:13:cb:02:5c:8e Desk Master IP Desktop Station 201 Entrance Main Entrance DHCP 00:13:cb:06:3a:3e TCIV-3 IP Substation 202 Elevator Main Hall DHCP 00:13:cb:08:00:fe TMIS-1 IP Substation 301 Office 1 1st floor DHCP 00:13:cb:06:of:9e TCIS-5 IP Substation 302 Office 2 2nd floor DHCP 00:13:cb:06:2a:54 TCIS-4 IP Substation 303 Office 3 3rd floor DHCP 00:13:cb:06:06:22 TCIS-6 IP Substation Table 5 Pulse system intercom information A.2 Planning a SIP Installation The tables below are examples of data you would require for a typical SIP IP intercom installation: Parameter Station mode Value SIP Server site IP gateway site IP address range site x IP network mask site Table 6 SIP system parameters 32 VS-IMT User Manual A100K11619

33 Dir. No. Name Location (Site) IP configuration MAC-address Station Type Other 101 Reception Reception :13:cb:00:32:d0 Flush Master IP Master Station 102 John Smith 103 Peter Brink Head Office :13:cb:02:5d:94 Desk Master IP Desktop Station Head Office :13:cb:02:5c:8e Desk Master IP Desktop Station 201 Entrance Main Entrance :13:cb:06:3a:3e TCIV-3 IP Substation 202 Elevator Main Hall :13:cb:08:00:fe TMIS-1 IP Substation 301 Office 1 1st floor :13:cb:06:of:9e TCIS-5 IP Substation 302 Office 2 2nd floor :13:cb:06:2a:54 TCIS-4 IP Substation 303 Office 3 3rd floor :13:cb:06:06:22 TCIS-6 IP Substation Table 7 SIP system intercom information 33 VS-IMT User Manual A100K11619

34 B VS-SDK for Pulse System Setup The VS-SDK for Pulse-enabled project lets you set up an intercom system project using our special Zenitel Application Protocol (ZAP). This type of project supports the easy setup of a Pulse system: Upload license to Pulse server Make client/server relations between stations Set up VS-Client as a Pulse client Perform basic configuration of stations It also supports a configuration specific to VS-SDK for Pulse intercom applications. B.1 Preparation First, create a new VS-SDK Project. To enable such a project: Select Tools > Options Check the Enable creating VS-SDK for Pulse enabled project box Once projects are enabled: Select Project > Create Project 34 VS-IMT User Manual A100K11619

35 Under the Project Type dropdown list, select VS-SDK for Pulse enabled project Set project parameters and click the CREATE button An empty VS-SDK project will be created. B.2 Discovery and basic configuration The next step in the configuration is discovering all intercom devices on the network. Select File > Launch Station Wizard (ZAP) or press Ctrl+Z The Wizard start screen is displayed. Click NEXT to get to the auto-discovery window. 35 VS-IMT User Manual A100K11619

36 This feature of VS-IMT automatically scans through a specified range of IP addresses and finds all relevant intercom devices. The functionality is similar to the Discover stations step in the Standard project. Figure 20 Discovery step In the list of discovered devices: Select the devices you want to configure and click NEXT In the second step of the wizard, select each device to view and change settings. When settings have been changed, for each device: Click the Apply button (green check mark) When all devices have been configured: Click the Configure button to push the configuration to the devices. As there are many options in the Configuration step, we will only describe the ones specific for VS- SDK for Pulse system. For detailed explanations of Client, Audio, Call and Ringlist settings, please consult A100K11194 Turbine IP Intercoms Technical Manual. 36 VS-IMT User Manual A100K11619

37 General settings Pulse Client and Pulse server settings Intercom API I/O Enable application to receive I/O (DTMF) Other and Ringlist settings Set Site, SIP username /password. Set up ringlists. Upload changes Configuration status Will show if changes are uploaded to a station Registration status Is Pulse client registered in the Pulse system Audio and Call setttings Settings that control speaker and microphone, and also some advanced audio features. Call settings are also provided. Intercom API Default control center Set it to Dir. No. or select a ringlist Figure 21 Configure step B.2.1 Server Configuration If a selected device is a server, select the Server radio button in the General Settings field. The main settings for a server device to connect to the Pulse network are listed under General Settings. IMPORTANT: The Pulse server must have a static IP address. This can be done in the DHCP server by fixing the IP address to the MAC address of the Pulse server. 37 VS-IMT User Manual A100K11619

38 Clean client directory: This will erase all clients that were previously configured on that server; otherwise new devices will be added to the existing list. License key: Copy and paste the license key from the license file and upload it to the server to enable the system and its functions. For client/server configuration it is required to configure server and clients together because configuration data needs to be sent to both the server and clients. However if you just want to add one (or more) client to the server, you need to discover both the server and client, and then set server address in client settings and leave the Clean client directory box unchecked. Once FINISH is clicked on the Review results page, all the selected stations will be added to the project. B.3 Additional Configuration The configuration of all devices can also be changed after adding them to the main VS-IMT screen. Selecting each device will display all device settings on the right side of the main window. Settings are grouped into different groups: Call Settings, SIP Settings, Audio Settings, and Ringlist settings. Note that array of configurable settings is much smaller than in Standard VS-IMT project. Selecting each Pulse Server in the project will initially open the ZAP Pulse Server settings group which offers the possibility of reconfiguring the existing Pulse system. Aside from adding Pulse clients to the Pulse server there is additional option of adding 3 rd -party SIP terminals and GSM/SIP gateways to the server. To add GSM/SIP gateways to the Pulse Server, follow these steps: Click the ADD button located below the GSM/SIP Gateways list A new entry will appear. Edit this entry so that Dir. No. is the same as the username which is set on the Gateway SIP settings. The Display Name does not affect the configuration and can be set to any value. Click Upload to push settings to the Pulse Server Note that a specific license for Gateways and 3 rd party SIP terminals has to be installed to be able to register. 38 VS-IMT User Manual A100K11619

39 Figure 22 Clients on a selected Pulse server The new configuration is immediately applied after clicking the UPLOAD button. Note that clients can be added to the Server directory either by selecting an existing client in the project (Add > Client from project), or by manually entering an External client. Figure 23 Adding a Pulse client from a project 39 VS-IMT User Manual A100K11619

40 B.3.1 Uploading SIP/Call/Audio/Ringlist Settings to Device These settings can be stored by clicking the Apply button of each setting group. It is possible to create multiple changes before pushing everything to the devices. Clicking on the UPLOAD button pushes all changes to all the changed devices. The two-step application process gives the user the possibility of discarding all changes if desired. Figure 24 Upload changes B.3.2 ZAP Specific Settings All the settings in the ZAP Specific Settings group are live - they are collected at the moment the user selects the ZAP Specific Settings group and applied immediately to the device by clicking the UPLOAD button. Server Registration Status: Real-time status - shows if device is registered on Pulse server Tone Test Options: Used for testing whether microphone is working by playing tone on the speaker and checking feedback on microphone. Tone test is currently supported only on Windows devices Control Center: Setting Control Center Number. I/O Settings: Indicates whether the selected client requires I/O license so that it can receive I/O actions (DTMF). Figure 25 ZAP Specific Settings 40 VS-IMT User Manual A100K11619

41 B.4 Licensing VS-IMT is used to load the License file and send the license key to the License manager (Domain controller / Pulse server). The license can be loaded to the Pulse server in three ways: 1. In the station wizard, inside of Configure step 2. In the main project window, by clicking on the Pulse Server station and then on Server licenses 3. In Project > Project Settings menu, under the License tab, and by selecting Pulse server from the Domain Controller dropdown list. In the License Upload dialog-box, it is enough to copy and paste the license key from the license file and clicking on the Upload button. The license will be uploaded to the server and the license status will be displayed immediately in VS-IMT. Figure 26 License upload Note: The license can be uploaded from the station web interface by selecting Station Administration > Licensing. The License Key can be inserted in the New License field. 41 VS-IMT User Manual A100K11619

42 C VS-IMT & Station Web Interface C.1 Standard VS-IMT Project Once stations are configured with VS-IMT it is recommended that the station web interface is used only for settings that are not available in VS-IMT. If it happens that the station is reconfigured using the station web interface or if the state of the station configuration is not known, it is strongly advised to rerun the Discovery Wizard and add the station to the project again. Existing stations in the project will be overridden and all settings will be updated. C.2 VS-SDK for Pulse-enabled Project All stations that are configured with VS-SDK for Pulse-enabled project or with any other tool that uses ZAP (Zenitel Application Protocol), will not be affected by changes done in a VS-IMT Standard project or the station web interface. In the station web interface, such a state is notified with a banner: VS-IMT does not provide the same information directly, so the user must be aware of such a scenario. In case the station needs to be configured in a Standard project, it is required to log into the station web interface and in Station Administration select the system command Delete ZAP data.lua. All configuration done in VS-SDK for Pulse enabled project on that station will then be lost (ZAP database is cleared). Alternatively, the station can be factory rebooted from the Standard project or the station web interface (WARNING: ALL CONFIGURATION WILL BE LOST). Use the Station wizard to discover the station again before continuing with any configuration either in Standard or in VS-SDK for Pulse enabled project type. 42 VS-IMT User Manual A100K11619

43 ZENITEL PROPRIETARY. This document and its supplementing elements, contain Zenitel or third party information which is proprietary and confidential. Any disclosure, copying, Zenitel Norway AS DOC NO. A100K11619