Migration tools to transition from BroadWorks, Webex for BroadWorks, and BroadCloud to Wholesale RTM solutions

Supported phones will be automatically created and assigned to users in Webex Calling by the provisioning tool. The phones marked “yes” in the column “Supported in the device move tool” will also be automatically moved from Cisco BroadWorks or BroadCloud to Webex Calling when the device move tool is run. Phones marked “No” in that column need a manual intervention to change the DMS URL in the Cisco BroadWorks device template or in the phone itself.

The last column provides the mapping of phone models to the “Device type” column of the file transform-tool/input/newphones.csv. (See Transform tool section of this article for more information on newphones.csv).

Partner administrators run this token generator utility tool at least one time before starting to run migration tools. Running this tool is a one-time activity after the partner account gets onboarded into the Wholesale RTM solution. This tool allows partner administrators to log in via web browser to get the unique TOKEN that is needed to update to the partner configuration files for the migration tools.

Prerequisites

After downloading, extract the migration tool binaries.

Set the JRE/JDK environment path in the token_generator.sh for MAC and token_generator.bat for Windows. If JAVA_HOME path already exists, it will be reused by the tool.

• MAC: JAVA_HOME="/Users/cisco/jdk/zulu@1.8.282/Contents/Home/"

• Windows: JAVA_HOME=C:\Progra~1\Java\jre1.8.0_321

Instructions to run

Run the following command in the terminal inside the token generator directory:

Windows:

token_generator.bat

MacOS:

./token_generator.sh

Output:

Tool Name: Token Generator Tool
Version: 1.13.0
Load the URL in your web browser: http://localhost:8080

Open the URL in the web browser on the terminal, login with the partner administrator credentials to get the TOKEN and copy the same for further usage.

The user interface illustrations are given below for reference:

Figure 3: Login with Cisco Webex

Figure 4: Credentials window

Figure 5: Token generation

Configure the following steps, before running the extract and device move tools in the secondary BroadWorks server.

Enable OCI-P connectivity

The device move tool communicates with the BroadWorks through OCI-P commands, to enable OCI-P connectivity use the steps below:

Step 1: Use the CLI to configure General Settings.

Run the following command in CLI to change to the GeneralSettings directory:

AS_CLI> cd /Applications/OpenClientServer/GeneralSettings.

Run the following command in CLI to get the current GeneralSettings:

AS_CLI/Applications/OpenClientServer/GeneralSettings> get
clientPort = 2208
clientPortEnabled = true
secureClientPort = 2209
secureClientPortEnabled = true
systemDomain = <>

If your settings do not match the above, use the set command to reconfigure your settings.

Step 2: Use the CLI to configure the OCI Proxy.

Change the directory to OCI Proxy:

AS_CLI> cd /Applications/OpenClientServer/OCIProxy

Run the following CLI to get current settings. You should see the following:

AS_CLI/Applications/OpenClientServer/OCIProxy> get
enabled = true
enabledLoginLevelScreening = false
enableResponseCaching = false
responseCacheDurationHours = 24
responseCacheRenewPeriodMins = 30
messageQueueCapacity = 50
messageQueueTimeoutSeconds = 1800

If your settings do not match the above, use the set command to reconfigure your settings.

Step 3: Use the CLI to configure OCI Provisioning.

Change to the Provisioning directory:

AS_CLI> cd /System/NetworkAccessLists/OCI/Provisioning

Run the following command to get the current OCI Provisioning settings:

AS_CLI/System/NetworkAccessLists/OCI/Provisioning> get
Address Description
========================
127.0.0.1 local as

Step 4: Run the command below in CLI to verify that your configuration is correct.

 AS_CLI/Maintenance/ManagedObjects> get broadworks and check
that your output looks OK.
See below for sample output:
AS_CLI/Maintenance/ManagedObjects> get broadworks
BroadWorks Managed Objects
==========================
* Server:
Identity..............: AS
Version...............: Rel_21.sp1_1.551
Administrative State..: Unlocked
* Applications:
Name Version Deployed Administrative State Effective State
=========================================================================================
ExecutionAndProvisioning 21.sp1_1.551 true Unlocked Unlocked
FlashPolicy 21.sp1_1.551 false Unlocked Stopped
OpenClientServer 21.sp1_1.551 true Unlocked Unlocked
WebContainer 21.sp1_1.551 true Unlocked Unlocked
4 entries found.
* Hosted Applications:
Name Version Context Path Deployed
==================================================================
CommPilot 21.sp1_1.551 / true
DeviceManagementFiles 21.sp1_1.551 /DeviceManagement true
JWSFiles 21.sp1_1.551 /FileRepos true
MediaFiles 21.sp1_1.551 /media true
OCIFiles 21.sp1_1.551 /ocifiles true
5 entries found.

