[Index]

Model: data/RoomosDeviceConfigurationProfile

Webex App Workspaces

Full HTML Help

Overview

Webex App workspaces are synced in from a Webex Control Hub.

This includes Calling Behaviour and Calendar settings, as well as Phone Numbers and Devices information associated with the workspace.

Upon sync, existing numbers in the Number Inventory will also updated with workspace details, for example in the corresponding Usage, Description, and Vendor fields.

You can define Webex App workspaces of various types in VOSS Automate, for example, meeting rooms or open spaces.

Add a Webex App Workspace

This procedure adds a Webex App workspace, and optionally, adds devices.

Note

You can add devices when adding a new workspace or when updating an existing workspace.

  1. In the Admin Portal, go to (default menus) Cisco Webex App > Workspaces.

  2. Choose the relevant hierarchy.

  3. Provide a workspace name, and capacity, and from the Type field, choose the workspace type.

  4. In the Send Device Activation Code To field, fill out the email address(es) where the device type code is sent.

    Note

    This code is unique to this created workspace and is entered into the device itself.

    Once the code is created, the Device Activation Code (read only) value is returned and shown, as well as its Device Activation Code Expiration Date.

    A VOSS Automate schedule checks the expiration date and generates a new code. The SIP Address of the workspace is also shown.

  5. In the Calling section, choose the calling behavior (free or hybrid).

    Note

    The hybrid calling option displays additional fields where you need to choose a site and an available directory number, which then generates a mail ID is generated from CUCM. The auto-generated value in the Mail ID from Unified CM field uses the following:

    wt_ + <random-number> + the email hostname set up for the Webex App service

    For example, wt_886821663180@myhost.com.

    A subscriber user for the device is then added at the selected site, with the following:

    • User Id and Last Name: wt_886821663180
    • First Name: workspace Name
    • Primary Extension: Directory Number
    • Phone: Spark Remote device with workspace specific settings

    Once the device code is entered, the page displays details of the device associated with the workspace in the Devices group, for example: Product, Connection Status and IP Address. A link to the device is then also available, to show details (read only) as listed under the Devices menu for Webex App.

  6. At Calendar section, you can add select a Calendar provider as available from the Scheduling section on the Webex Control Hub.

  7. At New Devices, you can add one or more new devices to the workspace. This allows for activating devices in a workspace using the RoomOS driver.

    1. Add the current IP Address for the Webex device.

      Note

      The configured IP address must be reachable by all of the VOSS Automate unified nodes via HTTPS using port 443.

    2. Select the Profile to use for configuring the device.

      Note

      The profile includes the required parameters for the configuration. Available profiles are managed via (default menus) Webex App > RoomOS Device Configuration Profiles.

    3. Add the device Username and Password if needed.

      Note

      You can add a device with the default username, admin, and no password. However, it is recommended that you add a second user on the device since, when the device registers with the Control Hub, by default, Control Hub disables the default username (admin) as part of the registration process, which prevents you from logging back in to the device using its IP address, unless you've added a second user. For example, without the second user, reset via the Admin Portal will not work because you will need to provide a username and password. If the default username is disabled, go to the Control Hub, locate your device, and access the device via the UI.

    Existing devices in the workspace are shown in the Devices group, while all devices are shown from the Devices menu.

  8. Save your changes. Wait for the transaction to complete.

Device Configuration Profiles

VOSS Automate ships with the following default device configuration profiles for Webex App:

ActivateWebexRoomOSDevice Used for activating a device.
ResetWebexRoomOSDevice Used for resetting an already active device.

Note

Configuration Blocks

The device configuration profiles contain configuration blocks, such as Configuration, Command and Activation.

Configuration Blocks Description
Configuration The step uses the configuration API for the device.
Command

This step uses the command API, and may be used for customization, for example, of buttons and widgets for the device user interface.

The <Upload> section in the XML is used to upload two .png files to the device, which can be used for the icons or panels.
Activation This step is only present in the ActivateWebexRoomOSDevice device configuration profile, and performs the last step in the device configuration, which involves activating the device in the Control Hub.

Note

