How it Works
Crestron
Loading...
xio cloud
Table of contents
Loading...

Crestron xio cloud Service

Download
Page 1
User Guide
XiOCloud®
View this document in HTML
crestron.com/docs/8214
Provisioning and Management Service
Crestron Electronics, Inc.
Page 2
Have feedback on this document?Contact docfeedback@crestron.com.
Original Instructions
The XiO Cloud® service is licensed under Crestron’s Cloudware License Agreement, available at
www.crestron.com/Legal/software-products-on-premises-and-cloudware/cloudware-license-agreement.
The Crestron XiO Cloud™ Gateway software is licensed under Crestron’s On-Premises Software License and Maintenance Agreement available at www.crestron.com/Legal/software-products-on-premises-and-cloudware/on-premises-software-
license-maintenance-agreement.
Crestron product development software is licensed to Crestron dealers and Crestron Service Providers (CSPs) under a limited nonexclusive, nontransferable Software Development Tools License Agreement. Crestron product operating system software is licensed to Crestron dealers, CSPs, and end-users under a separate End-User License Agreement. Both of these Agreements can be found on the Crestron website at www.crestron.com/legal/software_license_agreement.
Certain Crestron products collect information that may include personal data. For further details regarding those Crestron products that collect, process, and transmit information directly to Crestron via the Internet, please refer to the Crestron Privacy Statement Regarding Internet Data Collection, located at www.crestron.com/legal-data-collection-privacy.
Authorized Support Provider access to customer XiO Cloud accounts is subject to authorization by the customer and to Crestron's XiO Cloud Monitoring Services Terms of Use, available at: www.crestron.com/XiOMonitoringTOU.
The Crestron Device Assistant App is licensed under Crestron’s Mobile Apps Terms of Use, available at
www.crestron.com/Legal/mobile-apps-tos-privacy.
The specific patents that cover Crestron products are listed at www.crestron.com/legal/patents.
Certain Crestron products contain open source software. For specific information, visit www.crestron.com/opensource.
Crestron, the Crestron logo, 3-Series, 4-Series, AirMedia, Avia, Crestron Connected, Crestron Fusion, Crestron Mercury, Crestron Toolbox, DigitalMedia, DM, DM8G+, DM NVX, DMPS Lite, FlipTop, infiNETEX, XiOCloud, and Zūm are either trademarks or registered trademarks of Crestron Electronics, Inc. in the United States and/or other countries. Apple TV is either a trademark or a registered trademark of Apple, Inc. in the United States and/or other countries. Dante is either a trademark or registered trademark of Audinate Pty Ltd. in the United States and/or other countries. Blu-ray and Blu-ray Disc are either trademarks or registered trademarks of Blu-ray Disc Association (BDA) in the United States and/or other countries. Jabra and PanaCast are trademarks of GN Audio A/S in the United States and/or other countries. HDMI is either a trademark or a registered trademarks of HDMI Licensing LLC in the United States and/or other countries. Lenovo and ThinkSmart are either trademarks or registered trademarks of Lenovo in the United States and/or other countries. Active Directory, Azure, Excel, Microsoft, Microsoft Teams, and Skype are either trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Okta is either a trademark or a registered trademark of Okta, Inc. in the United States and/or other countries. JavaScript is either a trademark or a registered trademark of Oracle Corporation in the United States and/or other countries. Polycom is either a trademark or a registered trademark of Plantronics, Inc. in the United States and/or other countries. Roku is either a trademark or a registered trademark of Roku, Inc. in the United States and/or other countries. Samsung is either a trademark or a registered trademark of Samsung Electronics Co., Ltd in the United States and/or other countries. ServiceNow is either a trademark or a registered trademark of ServiceNow,Inc. in the United States and/or other countries.USB-C and USB Type-C are either trademarks or registered trademarks of USB Implementers Forum, Inc. in the United States and/or other countries. DisplayPort is either a trademark or registered trademark of Video Electronics Standards Association in the United States and/or other countries. Wi-Fi is either a trademark or a registered trademark of Wi-Fi Alliance in the United States and/or other countries. Zoom Rooms is either a trademark or a registered trademark of Zoom Video Communications, Inc. in the United States and/or other countries. Other trademarks, registered trademarks, and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Crestron disclaims any proprietary interest in the marks and names of others. Crestron is not responsible for errors in typography or photography.
©2025 Crestron Electronics, Inc.
Page 3
Contents
Introduction 1
What's New? 3
Getting Started 8
Step 1:Register for an Account and Choose Your Subscription 8 Step 2:Log In to the Service 8 Step 3:Build Your Environment 8 Step 4:ClaimDevices 9 Step 5:Manage Devices 9 Step 6: Manage Users 9 Step 7:Configure Account Settings 9
How to Subscribe 11
Choose Your Subscription 11 Free XiOCloud Subscriptions 13 XiOCloud Premium Subscriptions 13
New XiOCloud Premium Subscriptions 13 Renew Existing XiOCloud Premium Subscriptions 15 Increase Device Count for XiOCloud Premium Subscriptions 17
Email Notifications 18
Log in to the Service 20
Navigate the Service 23
Progress Tracker 26
Build the Environment 27
Create the Building Address Book 27
Manage Buildings 29 Manage Space Properties 32
Create the Group Tree 33
Manage Groups 34 Manage Rooms 38 Manage Desks 47
Claim Devices 59
Claim Devices via the Device Assistant App 60 Claim a Single Device via XiOCloud 71 Claim Multiple Devices via XiOCloud 74
Unclaim Devices 76 Add Devices to Rooms or Desks 77 Cut and Paste 80 Download Inventory 82
User Guide — Doc. 8214BU Contents • i
Page 4
View Grouped Devices, Rooms, and Desks 82
Manage Devices 85
Rename a Device 86 View Device Status 87
View Status for a Single Device 88
View Status for a Group of Devices 89 Configure Device Settings 90
Configure Settings for a Single Device 90
Configure Settings for a Group of Devices 93
Prevent Unnecessary Restarts 96 Manage Licenses 97
Manage Licenses for a Single Device 97
Manage Licenses for a Group or Room 101 Scheduled Actions 102
Create a Scheduled Action 105
Edit a Scheduled Action 108
Delete a Scheduled Action 108 Dashboard 109 Activity Log 111 Device Metadata 113 Update Firmware 113 Restart Devices 116 Refresh Devices 116
Manage Users 117
Add a New User 117 Edit User Information 119 Manage User Access 119 Delete a User 121 Download User Activity Audit Log 122 Single Sign-On 122 What's New Message 124
Subscription Utilization 125
XiOCloud ProgramConnector 128
Room Program 129 Room Control 130 System Check 131 Status Indicators 132
Room Health 133
Room Occupancy 133
Maintenance Mode 133 Custom Alerts 134
ii • Contents User Guide — Doc. 8214BU
Page 5
Account Dashboard 135
Device Status 137 Occupied Rooms 139 Active Alerts - last 48 hours 141 Firmware Releases 142 Room Utilization 143 Room Usage Over Time 144 Uptime By Device 145 Device Offline Incidents 146
Historical Reports 147
Alerts 152
Configure Contact Information 152 Configure Alert Levels 153 Manage Alerts 155
Add a New Alert 157
Delete an Alert 159 View Alerts 160 Alert Batching Rules 160
File Library 161
Manage Files 162
Add a Program or Project 163
Edit a Program or Project 165 EDIDs 167
Add a Custom EDIDFile 168
Delete a Custom EDIDFile 169 Manage Images 171
Add an Image File 172
Delete an Image File 174 Load a Program to a Control System 175
Upload a New Program 175
Manage Programs 177
Load a Program to Device 180
Manage a Loaded Program 182
Start/Stop a Loaded Program 183
Unregister a Loaded Program 183
Remote Control 184
Enable Remote Control 184 Request Remote Control Access 185
Initiate a Request 186
Accept or Decline the Request 187
End a Remote Control Session 187 View a User Interface 188
User Guide — Doc. 8214BU Contents • iii
Page 6
Control a User Interface 189 Privacy Considerations 189
Enable API Access 191
Manage Support Providers 193
Add a Support Provider 194 Manage Support Providers 195
FAQs 197
Troubleshooting 202
Works with XiO Cloud 204
Audio 205
Amplifiers 205
Digital Signal Processors 205
Multiroom Audio Accessories 205
Speakers 206 Conferencing 207
AirMediaWireless Presentation and Conferencing 207
Crestron Flex Solutions 207
Crestron Flex Hubs and Pods 215 Connectivity 216
USBSwitchers 216 Control 217
3-Series Control Systems 217
4-Series Control Systems 217
Crestron Virtual Control Server-Based Control Systems 217
Media Presentation Controllers 217
Smart Display Controllers 218 Intelligent Video 219
1 Beyond Intelligent Video 219 Lighting and Environmental 220
Lighting Control Systems 220 Power 221
Power Conditioners 221 Scheduling 222
Room Scheduling Touch Screens 222
Desk Scheduling Devices 222 Sensors 223
Occupancy Sensors 223 Third-Party Devices 224
Crestron Connected Devices 224
Crestron Driver Devices 224
Third-Party Device Monitoring Gateway Software 224 Touch Screens 225
iv • Contents User Guide — Doc. 8214BU
Page 7
Tabletop Touch Screens 225
Touch Screen Control Systems 225
Wall Mount Touch Screens 225
Wireless Touch Screens 226 Video 227
AirMediaWireless Presentation and Conferencing 227
Digital Graphics Engines 227
DigitalMedia Solutions 227
HDMISolutions 229
Smart Display Controllers 230
Appendixes 231
Appendix A: Configure ServiceNow for XiO Cloud Alerts 232
Client Prerequisites 232
Turn on ServiceNow Within XiOCloud 233
Create XiOIncident Script 234
Close Incident XiOScript 237
Close ServiceNow Incidents in XiOCloud 238
Additional Resources 248 Appendix B: User Access Matrix 249 Appendix C: XiO Cloud Program Connector Sources 252
User Guide — Doc. 8214BU Contents • v
Page 8

Introduction

The XiO Cloud® provisioning and management service allows all supported Crestron® devices and certain supported third-party devices across an enterprise to be managed and configured from one central, secure location in the cloud. The XiO Cloud service may be used to view the status of a device, to configure various device and network settings, to manage licenses, and to update device firmware.
NOTE:Third-party device management and configuration is supported by XiOCloud Premium subscriptions only.
The XiO Cloud service is an IoT (Internet of Things) based platform that provides the following benefits for an enterprise:
NOTE: Certain XiOCloud features are supported by an XiOCloud Premium subscription only. The following banner is shown above XiOCloud Premium features within accounts with free XiOCloud subscriptions. Other items, such as premium dashboard tiles, are grayed out and cannot be selected within accounts with free XiOCloud subscriptions.
For more information on XiOCloud subscriptions, refer to How to Subscribe on page 11. For a complete list of supported features for each subscription, refer to the XiOCloud Feature
Comparison Chart.
Quick Deployment
l
Configure new or replacement devices before installation
l
Retrieve device settings automatically
l
Drag-and-drop naming, configuration, and organization
Remote Management
l
Change settings for multiple devices across the enterprise simultaneously
l
Update firmware for all devices across the enterprise simultaneously
l
View cloud audit logs to identify and resolve issues quickly
Instant Monitoring
l
View live status of all connected devices from anywhere at any time
l
Monitor device changes in real time
l
No extra configuration tools are required for monitoring
Confident Evolution
l
Interactive dashboards provide real-world usage data
l
No programming is required for data gathering
User Guide — Doc. 8214BU XiOCloud® • 1
Page 9
l
Optimize workplace technology experiences
For more details and additional resources, refer to https://www.crestron.com/xiocloud.
NOTE:This document is current as of the XiOCloud version 2.5 release.
Refer to Getting Started on page 8 for important information on using the XiOCloud service and this document.
2 • XiOCloud® User Guide — Doc. 8214BU
Page 10