Verify open client server deployed and active

Use the commands below to deploy and start the Open Client Server on the secondary Application Server if it is not deployed or have not started already.

Step 1: Deploy the server with the following CLI command:

AS_CLI/Maintenance/ManagedObjects> deploy application OpenClientServer

Step 2: Start the server with this command:

AS_CLI/Maintenance/ManagedObjects> start application OpenClientServer

Enable numbers activation

Execute the following commands in CLI to enable the activation of the numbers:

Step 1: Run the number activiation command:

AS_CLI> cd SubscriberMgmt/NumberActivation

Step 2: Run the activation enabled command:

AS_CLI> set dnMode groupAndUserActivationEnabled

Step 3: At the confirmation prompt, enter Y.

For BroadCloud

The extract tool is integrated in the BroadCloud Service Provider portal. A service provider admin can:

1. Submit extract requests for up to 50 customers per request.
   Extract request can't be submitted for the same customer more than 10 times in a day.
2. Download the extracted data file, in ZIP format, for up to 28 days from request submission date.

The figures below show the Service Provider portal.

Figure 6: Service Provider portal

Figure 7: Service Provider portal

For Cisco BroadWorks and Webex for BroadWorks

1. The extract tool runs on the secondary Cisco BroadWorks Application Server within the partner network and connects via OCI-P.
2. The tool pulls raw enterprise, group, numbers, users, services, devices, and soft client's data from the Cisco BroadWorks or BroadCloud platform and outputs this data to XML files that provide the inputs for the transform tool.

The next sections explain how to install and configure the extract tool.

Prerequisites

1. SCP the extract tool binaries to secondary Cisco BroadWorks Application Server.
2. SSH to the secondary Cisco BroadWorks Application Server to configure the prerequisites and run the extract tool.
3. Configure the Service Provider and Group ID to extract from Cisco BroadWorks in the conf/exportTool.yml. Refer to the below sample YAML snippet:

   ServiceProviderID-A:
        - GroupID-A1
        - GroupID-A2
        - GroupID-A3
   ServiceProviderID-B:
                          - ALL
   

4. Ensure the secondary Cisco BroadWorks Application Server User ID, Password, and Host Name are correct in the conf/partner.cfg file:

   BROADWORKS_USER_ID = admin
   BROADWORKS_PASSWORD = admin
   BROADWORKS_HOST_NAME = localhost
   REFRESH_TOKEN = Partner administrator’s refresh token copied from the Token Generator tool.
   MIGRATION_MODE = Supported values are webex_for_broadworks_to_wholesale. The default value is broadworks_to_wholesale. Use webex_for_broadworks_to_wholesale for Webex for BroadWorks migrations.
   

   The REFRESH_TOKEN property is mandatory for a Webex for BroadWorks migration.

5. Modify the JDK/JRE environment path in the export.sh file if the secondary Cisco BroadWorks Application Server JDK/JRE environment path is different than the file:

   JAVA_HOME=/usr/local/java/java_base

Instructions to run

Run the command below in the secondary Cisco BroadWorks Application Server from the extract tool directory:

./export.sh

Terminal logs

The following logs are available in the terminal on successful export: Running BroadSoft Data Export Tool:

 Running BroadSoft Data Export Tool
************************************************
Starting Export Tool v: 1.15.0
Export started for SP=collabmigrationtestSP_engg, Group=collabmigrationtestGRP_engg
Exporting users for SP=collabmigrationtestSP_engg, Group=collabmigrationtestGRP_engg
Export users completed for SP=collabmigrationtestSP_engg, Group=collabmigrationtestGRP_engg
Export completed for SP=collabmigrationtestSP_engg, Group=collabmigrationtestGRP_engg
Export completed
Export Dump Zip Directory : output/20221017223452_ExportTool
Export Dump Zip File name :extracted_data_1666060500618.zip
Zip file with the name extracted_data_1666060500618.zip has been created
ZIP file creation process completed 
Exported files converted as ZIP file
**************************************************

Output

An output ZIP (extracted_data_<timestamp>.zip) file will be available in the same extract tool directory. Use the command below to view and use the ZIP file for the Transform Tool input:

ls –ltr
drwxr-xr-x 2 bwadmin bwadmin   4096 Oct  4 11:53 lib/
-rwxr-xr-x 1 bwadmin bwadmin 956719 Oct  4 11:53 exportTool.jar
-rwxr-xr-x 1 bwadmin bwadmin   2635 Oct  4 11:53 export.sh
drwxr-xr-x 2 bwadmin bwadmin   4096 Oct  5 05:04 conf/
drwxrwxr-x 3 bwadmin bwadmin   4096 Oct 17 22:34 output/
drwxrwxr-x 2 bwadmin bwadmin   4096 Oct 17 22:34 logs/
-rw-rw-r-- 1 bwadmin bwadmin  46341 Oct 17 22:35 extracted_data_1666060500618.zip

