[Index]

Model: relation/SparkCustomer

Customer Access

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

This procedure adds a Webex Teams service.

Webex Teams Feature Reference

Prequisites:

To allow VOSS-4-UC to connect to the Webex Teams Cloud API, obtain the following from the Cisco Webex page:

• a Webex Teams Organization Account Number
• an Access and Refresh token

Perform these steps:

1. Log in to the Admin GUI as a provider or reseller administrator.

2. Select the hierarchy path to the correct customer node.

3. Select Services > Webex Teams > Access Token to display Webex Teams Account.

   The form opens on a separate tab, at the following URL: https://us-central1-webex-teams-auth-token.cloudfunctions.net/webex_teams_oauth

4. Click the GET TOKENS link.

5. In the Email address field on the Cisco Webex page, enter a valid email address; then, click Next.

   An email address and password are only required the first time you log in to the Cisco Webex site.

6. In the Password field on the Cisco Webex page, enter a valid password; then, click Sign In.

7. View the codes/tokens generated and displayed on the form:

   • Organization ID

   • Access Token (14 days)

   • Refresh Access Token (90 days)

     Note

     • VOSS-4-UC automatically refreshes the access tokens every 7 days. To manually refresh the access tokens, click GET TOKENS on the Webex Teams Account form or Action > Refresh Access Token on the Customer Access form.
     • The Refresh Token is valid for 90 days. The number of valid days remaining for the access token is displayed in the Refresh Token Expires in counter on the Webex Teams Access Token Management for VOSS4UC page.
     • See https://developer.webex.com/docs/integrations for more details on access token management.

8. Click on each Copy button in turn to copy the item, return to the VOSS-4-UC tab, and paste in the appropriate field on the Customer Access form. Note that the access tokens must also be pasted into the 'Repeat' fields.

9. Fill out, at minimum, the other mandatory fields on the Customer Access form under Account Details:

   Field	Description
   Webex Teams Customer Name	Populated automatically, using the customer name.
   Default Calling Behaviour	Can be applied to synced in users, if also set in Global Settings (Automatically apply default calling behaviour on Webex Teams user data sync)
   Use Organization's Domain	Can be enabled if you select option Calling in Webex Teams (Unified CM) (same as Webex Teams Control Hub behavior) When selected, you may also enable Default UC Manager Profile
   Email Domain for Hybrid Calling in Workspaces	When hybrid calling is enabled for a workspace, a dummy subscriber email domain can be added.
   Subscription ID	Fill out the subscription ID (as seen on the Control Hub portal) to selectively manage multiple subscriptions in multiple sites. If required, fill out the newly managed subscription ID here.
   Site URL	The site URL for Webex Enterprise Edition meeting services. When syncing licenses and subscriptions, VOSS-4-UC only syncs in subscriptions matching the ID and services from the site. See also Webex Teams Licenses
   Enterprise Content Management Enabled and	These settings match the configuration setting on the
   Jabber Team Messaging Mode Enabled	user feature of the Webex Teams Control Hub, and apply to the corresponding Default Calling Behaviour selection: Calling in Webex Teams (Unified CM) and Cisco Jabber app. Note that with these calling behaviour options, Quick Add Group Templates for Jabber devices under the Webex Teams group are applied. See Quick Add Subscriber Group Default Model
   UC Manager Profiles	Added for use when managing users.
   HTTP Proxy String	Required only if a proxy server is required to connect to the Webex Teams cloud, for example: http://[ip address]:port
   HTTPS Proxy String	Required only if a proxy server is required to connect to the Webex Teams cloud, for example: https://[ip address]:port

10. Click Save. The Webex Teams Service is added.

11. Sync the Webex Teams Users for the customer. To do this, click Action > Sync Webex Teams Users on the Customer Access form.

    Note

    Webex Teams Users can also be synced from Administration Tools > Data Sync, and then running the SyncSpark[Customer] data.

Workflow Animation

The animation demonstrates how to create a Webex Teams service.

Customer Access

Webex Teams Feature Reference

Before You Begin

For VOSS-4-UC to connect to the Webex Teams Cloud API you need:

• a Webex Teams Organization Account Number
• an Access and Refresh token

Both are obtained from the Cisco Webex page.

Procedure

See procedure below for clarity if required:

1. Log in as provider or reseller administrator.

2. Make sure that the hierarchy path is set to the correct customer node.

3. Choose Services > Webex Teams > Access Token to open the Webex Teams Account form on a separate tab, i.e it opens the following URL:

   https://us-central1-webex-teams-auth-token.cloudfunctions.net/webex_teams_oauth

4. Click the GET TOKENS link.

5. Enter a valid Email address in the Email address field on the Cisco Webex page and click Next. An Email address and password are only required the first time you login to the Cisco Webex site.

