- Home
- /
- Article
Thanks for your feedback.
In this article
Feedback?This article outlines how the Tenant Data Migration Tool facilitates the transfer of Webex Contact Center Enterprise Administration Portal data between tenants.
Overview
The Tenant Data Migration Tool is useful to copy Webex CCE Portal data from one tenant to another. The following are some potential use cases for consideration:
- Migrate the tenant from one POD to another POD (such as migrating a tenant from HCS US commercial Portal to the Webex CCE Portal).
- Upgrade UCCE for a tenant UCCE and not using the existing upgrade. This allows for the data from the old tenant to transfer to the new tenant configured with the upgraded UCCE.
- Copy the Portal configuration data from the sandbox tenant to the production tenant.
Tenant data migration tool features
You can use the Tenant Data Migration Tool to copy the data from one tenant to another on the same or different Portal POD. The tool is capable of copying the data for the following features:
-
Routing Controls
-
User Defined Access Groups & Collections
-
Collection Objects
-
User Role Group Assignments
-
Audio Groups & Prompts
-
Schedule Skills
Copying data for features
Routing controls
To migrate or copy the Routing Controls data from the source tenant to a target tenant when
executing the tool, make sure the value of the <Migrate Routing Controls
Data> parameter is set to 1. For additional information about the parameters,
see Run tenant data migration tool.
The tool deletes all existing routing controls (all types) in the target tenant before copying the routing controls from the source tenant.
After running the migration script, log into Portal for the target tenant POD and do the following:
If the target tenant is on a POD with Portal version 12.6.0 or lower, the Wildfly service must be restarted on the support server.
If the target tenant is on a POD with Portal version 12.6.1 or above, log into Portal as internal user, and then navigate to the Administration > Support page. Locate the Portal Application Gateway service and click the Reload Cache icon. After the cache reload completes, click on the Reload AG Service icon.
User Defined Access Groups & Collections
To migrate or copy the user defined access groups, collections, and access group assignments
to the user from the source tenant to the target tenant when executing the tool, ensure the
value of the migrate access and collections groups parameter is set to 1. For
additional information about the parameters, see Run tenant data migration tool.
Collection Objects
To migrate or copy the object assignments to the collections.
User Role Group Assignments
To migrate or copy the user assignments to the role groups.
The user defined role groups must be created with the same name used in the source tenant.
Audio Groups & Prompts
To migrate or copy all audio groups, prompts, languages, and prompt versions.
The data migration tool does not copy the audio files. A deployment engineer must copy them manually.
Schedule Skills
To migrate or copy all active skill schedules or attribute schedules.
Access the tenant data migration tool
Prerequisites for running the tenant data migration tool
-
The target tenant POD Portal database server should be accessible from the specific server or location where the script is executed. It is recommended to use the target tenant Portal database server to execute this migration tool.
-
The source tenant Portal database server should be accessible from the target tenant's Portal database server.
Run the connectivity test either using Telnet or from the SQL Server Management Studio. SQLCMD should already be installed to run the migration tool.
Important information to know before running the tenant data migration tool
-
The target tenant should already be created in the target Portal POD.
-
All users from the source tenant should be created within the target tenant.
-
If the target tenant is on a POD with Portal version 12.6.0 or lower, use the Portal Bulk Request feature, found within Administration, to create users in bulk for the target tenant. Connect to the source tenant database server and build SQL scripts to generate the Bulk Request data file. Use the sample script "BulkUser-ReqDataGeneration.sql" which is included with the migration tool.
-
If the target tenant is on a POD with Portal v12.6.1 or above, use Portal Administration > Bulk Request > Import Agents/Supervisors feature to import all agents/supervisors into Portal and to create Portal users for all the agents/supervisors. When finished, create non-contact tenant-level users.
-
Download the tenant data migration tool
-
Connect to sftp.ttec.com
-
Access the HuPortal Releases folder and download the TenantMigrationScripts.zip file.
-
Extract the contents of the TenantMigrationScripts.zip file and check to ensure the TenantMigrationScripts folder is created and it contains the scripts.
Run tenant data migration tool
The copy_tenant_data.cmd script should run directly from the TenantMigrationScripts folder. The logs are created within the TenantMigrationScripts\logs.
-
Open command prompt window and go to the path where the .zip file is extracted.
-
Run the following command with all the parameters mentioned:
copy_tenant_data.cmd <Source Tenant Portal DB Server Name or IP> <Source Tenant Portal DB USER> <Source Tenant Portal DB PASSWORD> <Source Tenant INSTANCEID> <Target Tenant DB Server Name or IP> <Target Tenant DB USER> <Target Tenant DB PASSWORD> <Target Tenant INSTANCEID> <Migrate Routing Controls Data> <Migrate Access Groups And Collections> <Migrate User Role Group Assignments> <Migrate Schedule Skills Data> <Migrate Audio Manager Data> <Migrate Collection Objects Data>Real Example:
copy_tenant_data.cmd 8.33.237.192\ICPORTAL icaproduser IcaPr0dUser@! S01 8.33.237.193\ICPORTAL icaqauser IcaQ@User@! MT1 0 1 0 0 1 1Replace each parameter with a 1 to enable the script to migrate the data from the source tenant to the target tenant. Replace the parameter with a 0 to prevent the data from migrating from the source tenant to the target tenant.
Refer to the following parameter descriptions when you configure the command parameters:
Source Tenant INSTANCEID - Program prefix of the source tenant which is only 3 characters.
Target Tenant INSTANCEID - Program prefix of the target tenant which is only 3 characters.
Migrate Routing Controls Data - If 1 is entered for this parameter, Routing Control data is migrated from the source tenant to the target tenant, replacing all Routing Control data on the target tenant.
Migrate Access Groups And Collections - If 1 is entered for this parameter, Access Groups and Collections data is migrated from the source tenant to the target tenant, replacing all Access Groups and Collections data on the target tenant.
Migrate User Role Group Assignments - If 1 is entered for this parameter, Role Group data is migrated from the source tenant to the target tenant, replacing all Role Group data on the target tenant.
Migrate Schedule Skills Data - If 1 is entered for this parameter, Schedule Skills data is migrated from the source tenant to the target tenant, replacing all Schedule Skills data on the target tenant.
Migrate Audio Manager Data - If 1 is entered for this parameter, Audio Manager data is migrated from the source tenant to the target tenant, replacing all Audio Manager data on the target tenant.
Migrate Collection Objects Data -- If 1 is entered for this parameter, Collection Objects data is migrated from the source tenant to the target tenant, replacing all Collection Objects data on the target tenant.
-
After successfully running the script, check the log files created in the TenantMigrationScripts\logs folder.
-
Verify all the data copied properly from source tenant to the target tenant for all features configured for data migration.
