Once the basic Platform configuration has been completed, it is time to start configuring the software. This includes the very important step of patching the SUITE to the latest version of the software.
This article explains how to:
- Activate your license key
- Update the SUITE version
- Add a calendar integration
- Add a meeting room
- Add a video system
- Add a matching rule
- Deploy our configuration and begin using the Synergy SKY Software
|Synergy SKY Platform Configuration||
The Synergy SKY product has been deployed and running in a virtualized environment and the basic platform configuration has been completed. If this requirement is not already fulfilled, please start here.
As a Synergy SKY customer you receive a license document containing information regarding your license. Before you can continue with this guide, make sure that you have your API key available.
|Service account||This account should have FullAccess permissions to the Room resource calendars we intend to have the Synergy SKY software monitor|
|Room resource calendar||
The room must have the appropriate permissions and settings based on your current calendar integration
|Video System access||IP address, login credentials|
|Internet access from Software server||This is required for license activation as well as some MCU and Sensor access|
Note: This guide will explain how to configure the Synergy SKY Software for EWS, using a Cisco endpoint and Cisco Webex. For Graph API, Google API, or for more details on EWS API, as well as adding other endpoint and meeting types, please refer to our How To guides.
For more details related to each of the configuration pages in this guide, please refer to the Configuration Reference.
Step by Step Guide
Opening the Configuration Tool
1. Open the browser and enter the server URL/IP address, e.g. https://192.168.56.185.
2. Click Synergy CONFIG to enter the global configuration. When prompted for credentials, use the following default credentials:
3. You will be redirected to the End User License Agreement, and this agreement has to be accepted before you can proceed with the configuration
Activate Your License Key
- Click GENERAL SETTINGS and then License
- Provide your API key and click Validate. Once the API key is validated, the license details will populate, including expiry date and number of rooms covered by your license.
- Click Save Changes, and then deploy the configuration changes in order for the license information to take effect.
- If your installation of the Synergy SKY Platform does not have access to the Synergy SKY license server (refer to the General Requirements), you will need to contact your Synergy SKY representative to obtain an offline license key.
- You can check access to the License server by verifying the server can access THIS LINK in a browser. A successful check will show:
Upgrade SUITE to latest version
Synergy SKY SUITE uses a base image + patch for initial installations. This base + patch method helps keep our various deploys consistent and simple. Updating the software after initial deploy is crucial for proper functionality.
- Navigate to CONFIG TOOL > Software Updates
The page will display your current version
- Click "UPDATE INFORMATION" to check for the latest version
- The latest available release will display.
- Click "UPDATE" and monitor while the update is performed
- After the upgrade process is completed, click the "Return to Synergy SKY Suite" button
- Navigate back to CONFIG TOOL > Software Updates to verify you're running the latest version
Note: The software must be patched before continuing.
Adding a Calendar Integration
The Synergy SKY Software requires a calendar integration in order to run. The supported calendars are Microsoft Exchange on-prem, Microsoft Office 365 (Exchange Online) and Google Calendar. You will need an Exchange or Google Workspace administrator user to configure the respective calendar system prior to adding the calendar integration by following the relevant guide below:
- How To: Configure for Exchange with EWS
- How To: Configure for Exchange with Graph API (Office 365)
- How To: Configure for Google Calendar (Google Workspace)
Note: This guide will explain how to add an EWS integration. For Graph API, Google API, or for more details on EWS API, please refer to our How To guides. Also see our Configuration Reference for more information on the individual fields.
- Start here: GENERAL SETTINGS > Integrations Settings
- Under Connections, click ADD CONNECTION
- From the drop-down menu, select your connection type. In this example, we are using EWS
- Name the connection. This is necessary for later steps
- Fill in the remaining empty fields
- Click TEST CONNECTION
- Click SAVE to save the room and return to the previous page
- Under API Integrations, click ADD API INTEGRATION
- From 'Used for' dropdown, select Calendar
- A new dropdown will appear called 'Connection', select your named calendar connection
- The remaining fields should auto-populate. Verify they are correct
- We recommend leaving Polling Interval at 0
Note: For EWS integrations, Microsoft Exchange sometimes requires the username to be in the format of "domain\username" and sometimes "username@domain". In the latter cases the domain field is optional.
- Click SAVE to save the integration
- Ensure the new API Integration is ENABLED
- In the top-right corner of the page, click SAVE CHANGES
Adding a Meeting Room
In this section, we will choose which meeting room resources should be monitored by the Software.
For adding additional rooms, or rooms of different types, see our How To on adding rooms in this guide.
- Under GENERAL SETTINGS > Rooms
- Click ADD ROOMS and wait for available rooms lists to load
- Use the dropdown to find a specific Room List, or search for a specific room by name or address
- When you find the rooms you wish to add, click them to select, then click ADD SELECTED ROOMS
- The selected rooms will show in the Rooms list
- Click SAVE CHANGES
Note: You can click 'Edit' next to the newly added room to change the occupancy limit, or its prescribed VMR pool.
Adding a Video System
In this step we will add and define a video system, then we will tie it to the room we configured in the previous step.
For more details, or instructions on adding systems of different types (Poly, other), see our How To guide.
- Under GENERAL SETTINGS > Video Systems
- Click ADD VIDEOSYSTEM
- From the drop-down menu, select the room we added in the last step
- Select the Manufacturer from the dropdown
- Enter the Video System's IP address (applicable for Cisco endpoints only)
- Enter the login credentials for the endpoint. These will be the same used to log into the endpoint from the unit's web interface, which is accessed by browsing to the IP address in a web browser (Cisco endpoints only)
- Enter the URI for the system.
- The rest of the information should auto-populate
- Click the TEST CONNECTION button at the bottom.
- A successful test will populate the 'Serial Number' field
- Click SAVE to return to the previous page
- Click SAVE CHANGES in the top-right of the page
Adding a Matching Rule
This is where we define to the software what meeting type to look for in order to push a green JOIN button to the endpoint. In this section, we will add a matching rule for Webex meetings.
For more details, or how to add and organize rules for additional meeting types, see our How To here.
- Under JOIN > Matching Rules
- Click ADD
- Name the rule. We typically name them after the meeting type with which they are associated.
- From the 'Rule Type' drop-down, select Regex Rule
- Click BUILD REGULAR EXPRESSION
- From the 'Regex Template' drop-down, select 'Webex meetings'
- You'll notice the software automatically populates the Matching and Replace values. You can paste a Webex invite into the 'Sample Text' field to verify a match.
- Click SAVE to return to the previous window
- Click SAVE to save the rule and return to the Matching Rules page
- Your rule will now appear in the list
- Click SAVE CHANGES
Deploying a saved configuration
After each change we make in the various sections of the software, you must SAVE CHANGES before moving to the next. After saving, a notice appears stating that your changes have been saved to the database, but not yet deployed/applied.
Note: You can choose to deploy after every SAVED change, or you can make multiple changes to the configuration and deploy them all at once. For additional information on how to name, organize, and manage your configuration versions, see our How To here.
- Under CONFIG TOOL > Configuration Versions
- At the bottom of the Configuration Versions page, click the line named "Current" to select the staged configuration we've created
- Click DEPLOY CONFIGURATION to apply those changes
- Click OK to confirm deploy
- The list at the bottom will update with your current configuration set. By default, deployed configurations are named "Publish Current"
You have now completed the basic configuration of the Synergy SKY Software, and are ready to tailor make it to suit your needs. The next step in the configuration procedure is to review our How To guides that describe how to expand and configure the Software to your specific environment.