Understanding Personal Contacts

Use Control Hub to migrate your end users' Jabber custom contacts or any third-party custom contact source to Webex personal contacts. Contact migration to cloud is a one time import that enables you to search, look up, call, message, or invite your contacts similar to Jabber.

End users define Webex Personal Contacts in the Webex app.

Jabber Custom Contacts refer to non-directory contacts who are outside of your organization and contacts that are stored in the database of Cisco Unified Communications Manager - IM & Presence Service.

Third-party contacts refer to contacts who're outside your org that may be exported and later imported into Webex.

Prerequisite

Before you start migration of the personal contacts, make sure that you meet the following requirements:

  • Get familiar with Control Hub.

    Webex Control Hub is the management interface for the Webex platform. For more information, see Get Started with Webex Control Hub.

  • Access Control Hub with full administrator privileges.

    With full administrator privileges, you can assign one or more roles to any user in your organization. Ensure to assign a user with administrator privilege so you can migrate the rest of your Jabber custom contacts. For more information, see Assign Organizational Account Roles in Webex Control Hub.

  • Ensure the on-premises applications from where you plan to migrate the personal contacts such as Cisco Unified Communications Manager (Unified CM), Unified CM - IM and Presence Service is at version 11.5 or later to use the Control Hub migration wizard.

  • If you're migrating your end users' Jabber custom contacts, use Bulk Administration to download the end-user file from Cisco Unified Communications Manager (Unified CM) and contacts file from Unified CM - IM and Presence.

    Use the Import/Export menu in the Cisco Unified Communications Manager application, to import the users. See the Export Users Using Unified CM Bulk Administration for detailed information.

  • If importing custom contacts from third-party sources, use the procedure that is described in Import Personal Contacts from Third Party Sources.

  • Ensure that your migration task conforms to a maximum of 500 contacts per user and a maximum of 10,000 contacts in a single file. We recommend listing the same type of contacts in a single file.

Use Bulk Administration in the Unified CM application to export users and later import to Control Hub.

Use this procedure to obtain enduser file from the Cisco Unified Communications Manager IM & Presence Service, if the IM address scheme is User@Default Domain.

  1. Select Bulk Administration > Import/Export > Export to export the enduser list of the migrating users from the current home cluster. The Export Data window displays.

  2. Choose End User under User Data section in the Export Data window.

  3. Choose a filename for the exported list data. In the Job Description field, enter the description that you want to provide for the job. Export Configuration is the default description.

  4. Click Run Immediately or schedule the job to run later. Click Submit.

  5. Monitor the status of the export job. Use the Job Scheduler option in the Bulk Administration main menu to activate the job, if the job is scheduled to run later.


    Do not modify or update the tar file after you export the file from Unified CM application.

Complete these steps to import the users from the Cisco Unified CM application:

1

Download the export file and store it for use later when the user migration is complete. Choose Cisco Unified CM Administration > Bulk Administration > Upload/Download Files.

From the Upload/Download window select the tar file and click on Download Selected.

2

Un-tar the .tar file to any location on your machine using the tar -xvf command. Extract the enduser.csv file to the specified location. See the Configuration and Administration of the IM and Presence Service for detailed information.

Use the Migrate Personal Contacts to Webex card to synchronize user's contacts from on-premise deployment to Webex Control Hub.

1

From the customer view in Webex Control Hub, go to Updates and Migrations.

2

On the Migrate Personal Contacts to Webex card click Get started. The Contact Synchronization page appears.

Use this procedure to import the Contact lists from the on-premises application. You can delete the imported file, any pending migration tasks, or the failure report.

1

To import data, click the Select the type of contacts to import drop-down list and then select the domain address type.

The IM and Presence Server supports the following two IM addressing schemes:

  • Directory URI IM address scheme—Supports multiple domains, alignment with the user's email address, and alignment with Microsoft SIP URI.

  • User@default domain scheme—This is the default IM address scheme when you install the IM and Presence Server.