What's New?

Updates to the XiOCloud service and documentation are described below from newest to oldest (starting with XiOCloud release 1.63).
September 12, 2025
l
XiO Cloud v2.5 Released
o
XiO Cloud v2.5 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Added new Getting Started on page 8 topic for users new to the XiOCloud service.
o
Updated Build the Environment on page 27 and Appendix B: User Access Matrix on page 249 with the ability to claim devices directly into rooms and desks.
o
Updated Build the Environment on page 27 to reflect that a scheduling calendar email is now optional when adding or importing desks.
o
Updated Manage Users on page 117 with a note about how user logoff events are handled in the audit log.
o
Updated Alerts on page 152 with information about alert batching rules.
o
Updated File Library on page 161 with support for .ch5z files.
July 25, 2025
l
XiO Cloud v2.4 Released
o
XiO Cloud v2.4 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Added new Subscription Utilization on page 125 topic to describe controls for managing an XiOCloud Premium subscription utilization within the portal.
o
Updated How to Subscribe on page 11 with new email notification that is sent 90 days prior to the anniversary date of an XiOCloudPremium subscription.
o
Updated Manage Devices on page 85 with the ability to edit scheduled actions and information about scheduling actions across grouped spaces (rooms and desks).
User Guide — Doc. 8214BU XiOCloud® • 3
Page 11
June 30, 2025
l
Device Assistant App v2.1 Released
o
The Device Assistant App v2.1 has been released publicly.
l
Documentation Updates
o
Updated Build the Environment on page 27 and Appendix B: User Access Matrix on page 249 to reflect the ability for Global Administrators to claim devices directly into rooms or groups using the CrestronDevice Assistant app.
o
Added DM-NVX-385 and DM-NVX-385C to Works with XiO Cloud on page 204
June 6, 2025
l
XiO Cloud v2.3 Int 1 Released
o
XiO Cloud v2.3 Int 1 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated Build the Environment on page 27 and Appendix B: User Access Matrix on page 249 to reflect that standard users can now claim devices into XiOCloud via the XiOCloud portal.
o
Updated Appendix A: Configure ServiceNow for XiO Cloud Alerts on page 232 to add information for enabling a "close ticket" delay from XiOCloud to a ServiceNow® instance.
o
Updated Manage Users on page 117 to add support for Entra IDsingle sign-on integration.
May 23, 2025
l
XiO Cloud v2.3 Released
o
XiO Cloud v2.3 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated Manage Devices on page 85 with option to select a room's time zone for scheduled actions.
May 9, 2025
l
XiO Cloud v2.2 Int 1 Released
o
XiO Cloud v2.2 Int 1 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
4 • XiOCloud® User Guide — Doc. 8214BU
Page 12
o
Updated Navigate the Service on page 23 with information about the Subscription Utilization indicator (for XiOCloud Premium subscriptions only).
April 25, 2025
l
XiO Cloud v2.2 Released
o
XiO Cloud v2.2 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated How to Subscribe on page 11 to summarize the different email notifications sent to the account administrator and to add new XiOCloud Premium subscription true-up SKUs.
o
Updated Navigate the Service on page 23 with changes to Account Info window.
o
Updated Build the Environment on page 27 with instructions on how to claim Crestron devices using the Crestron Device Assistant app.
o
Updated Alerts on page 152 with ServiceNow® software and enable notification controls.
March 14, 2025
l
XiO Cloud v2.1 Released
o
XiO Cloud v2.1 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated Alerts on page 152 and Account Dashboard on page 135 to add information about room-based alerts (for XiOCloud Premium subscriptions only).
o
Added note to Historical Reports on page 147 and Account Dashboard on page 135 regarding time zone synchronization for hour-based reports.
o
Updated Log in to the Service on page 20 to reflect latest UIchanges.
o
Added Intelligent Video on page 219 to Works with XiO Cloud on page 204 with support for Automate VX2 models.
January 31, 2025
l
XiO Cloud v2.0 Released
o
XiO Cloud v2.0 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
User Guide — Doc. 8214BU XiOCloud® • 5
Page 13
o
Updated Introduction on page 1 with note XiOCloud Premium features.
o
Updated How to Subscribe on page 11 to reflect new processes for XiOCloud and XiOCloud Premium subscriptions.
o
Updated Navigate the Service on page 23 to add information on Account Info window.
o
Updated various topics to indicate XiOCloud Premium functionality (where applicable)and removed mention of discontinued XiOCloud licenses.
o
Removed Licensed Features topic (no longer applicable with new XiOCloud and XiOCloud Premium subscriptions).
o
Updated Third-Party Devices on page 224 in the Works with XiO Cloud on page 204 section to remove list of supported Crestron Connected® devices (these are provided instead in the linked web app).
January 9, 2025
l
XiO Cloud v1.64 Int 1 Released
o
XiO Cloud v1.64 Int 1 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated Build the Environment on page 27 to indicate that device IPaddresses are now selectable and will navigate to the device web configuration interface in a new tab (if available).
December 20, 2024
l
XiO Cloud v1.64 Released
o
XiO Cloud v1.64 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Updated Manage Devices on page 85 and XiOCloud ProgramConnector on page 128 with information about the maintenance mode schedule room action.
o
Updated Log in to the Service on page 20, Manage Users on page 117, and Alerts on page
152 to reflect latest UIchanges.
December 6, 2024
l
XiO Cloud v1.63 Int 1 Released
o
XiO Cloud v1.63 Int 1 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
6 • XiOCloud® User Guide — Doc. 8214BU
Page 14
o
Updated Log in to the Service on page 20 to reflect new login workflow.
o
Added notes to Account Dashboard on page 135 and Historical Reports on page 147 that certain data is shown only up until the end of the previous day.
November 15, 2024
l
XiO Cloud v1.63 Released
o
XiO Cloud v1.63 has been released publicly. Refer to the release notes posting on the Crestron website for detailed information about this release.
l
Documentation Updates
o
Added information about room scheduled actions to XiOCloud ProgramConnector on
page 128 and Manage Devices on page 85.
o
Added support for the DM-NVX-384(C) to Works with XiO Cloud on page 204.
User Guide — Doc. 8214BU XiOCloud® • 7
Page 15

Getting Started

Follow the seven steps below to get started with the XiOCloud service.
Step 1:Register for an Account and Choose Your Subscription
The XiOCloud service is available in a free XiO Cloud subscription (SW-XIOC) and a paid XiOCloud Premium subscription (SW-XIOC-PREMIUM-1YR-1-99, SW-XIOC-PREMIUM-1YR-100-499, and
SW-XIOC-PREMIUM-1YR-500+). All XiOCloud subscriptions require an XiOCloud account registration.
Anew XiOCloud account can be created when a subscription is activated, or an existing XiOCloud account can be selected.
l
Refer to How to Subscribe on page 11 for instructions on registering for an account and choosing a subscription.
l
Refer to Subscription Utilization on page 125 for information on managing device usage within an XiOCloud Premium subscription.
Step 2:Log In to the Service
Log in to the XiO Cloud service at https://portal.crestron.io. The account administrator identified in the new XiOCloud account registration will receive an email from Crestron that provides a username and a temporary password. These credentials are used for the initial login.
l
Refer to Log in to the Service on page 20 for instructions on logging in for the first time.
l
Refer to Navigate the Service on page 23 for information on how to navigate the XiOCloud user interface.
l
Refer to Single Sign-On on page 122 for information on how to configure a single sign-on (SSO) identity provider with an XiOCloud account.
Step 3:Build Your Environment
The XiO Cloud service environment consists of groups, rooms, desks, and devices. XiOCloud administrators are able to create virtual buildings with multiple floors that represent their organization's workspaces. Once a building has been created, rooms or desks that contain devices can be added using the group tree.
l
Refer to Create a New Building on page 30 for instructions on creating a building address book.
l
Refer to Create the Group Tree on page 33 for instructions on creating and managing groups, rooms, and desks.
8 • XiOCloud® User Guide — Doc. 8214BU
Page 16
Step 4:ClaimDevices
Devices must be claimed into the XiO Cloud service before they can be managed. Devices can be claimed individually or as a group. Supported Crestron devices can also be claimed using the
CrestronDeviceAssistant app. Any user (standard or admin) can claim devices into XiOCloud using
either the Crestron Device Assistant app or XiOCloud portal.
l
Refer to Works with XiO Cloud on page 204 to view all devices that are supported by the XiOCloud service.
l
Refer to Claim Devices via the Device Assistant App on page 60 for instructions on claiming devices using the Device Assistant app.
l
Refer to Claim a Single Device via XiOCloud on page 71 for instructions on claiming a single device using the XiOCloud user interface.
l
Refer to Claim Multiple Devices via XiOCloud on page 74 for instructions on claiming multiple devices at once using the XiOCloud user interface.
Step 5:Manage Devices
Devices may be managed via the XiO Cloud service after they have been claimed by the service and added into a group or room. Devices may be managed individually or as a group.
l
Refer to Add Devices to Rooms or Desks on page 77 for instructions on adding a claimed device to a room or desk.
l
Refer to Manage Devices on page 85 for information on various device management functions.

Step 6: Manage Users

Individuals in an organization can have their own login credentials to access the XiO Cloud service. The system administrator can limit a user's access to only the room or groups that they need to manage. Users can also receive custom device or room alerts that are generated from within XiOCloud.
l
Refer to Manage Users on page 117 for instructions on adding and managing users for the XiOCloud account.
Step 7:Configure Account Settings
Global administrators can configure various account settings to get the most out of their XiOCloud deployment.
l
Refer to Alerts on page 152 for instructions on configuring alerts for devices and rooms.
l
Refer to Remote Control on page 184 for instructions on configuring remote control for supported user control devices.
l
Refer to Enable API Access on page 191 for instructions on enabling the XiO Cloud REST API functionality.
User Guide — Doc. 8214BU XiOCloud® • 9
Page 17
l
Refer to Appendix A: Configure ServiceNow for XiO Cloud Alerts on page 232 for instructions on integrating your XiOCloud account with a ServiceNow® software instance.
l
Refer to Manage Support Providers on page 193 for instructions on granting account access to Authorized Support Providers.
10 • XiOCloud® User Guide — Doc. 8214BU
Page 18

How to Subscribe

The following sections describe how to subscribe to XiOCloud and XiOCloud Premium subscriptions.

Choose Your Subscription

