Guide
Synergy SKY 3.4.9
June 2015
TOC
1: Introduction 4
Synergy SKY platform modules 4
Synergy SKY install procedure - your responsibilities 4
Further information about Synergy SKY 4
2: Configuring the SKY Application Server 5
Hardware requirements 5
Task 1: Installing the SKY Application Server operating system 5
Task 2: Installing Web Server (IIS), .NET and Visual C++ 5
Task 3: Downloading install files to the server 6
3: Configuring the SKY ComNode 7
Hardware requirements 7
Task 4: Preparing the server 7
Task 5: Downloading the SKY ComNode (and SKY Application Server
upgrade) files 7
Task 6: Deploying the .ovf template 7
Task 7: Using the SKY ComNode console to configure the SKY ComNode
server settings 8
Task 8: Testing the SKY ComNode 10
Supported browsers 10
4: Configuring the SKY Database Server 11
Hardware requirements 11
Task 9: Installing the SKY Database Server operating system 11 Task 10: Installing Microsoft SQL Server on the SKY Database Server 11
Task 11: Enabling Mixed-Mode authentication 11
7: Configuring the infrastructure components 16 Task 15: Ensuring infrastructure components are running a supported
software version 16
8: Configuring the Lync Server (if applicable) 17
Task 16: Configuring the Lync SQL server for real-time monitoring of the
Lync Front-End server(s) 17
Task 17: Configuring the Lync SQL server for CDR reporting 17
Task 18: Providing our engineer with Lync access and information 18
9: Providing our engineer with access and information 19
Task 19: Enabling remote access 19
Task 20: Configuring and providing DNS hostnames 19
Task 21: Providing SQL Database server details 19
Task 22: Providing SMTP details 19
1: Introduction
Synergy SKY platform modules
The Synergy SKY platform consists of the following main modules, each residing on a dedicated server or virtual machine:
l SKY Application Server
l SKY ComNode
l SKY Database Server
l Remote Agent Server (Optional)
This document describes how to configure each of these servers so that they are ready for our engineer to begin the installation on the agreed install date.
Synergy SKY install procedure - your responsibilities
The Synergy SKY install procedure is complex, and most of the install steps will be carried out by one of our engineers.
Before our engineer begins the installation, you must complete all the tasks described in this document as follows:
1. Configure the SKY Application Server, SKY ComNode, SKY Database Server and Remote Agent Server (optional), each on a dedicated server or virtual machine as described in Tasks 1-13.
2. Configure your network for Synergy SKY so that the modules and
infrastructure components can communicate freely through the firewall as described in Task 14.
3. Ensure any infrastructure components you want to integrate with Synergy SKY are running a supported software version as described in Task 15. 4. Optionally, configure Lync to work with Synergy SKY as described in
Tasks 16-18.
5. Provide our engineer with access, server addresses, and credentials as described in Tasks 19-22.
If you have any problems with any of the steps described in this document, or are unable to provide any of the essential information or access required, contact your Synergy SKY representative well before the installation date so we can resolve the issues and ensure your installation goes smoothly.
2: Configuring the SKY Application Server
The SKY Application Server has multiple functions. Both the Synergy SKY admin portal and the provisioning portal run on this server. In addition, the following services are hosted on the SKY Application Server:
l Harvest service. l Alert service. l Processing service. l All of the API services.
Hardware requirements
The SKY Application Server must be a dedicated server or virtual machine with this hardware configuration as a minimum:
CPU RAM Hard drive capacity
l 4 cores l 2 Ghz
8 GB 100 GB
Task 1: Installing the SKY Application Server operating system
Install one of these supported Microsoft Windows versions on the server:l Windows Server 2008 r2 l Windows Server 2012
Task 2: Installing Web Server (IIS), .NET and Visual C++
Once you have installed Windows on the SKY Application Server:1. In Server Manager, go to Add roles and features. 2. Under Server Roles, install Web Server (IIS) with:
o Basic Authentication o Digest Authentication
o Forms Authentication (2008 Only)
3. Under Features, install:
o .NET Framework 4.5 o ASP.NET 4.5
4. Download and installWindows Powershell 4.0 using the instructions here:
How to install Windows Powershell 4.0.
5. Download and install both the following on the server:
o Microsoft Visual C++ 2010 x64 Redistributable o Microsoft Visual C++ 2010 x86 Redistributable
Task 3: Downloading install files to the server
Download the Synergy SKY installation files and save them in a folder on the desktop of the SKY Application Server as follows:
1. In a browser window, enter:http://ftp.synergysky.com/software.
2. Log in using these credentials:
o Username:synergyftp o Password:getapps
3. Click on the3.4.9/ folder, and download SynergySKY_ComNode_ U3.4.9.zip and SynergySKY_WinNode_U3.4.9.zip.
4. Create a folder on the desktop of the SKY Application Server and save the files there.
3: Configuring the SKY ComNode
The SKY ComNode is installed as a Linux VMWare application server package. The SKY ComNode server hosts the following services:
l XMPP server l LDAP server
l MongoDB
l Low level drivers
Once Synergy SKY is installed, you will carry out most maintenance tasks on the SKY ComNode.
Hardware requirements
The SKY ComNode server must be a dedicated server or virtual machine with this hardware configuration as a minimum:
CPU RAM Hard drive capacity
l 4 cores l 2 Ghz
8 GB 200 GB
Task 4: Preparing the server
Install VMWare ESX (vSphere) version 5.0 or later on the SKY ComNode server.
Task 5: Downloading the SKY ComNode (and SKY Application
Server upgrade) files
1. In a browser window, enter:http://ftp.synergysky.com/software
2. Log in using these credentials:
o Username:synergyftp o Password:getapps
3. Click on the 3.4.7/ folder, and downloadSynergySKYComNode_3.4.7_ 203.ovf.zip.
4. Go back to the /software directory, and click on each version folder for subsequent releases after 3.4.7, and download eachSynergySKY_ Winnode_U3.4.x.build file and save it on your network.
Our engineer needs these files to upgrade Synergy SKY to the latest version during the install.
Task 6: Deploying the .ovf template
1. On the SKY ComNode server, open the VMware vSphere client. 2. Deploy the OVF template you downloaded in Step 3 above.
This will automatically extract all the necessary information from the .mf and .vmdk files that were also in the same folder.
3. Configure the server resources to your own company's internal requirements.
4. Start the server.
Task 7: Using the SKY ComNode console to configure the SKY
ComNode server settings
1. SSH to the IP address of the SKY ComNode Server to access the Command Line Interface using the following credentials:
o Username:root
o Password:SynergySkyWord
3. Configure the network settings for the server to your own company's network requirements:
Task 8: Testing the SKY ComNode
Now you need to test that the SKY ComNode setup and configuration was successful by logging into the SKY ComNode web interface from a browser:
1. In a browser, type:http://[server IP address or FQDN]:8080
2. Log in with the default admin user:
o User name:admin
o Password:SynergySkyWord
3. Go toConfiguration > Aboutand verify that the correct component version is listed for the Synergy SKY ComNode component:
Supported browsers
Browser Version
Google Chrome 32.0 or later
Firefox* 26.0 or later
Safari 7.0 or later
Note:There are some limitations when using Firefox for generating reports in Synergy SKY. We recommend using Google Chrome on a Windows platform.
4: Configuring the SKY Database Server
The SKY Database Server runs on Microsoft SQL Server 2008 R2 or 2012. This database stores the following data:
l System configuration l System data
l CDRs
l System and event logs
Note:All other data is stored in the MongoDB which runs on the ComNode.
Hardware requirements
The SKY Database Server must be a dedicated server or virtual machine with this hardware configuration as a minimum:
CPU RAM Hard drive capacity
l 2 cores l 2 Ghz
4 GB 50 GB (Size here depends on usage pattern and data retention policies)
Note:You can use this database server to host other applications' databases.
Task 9: Installing the SKY Database Server operating system
Install one of the following supported Microsoft Windows versions on the server:l Windows Server 2008 r2 l Windows Server 2012
Task 10: Installing Microsoft SQL Server on the SKY Database
Server
Install one of the following supported Microsoft SQL versions on the server:
l Microsoft MSSQL 2008 R2 Standard/Enterprise l Microsoft MSSQL 2012 Standard/Enterprise
Task 11: Enabling Mixed-Mode authentication
Enable Mixed-Mode authentication on the SQL server:1. In SQL Server Management Studio, right-click on the server in the Object Explorer and select Properties.
2. In Security, change Server authentication toSQL Server and Windows Authentication mode.
3. Click OK.
5: Configuring the Remote Agent Server (optional)
The main purpose of the Remote Agent Server is to fetch status information and call data records from infrastructure devices deployed at remote sites. This server is not mandatory in all types of installations, but is recommended for deployments where infrastructure devices are installed remotely.
This section describes configuring Windows on the server in preparation for the Synergy SKY install.
Hardware requirements
The Remote Agent Server must be a dedicated server or virtual machine with this hardware configuration as a minimum:
CPU RAM Hard drive capacity
l 2 cores l 2 Ghz
4 GB 50 GB
Task 12: Installing Windows on the Remote Agent Server
Install one of the following supported Microsoft Windows versions on the server:l Windows Server 2008 r2 l Windows Server 2012
Task 13: Configuring Windows on the Remote Agent Server
Once you have installed Windows on the Remote Agent Server:1. In Server Manager, go to Add roles and features. 2. Under Features, install:
o .NET Framework 4.5
3. In a browser window, download and install both the following on the server:
o Microsoft Visual C++ 2010 x64 Redistributable o Microsoft Visual C++ 2010 x86 Redistributable
6: Configuring your network
Task 14: Configuring NTP, site administrator access and network
communication
1. Configure all servers and infrastructure components in your deployment towards the same NTP server(s), either directly or indirectly.
2. Ensure that the Synergy SKY platform has Site Administrator access to all infrastructure components and APIs.
3. Configure your network to allow the following communication:
Source Destination Protocol TCP port Description
SKY Application Server
Database Server SQL 1433 Read/write to/from
Synergy SKY database
SKY Application Server
Cisco VCS l HTTP
l HTTPS
l 80 l 443
Read status and call log from VCS API
SKY Application Server
l Cisco Codian
MCU
l Cisco Codian
ISDN Gateway
XML over RPC l 80 (if HTTPS is not
enabled on the gateway)
l 443
Read status and call log from MCU and/or ISDN RPC API
SKY Application Server
Cisco TCS l HTTP
l HTTPS
l 80 (if HTTPS is not
enabled on the gateway)
l 443
Read status and call log from TCS API
SKY Application Server
l Pexip Infinity
Management node
l Pexip Infinity
Conference node l HTTP l SSH l 443 l 22
Read status and call logs
SKY Application Server
Acano MCU l HTTP
l HTTPS l 80 l 443 Read status SKY Application Server
Polycom RMX l HTTP
l HTTPS l 80 l 443 Read status SKY Application Server
Polycom DMA l HTTP
l HTTPS l SNMP
l 80 l 443 l 8443
l Read status l DMA API port l Real time status
Source Destination Protocol TCP port Description
SKY Application Server
ComNode(s) l XMPP
l XMPP TLS
l 5222 l 5269 XMPP communications SKY Application Server
ComNode(s) l LDAP
l LDAPS
l 389 l 636
l LDAP directory l LDAPS directory
SKY Application Server
ComNode(s) HTTP 80 ComNode API
SKY Application Server
SMTP server(s) l HTTP l HTTPS
l 80 l 443
Send password reset email(s) SKY Remote Agent SKY Application Server l HTTP l HTTPS l 80 l 443 Data exchange
ComNode SMTP server(s) SMTP 25 (or any port
configured for SMTP)
Send alert email(s)
ComNode Database server SQL 1433 Create/update SQL
database
ComNode Any Web 80 iFrame import for
Provisioning Management Customization ComNode Cisco Codian MCU XML over RPC l 80 (if HTTPS is not
enabled on the gateway)
l 443
Provision VMRs
ComNode Pexip Infinity Management node l HTTP l HTTPS l 80 l 443 Provision VMRs
ComNode Acano MCU l HTTP
l HTTPS
l 80 l 443
Provision CoSpaces and initiate user
synchronization
Acano MCU ComNode l LDAP
l LDAPS
l 389 l 636
Synchronization of users
Acano MCU SKY Application Server
HTTP 80 CDR collection (both
protocol and port can be customized)
Any ComNode Web 8080 Browser access to
7: Configuring the infrastructure components
Task 15: Ensuring infrastructure components are running a
supported software version
The following infrastructure software versions are supported for use with
Synergy SKY. It is your responsibility to ensure that any infrastructure you want to integrate with Synergy SKY is running a supported software version:
Infrastructure Version Comments
Cisco VCS All versions
from X4.3 -X8.6
Polycom DMA v6.1 l There are limitations with call matching H.323 calls. l Provisioning is not supported for Polycom DMA.
l The RealPresence Platform API license is required to integrate
the Polycom DMA with Synergy SKY (at additional cost from Polycom).
Lync 2013 Billing and Provisioning are not supported for Lync. Codian MCU All versions
from 4.2 - 4.5
UTC offset must be set to 0 due to the lack of support for automatic DST change.
Cisco TelePresence Server
v3.0 and v3.1 Provisioning is not supported for Cisco TelePresence Server
Pexip Infinity MCU All versions from v1 - v10
l FQDN host addresses are not supported for Pexip Infinity
nodes.
l A cluster must be created for any Pexip management and
conference node (s).
l The management node must be set as the conference master. l Any conference nodes must be added to their intended cluster.
Acano Server v1.0, v1.2, v1.7
Polycom RMX v8.5.1 l Provisioning is not supported for Polycom RMX. l There are limitations with call matching H.323 calls.
Cisco Codian ISDN Gateway
v2.7 l UTC offset must be set to 0 due to the lack of support for
automatic DST change
l Provisioning is not supported for Cisco Codian ISDN Gateway.
Cisco TelePresence Management Suite (TMS)
all versions from v13.2 -v14.6 Cisco TelePresence
Content Server (TCS)
v5.0 - v6.1 l Reporting and Billing are only supported if the call is routed
8: Configuring the Lync Server (if applicable)
Note:This section only applies if you want to integrate Microsoft Lync with Synergy SKY.
To integrate with Lync, the Synergy SKY platform requires read access to two of the Lync databases.
Task 16: Configuring the Lync SQL server for real-time monitoring
of the Lync Front-End server(s)
For real-time monitoring, Synergy SKY needs access to thertcdyn database, under the SQL instanceRTCLocal.
In a typical Lync deployment with multiple front-end servers configured, Synergy SKY needs access to all the front-end servers to gather real-time monitoring information.
To configure the Lync SQL server for real-time monitoring of the front-end servers:
1. Enable Mixed-Mode authentication on the SQL server:
a. In SQL Server Management Studio, right-click on the server in the Object Explorer and select Properties.
b. In Security, change Server authentication toSQL Server and Windows Authentication mode.
c. Click OK.
d. Restart SQL server when prompted.
2. Create an SQL user with Read-Only access to each 'rtcdyn' database.
Task 17: Configuring the Lync SQL server for CDR reporting
To retrieve the data for CDR reports, Synergy SKY needs access to the Lync CDR database.The default Lync CDR database name islcscdr, and Synergy SKY does not currently support using any other name. You can choose where to locate this database, so the SQL Server instance name will vary.
CDR reporting is not configured by default in a Lync deployment. To configure the Lync SQL server for CDR reporting:
1. Enable Lync CDR reporting following these instructions:Deploying monitoring in Lync Server 2013.
2. Enable Mixed-Mode authentication on the SQL server:
a. In SQL Server Management Studio, right-click on the server in the Object Explorer and select Properties.
b. In Security, change Server authentication toSQL Server and Windows Authentication mode.
c. Click OK.
d. Restart SQL server when prompted.
3. Create an SQL user with Read-Only access to thelcscdr database.
Task 18: Providing our engineer with Lync access and information
Provide us with:l Hostname or IP address for all Lync front-end servers.
l Username and password for thertcdyn database for all front-end servers. l Hostname or IP address and SQL instance name for the CDR database. l Username and password for thelcscdr database.
l The port number used to connect to all the SQL server instances
described above (if not 1433).
Note:Always restart the SQL server after changing to 'SQL Server and Windows' (Mixed-Mode) authentication.
Note: If you are not using the default SQL port (1433), ensure that you have configured your firewall to allow traffic on the port you are using instead.
9: Providing our engineer with access and information
You must configure and document everything listed below, and provide the information to the Synergy SKY representative responsible for your installation before the installation date. Failure to do so will cause your installation to be delayed.
Task 19: Enabling remote access
Provide our engineer with remote access to:l The SKY ComNode.
l The SKY Application Server.
l Remote Agent Server (if applicable).
Task 20: Configuring and providing DNS hostnames
Provide our engineer with the DNS FQDN for:l The SKY ComNode.
l The SKY Application Server.
l Remote Agent Server (if applicable).
Task 21: Providing SQL Database server details
1. Provide our engineer with:o SQL Server IP/FQDN address o SQL Server port
2. Do one of the following:
o Provide our engineer with an SQL user withsysadmin rights to the
SQL server.
o Create a database and provide an SQL user withdb_owner rights to
that database, and the name of the database if not the default (synergysky).
Task 22: Providing SMTP details
Provide our engineer with the following SMTP information:
l Server address l Port number
l SMTP Credentials (username and password) l Sender name
l Sender address
Note:If you want to integrate Lync with Synergy SKY, see"Configuring the Lync Server (if applicable)" on page 17and ensure you provide our engineer with Lync server access and information as described in that section.
Document revision history
Date Revision Description
19 August 2015
01 l Updated the supported browsers section adding a caveat saying some
functionality is limited when generating reports in Firefox.
l Updated the supported infrastructure section with latest supported versions. l Added Polycom call matching over H.323 limitation to the Infrastructure support