To know the scheme that is used by the on-premises IM&Presence server, see the IM&Presence server settings. For more details about the addressing scheme, refer to Configure IM Addressing Scheme
2

Depending on the IM addressing schemes selected, drag and drop the contact.csv file or enduser.csv file.

  • For the Directory URI IM address scheme, select UCM IM&P Personal Contacts - Directory URI IM Address Scheme from the drop-down list. Then drag and drop the contact.csv file to import the contact list for the Unified IM&Presence server.

  • For the User@default domain scheme scheme, select UCM IM&P Personal Contacts - User@default domain from the drop-down list. Then drag and drop the enduser.csv that you exported from the Unified CM application and the contact.csv file.


 

Ensure that you import the enduser.csv file first from the .tar file that you exported from Unified CM application.

3

Click See file download details for detailed instructions on importing the file.

The Export Unified CM IM&Presence contact data window displays when importing contacts.csv file. Follow these steps to export and download personal contacts from the IM&Presence server.

Custom Contacts

  1. Log in to the Cisco Unified CM IM and Presence Administration application.

  2. Navigate to Bulk administration > Non-presence Contact List > Export Non-presence Contact List to download the contacts csv file from the IM&Presence server.

Normal Contacts
  1. Log in to Cisco Unified CM IM and Presence Administration application.

  2. Navigate to Bulk administration > Contact List > Export Contact List to download the contacts csv file from the IM&Presence server.


 

This feature does not support migrating of the Active Directory groups from the Cisco IM&Presence server using the CSV file. Also, Webex does not support Active Directory (AD) Groups. You can manually edit the CSV file to add the AD groups. On completion of the migration, these groups appear as personal groups on Webex,

The Export Unified CM user data window displays when importing enduser.csv file. To export and download user data from Unified CM, follow these steps:

  1. Under Bulk Administration select Import/Export, then select Export.

  2. From the list of exported files, select enduser.csv.

  3. Under Job Information, provide a file name and select the time line when you want to run the task. Click Submit.

  4. The file is listed under Upload/Download files in Bulk Administration, when it is ready.

  5. Download the CSV file. Do not modify the file until the migration completes.


 
On implementing the autodeletion policy, the uploaded or stored data that is older than 90 days is deleted.
4

On completing the upload successfully, Control Hub validates the contacts in the csv files.


 

During validation depending on the default scheme, you can see these changes in the Review file.

  • If IM address scheme is User@DefaultDomain—The User email and Contact email is replaced with the MAIL ID or DIRECTORY URI field from the enduser file.

  • For custom contacts—The User email is replaced with MAIL ID or DIRECTORY URI field from the enduser file.

You can see the replaced value under "User Email" or "Contact Email" field in the Review file. Control Hub uses this email address to check, if the user or contact exists in its Common Identity(CI).

The following details appear on the screen:

Identities

Description

Total imported contacts

Total number of contacts that are imported from the Unified CM IM & Presence server using the BAT file.

User Contacts in Webex

Total number of contacts that are associated to the user and are migrated to Webex.

Contacts to be migrated

Total number of contacts ready to be migrated to user's contact list.

Migrated Contacts

Total number of contacts that are successfully migrated to user's contact list.


 
  • You can choose Click to cancel import to cancel the import. If you have uploaded a wrong file or want to update the contact details, you can delete the imported file.

  • If you encounter a warning message after you upload the csv file stating: Found data in extra columns in input csv file, it implies that the record value in the input file is comma-separated. These values are now split and appear as two separate columns in the csv file. You must manually correct this value from the input csv file that you downloaded from the Cisco Unified IM& Presence server. If you do not correct the file and proceed with the validation, then incorrect data may be migrated.

(Optional)

  1. Click more option to View or Delete the imported file.

  2. Check both these options to enable the Delete button. Ensure that you are aware of the consequences of your action. You cannot undo this action.

  • I agree to delete all imported data.

  • I agree to delete all unsynchronized records.