The XiOCloud service is available in a free XiO Cloud subscription (SW-XIOC) and a paid XiOCloud Premium subscription (SW-XIOC-PREMIUM-1YR-1-99, SW-XIOC-PREMIUM-1YR-100-499, and
SW-XIOC-PREMIUM-1YR-500+). All XiOCloud subscriptions require an XiOCloud account registration.
Anew XiOCloud account can be created when a subscription is activated, or an existing XiOCloud account can be selected.
NOTE:For a complete list of supported features for each subscription, refer to the XiOCloud
Feature Comparison Chart.
l
The free XiOCloud subscription allows enterprises to provision, monitor, and manage Crestron devices across virtual rooms and desks that represent their physical spaces. It also provides support for user management, cloud activity logs, alerts, and file libraries, as well as some limited dashboard and APIfunctionality.
l
The XiOCloud Premium subscription provides all the functionality of the free XiOCloud subscription with additional support for third-party device management (including via the Crestron XiOCloud™ Gateway software), historical reports, program connector functionality, touch screen remote control, ServiceNow® software integration, full dashboard and API functionality, and more.
The XiOCloud Premium subscription uses a device-based licensing model: purchase a specified device count based on the anticipated number of devices in your XiOCloud account. If an account exceeds the budgeted device count over the course of the year, a true-up process is provided that allows you to purchase and adjust the device count either proactively (SW-XIOC-PREMIUM-TRUE-UP) or retroactively (SW-XIOC-PREMIUM-TRUE-UP-1-99, SW-XIOC-PREMIUM-TRUE-UP-100-499, and
SW-XIOC-PREMIUM-TRUE-UP-500+) to reflect your increased device usage. This model allows
enterprises to be flexible with their XiOCloud deployment based on changing business or space usage needs while avoiding any down time for new devices.
NOTE:XiOCloud accounts can only have one subscription type at a time.
User Guide — Doc. 8214BU XiOCloud® • 11
Page 19
The following table provides an overview of the XiOCloud Premium subscription licenses. For more information, including pricing, visit the product pages by selecting the appropriate link in the table.
License Model/SKU# Description
SW-XIOC-PREMIUM-1YR-1-99 3002322 One-year XiOCloud Premium subscription
for accounts with 1 to 99 total devices. Subscription is priced and purchased based on device count.
SW-XIOC-PREMIUM-1YR-100-499 3002324 One-year XiOCloud Premium subscription
for accounts with 100 to 499 total devices. Subscription is priced and purchased based on device count.
SW-XIOC-PREMIUM-1YR-500+ 3002325 One-year XiOCloud Premium subscription
for accounts with 500 or more devices. Subscription is priced and purchased based on device count.
SW-XIOC-PREMIUM-TRUE-UP 3002326 Device count true-up for XiOCloud
Premium subscriptions. Can be applied proactively to increase device count at any time during a subscription term. For more information, refer to the Crestron
XiOCloud Premium True-Up Guide.
SW-XIOC-PREMIUM-TRUE-UP-1­99
SW-XIOC-PREMIUM-TRUE-UP­100-499
SW-XIOC-PREMIUM-TRUE-UP­500+
3002332 Device count true-up for XiOCloud
Premium subscriptions with 1 to 99 total devices. Applied retroactively upon receipt of a true-up statement for the device count usage within the past year. For more information, refer to the Crestron
XiOCloud Premium True-Up Guide.
3002333 Device count true-up for XiOCloud
Premium subscriptions with 100 to 499 total devices. Applied retroactively upon receipt of a true-up statement for the device count usage within the past year. For more information, refer to the
Crestron XiOCloud Premium True-Up Guide.
3002334 Device count true-up for XiOCloud
Premium subscriptions with 500 or more devices. Applied retroactively upon receipt of a true-up statement for the device count usage within the past year. For more information, refer to the Crestron
XiOCloud Premium True-Up Guide.
12 • XiOCloud® User Guide — Doc. 8214BU
Page 20
Free XiOCloud Subscriptions
Authorized resellers and end users can request a free XiO Cloud subscription directly through the
Licensing and Registration Hub.
1. Within the hub, select the Crestron XiOCloud tab (open by default), and then expand the New Account Registration &Licensing accordion.
2. Select See the Form to open the XiOCloud Account Registration form.
3. Select New or Existing from the XiOCloud Account drop-down menu depending on whether a new or existing account will be used for the subscription.
4. Select Subscribe to free XiOCloud service from the Registration Type drop-down menu.
5. Enter all other required information in the appropriate fields.
6. Agree to the Crestron License Agreement and Privacy Statement Regarding Internet Data Collection by filling the check boxes.
7. Select Submit at the bottom of the form.
The form is submitted directly to Crestron, who initiates creating the account. The account administrator receives the new account information via email, including account credentials and a temporary password.
XiOCloud Premium Subscriptions
Authorized resellers can purchase new XiOCloud Premium subscriptions or renew existing subscriptions directly through Crestron. Existing subscriptions can also be upgraded to increase the device count.
NOTE:Crestron does not automatically activate renewals for XiOCloud subscriptions. The authorized reseller must submit a purchase order and an updated XiOCloud registration form to activate or renew the subscription, pending verification by Crestron. For more information, refer to
Renew Existing XiOCloud Premium Subscriptions on page 15.
New XiOCloud Premium Subscriptions
To purchase a new XiOCloud Premium subscription:
1. The authorized reseller submits a purchase order (PO)for the subscription to
orders@crestron.com (US), ceurorders@crestron.com (EU), asiaorders@crestron.com (ASIA), or anzorders@crestron.com (ANZ) Include the following information in the POto avoid ordering
delays:
l
Specify that the order is for a new XiOCloud Premium subscription
l
End user and project name (for reference)
l
Expected device count
l
Subscription term (in years)
2. The authorized reseller receives an order confirmation along with a link to the Licensing and
Registration Hub.
User Guide — Doc. 8214BU XiOCloud® • 13
Page 21
3. The authorized reseller forwards the order confirmation to the end user, including the request to complete the XiOCloud registration form.
NOTE:The end user must provide a POnumber or Crestron Sales Order number from the authorized reseller as part of the activation process.
4. The end user completes the XiOCloud registration form as follows when they are ready to activate the subscription:
a. Within the hub, select the Crestron XiOCloud tab (open by default), and then expand the
New Account Registration &Licensing accordion.
b. Select See the Form to open the XiOCloud Account Registration form.
c. Select New or Existing from the XiOCloud Account drop-down menu depending on
whether a new or existing account will be used for the subscription.
d. Select Subscribe to paid XiO Cloud Premium service from the Registration Type drop-down
menu.
e. Enter all other required information in the appropriate fields.
f. Enter the Purchase Order or Crestron Order Number as provided by the dealer.
g. Agree to the Crestron License Agreement and Privacy Statement Regarding Internet Data
Collection by filling the check boxes.
h. Select Submit at the bottom of the form.
5. The form is submitted directly to Crestron, who initiates creating the account.
6. The account administrator receives the new account information via email, including account credentials and a temporary password.
14 • XiOCloud® User Guide — Doc. 8214BU
Page 22
Refer to the following process diagram for an overview on how to order new XiOCloud Premium subscriptions.
Renew Existing XiOCloud Premium Subscriptions
To renew existing XiOCloud Premium subscriptions:
1. The authorized reseller submits a purchase order (PO)for the subscription to
orders@crestron.com (US), ceurorders@crestron.com (EU), asiaorders@crestron.com (ASIA), or anzorders@crestron.com (ANZ) Include the following information in the POto avoid ordering
delays:
l
Specify that the order is to renew an existing XiOCloud Premium subscription
l
End user and XiOCloud account name (for reference)
l
Expected device count (to be verified by Crestron)
l
Subscription term (in years)
2. The authorized reseller receives an order confirmation along with a link to the Licensing and
Registration Hub.
3. The authorized reseller forwards the order confirmation to the end user, including the request to complete the XiOCloud registration form.
NOTE:The end user must provide a POnumber or Crestron Sales Order number from the authorized reseller as part of the activation process.
User Guide — Doc. 8214BU XiOCloud® • 15
Page 23
4. The end user completes the XiOCloud registration form as follows when they are ready to renew the subscription:
a. Within the hub, select the Crestron XiOCloud tab (open by default), and then expand the
New Account Registration &Licensing accordion.
b. Select See the Form to open the XiOCloud Account Registration form.
c. Select Existing from the XiOCloud Account drop-down menu.
d. Select Renew XiO Cloud Premium Subscription from the Registration Type drop-down
menu.
e. Enter all other required information in the appropriate fields.
f. Agree to the Crestron License Agreement and Privacy Statement Regarding Internet Data
Collection by filling the check boxes.
g. Select Submit at the bottom of the form.
5. The form is submitted directly to Crestron, who initiates the renewal process.
6. The account administrator receives their updated account information via email, including the total device count and updated expiration date.
Refer to the following process diagram for an overview on how to renew XiOCloud Premium subscriptions.
16 • XiOCloud® User Guide — Doc. 8214BU
Page 24
Increase Device Count for XiOCloud Premium Subscriptions
End users can add more devices to their account before the end date of their subscription term. Crestron strongly recommends working with our Licensing team (license@crestron.com)to accurately determine what should be ordered based on the end user's account and needs.
To increase the device count for XiOCloud Premium subscriptions:
1. The authorized reseller submits a purchase order (PO)for the subscription to
orders@crestron.com (US), ceurorders@crestron.com (EU), asiaorders@crestron.com (ASIA), or anzorders@crestron.com (ANZ) Include the following information in the POto avoid ordering
delays:
l
Specify that the order is to increase the device count for an existing XiOCloud Premium subscription
l
End user and XiOCloud account name (for reference)
l
Updated device count
2. The authorized reseller receives an order confirmation along with a link to the Licensing and
Registration Hub.
3. The authorized reseller forwards the order confirmation to the end user, including the request to complete the XiOCloud registration form.
NOTE:The end user must provide a POnumber or Crestron Sales Order number from the authorized reseller as part of the activation process.
4. The end user completes the XiOCloud registration form as follows when they are ready to increase their device count:
a. Within the hub, select the Crestron XiOCloud tab (open by default), and then expand the
New Account Registration &Licensing accordion.
b. Select See the Form to open the XiOCloud Account Registration form.
c. Select Existing from the XiOCloud Account drop-down menu.
d. Select Increase Device Count for XiOCloud Premium Subscription from the Registration
Type drop-down menu.
e. Enter all other required information in the appropriate fields.
f. Agree to the Crestron License Agreement and Privacy Statement Regarding Internet Data
Collection by filling the check boxes.
g. Select Submit at the bottom of the form.
5. The form is submitted directly to Crestron, who confirms the provided information and then initiates increasing the device count for the remainder of the subscription term.
6. The account administrator receives their updated account information via email, including the new device count.
User Guide — Doc. 8214BU XiOCloud® • 17
Page 25
Refer to the following process diagram for an overview on how to increase the device count for XiOCloud Premium subscriptions.

Email Notifications

