Les téléphones pris en charge seront automatiquement créés et attribués aux utilisateurs dans Webex Calling par l’outil de provisionnement. Les téléphones marqués « Oui » dans la colonne « Pris en charge dans l’outil de déplacement du périphérique » seront également automatiquement déplacés de Cisco BroadWorks ou BroadCloud vers Webex Calling lorsque l’outil de déplacement du périphérique est exécuté. Les téléphones marqués « Non » dans cette colonne nécessitent une intervention manuelle pour modifier l’URL DMS dans le modèle de périphérique Cisco BroadWorks ou dans le téléphone lui-même.

La dernière colonne fournit le mappage des modèles de téléphone à la colonne « Type de périphérique » du fichier transform-tool/input/newphones.csv. (Voir la section Outil de transformation de cet article pour plus d’informations sur newphones.csv).

Les administrateurs partenaires exécutent cet outil utilitaire de génération de jetons au moins une fois avant de commencer à exécuter les outils de transfert. L’exécution de cet outil est une activité unique après l’intégration du compte partenaire dans la solution Wholesale RTM. Cet outil permet aux administrateurs partenaires de se connecter via un navigateur Web pour obtenir le JETON unique nécessaire pour mettre à jour les fichiers de configuration du partenaire pour les outils de transfert.

Prérequis

Installez Java 8, 11, 17, ou 21 sur l'ordinateur. Java est disponible à partir de nombreuses sources, notamment :

• https://learn.microsoft.com/en-us/java/openjdk/download
• https://aws.amazon.com/corretto/
• https://www.oracle.com/java/technologies/downloads/#java21

Après le téléchargement, extrayez les binaires de l’outil de migration.

Instructions à exécuter

Exécutez la commande suivante dans le terminal à l'intérieur du répertoire du générateur de jetons :

Windows :

token_generator.bat

MacOS :

./token_generator.sh

Sortie :

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

Ouvrez l'URL dans le navigateur Web du terminal, connectez-vous avec les informations d'authentification de l'administrateur partenaire pour obtenir le JETON et copiez-le pour une utilisation ultérieure.

Les illustrations de l'interface utilisateur sont données ci-dessous à titre de référence :

Figure 3 : Se connecter avec Cisco Webex

Figure 4 : Fenêtre d'informations d'authentification

Figure 5 : Génération du jeton

Configurez les étapes suivantes, avant d'exécuter les outils d'extraction et de déplacement de périphérique sur le serveur BroadWorks secondaire.

Activer la connectivité OCI-P

L'outil de déplacement du périphérique communique avec BroadWorks par le biais des commandes OCI-P, pour activer la connectivité OCI-P, utilisez les étapes ci-dessous :

Étape 1 : Utilisez l'interface de ligne de commande pour configurer les paramètres généraux.

Exécutez la commande suivante dans CLI pour passer au répertoire GeneralSettings :

AS_CLI> cd /Applications/OpenClientServer/GeneralSettings.

Exécutez la commande suivante dans CLI pour obtenir les paramètres généraux actuels :

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

Si vos paramètres ne correspondent pas aux paramètres ci-dessus, utilisez la commande configurer pour reconfigurer vos paramètres.

Étape 2 : Utilisez l'interface de ligne de commande pour configurer le proxy OCI.

Remplacer le répertoire par Proxy OCI :

AS_CLI> cd /Applications/OpenClientServer/OCIProxy

Exécutez l'interface de ligne de commande suivante pour obtenir les paramètres actuels. Vous devriez voir ce qui suit :

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

Si vos paramètres ne correspondent pas aux paramètres ci-dessus, utilisez la commande configurer pour reconfigurer vos paramètres.

Étape 3 : Utilisez l'interface de ligne de commande pour configurer la mise à disposition OCI.

Passer au répertoire de mise à disposition :

AS_CLI> cd /System/NetworkAccessLists/OCI/Provisioning

Exécutez la commande suivante pour obtenir les paramètres actuels de mise à disposition OCI :

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

Étape 4 : Exécutez la commande ci-dessous dans l’interface de ligne de commande pour vérifier que votre configuration est correcte.

 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.

Vérifier le serveur client ouvert déployé et actif

Utilisez les commandes ci-dessous pour déployer et démarrer le serveur client ouvert sur le serveur d'applications secondaire s'il n'est pas déployé ou s'il n'a pas déjà démarré.

