[Index]

Model: relation/WebexTeamsPlace

Webex Teams Workspaces

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Workspaces of various types - such as Meeting rooms or open spaces can be defined in VOSS-4-UC.

The data entered on this input form is formatted as a sequence of steps in an email message to be carried out on the Webex Teams Control Hub. See: Global Settings for an email message example.

  1. Provide a workspace Name, Capacity and select a workspace Type.

  2. Use the Send Device Activation Code To field for the email address(es) where the device type code is sent. 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-4-UC schedule checks the expiration date and generates a new code. The SIP Address of the workspace is also shown.

    The Calling group has options for the Calling Behavior (free or hybrid) The hybrid calling option allows for a Site to be selected, as well as a Directory Number that is available.

    The Mail ID input is then generated, using:

    wt_ + <random-number> + the email hostname set up for the Webex Teams service, for example wt_886821663180@myhost.com.

    A subscriber user for the device is then added at the selected site (Site), with:

Once the device code is entered, the VOSS-4-UC form also shows the 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 Teams.

The added workspace is listed on the Workspaces menu.

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.

This implements the relationship between a Webex App place and associated devices.

Model Details: relation/WebexTeamsPlace

Title Description Details
Place Settings Group Assigned by FDP
  • Field Name: Place Settings
  • Type: Object
Name * A friendly name for the workspace.
  • Field Name: Place Settings.displayName
  • Type: String
Capacity How many people the workspace is suitable for.
  • Field Name: Place Settings.capacity
  • Type: Integer
Type The workspace type.
  • Field Name: Place Settings.type
  • Type: String
  • Choices: ["No workspace type set", "Desk - individual", "Focus - high concentration", "Huddle - brainstorm/collaboration", "Meeting Room - dedicated meeting space", "Open Space", "Other"]
SIP Address SipUrl to call all the devices associated with the workspace.
  • Field Name: Place Settings.sipAddress
  • Type: String
Associated Devices The product type of the devices associated with this place.
  • Field Name: Place Settings.associated_devices
  • Type: String
Device Activation Code The activation code for registering and associating a device with this place.
  • Field Name: Place Settings.device_activation_code
  • Type: String
Device Activation Code Expiration Date The expiration date for the activation code.
  • Field Name: Place Settings.device_activation_code_expiry_date
  • Type: String
  • Format: date-time
Phone Numbers
  • Field Name: phoneNumbers.[n]
  • Type: Array
External
  • Field Name: Place Settings.phoneNumbers.[n].external
  • Type: String
Extension
  • Field Name: Place Settings.phoneNumbers.[n].extension
  • Type: String
Primary
  • Field Name: Place Settings.phoneNumbers.[n].primary
  • Type: Boolean
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how calls are made from this place. Default: freeCalling
  • Field Name: Place Settings.calling.type
  • Type: String
  • Default: freeCalling
  • Choices: ["No Calling", "Free Calling (default)", "Webex Calling", "Third-party SIP URI", "Webex Edge For Devices"]
Hybrid Calling Settings
  • Field Name: hybridCalling
  • Type: Object
End user email address in Cisco Unified CM Enter the Mail ID below to connect this place to the existing Unified CM account. This Mail ID ensures that the correct user account is connected with this place for hybrid calling. A default domain must be configured on the Webex Teams account to dervice this email address.
  • Field Name: Place Settings.calling.hybridCalling.emailAddress
  • Type: String
  • Pattern: (^$|^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$)
Site Select the Site where the associated Unifed CM user will be created. The Webex Teams places and devices will automatically be moved to this site.
  • Field Name: Place Settings.calling.site
  • Type: String
Site Pkid
  • Field Name: Place Settings.calling.site_pkid
  • Type: String
Directory Number Enter the DN to be used with the Unified CM account. This DN is used for hybrid calling.
  • Field Name: Place Settings.calling.directory_number
  • Type: String
Subscriber PKID Internal field for the subscriber ID.
  • Field Name: Place Settings.calling.subscriber_pkid
  • Type: String
Link to Subscriber Jump to the associated subscriber page.
  • Field Name: Place Settings.calling.subscriber_link
  • Type: String
  • Format: link
Calendar
  • Field Name: calendar
  • Type: Object
Calendar Type Which calendar provider do you want to use?. Default: none
  • Field Name: Place Settings.calendar.type
  • Type: String
  • Default: none
  • Choices: ["None", "Microsoft Exchange / Office 365", "Google Calendar"]
Workspace email address This is the email address that will be used to connect to the hybrid calendar service.
  • Field Name: Place Settings.calendar.emailAddress
  • Type: String
Devices
  • Field Name: devices.[n]
  • Type: Array
Link Link to jump to the device details.
  • Field Name: Place Settings.devices.[n].link
  • Type: String
  • Format: link
Product The product name.
  • Field Name: Place Settings.devices.[n].product
  • Type: String
Connection Status The connection status of the device.
  • Field Name: Place Settings.devices.[n].connectionStatus
  • Type: String
IP Address The current IP address of the device.
  • Field Name: Place Settings.devices.[n].ip
  • Type: String
Primary SIP URL The primary SIP address to dial this device.
  • Field Name: Place Settings.devices.[n].primarySipUrl
  • Type: String
New Devices New devices to add to the workspace
  • Field Name: input_devices.[n]
  • Type: Array
IP Address *
  • Field Name: Place Settings.input_devices.[n].IP
  • Type: String
Profile *
  • Field Name: Place Settings.input_devices.[n].Profile
  • Type: String
  • Target: data/RoomosDeviceConfigurationProfile
  • Target attr: name
  • Format: uri
Username Defaults to admin
  • Field Name: Place Settings.input_devices.[n].username
  • Type: String
Password Defaults to empty string
  • Field Name: Place Settings.input_devices.[n].password
  • Type: String
  • Is Password: True