The XiOCloud renewal contact or global administrator will receive email notifications in the following scenarios:
l
New free XiOCloud subscription has been obtained
o
An email is sent welcoming the end user to the XiOCloud service and explaining that all devices in the account will receive a free 60-day trial period for XiOCloud Premium features.
l
New or renewed XiOCloud Premium subscription has been obtained
o
An email is sent welcoming the end user to the XiOCloud service, summarizing their device count and subscription term, and explaining the true-up process that occurs on the subscription anniversary date.
18 • XiOCloud® User Guide — Doc. 8214BU
Page 26
l
Total device usage has reached 90%, 100%, or 110% of the budgeted device count for an XiOCloudPremium subscription
OR
It is 90 days prior to the subscription anniversary date and the total device usage exceeds 90% of the budgeted device count
o
An email is sent notifying the end user of their budgeted device count, total device usage, and subscription anniversary date. The email also summarizes options for increasing the end user's device count.
l
True-up statement is triggered when, at the anniversary date of an XiO Cloud Premium subscription, the end user's device usage has exceeded their device count by 10% or less and there are additional years remaining in their XiOCloud subscription term
OR
True-up statement is triggered when, at the anniversary date of an XiO Cloud Premium subscription, the end user's device usage has exceeded their device count by greater than 10%
o
An email is sent with true-up statement and provides the end user with options for adjusting or increasing their device count via the true-up process.
l
True-up adjustments have not been applied within 30, 45, or 60 days of the true-up statement for an XiOCloud Premium subscription
o
An email is sent reminding the end user to complete their true-up adjustments to avoid service interruptions.
l
XiOCloud Premium subscription is expiring soon
o
Emails are sent periodically before the expiration date to remind the end user to renew their subscription.
l
XiOCloud Premium subscription has expired
o
An email is sent explaining that the XiOCloud Premium subscription has been downgraded to a free XiOCloud subscription and providing information about purchasing a new XiOCloudPremium subscription.
User Guide — Doc. 8214BU XiOCloud® • 19
Page 27

Log in to the Service

A registered XiO Cloud account is required to use the XiO Cloud service. To register for an account, visit
www.crestron.com/Support/Tools/Licensing-Registration/XiO-Account-Registration.
The account administrator identified in the new XiOCloud account registration will receive an email from Crestron that provides a username and a temporary password. These credentials are used for the initial login.
NOTE:Users registered with a single sign-on (SSO)identity provider will receive their login credentials from their provider instead. For more information on configuring SSO with XiOCloud, refer to Single Sign-On on page 122.
Additional users are added from within the XiO Cloud service. For information about managing, adding, and deleting users, refer to Manage Users on page 117.
To log in to the XiO Cloud service:
1. Navigate to https://portal.crestron.io. The XiO Cloud landing page is displayed.
XiO Cloud Landing Page
20 • XiOCloud® User Guide — Doc. 8214BU
Page 28
2. Select Sign In. A page for entering login credentials is displayed.
Login Credentials Page
3. Enter your user name or email address (provided in the welcome email) in the text field, and then select Continue.
You are redirected to your identity provider to enter your login credentials. Crestron accounts will be directed to a Microsoft® Azure® service page for entering login credentials. Crestron uses Microsoft Azure services to manage login credentials for the highest level of enterprise security.
After logging into a Crestron account for the first time, you are asked to change your password and to provide an email address and mobile number. The email address and phone number are used for account recovery if your username or password is forgotten.
User Guide — Doc. 8214BU XiOCloud® • 21
Page 29
Upon successful login, you are redirected to the XiO Cloud service with the Dashboard page open by default.
XiOCloud Service Dashboard Page (showing XiOCloudPremium Subscription)
22 • XiOCloud® User Guide — Doc. 8214BU
Page 30

Navigate the Service

The XiOCloud service provides the following informational controls on the top right of the page.
Informational Controls
l
Select the alerts button to display recent What's New messages for the XiOCloud account. For more information, refer to What's New Message on page 124.
l
Select the progress tracker button to display progress status for tasks initiated within the XiOCloud service. For more information, refer to Progress Tracker on page 26.
l
Select the support button to display options for contacting Crestron True Blue support via email, chat, or phone.
l
Select the profile button to display the Account Info window.
User Guide — Doc. 8214BU XiOCloud® • 23
Page 31
l
The Account Info window provides the following information about the account:
o
The account number, name, subscription type, and expiration date.
o
The subscription device count, claimed devices that count toward the subscription, and total claimed devices (for XiOCloud Premium subscriptions only), which can be used to determine whether a true-up will be required. For more information, refer to How to
Subscribe on page 11 and Subscription Utilization on page 125.
o
Controls to sign out of the account.
The XiOCloud service also provides a navigation menu on the left of the page. The navigation menu is used to access the primary functions of the service.
Navigation Menu
The following navigation controls are provided:
l
Select the Home button to access the account dashboard page. The home page is displayed by default after logging into the service.
l
Select the Groups button to access the group tree, which contains all groups, rooms, and devices in the account.
l
Select the Settings button to access account settings and to manage alerts.
l
Select the Users button to view and manage account users.
l
Select the File Upload button to view and manage uploaded files.
l
Select the Historical Reports button to generate reports for various data sets within the account (for XiOCloud Premium subscriptions only).
l
Select the Help button to view documentation for getting started with the XiOCloud service.
24 • XiOCloud® User Guide — Doc. 8214BU
Page 32
Certain navigation controls show an expanded menu when selected. For example, selecting the Groups
button shows the group tree in the expanded menu.
l
Expanded menus can be collapsed by selecting the collapse button in the header bar.
l
When the menu is collapsed, select the expand button to display the menu again.
User Guide — Doc. 8214BU XiOCloud® • 25
Page 33

Progress Tracker

Certain tasks initiated within the XiOCloud service that involve large data sets (such as importing desks and devices for the CrestronDesk Scheduling functionality) can take a considerable amount of time to complete. The progress tracker function allows users to check on the status of these tasks running in the background at any time.
Select the progress tracker button on the top right of the page to display the Progress Tracker dialog box.
The Progress Tracker dialog box lists all in-progress tasks for the account in table form. A Filter function is provided to filter the table based on the entered information. Each table column also provides sorting controls to sort the data in that column.
The following information is provided for each task:
l
Task Name:The name of the task.
l
Started At:The date and time when the task was started.
l
Status:The current task status. Completed tasks show a green check icon with the date and time that the task was completed.
l
Description: Information about the task, such as the name of an imported file.
l
Initiated By:The XiOCloud user who initiated the task.
l
Actions:Provides actions for the task, such as clearing the task or downloading an imported file.
26 • XiOCloud® User Guide — Doc. 8214BU
Page 34

Build the Environment

The XiO Cloud service provides an environment that represents the organizational structure of an enterprise.
The XiO Cloud service environment consists of groups, rooms, desks, and devices. XiOCloud administrators are able to create virtual buildings with multiple floors that represent their organization's workspaces. Once a building has been created, rooms or desks that contain devices can be added using the group tree. Devices may be associated with rooms or desks once they are claimed by the service. Once devices are associated with rooms or desks, actions may be performed simultaneously for all grouped devices.
Use the following procedures to build the XiO Cloud service environment.

Create the Building Address Book

The building address book represents all workspaces with rooms or desks across an organization.
The SETTINGS menu for managing the building address book is located in the settings panel, which may
be accessed by clicking the Settings button in the navigation menu.
User Guide — Doc. 8214BU XiOCloud® • 27
Page 35
Select Building Address Book in the SETTINGS menu. A Building Address Book page is displayed to the right of the SETTINGS menu.
The building address book allows for new buildings to be created and existing buildings to be edited or deleted. In addition, the desk and space types that are available for reservation within the organization can be selected or customized.
28 • XiOCloud® User Guide — Doc. 8214BU
Page 36

Manage Buildings

Select the Building List tab in the Building Address Book page to show all buildings that have been created for the XiOCloud account.
Buildings are listed in a table that provides the following information:
l
Building Name:The user-defined building name. Selecting this name allows the building to be edited.
l
Address:The physical address of the building.
l
Country:The country where the building is located.
l
State:The state or province where the building is located.
l
City:The city where the building is located.
l
Nickname:An alternate or shorthand name for the building.
l
Time Zone:The time zone of the building.
NOTE:Support for time zones was added in XiOCloud version 1.62. Any buildings created
before this release will have their time zones assigned automatically based on the configured building address. If the building address cannot be verified, then the default "(UTC +00) UTC" time zone will be assigned to the building instead. Time zones can be changed at any time by editing the building.
By default, buildings are sorted in alphabetical order. Use the controls provided in each column header to sort buildings in ascending or descending order based on the column data. Use the search field to locate a specific building that matches the search criterion. The table also provides navigational controls that can be used to move between pages and set the number of table rows per page.
User Guide — Doc. 8214BU XiOCloud® • 29
Page 37
Create a New Building
To create a new building in the building address book:
1. Select the Building List tab in the Building Address Book page.
2. Select + Add Building. The Add Building dialog box is displayed.
3. Enter the following information for the building:
l
Building Name:
Required.
Enter the building name. This name will be displayed for the
building throughout the XiOCloud service.
l
Building NickName:Enter an alternate or shorthand name for the building.
l
Address:
30 • XiOCloud® User Guide — Doc. 8214BU
Required.
Enter the physical street address for the building.
Page 38
l
Country:
Required.
Use the drop-down menu to select the country where the building is
located.
l
State / Province:
Required.
If applicable, select the state or province where the building is
located. The available selections are populated based on the value selected for Country.
l
City:
Required.
l
Postal Code:
l
Total Number of Floor(s):Enter the total number of floors of the building that contains the
Enter the city where the building is located.
Required.
Enter the postal code associated with the building address.
organization, including floors that do not belong to the organization.
l
Selected Floor(s):
Required.
Use the drop-down menu to select the specific floors of the building that belong to the organization. A filled check box next to the floor number indicates that is has been selected. The available selections are populated based on the number entered for Total Number of Floor(s).
For example, if your organization is located on the eighth, ninth, and tenth floors of a building with 20 floors, select 8, 9, and 10 from the drop-down menu.
NOTE: Six floor levels with negative values are also provided in the Selected Floor (s)drop-down menu to support underground or basement floors.
l
Time Zone:
Required.
Use the drop-down menu to select the time zone of the building.
4. Once all required fields have been populated, select Add Building. The building is added to the table in the Building Address Book page.
Edit a Building
To edit an existing building, select the building name within its table row in the Building Address Book page. The Edit Building dialog box is displayed.
Once all changes have been made, select Update Building to return to the Building Address Book page.
User Guide — Doc. 8214BU XiOCloud® • 31
Page 39
Delete a Building
To delete an existing building, select the trash can icon within the building's table row in the Building Address Book page. Aconfirmation prompt is displayed asking whether the building should be deleted.
Select Yes to delete the building or No to cancel the deletion.
NOTE:Abuilding cannot be deleted if any rooms or desks are associated with it. If you attempt to
delete a building with associated rooms or desks, amessage window is displayed stating that all rooms and desks must be deleted or moved from the building before it can be deleted. For more information, refer to Delete a Desk on page 56.

Manage Space Properties

Select the Space Properties tab in the Building Address Book page to configure the desk and space types that can be reserved within the organization.
32 • XiOCloud® User Guide — Doc. 8214BU
Page 40
Select Desk Type or Space Type to configure desk or space types, respectively.
Ten default desk types and space types are provided. Fill the Show check box next to a desk or space type to make it available for selection when adding or editing a desk or room.
Additionally, all default desk or space types can be customized using the Desk Type or Space Type text fields.

Create the Group Tree