Étape 1 : Déployez le serveur avec la commande CLI suivante :

AS_CLI/Maintenance/ManagedObjects> deploy application OpenClientServer

Étape 2 : Démarrez le serveur avec cette commande :

AS_CLI/Maintenance/ManagedObjects> start application OpenClientServer

Activation de l’activation des numéros

Exécutez les commandes suivantes dans l’interface de ligne de commande pour activer les numéros :

Étape 1 : Exécutez la commande d'activation du numéro :

AS_CLI> cd SubscriberMgmt/NumberActivation

Étape 2 : Exécutez la commande activation activée :

AS_CLI> set dnMode groupAndUserActivationEnabled

Étape 3 : À l'invite de confirmation, saisissez O.

Pour BroadCloud

L'outil d'extraction est intégré dans le portail du fournisseur de services BroadCloud. Un administrateur du fournisseur de services peut :

1. Envoyez des demandes d'extraction pour un maximum de 50 clients par demande.
   La demande d'extraction ne peut pas être soumise pour le même client plus de 10 fois par jour.
2. Téléchargez le fichier de données extrait, au format ZIP, pendant une durée maximale de 28 jours à compter de la date d’envoi de la demande.

Les figures suivantes montrent le portail du fournisseur de services.

Figure 6 : Portail des fournisseurs de services

Figure 7 : Portail des fournisseurs de services

Demande d’extrait CSV

Lancer une demande d’extrait CSV

1. Télécharger le fichier CSV du client

   Cliquez sur le lien Télécharger le fichier CSV du client dans le coin supérieur droit de la section Initier une demande d’extrait CSV .

2. Modifier la liste des clients

   L’administrateur peut modifier ce fichier CSV pour n’inclure que les clients pour lesquels l’extrait doit être effectué.

3. Charger et envoyer

   Après la modification, chargez le fichier CSV modifié.

   Cliquez sur Envoyer pour lancer une demande d’extraction pour les clients listés et leurs emplacements associés.

Lancer une demande d’extraction pour un client avec un fichier CSV d’emplacements

1. Sélectionnez les clients et téléchargez les emplacements

   Choisissez un client dans la liste déroulante.

   Téléchargez le fichier correspondant locations.csv à partir de Afficher les clients→ Onglet Sites → Exporter les emplacements au format CSV.

2. Modifier le fichier des emplacements

   L’administrateur peut modifier le fichier CSV pour n’inclure que les emplacements qu’il souhaite extraire.

3. Charger et envoyer

   Téléchargez le fichier modifié locations.csv et cliquez sur Soumettre.

   Seuls les emplacements spécifiés pour le client sélectionné seront inclus dans la demande d’extraction.

Lancer une demande d'extraction pour tous les clients

1. Cliquez sur Envoyer pour lancer une demande d’extraction pour tous les clients et tous leurs emplacements sous le fournisseur de service actuel.

Pour Cisco BroadWorks et Webex pour BroadWorks

1. L'outil d'extraction s'exécute sur le serveur d'applications Cisco BroadWorks secondaire au sein du réseau partenaire et se connecte sur OCI-P.
2. L’outil extrait les données brutes d’entreprise, de groupe, de numéros, d’utilisateurs, de services, de périphériques et du client logiciel de la plateforme Cisco BroadWorks ou BroadCloud et émet ces données vers des fichiers XML qui fournissent les entrées pour l’outil de transformation.

Les sections suivantes expliquent comment installer et configurer l'outil d'extraction.

Prérequis

1. SCP les binaires de l'outil d'extraction vers le serveur d'applications Cisco BroadWorks secondaire.
2. SSH vers le serveur d'applications Cisco BroadWorks secondaire pour configurer les prérequis et exécuter l'outil d'extraction.
3. Configurez l'ID du fournisseur de service et du groupe à extraire de Cisco BroadWorks dans la conférence/exportTool.yml. Reportez-vous à l'exemple d'extrait YAML suivant :

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

4. Vérifiez que l'ID utilisateur, le mot de passe et le nom d'hôte du serveur d'applications Cisco BroadWorks secondaire sont corrects dans le fichier conf/partner.cfg :

   BROADWORKS_USER_ID = admin
   BROADWORKS_PASSWORD = admin
   BROADWORKS_HOST_NAME = localhost
   REFRESH_TOKEN = Partner administrator’s refresh token copied from the Token Generator tool.
   

   La REFRESH_TOKEN propriété est obligatoire pour une migration Webex pour BroadWorks.

