Configure Your BroadWorks Clusters

[once per cluster]

This is done for the following reasons:

• To enable Webex cloud to authenticate your users against BroadWorks (via XSP|ADP-hosted authentication service).

• To enable Webex apps to use Xsi interface for call control.

• To enable Webex to listen for CTI events published by BroadWorks (telephony presence and call history).

What you need to do:

1. Sign in to Partner Hub (admin.webex.com) with your partner administrator credentials.

2. Open Services page from the side menu, and find Additional links card.

   If the admin user does not have visibility of the Additional links card, it is recommended that you must open a case with Cisco TAC.

3. Click Add Cluster.

   This launches a wizard where you supply your XSP|ADP interfaces (URLs). You can add a port to the interface URL if you are using a non-standard port.

4. Name this cluster and click Next.

   The cluster concept here is simply a collection of interfaces, typically collocated on an XSP|ADP server or farm, that enable Webex to read information from your Application Server (AS). You may have one XSP|ADP per AS cluster, or multiple XSP|ADPs per cluster, or multiple AS clusters per XSP|ADP. Scale requirements for your BroadWorks system are out of scope here.

5. (Optional) Enter a BroadWorks user Account Name and Password that you know is within the BroadWorks system you are connecting to Webex, then click Next.

   The validation tests can use this account to validate the connections to the interfaces in the cluster.

6. Add your XSI Actions and XSI Events URLs.

7. Optional. Update the DAS URL with the URL of the Device Activation Service.

8. Optional. Check the Enable direct BroadWorks authentication check box if you want logins to BroadWorks to be direct to BroadWorks. Otherwise, authentication to BroadWorks is proxied through the Webex-hosted IdP proxy service.

   This check box affects these login situations:

   • User Activation Portal login—Users must enter their BroadWorks credentials when logging in to the portal. The above setting determines if the login is direct to BroadWorks or is through the IdP Proxy.

   • Client Login—If BroadWorks Authentication is configured in the Onboarding template, the above setting determines if client login to the Webex App is direct to BroadWorks or is proxied through the IdP Proxy.

9. Click Next.

10. On the CTI Interface page, do the following:

    1. Add the CTI URL and Port for the CTI interface to which you want to connect.

    2. Optional. Enable the Call History toggle and then enter your BroadWorks user ID. When this option is selected, BroadWorks call history events get synced to the Webex cloud. Users can view their call history on the Webex App.

    3. Optional. Enable the Do not disturb (DND) sync toggle and then enter your BroadWorks user ID. This option syncs DND events between Webex and BroadWorks, ensuring that the feature works the same on both platforms.

    4. Optional. Enable the Personal Assistant Status Sync toggle and then enter your BroadWorks user ID. This option synchronizes the personal assistant presence status between the BroadWorks Calling devices and the Webex App.

    5. Click Next.

11. Add your Authentication Service URL.

12. Select Auth Service with CI token validation.

    This option does not require mTLS to protect the connection from Webex, because the Authentication Service properly validates the user token against the Webex identity service before it issues the long-lived token to the user.

13. Review your entries on the final screen, and then click Create. You should see a success message.

    Partner Hub passes the URLs to various Webex microservices that test the connections to the supplied interfaces.

14. Click View Clusters and you should see your new cluster, and whether the validation succeeded.

15. The Create button may be disabled on the final (preview) screen of the wizard. If you cannot save the template, it indicates a problem with one of the integrations you just configured.

    We implemented this check to prevent errors in subsequent tasks. You can go back through the wizard as you configure your deployment, which may require modifications to your infrastructure (e.g. XSP|ADP, load balancer, or firewall) as documented in this guide, before you can save the template.

Checking the Connections to Your BroadWorks Interfaces

1. Sign in to Partner Hub (admin.webex.com) with your partner administrator credentials.

2. Open Services page from the side menu, and find BroadWorks Calling card.

3. Click View Broadworks Calling.

4. Partner Hub initiates connectivity tests from the various microservices towards the interfaces in the clusters.

   After the tests complete, the cluster list page shows status message next to each cluster.

   You should see green Success messages. If you see a red Error message, click the affected cluster name to see which setting is causing the problem.

5. Optional. Select a cluster if you want to see existing settings for that cluster, such as XSI-Actions, XSI-Events, DAS URL and the CTI interface settings.

Configure your Onboarding templates

Onboarding templates are the way that you will apply shared configuration to one or more customers as you onboard them via the provisioning methods. You must associate each template with a cluster (that you created in previous section).

You can create as many templates as you need, but only one template can be associated with a customer.

1. Sign in to the Partner Hub and select Customers.

2. Click the Onboarding templates button to view the existing templates.

3. Click Create Template.

4. In the Template Details window, add the Template name, Country or Region and Default email Language.

5. Click the drop-down for the CCW Subscription ID, find the listed subscriptions for the partner, and select the applicable subscription.

   This field is shown only for partners migrated from Webex for BroadWorks to Webex.

6. In the Service Setting window, use the Cluster dropdown to choose the cluster you want to use with this template.

7. Enter a Template Name, then click Next.