The group tree is in the environment panel, which may be accessed by selecting the Groups button in the navigation menu.
The group tree is the primary organizational structure of the XiO Cloud environment. Top-level groups, rooms, and desks appear in the group tree once they are added to the environment. One or more subgroups, rooms, and desks may also be added under each group.
The group tree is located under the ENVIRONMENT menu on the left side of the configuration pages. Groups, subgroups, rooms, and desks are ordered alphabetically. Asearch field is provided at the top of the ENVIRONMENT menu that can be used to find items within the environment group tree. Hover the cursor over the right edge of the group tree to display a vertical blue bar that can be used to adjust the tree width.
User Guide — Doc. 8214BU XiOCloud® • 33
Page 41
Environment Menu

Manage Groups

Groups are added within the group tree. Groups provide a means for organizing rooms, desks, and subgroups into logical categories (typically representing the structure of an enterprise or building). Actions can be performed for multiple devices at once at the group level.
34 • XiOCloud® User Guide — Doc. 8214BU
Page 42
Add a Top-Level Group
To add a top-level group:
1.
Select the ENVIRONMENT menu button to display a drop-down menu.
Environment - Drop-Down Menu
2. Select Add Group. A new group is added to the group tree.
Environment - New Group
3. Enter a descriptive group name in the New Group text field. A group name must be at least three characters long.
NOTE: Each group name must be unique. If a duplicate group name is entered, a notification is displayed stating that the group name already exists.
4.
Select the green check icon or select Enter to save the group. Select the red x icon to discard the group.
The group is reordered alphabetically in the top level of the group tree after it is added.
User Guide — Doc. 8214BU XiOCloud® • 35
Page 43
Select the group from the group tree to view and configure group settings. For more information, refer to Configure Settings for a Group of Devices on page 93.
Add a Subgroup
One or more subgroups may be added under the top-level group. A group hierarchy may contain up to eight levels.
To add a subgroup:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
Group - Drop-Down Menu
3. Select Add Group. A new subgroup is added under the selected group.
Group - New Group
4. Enter a descriptive subgroup name in the New Group text field. A subgroup name must be at least three characters long.
36 • XiOCloud® User Guide — Doc. 8214BU
Page 44
5.
Select the green check icon or select Enter to save the subgroup. Select the red x icon to discard the subgroup.
The subgroup is reordered alphabetically within its parent group after it is added.
Select the subgroup from the group tree to view and configure subgroup settings. For more information, refer to Configure Settings for a Group of Devices on page 93.
Rename a Group
Each group in the XiO Cloud service has a unique name, which allows the group to be identified and organized within the service. A group may be renamed as needed.
To change the group name in the group tree:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
Group - Drop-Down Menu
3. Select Rename Group. The group name becomes an editable text box.
Group - Edit Group Name
User Guide — Doc. 8214BU XiOCloud® • 37
Page 45
4. Enter a new group name in the text box. A group name must be at least three characters long.
5.
Select the green check icon or select Enter to save the group name. Select the red x icon to discard the changes.
Delete a Group
Groups may be deleted from the XiO Cloud service environment as needed. A group that contains a subgroup may not be deleted until all subgroups are removed.
To delete a group from the group tree:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
Group - Drop-Down Menu
3. Select Delete Group. A confirmation dialog box is displayed.
4. Select Yes to delete the group or select No to cancel the deletion.

Manage Rooms

Rooms can be added within groups or at the top level of the group tree. Rooms are designed to represent physical rooms within an enterprise that contain all cloud-enabled devices. Devices can be added to rooms after they claimed into the XiOCloud service. Rooms can also be tied to custom programming for monitoring, reporting, and control.
NOTE:As of XiOCloud version 1.55, new rooms are added using the building address book function. An import tool is provided for existing deployments that associates all existing rooms with a building address book. For more information, refer to Associate Rooms with a Building on page 45.
38 • XiOCloud® User Guide — Doc. 8214BU
Page 46
Add a New Room
To add a new room:
1.
Select the ENVIRONMENT menu button to display a drop-down menu.
Environment - Drop-Down Menu
2. Select Add Room. The Add Room dialog box is displayed.
User Guide — Doc. 8214BU XiOCloud® • 39
Page 47
3. Enter the following information for the desk:
l
Building:
Required.
Use the drop-down menu to select a building that will be associated with
the room from the building address book.
If the desired building is not shown, select +Add Building to display the Add Building dialog box. For more information on adding a building, refer to Create a New Building on page 30.
l
Floor:
Required.
Select the building floor where the room is located. The available selections
are populated based on the floors configured for the building.
l
Room Name:
Required.
Enter the room name. This name will be displayed for the room
throughout the XiOCloud service.
4. Select Save. The room is added to the group tree and is reordered alphabetically within its parent group after it is added.
Select the room from the group tree to view and configure group settings. For more information, refer to Configure Settings for a Group of Devices on page 93.
Edit a Room
Once a room has been added to the group tree, select it in the tree to open the room details page.
40 • XiOCloud® User Guide — Doc. 8214BU
Page 48
The following information is displayed for the room:
l
The user-defined room name and the building address.
l
Indicators that show the room health, whether the room is occupied (if it contains occupancy­sensing equipment), and whether the room is currently in maintenance mode.
l
A Room Details section that displays the space type, building name, floor, and time zone.
l
AStatus tab that displays various room status controls and indicators if the XiOCloud program connector has been configured. For more information, refer to XiOCloud ProgramConnector on
page 128.
l
An Equipment List tab that displays the status of associated devices.
l
AGroup View tab that displays options for managing all devices in the room. For more information, refer to Configure Settings for a Group of Devices on page 93.
l
An Alerts tab that displays any recent alerts that have been raised for the room. For more information, refer to Alerts on page 152.
An Action menu is also provided in the top right of the page that provides a Edit Details selection for editing the room details.
User Guide — Doc. 8214BU XiOCloud® • 41
Page 49
Select Edit Details to display editable fields for room settings.
The following settings can be edited:
l
Room Name:Enter the room name. This name will be displayed for the desk throughout the XiOCloud service.
l
Space Type:Use the drop-down menu to select the space type. The available selections are populated based on the space types configured for the building address book. For more information, refer to Manage Space Properties on page 32.
l
Building Name:Use the drop-down menu to select a building that will be associated with the room from the building address book.
l
Floor:Select the building floor where the room is located. The available selections are populated based on the floors configured for the building.
Select Save Details to save any changes. Atoast notification is shown indicating that the changes have been saved.
Rename a Room
Each room in the account has a unique name, which allows the room to be identified and organized within the service. A room may be renamed as needed.
To change the room name in the group tree:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
42 • XiOCloud® User Guide — Doc. 8214BU
Page 50
3. Select Rename Room. The room name becomes an editable text box.
Room - Edit Room Name
4. Enter a new room name in the text box. A room name must be at least three characters long.
5.
Select the green check icon or select Enter to save the room name. Select the red x icon to discard the changes.
Delete a Room
Rooms may be deleted from an XiO Cloud account environment as needed. A room that contains a device may not be deleted until all child devices removed.
To delete a room from the group tree:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
3. Select Delete Room. A confirmation dialog box is displayed.
4. Select Yes to delete the group or select No to cancel the deletion.
View Device Settings
Once devices have been associated with the room, navigate to the Equipment List section of the room status page to view the following device settings.
l
Device Name:The device name in XiOCloud.
l
Device Model:The device model.
l
Firmware Version:The firmware version running on the device.
l
Serial:The device serial number.
User Guide — Doc. 8214BU XiOCloud® • 43
Page 51
l
MACAddress:The MACaddress of the device network adapter used to connect to the XiOCloud service.
l
Online Status:Indicates whether the device is reporting online or offline within XiOCloud. Crestron XiOCloud Gateway connected devices that are reporting offline show a cloud connector
offline icon .
l
Pending Settings Delivery:Indicates whether device settings changed in XiOCloud are pending delivery to the device.
l
IPAddress:The current device IPaddress.
NOTE:Select the IPaddress to navigate to the web configuration interface for that device in
a new tab (if available).
l
Hostname:The device host name.
l
Application Mode:If applicable, indicates the application mode that is running on the device.
l
DHCPEnabled:Indicates whether DHCPis turned on or off for the device.
l
Room Status:If applicable, indicates status of the room for devices with room scheduling capabilities.
l
Calendar Connection:If applicable, indicates status of the calendar connection for devices with room scheduling capabilities.
An Actions column is also provided that allows the device to be configured or deleted. For more information on configuring a device, refer to Manage Devices on page 85.
The data that is displayed in the device table can be customized by filtering the table columns. By default, 12 columns are displayed that contain the data described in the list above.
To select or deselect table columns for the device status table, expand the drop-down menu at the top right of the table. Then, select or deselect an item in the menu to display or hide that column from the table, respectively. Use the check box at the top of the menu to select or deselect all columns.
NOTE:The device status table will reset to its default settings after logging out of the XiOCloud service.
The device status table can be downloaded as a CSVfile by selecting the Export to CSVbutton at the top right of the table. The CSVfile will include all table columns that have been selected as described above.
44 • XiOCloud® User Guide — Doc. 8214BU
Page 52
Associate Rooms with a Building
As of XiOCloud version 1.55, new rooms are added using the building address book function. An import tool is provided for existing deployments that associates all existing rooms with a building address book.
To associate rooms with a building using the import tool:
1.
Select the Settings button in the navigation menu.
2. Select Building Address Book. A Building Address Book page is displayed to the right of the SETTINGS menu.
User Guide — Doc. 8214BU XiOCloud® • 45
Page 53
3. Select the door icon in the table row of the desired building address book. An Associate Rooms dialog box is displayed.
NOTE:The door icon appears only if there are rooms in a deployment that are not associated with in address book. Once all rooms have been associated, this selection is no longer available.
4. Drag rooms from the Unassociated Rooms column into the appropriate floor of the building within the [Building] Floors column. The Unassociated Rooms column matches the structure of the XiOCloud group tree for the account.
l
Enter text into the filter text boxes to filter room, group, and floor data based on the entered text.
l
Select Select All to select all rooms within the Unassociated Rooms column.
l
Select Undo to undo the last performed action.
l
Select Revert to revert all rooms back to the Unassociated Rooms column.
46 • XiOCloud® User Guide — Doc. 8214BU
Page 54
5. Once all rooms have been associated, select Associate Rooms. All rooms are associated with the selected floors of the building address book.

Manage Desks