You can log in to your RoomOS device and view the API developer documentation for a description of the XML in each step.

Values used inside the configuration blocks (e.g. {{ pwf.http_proxy_mode }}) can be managed as name-value pairs (e.g. http_proxy_mode: Off) in the Values fieldset of the profiles.

When specifying icons or images in the configuration file, the default file contains two samples:

The .png files you're referencing in the configuration must be uploaded into VOSS Automate first via (default menus) Administration Tools > File Management. If the files are not uploaded, the configuration step will fail.

Custom device configuration profiles can be added and tested by selecting these on the input form of the Test Device Configuration Profile Rendering menu.

Test Device Configuration Profile Rendering

To test the device configuration profile rendering:

  1. In the Admin Portal, go to (default menus) Cisco Webex App > Test Device Configuration Profile Rendering.
  2. Select an available Profile from the drop-down, and provide or override name-value pairs for the profile as Mock Values instances.

Resetting RoomOS Devices

Webex meeting room device users may regularly change device settings throughout the day, for example, to change the volume, or camera settings. Since custom settings could impact future meetings, it may be considered good practice to regularly reset and clear device settings to their baseline configuration (standard settings).

In the Admin Portal you can set up a regular schedule for resetting Webex-registered meeting room devices, which will typically execute daily (before the start of the working day), or reset one or more devices manually, as required.

Reset schedules are configured via (default menus) Cisco Webex App > RoomOS Reset Schedule.

Alternatively, you can manually reset active devices, via (default menus) Cisco Webex App > Reset RoomOS Devices to Baseline.

You can view all registered (active) devices via (default menus) Cisco Webex App > Devices. You can add devices when adding a new workspace or when updating an existing workspace.

Manually Reset a RoomOS Device

  1. In the Admin Portal, go to (default menus) Cisco Webex App > Reset RoomOS Devices to Baseline.

  2. Choose the device scope (refresh action). The table describes the available options:

    Refresh Single Device Choose one active device from the list that displays when you select this option.
    Refresh Multiple Devices Choose from the list of active devices that display when you select this option.
    Refresh All Devices Resets all active devices.

  3. Choose a device configuration profile for resetting the device.

  4. Fill out your username and password.

  5. Click Save.

    The device configuration profile resets the selected active devices (one, more, or all, depending on the option you selected for device scope).

Schedule RoomOS Device Reset

This procedure configures a schedule that will execute to reset active RoomOS devices.

  1. In the Admin Portal, go to (default menus) Cisco Webex App > RoomOS Reset Schedule > Schedule Configuration Template.

  2. On the Schedule Configuration Template list view, click on the schedule you want to use.

    The schedule configuration template contains a workflow that is executed by the reset schedule. The default schedule configuration template name is WebexDeviceRefreshSchedule_CFT.

  3. On the schedule configuration page, choose the device scope, and the device configuration profile to use.

  4. Fill out the username and password that has access to the devices.

  5. Save your changes.

  6. Go to (default menus) Cisco Webex App > RoomOS Reset Schedule > Schedule, and click on the schedule.

  7. On the schedule form, create the schedule, and at Scheduled resources, at the Resource drop-down, choose the schedule (WebexDeviceRefreshSchedule).

  8. Save your changes.

    Devices will be refreshed according to the schedule and the workflow defined in the schedule configuration template.

RoomosDeviceConfigurationProfile

Model Details: data/RoomosDeviceConfigurationProfile

Title Description Details
Name *
  • Field Name: name
  • Type: String
Configuration Blocks
  • Field Name: configuration_blocks.[n]
  • Type: Array
Name *
  • Field Name: configuration_blocks.[n].name
  • Type: String
Body
  • Field Name: configuration_blocks.[n].body
  • Type: String
Values
  • Field Name: values.[n]
  • Type: Array
Name *
  • Field Name: configuration_blocks.[n].values.[n].name
  • Type: String
Value
  • Field Name: configuration_blocks.[n].values.[n].value
  • Type: String
XML Escape
  • Field Name: configuration_blocks.[n].values.[n].xml_escape
  • Type: Boolean