This transform tool is run for all migrations. The transform tool runs on any computer, including a partner's administrator laptop, and uses the Webex Public APIs. It reads the extract tool output ZIP (extracted_data_<timestamp>.zip) file as an input and transforms the raw XML into a JSON format that is used by the provisioning tool.

Prerequisites

After downloading and extracting the migration tools binaries, configure the following prerequisites:

1. Set the REFRESH_TOKEN (Token copied from the Token Generator Tool) and NAME_OF_MAIN_LOCATION in the conf/partner.cfg file:

   REFRESH_TOKEN=MzUwYjljODEtYmQ4MS00NGVhLTgwNGUtZjQ1NTEyZTViNzJkOTdj
   NAME_OF_MAIN_LOCATION=Main
   

2. Optionally set the PROVISIONING_ID (copied from the template in Partner Hub) in the conf/partner.cfg file:

   PROVISIONING_ID=YmE4MjFkZGYtYTlkNy00NDdlLWIwODctYmNkOTM2NjUyYWQ1

   To get more complete verification of the customer email address you can optionally set the PROVISIONING_ID.
3. Configure missing information in the input/customers.csv file (see next section) if missing.
4. Add the end user email address in the input/users.csv file.
5. If new phones are to be provisioned, add the mac address and email address of the user’s new phone to input/newphones.csv file. This is required only if the partner administrators want to provision new phones in Wholesale calling.
6. Convert the BroadWorks Call Centers into the CxEssentials by using the input/cxessentials.csv file.
7. Optionally, enable the UPGRADE_ALL_CALL_CENTERS_TO_CX_ESSENTIALS property to convert all Call Centers to CxEssentials.
8. Use the input/locations.csv file to support the large enterprise migration that allows administrators to migrate their customer’s locations by location
9. Optionally enable usage of MAC addresses from the User-Agent header of the SIP REGISTER message when the MAC address is not available in the Cisco BroadWorks device profile. Uncomment the line "USE_MAC_ADDRESS_FROM_SIP_REGISTER=yes" in file conf/partner.cfg

Filling-up the input/customers.csv

The file input/customers.csv provides data that maybe missing in Cisco BroadWorks or BroadCloud. This file can be left empty if all mandatory information is already available. You don’t have to fill in all columns, only the missing information is mandatory.

The table below explains the most important columns in input/customers.csv.

Instructions to run

Run the Transform Tool in any operating system. Use the below steps to run the tool in Windows and macOS:

Windows

Execute the command below to run the Transform Tool in Windows:

transform.bat -extract=<Extract-Tool-Output-Zip-file> -customers=<Input-Path-Customers-CSV> -users=<Input-Path-Users-CSV> -newphones=<Input-Path-NewPhones-CSV>

macOS

Execute the following steps to run the transform tool on macOS:

1. Create a virtual environment and install dependencies to run the transform tool using Python:

   python3 -m venv venv
   source venv/bin/activate
   python3 -m pip install requests
   python3 -m pip install requests-oauthlib
   

2. Run the transform tool:

   ./transform.sh -extract=<Extract-Tool-Output-Zip-file> -customers=<Input-Path-Customers-CSV> -users=<Input-Path-Users-CSV> -newphones=<Input-Path-NewPhones-CSV>

Customer/user precheck

The Transform Tool makes API calls to Webex to catch potential provisioning issues. By default, it will validate the customer’s address and primary email. If the PROVISIONING_ID value is specified in the conf/partner.cfg file, it will also validate location information. The precheck results are included in the exception report.

Additionally, the following optional parameters can be added when running the transform tool:

precheck

In addition to running the precheck API for the customer information, the Transform Tool will also run the precheck API for the subscriber emails.

precheckinfo

By default, only precheck errors (i.e., issues that will block provisioning) are included in the exception report. Adding this flag will include successful precheck results as well (e.g., if a Webex organization already exists that can be automatically attached).

Terminal logs

The following logs in the terminal on successful transform:

Summary Report
BroadWorks enterprises that can be successfully migrated: 1
BroadWorks enterprises that cannot be migrated: 0
BroadWorks users that can be successfully migrated: 4
BroadWorks users that cannot be migrated: 0
Phones that can be successfully migrated: 3
Phones that are not compatible with Webex Calling: 0

Exception report

Transform Tool generates the exception report inside the output/<timestamp>/exception_report.txt directory. You can use this report to identify the issues that will affect the migration and fix them in the Cisco BroadWorks system.

After modifying the user data to resolve the exception, rerun the Extract and Transform Tools with the new data. The sample exception report file as follows:

Exception Report
Tue Oct 18 08:12:09 2022

Enterprises with Communication Barring Feature
Recommendation: manually configure the Outgoing Calling Plan in Control Hub
________________________________________________________________________________
collabmigrationtestGRP_engg

Output

An output JSON (customer.json) file will be available in the output/<timestamp>/<groupid> directory. The sample customer.json file is as follows:

{
    "customer": {
        "provisioningId": "!!!!!!!!!!REPLACE_WITH_PROVISIONINGID!!!!!!!!!!",
        "packages": [
            "webex_calling",
            "common_area_calling"
        ],
        "externalId": "external_id_engg_grp1",
        "address": {
            "addressLine1": "100 Main Street",
            "addressLine2": "",
            "city": "Gaithersburg",
            "stateOrProvince": "MD",
            "zipOrPostalCode": "20877",
            "country": "US"
        },
        "customerInfo": {
            "name": "Engineering Group - 1",
            "primaryEmail": "amareswaranvel+engineeringgroup1@gmail.com"
        },
        "provisioningParameters": {
            "calling": {
                "location": {
                    "name": "Main",
                    "address": {
                        "addressLine1": "100 Main Street",
                        "addressLine2": "",
                        "city": "Gaithersburg",
                        "stateOrProvince": "MD",
                        "zipOrPostalCode": "20877",
                        "country": "US"
                    },
                    "timezone": "America/New_York",
                    "language": "en_us",
                    "numbers": [
                        "+15205551101",
                        "+15205551102",
                        "+15205551103",
                        "+15205551104",
                        "+15205551105",
                        "+15205551106",
                        "+15205551107",
                        "+15205551108",
                        "+15205551109",
                        "+15205551110"
                    ],
                    "mainNumber": "+15205551101"
                }
            }
        }
    },
    "broadworks_info": {
        "service_provider_id": "collabmigrationtestSP_engg",
        "group_id": "collabmigrationtestGRP_engg"
    },
    "subscribers": [
        {
            "amareswaranvel+benjaminjack@gmail.com": {
                "subscriber": {
                    "customerId": "!!!!!!!!!!REPLACE_WITH_CUSTOMERID!!!!!!!!!!",
                    "email": "amareswaranvel+benjaminjack@gmail.com",
                    "package": "webex_calling",
                    "provisioningParameters": {
                        "firstName": "Benjamin",
                        "lastName": "Jack",
                        "primaryPhoneNumber": "+15205551102",
                        "extension": "1102"
                    }
                },
                "features": [
                    {
                        "/v1/people/{personId}/features/voicemail": {
                            "enabled": true,
                            "sendBusyCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT"
                            },
                            "sendUnansweredCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT",
                                "numberOfRings": 3
                            },
                            "messageStorage": {
                                "mwiEnabled": true,
                                "storageType": "EXTERNAL",
                                "externalEmail": "engineering17861@mailnator.com"
                            }
                        }
                    }
                ],
                "devices": [
                    {
                        "cisUuid": "!!!!!!!!!!REPLACE_WITH_PERSONID!!!!!!!!!!",
                        "product": "DMS Cisco 7861",
                        "mac": "CC98914EAAD7"
                    }
                ]
            }
        },
        {
            "amareswaranvel+lucasoliver@gmail.com": {
                "subscriber": {
                    "customerId": "!!!!!!!!!!REPLACE_WITH_CUSTOMERID!!!!!!!!!!",
                    "email": "amareswaranvel+lucasoliver@gmail.com",
                    "package": "webex_calling",
                    "provisioningParameters": {
                        "firstName": "Lucas",
                        "lastName": "Oliver",
                        "primaryPhoneNumber": "+15205551103",
                        "extension": "1103"
                    }
                },
                "features": [
                    {
                        "/v1/people/{personId}/features/voicemail": {
                            "enabled": true,
                            "sendBusyCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT"
                            },
                            "sendUnansweredCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT",
                                "numberOfRings": 3
                            },
                            "messageStorage": {
                                "mwiEnabled": true,
                                "storageType": "EXTERNAL",
                                "externalEmail": "engineering16821@mailnator.com"
                            }
                        }
                    }
                ],
                "devices": [
                    {
                        "cisUuid": "!!!!!!!!!!REPLACE_WITH_PERSONID!!!!!!!!!!",
                        "product": "DMS Cisco 6821",
                        "mac": "5486BCAE7E45"
                    }
                ]
            }
        },
        {
            "amareswaranvel+leojackson@gmail.com": {
                "subscriber": {
                    "customerId": "!!!!!!!!!!REPLACE_WITH_CUSTOMERID!!!!!!!!!!",
                    "email": "amareswaranvel+leojackson@gmail.com",
                    "package": "webex_calling",
                    "provisioningParameters": {
                        "firstName": "Leo",
                        "lastName": "Jackson",
                        "primaryPhoneNumber": "+15205551104",
                        "extension": "1104"
                    }
                },
                "features": [
                    {
                        "/v1/people/{personId}/features/voicemail": {
                            "enabled": true,
                            "sendBusyCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT"
                            },
                            "sendUnansweredCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT",
                                "numberOfRings": 3
                            },
                            "messageStorage": {
                                "mwiEnabled": true,
                                "storageType": "EXTERNAL",
                                "externalEmail": "engineeringmacpc@mailnator.com"
                            }
                        }
                    }
                ],
                "devices": []
            }
        },
        {
            "amareswaranvel+owenalex@gmail.com": {
                "subscriber": {
                    "customerId": "!!!!!!!!!!REPLACE_WITH_CUSTOMERID!!!!!!!!!!",
                    "email": "amareswaranvel+owenalex@gmail.com",
                    "package": "webex_calling",
                    "provisioningParameters": {
                        "firstName": "Owen",
                        "lastName": "Alexander",
                        "primaryPhoneNumber": "+15205551101",
                        "extension": "1101"
                    }
                },
                "features": [
                    {
                        "/v1/people/{personId}/features/voicemail": {
                            "enabled": true,
                            "sendBusyCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT"
                            },
                            "sendUnansweredCalls": {
                                "enabled": true,
                                "greeting": "DEFAULT",
                                "numberOfRings": 3
                            },
                            "messageStorage": {
                                "mwiEnabled": true,
                                "storageType": "EXTERNAL",
                                "externalEmail": "engineering8811@mailnator.com"
                            }
                        }
                    }
                ],
                "devices": [
                    {
                        "cisUuid": "!!!!!!!!!!REPLACE_WITH_PERSONID!!!!!!!!!!",
                        "product": "DMS Cisco 8811",
                        "mac": "F87B204E4066"
                    }
                ]
            }
        }
    ],
    "auto_attendants": [],
    "call_queues": [],
    "hunt_groups": [],
    "schedules": [],
    "call_parks": [],
    "call_pickups": [],
    "paging_groups": [],
    "voice_portals": [
        {
            "name": "Automated Voice Portal",
            "firstName": "Automated",
            "lastName": "Voice Portal",
            "languageCode": "en_us",
            "phoneNumber": "+15205551105",
            "extension": "1105"
        }
    ],
    "shared_call_appearances": [],
    "business_communicator_desktop_to_upgrade_to_webex_app": [
        "PC Comm - Engg Device Profile"
    ],
    "connect_client_to_upgrade_to_webex_app": [],
    "locations": [],
