Add VOSS over an existing Webex organization ================================================== .. _25.2|EKB-23112: Add VOSS over an existing Webex organization (configuration already in place) ................................................................................... This procedure adds VOSS over an existing Webex organization with configuration already in place: * The Webex organization has been previously configured in the Webex Control Hub. * Webex Calling configuration is in place (including locations; may also include additional configuration, such as for numbers, users, and devices). VOSS syncs in the configuration and automatically creates the required sites. Users, numbers, and devices are automatically moved to the appropriate sites. 1. In the VOSS Admin portal: a. Add the VOSS customer. .. image:: /src/images/webex-onboarding-best-practices_html_968c5e5a.png b. In **Global Settings**: * Disable HCS rules for the customer to allow Webex Calling number management without the restrictions of the Cisco HCS dialplan. .. image:: /src/images/webex-onboarding-best-practices_html_8ee56c3d.png * Ensure that Webex App (Teams) is enabled for the customer to allow the display of conditional menu items. .. image:: /src/images/webex-onboarding-best-practices_html_ac1bcaf9.png c. Optional. Create intermediate nodes, if required. .. note:: This step allows sites to be grouped under intermediate nodes (divisions), which is useful where there are a large number of sites and/or the administration of those sites should be available to groups of administrators, each of whom are responsible for a subset of those sites. .. image:: /src/images/webex-onboarding-best-practices_html_1d861767.png d. Create Webex Location Node mapping, if required. .. note:: This step allows the mapping of partially matched location names to match to the intermediate nodes created in the previous step. When syncing in locations from the Webex Control Hub, sites are automatically created under their appropriate intermediate nodes. Location names that don't match these rules are created under the Customer hierarchy. .. image:: /src/images/webex-onboarding-best-practices_html_4acbbf4e.png e. In each site's *Site Defaults*, add or update the **Webex Location ID** field to prevent the automatic creation of new sites. .. note:: In some cases, sites may already exist in VOSS, typically, where VOSS already provides managed services using different vendor technologies. In this case, update the existing Site Defaults Doc (SDD) parameter, **Webex Location ID**, for each site, prior to connecting VOSS to the Webex Control Hub. Location names and VOSS site names do *not* need to match. Adding the *Webex Location ID* to the SDD prevents the creation of new sites. .. image:: /src/images/webex-onboarding-best-practices_html_46110e7e.png 2. In the Webex Control Hub: a. On the **Account** page, obtain the **Organization ID**. .. note:: The *Organization ID* will be required when connecting VOSS to the Webex Control Hub. .. image:: /src/images/webex-onboarding-best-practices_html_c7a48b06.png b. Add an admin user that VOSS can use to access the Webex Control Hub, and ensure that the correct roles are assigned. .. image:: /src/images/webex-onboarding-best-practices_html_d8cc605e.png 3. In the VOSS Admin Portal: * Add the *Organization ID* you obtained from Webex Control Hub. * If an HTTP(s) proxy is in use for internet access, fill out a value for **HTTP Proxy String** / **HTTPS Proxy String**. * Save your changes. .. image:: /src/images/webex-onboarding-best-practices_html_127fad80.png * Re-open the form you saved, then click the **Connect to Webex Control Hub** link to open Webex Control Hub. .. image:: /src/images/webex-onboarding-best-practices_html_ecb7465d.png 4. Log in to Webex Control Hub with the user credentials to be used for Control Hub access. 5. In the VOSS Admin portal, execute the full sync to pull in all Control Hub data. Site-specific data is automatically moved to the sites created. .. image:: /src/images/webex-onboarding-best-practices_html_9e948d6e.png The initial configuration and import of the Webex customer is now complete. Add VOSS over an existing, un-provisioned Webex organization ................................................................... This procedure adds VOSS over an existing, un-provisioned Webex organization: * The Webex organization has been previously created in the Webex Control Hub. * Webex Calling configuration does not yet exist. VOSS will be used to create and manage Webex Calling configuration. .. note:: At the time of writing (25.1), some configuration must be managed via the Webex Control Hub. This topic does not include details for Webex setup outside of VOSS, such as LDAP integration and *Organization* settings. Refer to the Webex documentation for these details. 1. In the VOSS Admin portal: a. Add the VOSS customer. .. image:: /src/images/webex-onboarding-best-practices_html_968c5e5a.png b. In **Global Settings**: * Disable HCS rules for the customer to allow Webex Calling number management without the restrictions of the Cisco HCS dialplan. .. image:: /src/images/webex-onboarding-best-practices_html_8ee56c3d.png * Ensure that Webex App (Teams) is enabled for the customer to allow the display of conditional menu items. .. image:: /src/images/webex-onboarding-best-practices_html_ac1bcaf9.png c. Optional. Create intermediate nodes, if required. .. note:: This step allows sites to be grouped under intermediate nodes (divisions). This may be useful where there are a large number of sites and/or the administration of those sites should be available to groups of administrators, each of whom are responsible for a subset of those sites. .. image:: /src/images/webex-onboarding-best-practices_html_1d861767.png d. Manually add new VOSS sites. .. image:: /src/images/webex-onboarding-best-practices_html_ed658046.png 2. Log in to the Webex Control Hub, then: a. Obtain the **Organization ID** from the **Account** page. .. note:: The *Organization ID* will be required when connecting VOSS to the Webex Control Hub. .. image:: /src/images/webex-onboarding-best-practices_html_c7a48b06.png b. Add an admin user that VOSS can use to access the Webex Control Hub, and ensure that the correct roles are assigned. .. image:: /src/images/webex-onboarding-best-practices_html_d8cc605e.png 3. In the VOSS Admin portal: a. Add Webex Control Hub access: * Add the *Organization ID* you obtained from Webex Control Hub. * If an HTTP(s) proxy is in use for internet access, fill out a value for **HTTP Proxy String** / **HTTPS Proxy String**. * Save your changes. .. image:: /src/images/webex-onboarding-best-practices_html_127fad80.png b. Re-open the form you saved, then click the **Connect to Webex Control Hub** link to open Webex Control Hub. .. image:: /src/images/webex-onboarding-best-practices_html_ecb7465d.png 4. Log in to Webex Control Hub with the user credentials to be used for Control Hub access. 5. In VOSS: a. Execute the full sync to pull in all Control Hub data. .. image:: /src/images/webex-onboarding-best-practices_html_9e948d6e.png b. Add locations to the Control Hub: .. image:: /src/images/webex-onboarding-best-practices_html_a65554e5.png 6. In Webex Control Hub, set up calling connection: * Go to **Locations**. * Select the required location. * On the **Calling** tab, add the PSTN connection type. .. note:: This is reserved for future development in VOSS. 7. In VOSS: a. Execute a full pull sync to pull location calling settings from Webex Control Hub into VOSS. Location calling settings can now be managed from VOSS. .. image:: /src/images/webex-onboarding-best-practices_html_8c8d138e.png b. Add numbers into the VOSS inventory, and then push those numbers into the Control Hub. .. image:: /src/images/webex-onboarding-best-practices_html_22076b42.png The initial configuration and import of the Webex customer is now complete. Sync Webex data from the Control Hub --------------------------------------- To keep data up to date, use schedules to sync Webex data from the Webex Control Hub: * ``SyncSparkXXXX``: An automatically created data sync (``XXX`` is the customer name). Schedule this sync to run at suitable intervals where it is interleaved with other Webex syncs. * ``SyncSparkUsersXXXX``: A data sync that syncs only users. Recommended where flow through provisioning is used. This user sync may run more frequently than the full sync in order to reduce delays in provisioning or removing users. In the case where numbers are updated frequently outside of VOSS, a data sync to sync only numbers should run more frequently. This will be required not just for adding and deleting numbers, but also to update their usage status if numbers are allocated and de-allocated outside of VOSS. Webex number ownership changes and inventory updates '''''''''''''''''''''''''''''''''''''''''''''''''''''''' When VOSS synchronizes data from the Webex Control Hub, number inventory entries are not only created, but are also **updated** to reflect changes made in Webex. This includes changes to the **owner type** of a number, for example: * A number reassigned from a user to a Hunt Group * A number moved to an Auto Attendant, Call Queue, or Paging Group * A voice messaging or voicemail service being added or removed During sync, VOSS evaluates the Webex number owner type and updates the Internal Number Inventory (INI) accordingly, including recalculating: * **Status** (for example, ``Used`` vs ``Used-Utility``) * **Usage** (for example, ``User``, ``Device``, ``Hunt_Group``, ``Auto_Attendant``) .. rubric:: Utility and service numbers Numbers associated with Webex calling services (such as Hunt Groups, Auto Attendants, Call Queues, or Paging Groups) are intentionally classified as **utility numbers** in VOSS. These numbers are marked with: * Status: ``Used-Utility`` * A service-specific Usage value This distinction ensures service and pilot numbers are not treated as user-assignable numbers and allows accurate reporting and inventory auditing. .. rubric:: Reconciliation of external changes If numbers are assigned, unassigned, or moved between services directly in the Webex Control Hub, VOSS updates the corresponding inventory records during the next sync execution. This behavior applies to both: * New numbers discovered during sync * Existing numbers whose ownership or role has changed Webex Control Hub rate limiting ................................ The Webex Control Hub may rate limit API calls to manage load on the Control Hub. Webex rate limit details are described at https://developer.webex.com/docs/basics . In the event of rate limiting, the Control Hub will respond with a ``429``, and include a ``Retry-After`` header, defines the time that VOSS should wait before retrying the API call. Rate limiting is applied to all customers that were granted access via any one admin account. Therefore, a service provider using a single account to manage multiple customers will have the rate limit applied across all customers.