Webex Workspace Integration

The Webex Workspace Integration allows you to connect your Aida Platform site with Cisco Webex devices, enabling smart building controls directly from Webex Room Navigator devices and other Webex endpoints.

Overview

This integration provides:

• Device Discovery: Automatically discover Webex devices in your organization
• Panel Management: Create custom control panels for building automation
• Real-time Control: Control lights, shades, HVAC, and other building systems from Webex devices
• Webhook Monitoring: Track device interactions and system events
• Controller Assignment: Link Webex devices to specific building controllers

Integration Architecture

Prerequisites

Before setting up the integration, ensure you have:

• Webex Control Hub Access: Admin access to your organization's Webex Control Hub
• Aida Platform Site: An active site configured in the Aida Platform
• Network Connectivity: Webex devices must be able to reach the Aida Platform API
• Controller Access: At least one Aida Controller configured and accessible

Setup Process

Step 1: Create Integration in Aida Platform

1. Navigate to Site Management
   • Go to your Aida Platform dashboard
   • Select the site where you want to add Webex integration
   • Click on "Webex Integration" in the integrations section

2. Add New Integration
   • Click "Add Integration" button
   • Fill in the required information:
     • Client ID: (Will be obtained from Webex Control Hub)
     • Client Secret: (Will be obtained from Webex Control Hub)
     • Webhook URL: (Automatically generated by the platform)

3. Download Manifest File
   • Click "Download Manifest" to get the integration manifest
   • Save the manifest.json file to your local machine
   • This file contains the integration configuration for Webex

Step 2: Configure in Webex Control Hub

1. Access Webex Control Hub
   • Go to admin.webex.com
   • Log in with your admin credentials
   • Navigate to "Workspaces" → "Integrations"

2. Add Integration
   • Click "Add Integration"
   • Select "Upload Integration"
   • Choose the manifest file downloaded from Aida Platform
   • Click "Upload"

3. Get Credentials
   • After successful upload, you'll see the integration details
   • Copy the Client ID from the integration page
   • Copy the Client Secret from the integration page

Step 3: Complete Integration Setup

1. Return to Aida Platform
   • Go back to the Webex Integration page
   • Paste the Client ID from Webex Control Hub
   • Paste the Client Secret from Webex Control Hub
   • Click "Create" to save the integration

2. Activate Integration in Webex

   • Return to Webex Control Hub
   • Go to your integration
   • Select "Activate"
   • Click "Activate" to enable the integration
   • Click "Done"
   • Verify "Active"

3. Verify Integration Status

   • In Aida Platform, check that the integration shows "Active"
   • Integration Status "Active"

Step 4: Device Management

1. Discover Webex Devices
   • In the Webex Integration dialog, go to "Device Management"
   • Click "Refresh Devices" to discover available Webex devices
   • The system will list all Webex devices in your organization

2. Assign Controllers
   • Select a Webex device from the list
   • Choose an Aida Controller to assign to the device
   • Click "Assign Controller" to link the device to the controller
   • Repeat for all devices you want to control

Step 5: Panel Configuration

1. Load Default Template
   • Go to "Panel Management" in the integration dialog
   • Click "Load Default Template" to get started with basic controls
   • The template includes common building automation controls

2. Customize Panels
   • Select specific devices to configure
   • Choose control types (lights, shades, HVAC, etc.)
   • Configure button layouts and control parameters
   • Save panels to specific devices

3. Test Panels
   • Use the "Panel Test" feature to verify controls work
   • Test individual buttons and control sequences
   • Monitor webhook events to confirm successful communication

Configuration Options

Panel Types

The integration supports various panel configurations:

• Lighting Controls: Dimmer controls, on/off switches, scene controls
• Shade Controls: Open/close, position control, preset positions
• HVAC Controls*: Temperature adjustment, fan speed, mode selection (*coming soon)
• Security Controls*: Door locks, access control, alarm systems (*coming soon)
• Custom Controls*: Any building system accessible via the Aida Controller (*coming soon)

Device Assignment

• Single Device: Assign one aida controller to each Webex device
• Multiple Devices: Assign same controller to multiple Webex devices
• Zone-based: Aida controller will manage grouping of controlled devices

Monitoring and Troubleshooting

Webhook Monitoring

1. View Webhook Events
   • Go to "Webhook Monitoring" in the integration dialog
   • View real-time webhook events from Webex devices
   • Monitor device interactions and system responses

2. Event Details
   • Click on individual webhook events to see detailed information
   • View JSON payload data for debugging
   • Track device status changes and control commands

Common Issues

Integration Not Activating

• Verify Client ID and Client Secret are correct
• Check that the manifest file was uploaded successfully
• Ensure webhook URL is accessible from Webex

Devices Not Discovered

• Verify network connectivity between Webex devices and Aida Platform
• Check that the integration has proper API permissions
• Ensure devices are registered in Webex Control Hub

Panels Not Working

• Verify controller assignment is correct
• Check that building systems are properly configured
• Test individual control commands
• Monitor webhook events for error messages

Security Considerations

• OAuth Tokens: Integration uses secure OAuth 2.0 authentication
• Webhook Security: All webhooks are signed and verified
• API Permissions: Integration requests only necessary permissions
• Data Encryption: All communication is encrypted in transit

Support and Maintenance

Regular Maintenance

• Monitor integration status and webhook events
• Update panel configurations as building systems change
• Review and rotate API credentials periodically
• Test integration functionality after system updates

Getting Help

• Check the webhook monitoring for error messages
• Review the integration logs for detailed error information
• Contact support with specific error messages and device information

Next Steps

After successful integration setup:

1. Configure Building Systems: Ensure all building systems are properly connected to Aida Controllers
2. Test Controls: Verify that all panel controls work as expected
3. Train Users: Provide training to building occupants on using Webex devices for building controls
4. Monitor Performance: Use webhook monitoring to track system performance and usage

The Webex Workspace Integration provides a powerful way to bring building automation controls directly to Webex devices, creating a seamless experience for building occupants and facility managers.