"webex_for_broadworks_info": {
        "users": [
            {
                "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvY2QzNGViNWYtYTVmMi00OWQ1LTlkNWMtZTg1MDJiMDE4YTQ5"
            }
        ],
        "hydra_orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jMjJiYTMwNC1mODQ4LTRlOTktYWFmYy0zYWRlMjBmYTgzZTg",
        "hydra_customer_config_id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvYmIyMzA1MDEtMTUzMS00MzNiLTllM2QtODExY2FlYTExYmVk"
    }
}

The provisioning tool can run on any machine usually the (partner's administrator laptop) and uses the Webex Public APIs. It reads the transform tool output JSON (customer.json) file as an input and provisioning the customers, locations, numbers, users, services, and devices in the Webex Wholesale RTM solution.

Prerequisites

Configure the following prerequisites inside the provisioning tool directory:

1. Install Java 8, 11, or 17 on the computer. Java is available from many sources, including:
   • https://learn.microsoft.com/en-us/java/openjdk/download
   • https://aws.amazon.com/corretto/
   • https://download.oracle.com/java/17/latest/jdk-17_macos-x64_bin.dmg
2. After downloading and extracting the Migration tools binaries, set the JAVA_HOME environment variable in the provisioning_tool.sh for MAC and provisioning_tool.bat for Windows.
3. The partner.cfg file:
   • Set the WHOLESALE_PROVISIONING_ID and REFRESH_TOKEN (Token copied from the Token Generator Tool). The partner administrators must contact their account team to get the PROVISIONING_ID:

     WHOLESALE_PROVISIONING_ID = Y2U4YWQxYmQtMWZlNy00NjRiLWExMmItMGJkODMzN2U5NmU0
     REFRESH_TOKEN=MzUwYjljODEtYmQ4MS00NGVhLTgwNGUtZjQ1NTEyZTViNzJkOTdj 
     

   • Set ALLOW_ADMIN_INVITE_EMAILS to false, if partner don’t want to send a welcome email to the users. The default value is true.

4. Use the WEBEX4BWKS_EMAIL_SUBJECT property for Webex for BroadWorks migrations to send the change password request email subject for Webex for BroadWorks subscribers.
5. Use the WEBEX4BWKS_EMAIL_BODY property for Webex for BroadWorks migrations to send the change password request email body for Webex for BroadWorks subscribers.

For BroadCloud migrations same region:

1. The tool skips the numbers, devices, and Shared Call Appearances provisioning.
2. The tool creates users and virtual users with extension and temporary extension.

For BroadCloud migrations another region:

1. The tool will provision numbers, devices, and Shared Call Appearances.
2. The tool creates users and virtual users with actual phone numbers and extension.
   All Europe BroadCloud migrations are to another region.

Instructions to run

Use the following steps to run the tool in Windows and macOS:

Windows

Execute the following steps to run the tool on Windows OS:

To provision single customer:
provision.bat -input=<Transform-Tool-Output-Customer-JSON-File-Path>
To provision multiple customers:
provision.bat -input=<Transform-Tool-Timestamp-Output-Directory-Path> 

macOS

Execute the following steps to run the tool on macOS:

To provision single customer:
./transform.sh -input=<Transform-Tool-Output-Customer-JSON-File-Path>
To provision multiple customers:
./transform.sh -input=<Transform-Tool-Timestamp-Output-Directory-Path>

Prerequisites for Webex for BroadWorks Migration

Partner Administrators must update their BroadWorks onboarding template for Webex for BroadWorks coexistence features. Refer to the following image:

Once the Webex for BroadWorks Onboarding template is updated to support migration, request the Cisco Account Team to enable the "wholesale-partner-blending-enabled" feature toggle at the partner level. This will allow Wholesale packages to be added to existing Webex for BroadWorks customer organizations during provisioning.

Run the provisioning tool with an additional argument.

Preparation phase: is the default phase where Administrators can provision the BroadWorks users as a Wholesale subscriber and continue with the Webex for BroadWorks users.

Maintenance phase: is the second phase where Administrators can assign the Wholesale license to the existing Webex for BroadWorks users. You must run the provisioning tool with an argument maintenance.

Post Migration phase: Is the final phase when Administrators can convert the BroadWorks to Wholesale completely. You must run the provisioning tool with an argument postmigration.

Terminal logs

Following are the logs in the terminal on successful provisioning:

Tool Name: Provisioning Tool
Version: 1.15.0
 
********** Started Processing File : input/customer.json ****************
 
Provisioning Customer
Waiting for customer external_id_engg_grp1 to complete provisioning...
Waiting for customer external_id_engg_grp1 to complete provisioning...
 
Customer external_id_engg_grp1 status : provisioned
Provisioning Numbers
Provisioning Users
Provisioning User Features
Provisioning Greetings
Provisioning Schedules
Provisioning Devices
Provisioning Shared Call Appearances
Provisioning Auto Attendants
Provisioning Call Queues
Provisioning Hunt Groups
Provisioning Group Pagings
Provisioning Call Parks
Provisioning Call Pickups
Provisioning Voice Portal
 
********** Completed File : input/customer.json ****************

A table will be printed with the number of locations created for each run:

Output

Provisioning tool generates success and error reports inside the output/<external_id>/*.success/error files. Review output success and error logs to verify successful provisioning.

Partner administrators can verify the customer provisioning in the Partner Hub and Control Hub portal. Refer to the following illustrations from the Partner Hub and Control Hub portal:

Figure 8: Partner Hub

Figure 9: Control Hub

Figure 10: Devices

Figure 11: Calling

For BroadCloud

For BroadCloud partners, use the Service Provider portal to submit a migration request for numbers, devices, and SCA migrations.

Within the Service Provider portal, a migration request can include up to 50 customers. A maximum of 10 requests can be submitted within a day.

The figures below show the Service Provider portal.

Figure 12: Service Provider portal

Figure 13: Service Provider portal

For Cisco BroadWorks and Webex for BroadWorks

For Cisco BroadWorks and Webex for BroadWorks migrations, the tool runs on the secondary Cisco BroadWorks Application Server within the partner network and connects to the AS through OCI-P. It uses the Transform Tool output JSON (customer.json) file as input and run the OCI-P commands to migrate devices and soft clients.

On successful operation, the device move tool will:

1. Deregister devices from the Cisco BroadWorks and register them in Wholesale.
2. Users using the UC-One client will redirect to the Webex App on first-time sign-in.
3. Deactivate the Phone Numbers from Cisco BroadWorks or remove the phone numbers from BroadCloud.
4. Activate numbers in Wholesale.
5. Create Shared Call Appearances in Wholesale for BroadCloud migrations. [This step is applicable only for BroadCloud migrations].

SCP and SSH

1. SCP the device move tool to the secondary Cisco BroadWorks Application Server.
2. SSH to the secondary Cisco BroadWorks Application Server to configure the prerequisites and run the device move tool.

Prerequisites

1. Set the REFRESH_TOKEN (Token copied from the Token Generator Tool) in the conf/partner.cfg file:

   REFRESH_TOKEN=MzUwYjljODEtYmQ4MS00NGVhLTgwNGUtZjQ1NTEyZTViNzJkOTdj

2. Ensure the secondary Cisco BroadWorks Application Server User ID, Password, and Host Name are correct in the conf/deviceMoveTool.conf file:

   BROADWORKS_USER_ID = admin
   BROADWORKS_PASSWORD = admin
   BROADWORKS_HOST_NAME = localhost
   

3. To resend activation emails, you need to set RESEND_INVITATION_EMAILS=true in the conf/partner.cfg file.

   If administrators wish to send invitation emails to their users during migration, they should uncomment the "RESEND_INVITATION_EMAILS=true" property in the conf/partner.cfg file. Otherwise, the property should remain unchanged.

4. Verify the JDK/JRE environment path is correct in devicemove.sh

   JAVA_HOME=/usr/local/java/java_base

5. Administrators can use the locations.csv file from the input directory to migrate the specific groups instead of all groups under an enterprise.

Polycom phones

To move Polycom phones from Cisco BroadWorks to Wholesale Calling, a partner administrator must create a new Identity/Device Profile Type File at the System level in Cisco BroadWorks each Polycom device template. Refer to figure 14 and upload the custom file device-move-tool/conf/deviceProfile/{region}/polycom_vvx.cfg. After uploading the new device file, ensure the newly created file exists at the Group level. Also ensure that file migration_%BWMAC ADDRESS%.cfg doesn’t conflict with any existing file in your system).

It’s used internally by the device move tool.

The migration process for Polycom phones:

1. The device move tool replaces the file %BWMACADDRESS%.cfg at the device level with polycom_vvx2.cfg. This file refers to migration_%BWMACADDRESS%.cfg.
2. Rebuild the device profiles at the group level or device level.
   Acting at the group level or device level depends on the configuration of parameter deviceLevelRebuild in the file device-move-tool/conf/partner.cfg.
3. The device move tool asks the Cisco BroadWorks Application Server to reboot phones at the group level or device level.
4. After the reboot request, Polycom phones download and process% BWMACADDRESS%.cfg, which asks the Polycom phones to download and process migration_%BWMACADDRESS%.cfg, which sets the device.prov.serverName to https://plcm.sipflash.com.
   https://plcm.sipflash.com for the US region, other regions have different URLs.
5. The Polycom phone downloads %BWMACADDRESS%.cfg from https://plcm.sipflash.com and will be managed by the Webex Calling DMS.

Figure 14: Identity/device profile type file add

Instructions to run

There are two methods to invoke the DMT, first one is to invoke through a single customer at a time and the other is to run through multiple customers simultaneously.

The device move tool is run from the secondary Cisco BroadWorks Application Server inside the device move tool directory:

For device move single customer:
./devicemove.sh -input=<Transform-Tool-Output-Customer-JSON-File-Path>
 ./devicemove.sh -input=/tmp/customername.json
 For device move multiple customers:
./devicemove.sh -input=<Transform-Tool-Timestamp-Output-Directory-Path>
 ls -l /tmp/directoryofcustomers/
customer1.json 
customer2.json
customer3.json
Additionally, the device move tool supports migrate single/specific phone(s) from 1.35.0 release.
Use the command below:
./devicemove.sh -integration -input= <Transform-Tool-Output-Customer-JSON-File-Path> -macaddress=4CBC4883A6F8,48256741CBE9

Terminal logs

Following are the logs in the terminal on successful running the device move tool for device migration:

Tool Name: Device Move Tool
Version: 1.15.0
Device Tool Started...
Valid Devices for migration :
-------------------------------------------------------------------------------------------------------------------
|    Device Type |          Mac |                                 Version |                                 Email |
-------------------------------------------------------------------------------------------------------------------
| DMS Cisco 7861 | CC98914EAAD7 | Cisco-CP-7861-3PCC/11.3.7_cc98914eaad7_ | amareswaranvel+benjaminjack@gmail.com |
| DMS Cisco 6821 | 5486BCAE7E45 | Cisco-CP-6821-3PCC/11.3.7_5486bcae7e45_ |  amareswaranvel+lucasoliver@gmail.com |
| DMS Cisco 8811 | F87B204E4066 | Cisco-CP-8811-3PCC/11.3.7_f87b204e4066_ |     amareswaranvel+owenalex@gmail.com |
-------------------------------------------------------------------------------------------------------------------
Do you want to migrate all these devices? ([Y]es or [N]o) 
yes
Uploading Device Profiles for DMS Cisco MPP LC
Rebuild Device Process Started
Rebuild Device Process Completed Successfully
Reboot Process Started
Reboot Process Completed Successfully
Modifying profiles for Business Communicator under group collabmigrationtestGRP_engg
Activate webex phone numbers process started for customer org Id : 85ea1d6f-ff9e-41a1-843f-7362aaf12b4c
Activate webex phone numbers process completed for customer org id : 85ea1d6f-ff9e-41a1-843f-7362aaf12b4c
Deactivate broadworks phone numbers process started for groupId : collabmigrationtestGRP_engg
Deactivate broadworks phone numbers process completed for groupId : collabmigrationtestGRP_engg
Device Migration Completed

Output

After the device migration, devices have come online and ready to make/receive calls. Refer to figure 15 to see an example of the device status:

Figure 15: Device status

After the device migration, numbers have come active. Refer to figure 16 to see an example of what numbers are active:

Figure 16: Numbers active

The revert operation must be executed for one enterprise at a time.

For BroadCloud Carrier

The revert process for BroadCloud partners is as follows:

1. Open a ticket with Cisco TAC to request a device revert.
2. Run the device move tool on revert mode:
   • Phone numbers will be unassigned from Webex Calling, leaving users and services with extensions only.
   • Email addresses in Webex Calling will be reverted to temporary email addresses.
   • Phones will be deleted from Webex Calling.
   • Phone numbers, email addresses used as alternatedIds, and phones will be recreated in BroadCloud.
   • Phones will be rebooted.
3. Partner administrators must move PSTN phone numbers back to BroadCloud Carrier.

For Cisco BroadWorks and Webex for BroadWorks

The revert process for Cisco BroadWorks and Webex for BroadWorks is as follows:

1. Open a ticket with Cisco TAC to request a device revert.
2. Run the device move tool on revert mode on the secondary BroadWorks Application Server to revert the device migrations. This will set the DMS URL back to the service provider DMS URL for device profiles in Cisco BroadWorks and re-activate phone numbers.
3. The Webex Calling Team sets the DMS URL back to the service provider DMS URL in device profiles in Webex Calling.
4. Partner administrators must deactivate or delete the phone numbers in the Webex Calling through the Control Hub portal.
5. Partner administrators must move PSTN phone numbers back to Cisco BroadWorks.

Instructions to run device move tool in revert mode

Follow the steps below to run the device move tool in revert mode:

Run the command below in the secondary Cisco BroadWorks Application Server inside the device move tool directory:

Revert profiles

./devicemove.sh -input= <Transform-Tool-Output-Customer-JSON-File-Path> -revertProfiles

Revert numbers

./devicemove.sh -input= <Transform-Tool-Output-Customer-JSON-File-Path> -revertNumbers

Terminal logs

We will get the following logs in the terminal on successful running the device move tool for revert operation:

Revert profiles

Tool Name: Device Move Tool
Version: 1.15.0
Device Tool Started for Revert Process...
Devices that can be moved back from Webex Calling to BroadWorks:
- -------------------------------------------------------------------------------------------------------------------
|    Device Type |          Mac |                                 Version |                                 Email |
-------------------------------------------------------------------------------------------------------------------
| DMS Cisco 7861 | CC98914EAAD7 | Cisco-CP-7861-3PCC/11.3.7_cc98914eaad7_ | amareswaranvel+benjaminjack@gmail.com |
| DMS Cisco 6821 | 5486BCAE7E45 | Cisco-CP-6821-3PCC/11.3.7_5486bcae7e45_ |  amareswaranvel+lucasoliver@gmail.com |
| DMS Cisco 8811 | F87B204E4066 | Cisco-CP-8811-3PCC/11.3.7_f87b204e4066_ |     amareswaranvel+owenalex@gmail.com |
-------------------------------------------------------------------------------------------------------------------
Do you want to move back these devices from Webex Calling to BroadWorks? (Yes, Y, No, N): 
yes
Uploading Device Profiles for DMS Cisco MPP LC
Rebuild Device Process Started
Rebuild Device Process Completed Successfully
Reboot Process Started
Reboot Process Completed Successfully
Device Migration Completed for Deprovision Process

Revert numbers

Tool Name: Device Move Tool
Version: 1.15.0
Do you want to continue reverting numbers to Broadworks ?  ([Y]es or [N]o): 
Y
[+15205551101, +15205551102, +15205551103, +15205551104, +15205551105, +15205551106, +15205551107, +15205551108, +15205551109, +15205551110]
Starting revert
Activate broadworks phone numbers process started for groupId : collabmigrationtestGRP_engg
Activate broadworks phone numbers process completed for groupId : collabmigrationtestGRP_engg
Device Migration Revert process Completed Successfully