Synchronize Users against Cisco Webex Control Hub
Imagicle UCX Cloud Suite can import users, HG (native Hunt Group), CQ (native Call Queue), AA (native Auto Attendant), VL (Webex Virtual Line) and WS (Workspace) from Webex Control Hub, thanks to available Cisco Webex (XSI) APIs for this purpose.
Provided Webex APIs allow to import users from multiple Webex Organizations, if required.
Before configuring such import connector, please mind below-listed requirements:
- Imagicle UC Cloud Suite must be in place, with a valid license subscription.
- Imagicle UC Cloud Suite must be authenticated against Imagicle Cloud Services, as described in this article.
- A Full Admin user belonging to Webex customer's organization
Authorization Procedure
Please connect to the Imagicle Onboarding Web Portal for Webex Calling MT and enter customer's data, including above mentioned customer's Full Admin Webex user.
Once customer data has been entered, please proceed to next page and authorize Imagicle to access customer's Webex Org:
Once AUTHORIZE button is hit, you are prompted to login to Webex with same Full Admin account and confirm the authorization, as shown in below screenshot:
Once "Accept" button is clicked, you are redirected to the actual authorization page, showing different buttons for different authorizations. See below:
Please click on the top SEE HOW in the list, to display the procedure to authorize users' synch against Webex Control Hub:
Just open another browser tab and login to Webex Control Hub with same Full Admin account and follow the first three steps highlighted in the procedure and eventually toggle the authorization at step 4. Do not forget to Save it, as below displayed:
Now you can go back to the Imagicle procedure and hit CHECK AUTHORIZATION to make sure the app has been actually authorized. Once confirmed, please hit GO BACK to display once again the authorization page, this time with the relevant authorization button turned to green:
If the procedure hasn't been correctly accomplished or if the Full Admin account is missing some permissions, you might get the following error message: "The authorization check for your organization failed. Please try again and make sure you follow the procedure thoroughly".
You can safely repeat the procedure and eventually click on REAUTHORIZE to solve the issue. See below sample:
Note: Same REAUTHORIZE button can be used to authorize the Imagicle app once the token is expired.
Please note that other apps might be required for Webex Calling Native Call Control and to retrieve presence status from Webex Control Hub. Please consult relevant KB articles.
Once you have authorized all required apps, please click on "COMPLETE REQUEST" to trigger the Imagicle internal process to enable the Webex tokens.
Please inform Imagicle Tech Support about the successful authorization, so the enablement can be accomplished on Imagicle Cloud too. We are going to inform you when you can proceed with below settings.
Enabling Webex Users' Synch from Imagicle Web Portal
Once above token has been issued, you can proceed with actual Webex Cloud users' synch enablement.
Please access to Imagicle UCX Suite web portal as Administrator and go to ADMIN ⇒ User Management ⇒ Synchronize users with an external data source » ⇒ Configure Data Sources >>
Select "Cisco Webex" to get the following three options:
Depending on the Imagicle apps you wish to leverage in your Webex environment, one or multiple options can be selected:
- Cisco Webex Users: For UCX Console, Advanced Queuing, Auto Attendant and Contact Manager usage. This connector just imports Webex users from Control Hub.
- Cisco Webex Virtual Objects: For Call Analytics, Call Recording and Hotel Services. This connector imports Webex Virtual Lines, Hunt Groups, Workspaces, native Queues and Auto Attendants from Control Hub.
- Cisco Webex Fax Workspaces: For Digital Fax. This connector imports fax-related Workspaces associate to Imagicle Customer Managed Devices from Control Hub.
If relevant "STATUS" indicator goes green, then it means Imagicle UCX Cloud Suite can reach Webex Cloud. Otherwise, please check below table for most typical error messages appearing underneath the red STATUS indicator:
|
Issue |
Error message |
|
ClientID/secret wrong configured |
Client ID or Client Secret are misconfigured |
|
Suite not enabled on Imagicle Cloud to users sync |
UC Suite is not enabled in the Imagicle Cloud to synchronize users. Check OAuth2 token enablement. |
|
the Imagicle Cloud is not reachable (on-prem UC Suite only) |
Imagicle Cloud unreachable |
|
Other |
An unexpected error occurred while checking Imagicle Cloud connection |
Proxy Support
If your Imagicle UCX Suite can reach Internet through a proxy, please configure it by following this KB article. Webex import connector supports proxy configuration.
Configuring Synchronization Rules
Please access to Imagicle UCX Suite web portal as Administrator and go to ADMIN ⇒ User Management ⇒ Synchronize users with an external data source » ⇒ Configure Synch Rules >>
Select either one of the three "Cisco Webex" options, as per below screenshot:
The sync service uses the Webex Calling user's email as primary key..
For all other users' fields, they are imported from a fixed Webex field or you can choose from which Webex field to populate them.
Users Synch Rules
See below table including Webex Users specific field mapping:
| UCX Suite Display Name | Mapping criteria | Synched from | Example Value |
| Preferred language |
Only when adding, set this value |
EN, IT, FR, DE, AR, etc. | |
| Password | Only when adding, set this value | P@ssw0rd! | |
| Active Directory username | Import every time from source | username Webex id |
john.smith Max 255 chars |
| Domain | Import every time from source | domain coming from Email field | company.com |
| Single Sign-On (SSO) ID |
|
Webex Mail | john.smith@company.com |
| Conversational AI Username |
|
Webex Mail | john.smith@company.com |
| First Name | Import every time from source | firstname | John |
| Last Name | Import every time from source | lastname |
Smith Max 255 chars |
| User PIN | Only when adding, set this value | 1234 | |
| First extension number* |
|
ESN = location.routingPrefix + webexCalling.extension Phone Number = webexCalling.countryCode + webexCalling.number |
33 + 6623 or +447259856623 |
| First extension number Alias* |
|
Extension = webexCalling.extension Phone Number = webexCalling.countryCode + webexCalling.number ESN = location.routingPrefix + webexCalling.extension Work Phone = workPhone email = Webex Mail |
6623 or +447259856623 or 33 + 6623 or +44984664564 or john.smith@company.com Max 255 chars |
| Enable billing for first extension number |
Only when adding, set this value |
= False = True |
|
| Cdr User Id |
|
commonIdentityId |
Max 255 chars |
| Device name |
|
nativeUserId |
Max 255 chars |
| Preferred Device name |
|
nativeUserId | Max 255 chars |
| PBX Username |
|
nativeUserId |
Max 255 chars |
|
Webex Mail | john.smith@company.com | |
| Department |
|
Organization Name = organization.name Location Name = location.name Department = department |
Sales Max 255 chars |
| Recording Group name |
|
Organization Name = organization.name Location Name = location.name Department = department |
Sales Max 255 chars |
| Cost Center |
|
Organization Name = organization.name Location Name = location.name Department = department |
Sales Max 255 chars |
| Office Location |
|
Organization Name = organization.name Location Name = location.name Department = department |
France Max 255 chars |
| Number of masked digits in Call Analytics | Only when adding, set this value | 3 | |
| Enable billing for voicemail number | Only when adding, set this value |
= False = True |
|
| VoiceMail Number |
|
*55 + ESN (location.routingPrefix + webexCalling.extension) |
*55 + 33 + 6623 |
| VoiceMail Address |
|
Webex Mail | john.smith@company.com |
| Do not keep sent voicemails | Only when adding, set this value |
= False = True |
|
| Home Phone |
|
workPhone | +44984664564 |
| Mobile Business Number |
|
mobilePhone | +44702465646 |
| User address |
|
Default mapping***: {streetAddress}, {postalCode} {locality}, {region} - {country} |
102 Edith Groove,SW1 London, Greater London - United Kingdom |
| Fax Number |
|
faxNumber | +44984664564 |
| Fax Group Username |
|
Fax Number = faxNumber Organization Name = organization.name Location Name = location.name Department = department |
Sales Max 255 chars |
| Fax Company Name |
|
organization.name | ACME Inc. |
| Fax Default Priority (0/1/2) |
|
0, 1, 2 | |
| Enable billing for fax number | Only when adding, set this value |
= False = True |
|
| Fax: enable send | Only when adding, set this value |
= False = True |
|
| Fax: enable receive | Only when adding, set this value |
= False = True |
|
| Enable Fax2Email | Only when adding, set this value |
= False = True |
|
| Fax to email address |
|
Webex Mail | john.smith@company.com |
| Fax2Email attach fax | Only when adding, set this value |
= False = True |
|
| Disable caller lookup on phone | Only when adding, set this value |
= False = True |
|
| Rich Presence SIP URI |
|
Webex Mail | |
| Microsoft URI |
|
Webex Mail | |
| Webex URI |
|
Webex Mail | john.smith@company.com |
| Send email notifications | Only when adding, set this value |
= False = True |
|
| Attach recording file to email notifications | Only when adding, set this value |
= False = True |
|
| Is a room | Only when adding, set this value |
= False = True |
|
| Picture |
|
AvatarURL** | Max 200KBytes size (default) |
* Imagicle supports overlapping extension numbers by selecting to import ESN instead of Extension Number. ESN includes a location prefix + Webex Calling Extension, so Imagicle Advanced Queuing can transfer calls to overlapping operators' internal numbers, without having to leverage +E.164 Phone Numbers.
** AvatarURL points to a server on Webex Cloud, which should be reachable by Imagicle UC Suite to retrieve each picture through a http request. User images can be in the most common formats, e.g. png, jpg, jpeg and bmp.
*** User address mapping can be changed on request. Please contact Imagicle for further details.
User's title attribute (title) is also importable from Webex Control Hub. Please contact Imagicle if you wish to add this information into a custom field.
Virtual Objects Synch Rules
| UCX Suite Display Name | Mapping criteria | Synched from | Example Value |
| Username |
"<acronym of type>_<phonenumber> or <ESN> or <name>" |
the acronym of type is set by identifying the type returned from Imagicle API and it can assume the following values:
After underscore is added:
|
HG_4589921, HG_test, CQ_394914524886 WS_78373977 Max 20 chars |
| Preferred language | Only when adding, set this value | EN, IT, FR, DE, AR, etc. | |
| Password | Only when adding, set this value | ||
| Active Directory username | Import every time from source | username coming from Email field or from Webex id |
john.smith Max 255 chars |
| Domain | Import every time from source | empty | |
| Single Sign-On (SSO) ID |
|
empty | |
| Conversational AI Username |
|
Webex Mail | john.smith@company.com |
| First Name | Import every time from source | empty | |
| Last Name | Import every time from source | name |
Max 255 chars |
| User PIN | Only when adding, set this value | 1234 | |
| First extension number* |
|
ESN = location.routingPrefix + webexCalling.extension Phone Number = webexCalling.countryCode + webexCalling.number |
33 + 6623 or +447259856623 |
| First extension number Alias* |
|
Extension = webexCalling.extension Phone Number = webexCalling.countryCode + webexCalling.number ESN = location.routingPrefix + webexCalling.extension Work Phone = workPhone email = Webex Mail |
6623 or +447259856623 or 33 + 6623 or +44984664564 or john.smith@company.com Max 255 chars |
| Enable billing for first extension number |
Only when adding, set this value |
= False = True |
|
| Cdr User Id |
|
commonIdentityId |
Max 255 chars |
| Device name**** |
|
empty | |
| Preferred Device name |
|
nativeUserId | Max 255 chars |
| PBX Username |
|
nativeUserId |
Max 255 chars |
| Department |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Recording Group name |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Cost Center |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Office Location |
|
Organization Name = organization.name Location Name = location.name |
France Max 255 chars |
| Number of masked digits in Call Analytics | Only when adding, set this value | 3 | |
| Enable billing for voicemail number | Only when adding, set this value |
= False = True |
|
| VoiceMail Number |
|
||
| VoiceMail Address |
|
empty | |
| Do not keep sent voicemails | Only when adding, set this value |
= False = True |
|
| Home Phone |
|
workPhone | +44984664564 |
| Mobile Business Number |
|
mobilePhone | +44702465646 |
| User address |
|
Default mapping***: {streetAddress}, {postalCode} {locality}, {region} - {country} |
102 Edith Groove,SW1 London, Greater London - United Kingdom |
| Fax Number |
|
faxNumber | +44984664564 |
| Fax Group Username |
|
Fax Number = faxNumber Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Fax Company Name |
|
organization.name | ACME Inc. |
| Fax Default Priority (0/1/2) |
|
0, 1, 2 | |
| Enable billing for fax number | Only when adding, set this value |
= False = True |
|
| Fax: enable send | Only when adding, set this value |
= False = True |
|
| Fax: enable receive | Only when adding, set this value |
= False = True |
|
| Enable Fax2Email | Only when adding, set this value |
= False = True |
|
| Fax to email address |
|
Webex Mail | john.smith@company.com |
| Fax2Email attach fax | Only when adding, set this value |
= False = True |
|
| Disable caller lookup on phone | Only when adding, set this value |
= False = True |
|
| Rich Presence SIP URI |
|
Webex Mail | |
| Microsoft URI |
|
Webex Mail | |
| Webex URI |
|
Webex Mail | john.smith@company.com |
| Send email notifications | Only when adding, set this value |
= False = True |
|
| Attach recording file to email notifications | Only when adding, set this value |
= False = True |
|
| Is a room | Only when adding, set this value |
= False = True |
|
| Picture |
|
AvatarURL** | Max 200KBytes size (default) |
* Imagicle supports overlapping extension numbers by selecting to import ESN instead of Extension Number. ESN includes a location prefix + Webex Calling Extension, so Imagicle Advanced Queuing can transfer calls to overlapping operators' internal numbers, without having to leverage +E.164 Phone Numbers.
** AvatarURL points to a server on Webex Cloud, which should be reachable by Imagicle UC Suite to retrieve each picture through a http request. User images can be in the most common formats, e.g. png, jpg, jpeg and bmp.
*** User address mapping can be changed on request. Please contact Imagicle for further details.
**** WS device name can't be imported through Webex XSI APIs, but it can be manually retrieved from Control Hub: Workspace ⇒ Calling ⇒ Call experience ⇒ Call recording ⇒ Show call recording platform information ⇒ External Identifier.
Fax Workspaces Synch Rules
| UCX Suite Display Name | Mapping criteria | Synched from | Example Value |
| Username |
<WSF>_<phonenumber OR ESN OR name> |
WSF is the acronym for Imagicle Fax Workspaces. After underscore is added:
|
WSF_4589921 Max 20 chars |
| Preferred language | Only when adding, set this value | EN, IT, FR, DE, AR, etc. | |
| Password | Only when adding, set this value | ||
| Active Directory username | Import every time from source | username coming from Email field or from Webex id |
john.smith Max 255 chars |
| Domain | Import every time from source | empty | |
| Single Sign-On (SSO) ID |
|
empty | |
| Last Name | Import every time from source | name |
Max 255 chars |
| Cdr User Id |
|
commonIdentityId |
Max 255 chars |
| Device name**** |
|
nativeUserId |
Max 255 chars |
| Preferred Device name |
|
nativeUserId | Max 255 chars |
| PBX Username |
|
nativeUserId |
Max 255 chars |
| Department |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Recording Group name |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Cost Center |
|
Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Office Location |
|
Organization Name = organization.name Location Name = location.name |
France Max 255 chars |
| Home Phone |
|
workPhone | +44984664564 |
| Mobile Business Number |
|
mobilePhone | +44702465646 |
| User address |
|
Default mapping***: {streetAddress}, {postalCode} {locality}, {region} - {country} |
102 Edith Groove,SW1 London, Greater London - United Kingdom |
| Fax Number |
|
phoneNumber or ESN | +44984664564 |
| Fax Group Username |
|
Fax Number = faxNumber Organization Name = organization.name Location Name = location.name |
Sales Max 255 chars |
| Fax Company Name |
|
organization.name | ACME Inc. |
| Fax Default Priority (0/1/2) |
|
0, 1, 2 | |
| Enable billing for fax number | Only when adding, set this value |
= False = True |
|
| Fax: enable send | Only when adding, set this value |
= False = True |
|
| Fax: enable receive | Only when adding, set this value |
= False = True |
|
| Enable Fax2Email | Only when adding, set this value |
= False = True |
|
| Fax to email address |
|
Webex Mail | john.smith@company.com |
| Fax2Email attach fax | Only when adding, set this value |
= False = True |
|
| Send email notifications | Only when adding, set this value |
= False = True |
|
| Attach recording file to email notifications | Only when adding, set this value |
= False = True |
* Imagicle supports overlapping extension numbers by selecting to import ESN instead of Extension Number. ESN includes a location prefix + Webex Calling Extension, so Imagicle Advanced Queuing can transfer calls to overlapping operators' internal numbers, without having to leverage +E.164 Phone Numbers.
** AvatarURL points to a server on Webex Cloud, which should be reachable by Imagicle UC Suite to retrieve each picture through a http request. User images can be in the most common formats, e.g. png, jpg, jpeg and bmp.
*** User address mapping can be changed on request. Please contact Imagicle for further details.
**** WS device name can't be imported through Webex XSI APIs, but it can be manually retrieved from Control Hub: Workspace ⇒ Calling ⇒ Call experience ⇒ Call recording ⇒ Show call recording platform information ⇒ External Identifier.
User's title attribute (title) is also importable from Webex Control Hub. Please contact Imagicle if you wish to add this information into a custom field.
Remarks
- Only users having a phone line assigned on Control Hub will have the extension number populated on the Imagicle suite. Users without a valid line will result in suite users with blank extension number.
- If Webex user's email is changed, at the next synchronization relevant UCX Suite user is removed and another UCX Suite user is created with the new Active directory username and Domain values, losing the old users configurations and data.
- User changes done on Control Hub take 24 hours to reflect into the suite users leveraging the synchronization. Consider this if you are planning a go-live or cutover involving Imagicle services.
- Imagicle supports the audio recording of Webex Workspaces too. They are not automatically provisioned from Control Hub, therefore they must be manually added, as described here.
|
||
| This article was: |
| Prev | Next | |
| Synchronize Users against Azure AD Source | Single Sign On |