[Index]

Model: relation/WebexTeamsPlace

Webex App Workspaces

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

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

Details synced in includes calling behavior and calendar settings, as well as phone numbers and device information associated with the workspace.

When a sync occurs, existing numbers in the number inventory will also updated with workspace details, for example in the corresponding Usage, Description, and Vendor fields.

You can add various types of Webex App workspaces in 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. Log in to the Admin Portal as provider admin, then go to the Webex App Workspaces list view.

  2. Click the Plus icon (+) to add a new workspace, then choose the relevant site.

    Note

    Workspaces are created at site level.

  3. Fill out details for the new workspace:

  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.

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

  5. At Calling Behavior, select the workspace calling behavior:

  6. If you've chosen Webex Calling as the calling behavior, at Webex Calling Settings, fill out a phone number and extension.

    Note

    Webex Calling settings display on the page only when Webex Calling is selected.

  7. At Calendar Type, optionally, select a calendar provider (these options are those available from the Scheduling section on the Webex Control Hub - for example, Microsoft Exchange / Office 365, or Google Calendar). If you choose a calendar type, you will need to fill out a workspace email address.

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

    Note

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

    For each new device:

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

    The new workspace and devices are registered with Webex Control Hub, which assigns an activation code. The activation code is used to make a second connection to the device local IP address to run the activation step with the configuration you specified in the configuration blocks.

    In the Admin Portal, you can view the new workspace in the the Workspaces list view. To view new devices, use the Action search to locate the Devices page.

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
Supported Devices Supported devices cannot be changed after the workspace has been created
  • Field Name: Place Settings.supportedDevices
  • Type: String
  • Choices: ["Collaboration devices", "MPP phones"]
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"]
Webex Calling Settings
  • Field Name: webexCalling
  • Type: Object
Location Location ID when adding a Webex Calling workspace.
  • Field Name: Place Settings.calling.webexCalling.locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Phone Number Phone Numberwhen adding a Webex Calling workspace.
  • Field Name: Place Settings.calling.webexCalling.phoneNumber
  • Type: String
Extension Extension when adding a Webex Calling workspace.
  • Field Name: Place Settings.calling.webexCalling.extension
  • Type: String
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