5

On validating the csv file, the Review for sync button is enabled. The Review for sync page allows you to view the list of eligible contacts and the contacts with error.

6

Click Bulk Edit to fix the flagged errors. Click Download XLS file to download the error report. Navigate to the Failure reason column in the report and take the appropriate action to resolve the error and upload the latest file. See Migrated Contacts for detailed information. Click Choose file to upload the file and validate the file again.

7

Once the processing completes, the total number of valid contacts ready to migrate to Webex App displays. Click Migrate Contacts to start the migration.

8

To begin migration, enter a task name and click Confirm and Migrate.

9

A task is created, and you can view the Track Migration progress to know the status of migration. On completion of the task, see the Success KPI under the Track Migration progress, to know the number of contacts that are migrated successfully.

Only valid records are migrated and invalid records are not migrated.

10

Click the down arrow next to Errors in the Track Migration section to download the Summary report.

The newly migrated contacts are now listed in the Webex app.

This feature provides a generic mechanism to import any user's contacts into the Webex personal contact (contact service) database. This is generic in that the source of the contacts may be from on-premises deployments, cloud-competitor contact systems, or even the Webex Calling MT deployments. It opens up the migration scenarios to support any personal contact import case, not just Unified CM.


  • Replace the old contact details with the new details that are provided in the new generic file using the Contact UUID.

  • The tool populates the Contact UUID field. After you migrate a contact has, the corresponding Contact UUID information is available in the Migration Summary.csv file.

  • Don't modify the Contact UUID field in the template file or the Migration Summary.csv file. Also, there should not be duplicate Contact UUIDs in the template file. Hence, don't copy records to create another row in the file.

  • If you want to update any information that is related to a contact, you must add all the details of the contact to the new file in addition to the Contact UUID. Use the Contact UUID from the latest Migration Summary.csv file.

Use the following procedure to import your users' personal contacts that reside in third-party sources.

1

To import data, click the Select the type of contacts to import drop-down list and choose Generic Personal Contacts.

2

Click Download sample template.

3

After you fill the template file with data for all the personal contacts, drag and drop it on the Import personal contacts section. Alternatively, click browse for files and navigate to the folder location where the filled sample template file exists and upload it.


 
  • The supported formats for the Photo Type field are JPEG, PNG, BMP, and GIF.

  • The Photo Encoding scheme must be Base64 so that the data gets processed.

  • The following fields in the template file are mandatory:

    • User Email

    • Display Name

    • Contact Email or Phone Number

      —Either one of these fields must be filled.

    If any of the mandatory fields in the template is not filled, the record corresponding to that personal contact is marked invalid during the validation process.

4

After the upload is successful, Control Hub validates the contacts in the CSV file.


 

After the validation process is complete, the label Custom is displayed next to the contacts.

For details about the KPIs, refer to the table in the Import Personal Contacts from On-Premises Application section.

5

Perform steps 5–10 in the Import Personal Contacts from On-Premises Application section.

This page lists the error and warning messages for the selected contacts. It also provides you with the necessary suggestions and solutions to resolve them. Resolve the errors before you proceed. However, you can ignore the warnings.

Note: You can also remove the contacts with errors and proceed.

1

You can view the count of these values:

  • Invalid Contacts

  • Invalid Users

  • Valid Users

  • Contacts that can be migrated.

2

Click Bulk Edit to fix the flagged errors. Click Download XLS file to download the error report. Navigate to the Failure reason column in the report and take the appropriate action to resolve the error and upload the latest file. Click Choose file to upload the file and validate the file again.

3

Click Migrate Contacts.

The migrate contacts progress bar displays and you cannot perform any action until the migration completes.

4

View the status of the migration from the Track Migration Status page. This page displays the count of the successfully migrated contacts and the contacts that failed to migrate.