For accounts that use desk scheduling, desks can be added to groups and subgroups within the group tree. After a desk has been added, it can be associated with a building from the building address book and then assigned a unique desk scheduling device and scheduling calendar address.
Import Desks and Devices
Desks and their associated desk scheduling devices can be mass provisioned into the XiOCloud service via a CSVfile. Once the CSVfile is imported successfully, all new desks and devices will be added to the appropriate buildings and floors within the XiOCloud environment tree.
To import desks and devices into the XiO Cloud service:
1. Create a new CSV file with the following header columns in the first row. The name of each header column must match the following items exactly.
NOTE:Asample CSVfile with prepopulated header columns can also be downloaded from the Import Desks &Devices dialog box that is described later in this procedure.
l
Building Name
l
Floor
l
Desk Name
l
Desk Type
l
Calendar Email
User Guide — Doc. 8214BU XiOCloud® • 47
Page 55
l
Serial
l
MACAddress
2. For each desk and associated device, enter the following data in the appropriate columns of a new table row. Each desk must have its own table row.
l
Building Name:The building that will be associated with the desk. The building must have already been created in the building address book prior to importing the CSVfile.
l
Floor:The building floor where the desk is located. The floor must match one of the floors configured for the building.
l
Desk Name:The desk name that will be displayed for the desk throughout the XiOCloud service and in the DeskScheduling UI on the touch screen.
l
Desk Type:The desk type. The desk type must match one of the desk types configured for the building address book. For more information, refer to Manage Space Properties on page
32.
l
Calendar Email:The unique scheduling calendar address that is paired with the desk to control reservations. This field is optional and can be left empty regardless of scheduling partner usage.
l
Serial:The serial number of the associated touch screen.
l
MACAddress:The MACaddress of the associated touch screen.
NOTE:The Calendar Email, Serial, and MACAddress fields are not required to create a
desk from the CSVfile. Desk scheduling devices can be associated manually with a desk at a later time.
Refer to the following mock CSVfile as an example.
3. Save the CSVfile to an accessible location on the local computer.
48 • XiOCloud® User Guide — Doc. 8214BU
Page 56
4.
Select the context menu button for the ENVIRONMENT menu to display a drop-down menu.
5. Select Import Desks &Devices. The Import Spacesand Devices dialog box is displayed.
NOTE:The Import Desks &Devices selection is also available in the context menu for groups and subgroups. Making this selection at the group level will limit the import to that group.
User Guide — Doc. 8214BU XiOCloud® • 49
Page 57
6. Select Add File, and then select the CSV file created earlier in this procedure. The CSVfile is shown in the dialog box if it is valid.
7. Select Open. The Import Validation dialog box is displayed.
The Import Validationdialog box shows the total number of desks that will be imported and reports any errors that are found within the CSVfile data. Each row of the CSVfile is shown and can be modified within the dialog box. The following controls are provided:
l
Use the Filter function to filter the CSVfile table based on the entered information.
l
Use the sorting controls in the table headers to sort the data in that column.
l
Select Export.csv to export the provided CSVfile to the local computer.
l
Fill the Show Errors Only check box to show only the table rows that contain errors. Any data with errors is shown with red text. Hover over an error to view a pop-up description explaining the error.
l
Select within any table cell to edit the data within that cell.
8. Select Import once all errors have been corrected. The CSVfile upload progress begins.
50 • XiOCloud® User Guide — Doc. 8214BU
Page 58
To check the status of the CSVfile upload, select the progress tracker button at the top right of the page. AProgress Tracker dialog box is displayed that shows the progress of the import task.
NOTE:Large CSVfiles may take a considerable amount of time to upload. The status of the upload is always available within the Progress Tracker dialog box. For more information, refer to Progress
Tracker on page 26.
Once the CSVfile has been uploaded successfully, a toast notification is shown indicating this. The group tree is updated to show the new desks and child devices.
Add a New Desk
To add a new desk to a group manually:
1. Position the cursor over the group name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group to display a drop-down menu.
User Guide — Doc. 8214BU XiOCloud® • 51
Page 59
3. Select Add Desk. The Add Desk dialog box is displayed.
4. Enter the following information for the desk:
l
Building:
Required.
Use the drop-down menu to select a building that will be associated with
the desk from the building address book.
If the desired building is not shown, select +Add Building to display the Add Building dialog box. For more information on adding a building, refer to Create a New Building on page 30.
l
Floor:
Required.
Select the building floor where the desk is located. The available selections
are populated based on the floors configured for the building.
l
Desk Name:
Required.
Enter the desk name. This name will be displayed for the desk
throughout the XiOCloud service and in the DeskScheduling UI on the touch screen.
l
Desk Type:Use the drop-down menu to select the desk type. The available selections are populated based on the desk types configured for the building address book. For more information, refer to Manage Space Properties on page 32.
l
Calendar Email: Enter a unique scheduling calendar address that is paired with the desk to control reservations. This field is optional and can be left empty regardless of scheduling partner usage.
52 • XiOCloud® User Guide — Doc. 8214BU
Page 60
5. Select Save. The desk is added to the group and is reordered alphabetically within its parent group after it is added.
Edit a Desk
Once a desk has been added to the XiOCloud environment tree, select it in the tree to open the desk details page.
The following information is displayed for the desk:
l
The user-defined desk name and the building address.
l
A Details section that displays the desk type, scheduling calendar email address, building name, floor, and time zone.
User Guide — Doc. 8214BU XiOCloud® • 53
Page 61
l
An Equipment List section that displays the status of the associated deskscheduling device (once added) and provides controls for adding a device.
An Action menu is also provided in the top right of the page that provides a Edit Desk Details selection for editing the desk.
Select Edit Desk Details to display editable fields for desk settings.
The following settings can be edited:
l
Desk Name:Enter the desk name. This name will be displayed for the desk throughout the XiOCloud service and in the DeskScheduling UI on a TSS-470Etouch screen.
l
Desk Type:Use the drop-down menu to select the desk type. The available selections are populated based on the desk types configured for the building address book. For more information, refer to Manage Space Properties on page 32.
l
Calendar Email:Enter the unique scheduling calendar address that is paired with the desk to control reservations. This field is optional and can be left empty regardless of scheduling partner usage.
l
Building Name:Use the drop-down menu to select a building that will be associated with the desk from the building address book.
l
Floor:Select the building floor where the desk is located. The available selections are populated based on the floors configured for the building.
Select Save Changes to save any changes. Atoast notification is shown indicating that the changes have been saved.
54 • XiOCloud® User Guide — Doc. 8214BU
Page 62
Rename a Desk
To rename an existing desk from the XiOCloud environment tree:
1. Position the cursor over the desk name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the desk to display a drop-down menu.
3. Select Rename Desk. The room name becomes an editable text box.
4. Enter a new desk name in the text box. A room name must be at least three characters long.
5.
Select the green check icon or press Enter to save the room name. Select the red x icon to discard the changes.
User Guide — Doc. 8214BU XiOCloud® • 55
Page 63
Delete a Desk
To delete an existing desk:
1. Position the cursor over the desk name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the desk to display a drop-down menu.
3. Select Delete Desk. Aconfirmation prompt is displayed asking whether the desk should be deleted.
4. Select Delete Desk to delete the desk or close the message window to cancel the deletion.
NOTE:If a desk scheduling device is associated with the desk, the device will become unassociated with the desk and return to the Unassociated Devices node within the XiOCloud environment tree.
Associate a DeskScheduling Device with a Desk
Each desk within the XiOCloud environment tree must be associated with a unique desk scheduling device. Once a device is associated with the desk, status and settings for the device and scheduling calendar connection can be viewed.
NOTE:The following procedure assumes that the desk scheduling device has been claimed to the XiOCloud service and is not associated with another desk. For more information on how to claim a device, refer to Claim Devices on page 59.
56 • XiOCloud® User Guide — Doc. 8214BU
Page 64
To associated a deskscheduling device with a desk:
1. Select the desk within the XiOCloud environment tree to display its status page.
2. Select Click here to add new devices in the Equipment List section. The Add Device dialog box is displayed.
NOTE:Alternately, the Add Device selection in the desk's environment tree context menu can be used to open the Add Device dialog box.
3. From the Unassociated Devices tab, use the Select Device drop-down menu to select an unassociated desk scheduling device within the XiOCloud account.
User Guide — Doc. 8214BU XiOCloud® • 57
Page 65
4. Select Add Device once the unassociated desk scheduling device has been selected. The device is added to the Equipment List section of the desk status page.
NOTE:It may take up to 15 minutes for the device to establish a connection with theXiOCloud service.
View Device Settings
Once the desk scheduling device has been associated with the desk, navigate to the Equipment List section of the desk status page to view the following device settings.
l
Cloud Status:Indicates whether the device is reporting online or offline within XiOCloud. Adevice is considered offline after it fails to respond to multiple call attempts issued five minutes after the device first reports as disconnected.
l
Calendar:Reports the current status of the scheduling calendar connection:
o
Shows a green check icon if the scheduling calendar connection is active.
o
Shows a red x icon if the scheduling calendar connection is inactive.
o
Shows a question mark icon if the scheduling calendar connection status is unknown (reported only if the device is showing as offline).
l
Device Name:The device name in XiOCloud.
l
Device Model:The device model.
l
MACAddress:The MACaddress of the device network adapter used to connect to XiOCloud.
l
Serial #:The device serial number.
l
IPAddress:The current device IPaddress.
NOTE:Select the IPaddress to navigate to the web configuration interface for that device in
a new tab (if available).
l
Hostname:The device host name.
58 • XiOCloud® User Guide — Doc. 8214BU
Page 66
An Actions column is also provided that allows the device to be configured or deleted. For more information on configuring a device, refer to Manage Devices on page 85.

Claim Devices

Devices must be claimed into the XiO Cloud service before they can be managed. Devices can be claimed individually or as a group. Supported Crestron devices can also be claimed using the
CrestronDeviceAssistant app. Any user (standard or admin) can claim devices into XiOCloud using
either the Crestron Device Assistant app or XiOCloud portal.
NOTE:Third-party device support requires an XiOCloud Premium subscription. Supported third-party devices that do not use the Crestron Connected® connection protocol must be claimed using a Crestron control system or the Crestron XiOCloud™ Gateway software. For more information, refer to the XiOCloud® Service Third-Party Device Monitoring Configuration Guide.
The device MACaddress and serial number (generally shown with an "SN" prefix) are required to claim the device into XiOCloud. The MAC address and serial number are located on labels affixed to the shipping box or device. Locate and verify these values before proceeding to claim the device using any of the following procedures.
The following image shows an example of these labels on a TSS-470E.
User Guide — Doc. 8214BU XiOCloud® • 59
Page 67
NOTES:
l
If the device has multiple MAC addresses, use the MAC address that is providing the primary connection back to the network (typically from the adapter with the lowest numeric value, such as "MAC1"). For most devices, the Ethernet MAC address should be used. However, if your device is connecting to the network over a different protocol (such as Wi-Fi® communications), use the MAC address for that protocol instead.
l
If claiming a Crestron software product (such as Crestron Virtual Control server software), the serial number and MACaddress are generated by the software and can be located using its web configuration interface. For Crestron software products that are preinstalled on a computer or other device (such as the VC-4-SERVER-25), do not use the serial number and MAC address labeled on the device.

Claim Devices via the Device Assistant App