5. Modifiez le chemin d'environnement JDK/JRE dans le fichier export.sh si le chemin d'environnement JDK/JRE du serveur d'applications Cisco BroadWorks secondaire est différent du fichier :

   JAVA_HOME=/usr/local/java/java_base

Instructions à exécuter

Exécutez la commande suivante dans le serveur d'applications Cisco BroadWorks secondaire à partir du répertoire de l'outil d'extraction :

./export.sh

Journaux du terminal

Les journaux suivants sont disponibles sur le terminal lors d'une exportation réussie : Exécution de l'outil d'exportation de données BroadSoft :

 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
**************************************************

Sortie

Un fichier de sortie ZIP (extracted_data_<timestamp>.zip) est disponible dans le même répertoire d'outil d'extraction. Utilisez la commande suivante pour afficher et utiliser le fichier ZIP pour la saisie de l'outil de transformation :

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

Cet outil de transformation s’exécute pour toutes les migrations. L’outil de transformation s’exécute sur n’importe quel ordinateur, y compris l’ordinateur portable administrateur d’un partenaire, et utilise les API publiques de Webex. Il lit le fichier ZIP (extracted_data_<timestamp>.zip) de sortie de l'outil d'extraction en tant qu'entrée et transforme le XML brut en un format JSON qui est utilisé par l'outil de mise à disposition.

Prérequis

Après avoir téléchargé et extrait les binaires des outils de migration, configurez les prérequis suivants :

1. Configurez le JETON D’ACTUALISATION_ (jeton copié à partir de l’outil générateur de jetons) et le NOM_DE_L’EMPLACEMENT PRINCIPAL_dans le fichier conf/partner.cfg :

   REFRESH_TOKEN=MzUwYjljODEtYmQ4MS00NGVhLTgwNGUtZjQ1NTEyZTViNzJkOTdj
   NAME_OF_MAIN_LOCATION=Main
   

2. Vous pouvez également configurer l’ID_PROVISIONING (copié à partir du modèle dans le Hub partenaire) dans le fichier de conférence/partner.cfg :

   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
10. The network server sync feature allows administrators to provision phone numbers, MAC addresses, and users email addresses during the provision in the same region migration. To enable it, set USE_NS_SYNC=yes in conf/partner.cfg.

    If NS sync is disabled, phone number and device provisioning will be skipped, and users will get temporary email addresses.

11. Optionally enable the properties ANALOG_USER_TYPE_ENABLE_CALL_WAITING, ANALOG_USER_TYPE_ENABLE_MUSIC_ON_HOLD, and ANALOG_USER_TYPE_DISABLE_T38 to configure call waiting, music on hold, and disable T38 settings for all analog-type users.

12. If you want to set up generic gateway devices, add the device's MAC address and user ID to the input/genericgateways.csv file. Also, mention whether the user is the PRIMARY owner or a SHARED user (for shared call appearances). This is only needed if partner admins plan to use generic gateway devices in Wholesale Calling.

    This feature is not available for BroadCloud to Wholesale migrations.

13. For BroadCloud migrations, to convert all users with the messaging station type to voice_mail_group, update the conf/rialto_station_type_to_wholesale_package.csv file by replacing the Wholesale Package value with voice_mail_group for the row where the Rialto Station Type is messaging.

    Optionally, enable the COMMON_VOICE_MAIL_GROUP_PASSCODE property in partner.cfg to configure the default PIN for voice mail groups.

    If this property is not specified in partner.cfg, it must be provided per customer in the customers.csv file under the commonVoicemailGroupPassCode column.

14. For migration of common contacts to Webex Calling

    It is the enhancement for managing enterprise and site-level common contacts. These contacts can now be migrated either as organization contacts (Org Contacts) or as virtual extensions, based on the configuration settings. Below are the details to guide you through this migration process.

    Key configuration:

    • COMMON_PHONE_LIST_TO_VIRTUAL_EXTENSION_START_RANGE

      A new property, COMMON_PHONE_LIST_TO_VIRTUAL_EXTENSION_START_RANGE, is introduced in the partner.cfg file. This property determines how common contacts are migrated from Rialto to Webex Calling.

    • Without COMMON_PHONE_LIST_TO_VIRTUAL_EXTENSION_START_RANGE Configured

      Common contacts will be migrated as organization contacts (Org Contacts).

      No additional configuration is required.

      Contacts remain accessible at the organization level.

    • With COMMON_PHONE_LIST_TO_VIRTUAL_EXTENSION_START_RANGE configured

      Common contacts will be migrated as Virtual Extensions.

      Each contact will be appended with an extension number, and the start range of the extension is defined in the COMMON_PHONE_LIST_TO_VIRTUAL_EXTENSION_START_RANGE property in partner.cfg.

      Virtual extensions are supported at both the organization level and location level, depending on the scope of the contact.