8. Configure your provisioning mode, using these recommended settings:

   Table 1. Recommended Provisioning Settings for Different Provisioning Modes

   Setting Name	Flowthrough provisioning with trusted emails	Flowthrough provisioning without emails	User self-provisioning
   Enable BroadWorks Flow Through Provisioning (include provisioning account credentials if On**)	On Supply the provisioning Account Name and Password as per BroadWorks configuration.	On Supply the provisioning Account Name and Password as per BroadWorks configuration.	Off
   Automatically Create New Organizations in Control Hub	On†	On†	On†
   Service Provider Email Address	Select an email address from the dropdown (you can type some characters, to find the address if it's a long list). This email address identifies the administrator within your Partner organization who will be granted delegated admin access to any new customer organizations created with the Onboarding template.
   Country	Choose which country you use for this template. The country you choose matches customer organizations that are created with this template to a particular region. At present, the region could be (EMEAR) or (North America and rest of world). See the country to region mappings in this spreadsheet. The organization country will determine the default global call-in numbers for Cisco PSTN in Webex Meeting Sites. Refer to the Country section of help page for more information.
   BroadWorks Enterprise Mode Active	Enable this if the customers you provision with this template are enterprises in BroadWorks. If they are groups, leave this switch off. If you have a mix of enterprises and groups in your BroadWorks, you should create different templates for those different cases.

   Notes from the table:

   • † This switch ensures that a new customer organization is created if a subscriber’s email domain does not match an existing Webex organization.

     This should always be on, unless you are using a manual ordering and fulfilment process (via Cisco Commerce Workspace) to create customer organizations in Webex (before you start provisioning users in those organizations). That option is often referred to as the "Hybrid Provisioning" model, and is out of the scope of this document.

   • ** "Provisioning account" refers to the BroadWorks system-level admin account. On BroadWorks, you need an admin account with these attributes: Administrator Type=Provisioning, Read-only=Off.

9. Select the default services package for customers using this template (see Packages in the Overview section); either Basic, Standard, Premium or Softphone.

   You can override this setting for individual users via Partner Hub.

10. Optional. Check Disable Cisco Webex Free Calling if you want to disable Webex Calls,.

11. For Meeting Join Configuration, select one of the following options:

    • Cisco Call-in Numbers (PSTN)

    • Partner-provided Call-in Numbers (BYoPSTN)—If you select this option, refer the Bring Your Own PSTN Solution Guide for Webex for Cisco BroadWorks for detailed information on how to configure this option.

12. Click Next.

13. There are two approaches for provisioning subscribers with regards to how their identities are verified – using Trusted Emails or Untrusted Emails.

    In the Trusted Email workflow users provide email addresses to the partner who adds them in BroadWorks. You as a partner are responsible for provisioning the email address as part of either the flow-through or API method.

    It is highly recommended to use the Trusted provisioning method because it ensures that all subscribers are fully provisioned by you as a partner and there is no action required from the end users.

    In the Untrusted email case users need to verify their emails before provisioning, or users can self-activate themselves.

    In the Untrusted case there are several provisioning modes based on the verification settings in the table below:

    Table 2. Recommended User Verification Settings for Untrusted Provisioning Modes

    Setting Name	Flowthrough provisioning without emails	User self-provisioning
    Provision Admin First	Recommended*	Not applicable
    Allow users to self activate	Not applicable	Required

    • Notes from the table:

    • * Each customer organization in Webex is required to have at least one user with administrator role. The first user to whom you assign Integrated IM&P in BroadWorks takes the customer administrator role if a new customer organization is created in Webex. As a Service Provider you may want to have control over who gets the role. Checking this setting blocks users from completing activation until the first user you provisioned is activated. If you uncheck this setting, then the first user to become active in the new organization becomes the customer administrator.

14. Click Next.

15. Select the default authentication mode (either BroadWorks Authentication or Webex Authentication) for user login to Webex.

    This setting has no effect on user login to the User Activation Portal. Users must use their BroadWorks user ID and password when logging in to the portal, irrespective of how the Onboarding template is configured.

    This setting will be applied to newly created customer organizations only. If partner administrators try to apply a new authentication setting to existing customer organizations, the existing settings apply so that existing users don't lose access. To change the authentication mode for existing customer organizations, you must open a ticket with Cisco TAC.

    (See Authentication Mode in the Prepare your Environment section).

16. Click Next.

17. For Preferences, configure the following:

    1. Choose whether you want to Prefill user email addresses in login page.

       You should only use this option if you selected BroadWorks Authentication and have also have put the users’ email addresses in the Alternate ID attribute in BroadWorks. Otherwise, they will need to use their BroadWorks username. The login page gives an option to change user, if necessary, but this may lead to login issues.

    2. If you want to enable directory sync, set the Enable phone directory sync for all new customer organizations toggle to On.

       This option enables Webex to read BroadWorks contacts into the customer organization, so that users can find and call them from the Webex app.

    3. Enter a Partner Admin.

       This name is used in the automated email message from Webex, that invites users to validate their email addresses.

    4. Make sure the Allow admin-invite emails when attaching to existing orgs toggle is On (the default setting is On).

    5. Click Next.

18. Review your entries on the final screen. You can click the navigation controls at the top of the wizard to go back and change any details. Click Create.

    You should see a success message.

19. Click View Templates and you should see your new template listed with any other templates.

20. Click the template name to modify or delete the template, if necessary.

    You do not need to re-enter the provisioning account details. The empty password/password confirm fields are there to change the credentials if you need to, but leave them empty to keep the values you gave to the wizard.

21. Add more templates if you have different shared configurations you want to provide to customers.

    Keep the View Templates page open, as you may need template details for a following task.