The CrestronDeviceAssistant app is a mobile application that claims supported Crestron devices into the XiOCloud® service. Simply scan the MAC address and serial number label on the device when prompted, and the Crestron Device Assistant app will claim the device into the XiOCloud service in only a few steps.
The Crestron Device Assistant app is available for download from the App Store® app on supported Apple®iPhone® devices or from the Google Play™ app on supported Android™ OSdevices.
60 • XiOCloud® User Guide — Doc. 8214BU
Page 68
To claim a device using the app:
1. Open the Crestron Device Assistant app on your mobile device.
2. Select Customer Sign in or Dealer Sign in depending on your role. The Welcome to Crestron
XiOCloud screen is displayed.
NOTE:Select Customer Sign in if you are signing into your own XiOCloud account. Select Dealer Sign in if you are an Authorized Support Provider signing into a customer account.
Dealers will be taken to a screen for entering their Crestron web account credentials prior to signing into the customer account. For more information on managing support providers in customer accounts, refer to Manage Support Providers on page 193.
User Guide — Doc. 8214BU XiOCloud® • 61
Page 69
3. Enter your full user name (for example, "jsmith@crestron.io"). For more information, refer to Log
in to the Service on page 20.
4. Select Continue. The Enter password screen is displayed.
NOTE:Users registered with a single sign-on (SSO)identity provider will be redirected to their identity provider instead to enter login credentials.
62 • XiOCloud® User Guide — Doc. 8214BU
Page 70
5. Enter your account password.
User Guide — Doc. 8214BU XiOCloud® • 63
Page 71
6. Select Sign in.
Upon successful sign in, a Terms and Conditions for Crestron Mobile Apps screen is displayed.
7. Agree to the Mobile Apps Terms of Use and Privacy Statement by turning on their toggles, then select Agree.
NOTE:An optional Allow Analytics toggle is also provided on this screen. If this toggle is turned on, Crestron will be able to collect anlaytics data to analyze and improve app performance. The collected data may include app settings, app usage, and app diagnostic events. Analytics can be turned on or off at any time within the Account settings.
64 • XiOCloud® User Guide — Doc. 8214BU
Page 72
The Device Assistant screen is displayed.
8. Select Scan Device.
NOTE:If the MACaddress and serial number labels are damaged or missing and cannot be scanned, select Enter Manually from the Add Device screen. The app will prompt you to enter the serialnumber and MACaddress of the device. Select Add Device once the required information has been entered to view the Confirm Details screen.
User Guide — Doc. 8214BU XiOCloud® • 65
Page 73
9. When prompted, agree to allow the app to use the phone camera. The camera opens in a screen for scanning device labels.
10. Hover the phone camera over the device label(s) that include the serial numberand MACaddress. The app's text recognition feature will attempt to populate the MACand SNvalues on screen once they are scanned.
NOTE:If the populated values are not correct, attempt to rescan the label from a different distance or angle. As long as the correct values are captured within the app, any incorrect values will be ignored during device identification and do not need to be deleted. Populated values can be manually edited by tapping the edit button next to MAC and SN. All populated values can also be deleted by tapping the x button.
66 • XiOCloud® User Guide — Doc. 8214BU
Page 74
11. Select Continue. The app attempts to identify the device within the XiOCloud service.
If the identification is successful, a Confirm Details screen is shown with information about the device and the XiOCloud account that will claim it.
NOTE:If you are logged in as a dealer, use the XiOAccount setting to select the customer account that will claim the device. This setting is not selectable if you are logged in as an end user.
User Guide — Doc. 8214BU XiOCloud® • 67
Page 75
12. To claim a device into a specific room within the XiOCloud account, tap Select Room.
68 • XiOCloud® User Guide — Doc. 8214BU
Page 76
13. Use the group tree that is displayed to locate the desired room in the account, and then tap it to make the selection. Additionally, use the search function at the top of the group tree to filter groups or rooms based on the entered text.
User Guide — Doc. 8214BU XiOCloud® • 69
Page 77
NOTES:
l
Only global administrators can claim devices into rooms. Standard users can claim devices into the Unassociated Devices group within the XiOCloud group tree.
l
Desks are not shown in the app group tree. Use the XiOCloud portal to associate claimed devices with desks.
l
If no room is selected, the device will be claimed into the Unassociated Devices group.
l
If a device is already claimed into the account and you attempt to reclaim it into a new room, the device will be moved into that room from its prior location. Devices cannot be moved from a room into Unassociated Devices via the app.
l
If a new room or group is added to the account while the app is open, pull to refresh to see the changes in the app.
l
Devices claimed into rooms will inherit their associated group policies automatically.
14. Select Claim Device. The app will attempt to claim the device into the XiOCloud account.
70 • XiOCloud® User Guide — Doc. 8214BU
Page 78
15. If the claim is successful, a success message is displayed, and the claimed device is added to the selected room within the XiOCloud group tree. Select ClaimAnother Device to restart the claiming process, or select the x button to return to the home screen.
The device may now be managed within XiOCloud.
Claim a Single Device via XiOCloud
To claim a single device using the XiOCloud web interface:
NOTE:As of the XiOCloud version 2.5 release, devices can be claimed directly into rooms or desks as described in the following procedure.
1. Record the MAC address and serial number of the device.
2. Determine where the device will be claimed within the XiOCloud group tree:
User Guide — Doc. 8214BU XiOCloud® • 71
Page 79
l
To claim into a specific room or desk, select the context menu button for that room or desk to display a drop-down menu.
Room - Drop-Down Menu
l
To claim into the Unassociated Devices group, select the ENVIRONMENT menu button to display a drop-down menu.
Environment - Drop-Down Menu
72 • XiOCloud® User Guide — Doc. 8214BU
Page 80
3. Select Claim Device. The Claim Device dialog box is displayed.
NOTE:Scan the QR code on the bottom of the dialog box with your mobile device to open a web page with links to the Device Assistant app download pages for each OS. If the Crestron Device Assistant app is already installed on the mobile device, scanning the QR code opens the app instead. For more information on claiming devices with the Device Assistant app, refer to
Claim Devices via the Device Assistant App on page 60.
Claim Device Dialog Box
4. Enter the MAC address and serial number recorded in step 1 in the MAC Address and Serial Number fields, respectively.
5. Select Claim. A success message is displayed if the claim is successful.
NOTE: If an error message is displayed stating that the device does not exist, connect the
device to a network that has access to the internet, wait 15 minutes, and then try again.
6. Select X to close the dialog box. The claimed device is added to the chosen room or desk. If the device was claimed from the ENVIRONMENTmenu, then it as added to the Unassociated Devices group instead.
User Guide — Doc. 8214BU XiOCloud® • 73
Page 81
Unassociated Devices
The device may now be managed and assigned to a group, room, or desk (if unassociated).
NOTE: Observe the following points when claiming a device to a room or desk:
l
Standardusers with Admin and Tech roles can only claim devices into rooms or desks to which they have been granted access. For more information, refer to Manage Users on page 117
l
Only one device can be associated with a desk at a time. If a device is already associated with a desk, then the ClaimDevices function will not be selectable in the desk's drop-down menu.
l
Devices claimed into rooms or desks will inherit their associated group policies automatically.
Claim Multiple Devices via XiOCloud
To claim multiple devices:
1. Record the MAC address and serial number of each device as a comma delimited CSV file.
The CSV file should be formatted as shown below:
CSV File Format
NOTE: An optional third column may be added to the CSV file with custom device names.
After being claimed, the device will take the custom name from the CSV file instead of its default name. For example, if adding a custom device name to the first example above, the formatting would be 00.10.73.8b.81.b6,17284712,[custom device name]
2. Save the CSV file to a location that may be accessed by the computer used to access the XiO Cloud service.
74 • XiOCloud® User Guide — Doc. 8214BU
Page 82
3.
In the XiO Cloud service, select the ENVIRONMENT menu button to display a drop-down menu.
Environment - Drop-Down Menu
4. Select Claim Multiple Devices. The Claim Multiple Devices dialog box is displayed.
Claim Multiple Devices Dialog Box
5. Select Choose, and then select the CSV file created in step 1.
6. Select Claim to claim all of the devices listed in the file. A message indicating the claim status of each device is displayed.
NOTE: If an error message is displayed stating that a device does not exist, connect that device to a network that has access to the internet, wait 15 minutes, and then try again.
User Guide — Doc. 8214BU XiOCloud® • 75
Page 83
7. Select X to close the dialog box. The claimed devices are added to the Unassociated Devices group within the XiOCloud group tree
Unassociated Devices
The devices may now be managed and assigned to a group or room.

Unclaim Devices

Devices may be unclaimed to remove them from a user's account. Once a device is unclaimed:
l
The device is no longer counted against the allotted number of devices for the account
l
The device may be claimed by another account.
l
The XiO Cloud service no longer enforces any settings on the device.
To unclaim a device:
1. Position the cursor over the device in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button of the device to display a drop-down menu.
Device - Drop-Down Menu
3. Select Unclaim Device. A confirmation dialog box is displayed.
4. Select Yes to unclaim the device, or select No to cancel.
76 • XiOCloud® User Guide — Doc. 8214BU
Page 84
NOTE: If a device that has any licenses on it is unclaimed, the licenses remain with the account and not the device. The licenses are removed from the device once it is unclaimed, and the licensed functionality is no longer available on the device.

Add Devices to Rooms or Desks

Devices may be added to rooms after they are claimed by the XiO Cloud service. Once devices are added to rooms or desks, all devices within a group or desk may be monitored and controlled at once.
Two methods may be used to add devices to a room or desk: Devices may be added via the context menu for the room or desk, or devices may be dragged from the Unassociated Devices group into a room or desk.
NOTE:DSS-100 devices are added to a Device Assistant Group in the group tree after they are claimed via the Crestron Device Assistant mobile app. Drag these devices to a room or desk from this group instead.
To add devices to a room or desk via its context menu:
1. Position the cursor over the room or desk name in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the group or room to display a drop-down menu.
Room - Drop-Down Menu
User Guide — Doc. 8214BU XiOCloud® • 77
Page 85
3. Select Add Device. A text box is added under the selected room or desk.
Group - Add Device Text Box
4. Start typing the name of the desired device. A list of claimed devices that match the entered text is displayed below the text box.
Group - Add Device Text Box (with Text)
5. Select the desired device by clicking on it or by navigating to the device using the arrow keys and pressing Enter.
78 • XiOCloud® User Guide — Doc. 8214BU
Page 86
The device is reordered alphabetically within its parent room or desk after it is added. It is no longer shown in the Unassociated Devices group.
Group - Device Added
To drag a device from the Unassociated Devices group into another room or desk:
1. Select and hold the pointer over the device.
2. Drag the device from the Unassociated Devices group and drop it into the desired room or desk. The device is added to the room or desk and is no longer shown in the Unassociated Devices group.
To return a device to the Unassociated Devices group:
1. Position the cursor over the device in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button for the device to display a drop-down menu.
Device - Drop-Down Menu (Cut Action)
3. Select Unassociate Device. The device is added back to the Unassociated Devices group and is no longer shown in its previous room or desk.
Devices may also be dragged to the Unassociated Devices group or to any other room or desk that supports added devices.
Select the device from the group tree to view and configure device settings. For more information, refer to Configure Device Settings on page 90.
User Guide — Doc. 8214BU XiOCloud® • 79
Page 87

Cut and Paste

The cut and paste functionality allows items in the group tree to be moved more easily than the traditional drag and drop method, which is helpful when associating devices to rooms or groups in bulk. Cutting and pasting can be performed using the UIcontrols or keyboard shortcuts.
NOTE:Any item in the group tree can be cut and pasted. However, pasted items must abide by the organizational hierarchy of the group tree. For example, devices can only be pasted to rooms or desks, top-level groups cannot be pasted under subgroups, and so forth.
To cut items (add them to the clipboard):
1. Select one or more items from the group tree. Press Ctrl +Shift on your keyboard to select multiple items.
2.
Select the context menu button for one of the selected items to display a drop-down menu.
Device - Drop-Down Menu
3. Select Cut. The selected item(s) are added to the clipboard. Alternately, press Ctrl+x on your keyboard to perform this action.
To paste items that have been cut (added to the clipboard):
80 • XiOCloud® User Guide — Doc. 8214BU
Page 88
1. Select the parent node in the group tree where the cut items should be pasted.
2.
Select the context menu button for the selected group tree node.
Group - Drop-Down Menu (Paste Action)
3. Select Paste. The selected item(s) are pasted into the selected group tree node as long as it abides by the group tree hierarchy. Alternately, press Ctrl+v on your keyboard to perform this action.
To undo the previous cut or paste action, select Undo from the appropriate context menu or press Ctrl+z on your keyboard.
User Guide — Doc. 8214BU XiOCloud® • 81
Page 89