6. Enter a valid password in the Password field on the Cisco Webex page, and click Sign In. The following codes/tokens are generated and displayed on the form:

   • Organization ID
   • Access Token (14 days)
   • Refresh Access Token (90 days)

   Note

   • VOSS-4-UC automatically refreshes the access tokens every 7 days. To manually refresh the access tokens, click GET TOKENS on the Webex Teams Account form or Action > Refresh Access Token on the Customer Access form.
   • The Refresh Token is valid for 90 days. The number of valid days remaining for the access token is displayed in the Refresh Token Expires in counter on the Webex Teams Access Token Management for VOSS4UC page.
   • Refer to https://developer.webex.com/docs/integrations for more details on access token management.

7. Click on each Copy button in turn to copy the item, return to the VOSS-4-UC tab, and paste in the appropriate field on the Customer Access form. Note that the access tokens must also be pasted into the 'Repeat' fields.

8. Complete at minimum the other mandatory fields on the Customer Access form:

   • The Webex Teams Customer Name field is populated automatically using the Customer Name.
   • Enter the HTTP Proxy String. Only if a proxy server is required to connect to the Webex Teams cloud, e.g. http://[ip address]:port.
   • Enter the HTTPS Proxy String. Only if a proxy server is required to connect to the Webex Teams cloud, e.g. https://[ip address]:port.

9. Click Save to add the Webex Teams Service.

What to Do Next

Sync the Webex Teams Users for the customer by clicking Action > Sync Webex Teams Users on the Customer Access form.

Webex Teams Users can also be synced from Administration Tools > Data Sync, and then running the SyncSpark[Customer] data.

Customer Access

Full HTML Help

This procedure adds the Cisco Webex service (Webex Control Hub instance).

Prerequisites:

• A Network Device List (NDL) must be configured for any customer that has the Webex Service created.

See the Network Device Lists (NDLs) topic in the Core Feature Guide.

• To allow VOSS Automate to connect to the Cisco Webex Control Hub, obtain the following from the Cisco Webex page:
  • The Webex Control Hub Account Organization ID

To create the Cisco Webex service:

1. Log in to the Admin GUI as a provider or reseller administrator.

2. Select the hierarchy path to the correct customer node.

3. Select Apps Management > Webex Control Hub Access to display the list view of all the configured Webex Organizations.

   Note

   Existing accounts added before Automate 21.4-PB3 will show the internal account ID as the Organization Account Number, while accounts added from Automate 21.4-PB3 onwards, show the external account ID.

   Click Add (+).

4. Enter the Webex App Customer Name. The default is the Automate Customer name.

5. Enter your Webex Control Hub Account Organization ID (external account ID) in the Organization Account Number field. This can be obtained from the Webex Control Hub admin portal under the Account menu.

6. Enter the Admin Account Email to specify the administrator managing the account. This is an informational field only.

7. The HTTP Proxy String and HTTPS Proxy String fields are required only if a proxy server is required to connect to the Cisco Webex Control Hub API, for example: http://[ip address]:port or https://[ip address]:port.

8. Note: The Webex organization account details need to be added to Automate first, before Access Tokens can be obtained.

9. Click Save.

   Note

   When adding a new Webex Control Hub Access entry for a customer, data syncs and schedules are automatically created. Deleting a customer's Webex Control Hub Access automatically deletes these data syncs and schedules.

10. After saving the new Webex organization and returning to the created account, the Access Tokens section contains a Connect to Webex Control Hub link that is used to request the tokens.

    Click the Connect to Webex Control Hub link to obtain the access tokens for the Webex Control Hub account. When the link is first used, a Webex admin user, with sufficient privileges, is required to login and accept the API authorization scope needed by Automate for integration.

    This action then redirects you to the Transactions page in VOSS Automate, where the progress for the retrieval of the access tokens can be monitored.

    Note

    The sync of roles and licenses into VOSS Automate are also part of this transaction.

11. After the transaction completes successfully, the Access Tokens section shows Access Token Expires At and Refresh Token Expires At expiry times.

    Note

    • VOSS Automate automatically refreshes the access tokens every 7 days for 90 days, in other words, until the expiry of the Refresh Token.
    • The Refresh Token is valid for 90 days. The Connect to Webex Control Hub link can be used to refresh it. VOSS Automate General Settings contain options for the Webex App Tab to send impending expiry notifications and messages. See: Global Settings.
    • See https://developer.webex.com/docs/integrations for more details on access token management.

Related Topics

• Quick Add Subscriber Group Default Model
• Webex App Licenses

This relation implements the workflows to manage Spark Customer connection parameters and enabled services.

Model Details: relation/SparkCustomer