15. Exclusion of selected phone numbers from migration:

    To exclude specific phone numbers from the migration process, the following two-step procedure using the transform tool must be followed:

    • Initially execute the transform tool for the first time. Upon completion, the tool will generate a file named telephone_numbers_inventory.csv, located within the output/timestamp/ directory. The customer is required to review this file and indicate "Yes" in the "Drop Tn's" column for each phone number that should be excluded from the upcoming migration.
    • After updating the telephone_numbers_inventory.csv file with the appropriate exclusion flags, the transform tool is executed a second time. The updated file should be passed as an argument in the following format.

      ./transform.sh -extract=input/extracted_data_1747640608219.zip -decommissionnumbers={filepath/telephone_numbers_inventory.csv}

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.

Filling-up the input/users.csv

The file input/users.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.

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= -customers= -users= -newphones=

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
   python3 -m pip install phonenumbers
   

2. Run the transform tool:

   ./transform.sh -extract= -customers= -users= -newphones=

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

Sortie

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.

Prérequis

Configure the following prerequisites inside the provisioning tool directory:

1. Install Java 8, 11, 17, or 21 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://www.oracle.com/java/technologies/downloads/#java21
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.
6. The network server sync feature allows administrators to provision phone numbers, MAC addresses, and users email addresses during the provision in the same region migration. To enable it, set USE_NS_SYNC=yes in conf/partner.cfg.

   If NS sync is disabled, phone number and device provisioning will be skipped, and users will get temporary email addresses.

7. Use the CUSTOM_TAGS property to add tags after customer creation.

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=
To provision multiple customers:
provision.bat -input= 

macOS

Execute the following steps to run the tool on macOS:

To provision single customer:
./transform.sh -input=
To provision multiple customers:
./transform.sh -input=

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:

Sortie

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 : Hub partenaire

Figure 9 : Control Hub

Figure 10 : Appareils

Figure 11 : Appel

Post-Provisioning Restrictions

Once provisioning is complete for a BroadCloud migration, the following actions will be blocked:

• CAP Portal – Adding users or ported devices.
• SP Portal – Creating ADD orders with devices or numbers.
• RSB API – Creating ADD orders with devices or numbers and creating users. RSB ADD orders made with devices or numbers will be rejected.

For BroadCloud

For BroadCloud partners, use the Service Provider portal to submit a migration request for numbers, devices, and Shared Call Appearances (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 Network Server Sync feature allows administrators to deactivate the broadCloud location and activate the Webex Calling location on setting the USE_NS_SYNC=yes in the conf/partner.cfg. After migration, devices and phone numbers are activated in Webex Calling location.

Administrators can enable automated rollback by setting ROLLBACK_TO_BROADCLOUD=true in the conf/partner.cfg file, which moves devices back to BroadCloud after migration. It supports both same- and different-region migrations with NS Sync, but only for successful migrations. For failed ones, administrators must raise a Cisco TAC before requesting rollback.

There are two options available for selecting the migration type in the portal:

• Migration – Select this option to initiate a request for migrating numbers, devices, and Shared Call Appearances (SCA).
• Device Status – Select this option to view the current status of a device on BroadCloud and Calling.

The following figures show the Service Provider portal.

Figure 12 : Service Provider portal

Figure 13 : Service Provider portal

Migrate selected locations (optional)

To start the migration for a specific subset of locations listed in the customer.json file, include a locations.csv file with your request. This CSV should list only the locations you intend to migrate.

To download the list of available active sites navigate to View Customers → Select a Customer → Export Locations as CSV.

Figure 14 : Export Locations as CSV

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.

Prérequis

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=
 ./devicemove.sh -input=/tmp/customername.json
 For device move multiple customers:
./devicemove.sh -input=
 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=  -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

Sortie

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 : Statut du périphérique

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=  -revertProfiles

Revert numbers

./devicemove.sh -input=  -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