Download Inventory

An inventory report for the XiOCloud account can be downloaded as a CSVfile. The inventory report includes basic information about claimed devices and their location within the group tree.
To download the inventory report:
1.
Select the ENVIRONMENT menu button to display a drop-down menu.
Environment - Drop-Down Menu
2. Select Download Inventory. The inventory report is downloaded to your PCas a CSVfile.

View Grouped Devices, Rooms, and Desks

Select a group from the ENVIRONMENT menu to display its configuration page. Selections for viewing all devices, rooms, and desks within the group are provided. The Device tab is selected by default.
NOTE:Viewing grouped rooms and desks requires an XiOCloud Premium subscription.
82 • XiOCloud® User Guide — Doc. 8214BU
Page 90
l
Select Device to view status, configure settings, and perform other actions for all devices associated with rooms or desks in the group. For more information, refer to Manage Devices on
page 85.
l
Select Rooms to view the status of all rooms within the group.
The following information is displayed for each room by default:
NOTE:Most room status is driven by the XiOCloud program connector functionality. For more information on adding this functionality to a room, refer to XiOCloud
ProgramConnector on page 128
o
The room name, which can be selected to open its details page
o
The current room health
o
The space type
o
The reported occupancy state
o
The system power state
o
The power state of the display(s) in the room
o
The current source routed to the primary display in the room as described in Appendix C:
XiO Cloud Program Connector Sources on page 252
o
The maintenance mode status
o
The date and time when a system check was last run
l
Select Desks to view the status of all desks within the group.
User Guide — Doc. 8214BU XiOCloud® • 83
Page 91
The following information is displayed for each desk by default:
o
The desk name, which can be selected to open its details page
o
The email address associated with the desk scheduling calendar
o
The space type
The data that is displayed for devices, rooms, or desks can be customized by filtering the table columns. To select or deselect table columns for devices, rooms, or desks, expand the drop-down menu at the top right of the status table. Then, select or deselect an item in the menu to display or hide that column from the status table, respectively. Use the check box at the top of the menu to select or deselect all columns.
The column selections for devices are shown below as an example.
Column Selection Drop-Down Menu (Device Tab)
NOTE:Changes made to the status table are made only on a per-group basis. The status table will
reset to its default settings after logging out of the XiOCloud service.
The status table for devices, rooms, or desks can be downloaded as a CSVfile by selecting the Export to CSVbutton at the top right of the status table. The CSVfile will include all table columns that have been selected as described above.
Enter text into the Global Filter text box to search for and display results that match the searchterms.
If the status table spans multiple pages, use the navigation arrows on the bottom of the page to move forward or backward through the pages, or select a page number to navigate to it. Additionally, the number of devices, rooms, or desks displayed on each page may be set to 5, 10, 20, or 25.
84 • XiOCloud® User Guide — Doc. 8214BU
Page 92

Manage Devices

Devices may be managed via the XiO Cloud service after they have been claimed by the service and added into a group or room. Devices may be managed individually or as a group.
Select a device from the group tree to view and configure the device status, settings, and licenses. The configuration page for the device also provide options for viewing status dashboards and activity logs, and automated actions may be scheduled for the device.
NOTE: Not all device management options are available for some devices.
Device Configuration Page
Use the following procedures to manage devices via the XiO Cloud service.
User Guide — Doc. 8214BU XiOCloud® • 85
Page 93

Rename a Device

Each device in the XiO Cloud service has a unique device name, which allows the device to be identified and organized within the service. The device name is used only by the XiO Cloud service.
By default, the device name is set as the host name of the device. However, the device may be renamed as needed.
NOTE: Changing the device name has no impact on the host name or other identifying features on the hardware.
Two methods may be used to rename a device: The device name may be changed in the group tree or from its configuration page.
To change the device name in the group tree:
1. Position the cursor over the device in the ENVIRONMENT menu to reveal its context menu.
2.
Select the context menu button of the device to display a drop-down menu.
Device - Drop-Down Menu
3. Select Rename Device. The device name becomes an editable text box.
Device - Edit Device Name
4. Enter a new device name in the text box. A device name must be at least three characters long.
5.
Select the green check icon or select Enter to save the device name. Select the red x icon to discard the changes.
86 • XiOCloud® User Guide — Doc. 8214BU
Page 94
To change the device name from the configuration page:
1. Select the device from the group tree to display its configuration page.
Device Configuration Page
2. Select the device name on the top left of the configuration page. The device name becomes an editable text box.
Device Configuration Page - Edit Device Name
3. Enter a new device name in the text box. A device name must be at least three characters long.
4.
Select the green check icon or select Enter to save the device name. Select the red x icon to discard the changes.

View Device Status

The device status may be viewed for individual devices or for multiple devices within the same group or room.
User Guide — Doc. 8214BU XiOCloud® • 87
Page 95

View Status for a Single Device

To view the status for a single device, select a device from the group tree to display its configuration page. The Status tab is open by default.
NOTE:Adevice must be added into a room or group before its configuration page can be viewed.
Device Configuration Page - Status Tab (Devices)
The Status tab provides expandable "accordions" that display static and changing device attributes. Dynamic attributes, such as volume, change in the appropriate status accordion within seconds of being changed on the device.
Select an accordion name to expand it. If the accordion is expanded, select the accordion name again to collapse it. The accordions provided vary depending on the device.
88 • XiOCloud® User Guide — Doc. 8214BU
Page 96

View Status for a Group of Devices

To view the status for multiple devices within the same group or room, select a group or room from the group tree to display its configuration page. The Status tab is selected by default.
Group Configuration Page - Status Tab (Device Status)
The Status section lists all of the devices within the group or room and any subgroups in table format. The Device Status table provides a subset of important status information for the devices within the group and its subgroups.
NOTE:Selecting the Unassociated Devices group displays the device status for all unassociated devices in the account. Only the Name, Device Model, Serial, and MACAddress status fields are provided for unassociated devices. An unassociated device must be moved to a room or group before its individual status can be viewed.
The following information is displayed for each device by default:
l
The name and model
l
The loaded firmware version, including whether any firmware updates are pending
l
The serial number and MAC address
l
The online status, which indicates whether the device is connected to the XiOCloud service
l
The pending settings delivery status, which indicates whether any device settings changes are pending
NOTE: If the Pending Settings Delivery status is Yes, device settings have been saved in the portal but have not yet been applied to the device (such as in instances where the device is unplugged).
The data that is displayed for each device in a group or room can be customized by filtering the table columns for that group or room. By default, 7 columns are displayed that contain the data described in the list above. Up to 15 columns can be displayed by selecting or deselecting a column in the provided drop-down menu.
User Guide — Doc. 8214BU XiOCloud® • 89
Page 97
To select or deselect table columns for a group or room, expand the drop-down menu at the top right of the status table. Then, select or deselect an item in the menu to display or hide that column from the status table, respectively. Use the check box at the top of the menu to select or deselect all columns.
Column Selection Drop-Down Menu
NOTE:Changes made to the status table are made only on a per-group or room basis. The status
table will reset to its default settings after logging out of the XiOCloud service.
The device status table for a group or room can be downloaded as a CSVfile by selecting the Export to CSVbutton at the top right of the status table. The CSVfile will include all table columns that have been selected as described above.
Enter text into the Global Filter text box to search for and display devices that match the searchterms.
If the device lists spans multiple pages, use the navigation arrows on the bottom of the page to move forward or backward through the pages, or select a page number to navigate to that page. Additionally, the number of devices displayed on each page may be set to 5, 10, 20, or 25 devices.

Configure Device Settings

Device settings may be configured for individual devices or for multiple devices within the same group or room.

Configure Settings for a Single Device

To configure the settings for a single device, select a device from the group tree to display its configuration page, and then select the Settings tab.
NOTE:Adevice must be added into a room or group before its configuration page can be viewed.
90 • XiOCloud® User Guide — Doc. 8214BU
Page 98
Device Configuration Page - Settings Tab (System Setup)
The Settings tab provides selections for configuring various device settings. When a device is first claimed and added to a group, the current device settings are prepopulated in the XiO Cloud service.
To change a device setting:
1. Locate the device setting in the appropriate Settings accordion.
The accordions provided vary depending on the device. Some accordions include subsections that may be expanded by selecting the plus (+) button next to the subsection name. If the subsection is expanded, select the minus (-) button to collapse the subsection.
2. Fill the check box next to a setting to enable it in XiO Cloud.
If a setting is not enabled in XiO Cloud, it will not be sent to the device and can be managed by processes outside of XiO Cloud (such as joins).
User Guide — Doc. 8214BU XiOCloud® • 91
Page 99
NOTE: If a setting is enabled in XiO Cloud, it will show what is currently saved in the portal. If a setting is not enabled in XiO Cloud, it will show what is currently set on the device.
For more information on configuring specific settings for a device, refer to its documentation at
www.crestron.com/manuals.
Once a device setting has been changed, the Actions button on the top right of the configuration page changes to a Save Changes button. Select Save Changes to push the updated setting(s) to the device.
Save Changes Button
After the settings have been pushed from the cloud to the device successfully, a toast notification is displayed confirming the success.
Device Settings Saved Successfully Message
If the device has not yet received the settings, orange "Delivery to Device Pending" text is shown next to the changed settings until the device receives the settings.
NOTES:
l
Depending on the settings that are changed, the device may restart a few minutes after Save Changes is selected.
l
Each setting checks for valid input. If an invalid input is entered, red text explaining the error is displayed next to the setting, and a red underline is shown under the setting. Changes cannot be saved until the error is resolved.
l
A setting entered at the group level cannot be edited on the individual device page. Each device in a group inherits any group-level settings.
To undo changes before saving the settings to the device, select the drop-down arrow next to the Action (or Save Changes) button, and then select Revert. The device settings are returned to their last saved state.
92 • XiOCloud® User Guide — Doc. 8214BU
Page 100

Configure Settings for a Group of Devices

To configure the settings for multiple devices within the same group or room, select a group or room from the group tree to display its configuration page, and then select the Settings tab.
Group Configuration Page - Settings Tab (System Setup)
Configuring device settings (such as language or date and time) at the group level pushes the settings to every device in that group or room or its subgroups. Device settings configured at the group level overwrite the same settings on the individual device pages.
NOTE:No device settings can be configured for devices within the Unassociated Devices group. An unassociated device must be moved to a room or group before its settings can be configured.
Each group-level setting in the Settings section provides a check box next to the setting:
l
Select an empty check box to activate the associated setting at the group level. Green text is displayed next to the setting to indicate that the setting is now included in the group settings.
l
Select a filled check box to disable the associated setting at the group level.
User Guide — Doc. 8214BU XiOCloud® • 93
Loading...
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use