Skip to main content

Exécuter l'outil Préparation à la migration

Important

Only use this tool to migrate from Server version 2022.2 or earlier. The encryption mechanism was updated in the 2022.3 version.

Avant de commencer

L'outil Préparation à la migration crée une copie incrémentielle des données de workflow stockées dans votre base de données. Au cours de ce processus, l'outil vous fournira une estimation de l'espace requis pour continuer. Ne poursuivez pas si vous ne disposez pas de l'espace suffisant.

Avertissement

Vous devez vérifier manuellement que vous disposez de suffisamment d'espace pour effectuer ce processus. L'outil Préparation à la migration ne peut pas vérifier l'espace disponible.

Étape 1 : installer l'outil Préparation à la migration

  1. Download the installer from downloads.alteryx.com and run it.

  2. Accept the EULA. Select Next.

  3. To change the installation location, select Change. Or select Next to accept the default location.

  4. Follow the prompts to complete the installation.

Étape 2 : démarrer l'outil Préparation à la migration

  1. Open a Command Prompt or PowerShell.

  2. Navigate to the chosen installation path (Default: C:\Program Files\Alteryx Migration Tool\).

  3. Run one of the commands to run the Migration Prep Tool. Note: If you use PowerShell, add .\ to the start of each command. You can run this operation on any host that has access to the MongoDB server. You can safely run it multiple times without downtime.

    For multi-node setup, the IP Address/Hostname, Controller Token and NON_ADMIN_MONGO_PASSWORD should be of the machine where controller node is running according to the configuration done during the multi-node setup.

    For single node, the details should be of the same machine where Alteryx Server is installed.

How to use the examples:

Replace these variables in the connection string with the values appropriate for your environment. These are the same credentials used to configure your Server database and can be found in Alteryx System Settings.

  • {authenticationDB} = the database that will authenticate the specified user credential.

    • If your Server is configured to use the embedded MongoDB, use the non-admin MongoDB password. In the connection string, your authSource should be ‘AlteryxService’.

    • For user-managed MongoDB, contact your MongoDB administrator to confirm the user credentials and authSource.

  • {port} = the service port MongoDB uses to provide access to the database.

  • {host.domain.tld} = the fully qualified domain name of your MongoDB server.

  • {password} = credential for the user.

  • {user} = username to access the database.

  • {atlasCluster.cloudProvider.mongodb.net} = the MongoDB Atlas cluster address.

Database

Étape

Embedded MongoDB

Note: NON_ADMIN_MONGO_PASSWORD',’CONTROLLER_TOKEN’ and 'localhost' should be changed based on your current setup.

Both App Chunk and RunAS_Credentials Migration

AlteryxServiceMigrator22_2.exe -p -c "mongodb://user:NON_ADMIN_MONGO_PASSWORD@localhost:27018/AlteryxService?authSource=AlteryxService" -i <host/IP_Address> -t <Controller_Token>

App Chunk Migration Only

AlteryxServiceMigrator22_2.exe --appsonly -c "mongodb://user:NON_ADMIN_MONGO_PASSWORD@localhost:27018/AlteryxService?authSource=AlteryxService" -i <host/IP_Address> -t <Controller_Token>

RunAs_Credential Migration Only

AlteryxServiceMigrator22_2.exe --credonly -c "mongodb://user:NON_ADMIN_MONGO_PASSWORD@localhost:27018/AlteryxService?authSource=AlteryxService" -i <host/IP_Address> -t <Controller_Token>

User-Managed MongoDB

Note: ‘Password’, ‘port’, ‘host.domain.tld’ and ‘authenticationDB’ should be changed based on your current MongoDB instance.

Both App chunk and RunAS_Credentials Migration

AlteryxServiceMigrator22_2.exe -p -c "mongodb://user:password@{host.domain.tld}:{port}/AlteryxService?authSource={authenticationDB} -i <host/IP_Address> -t <Controller_Token>

App Chunk Migration Only

AlteryxServiceMigrator22_2.exe --appsonly -c "mongodb://user:password@{host.domain.tld}:{port}/AlteryxService?authSource={authenticationDB} -i <host/IP_Address> -t <Controller_Token>

RunAs_Credential Migration Only

AlteryxServiceMigrator22_2.exe --credonly -c "mongodb://user:password@{host.domain.tld}:{port}/AlteryxService?authSource={authenticationDB} -i <host/IP_Address> -t <Controller_Token>

MongoDB Replica Sets

Both App Chunk and RunAS_Credentials Migration

AlteryxServiceMigrator22_2.exe -p -c "mongodb://{user}:{password}@{host1.domain.tld}:{port},{host2.domain.tld}:{port},{host3.domain.tld}:{port}/AlteryxService?authSource={authenticationDB}" -i <host/IP_Address> -t <Controller_Token>

App Chunk Migration Only

AlteryxServiceMigrator22_2.exe –-appsonly -c "mongodb://{user}:{password}@{host1.domain.tld}:{port},{host2.domain.tld}:{port},{host3.domain.tld}:{port}/AlteryxService?authSource={authenticationDB}" -i <host/IP_Address> -t <Controller_Token>

RunAs_Credential Migration Only

AlteryxServiceMigrator22_2.exe --credonly -c "mongodb://{user}:{password}@{host1.domain.tld}:{port},{host2.domain.tld}:{port},{host3.domain.tld}:{port}/AlteryxService?authSource={authenticationDB}" -i <host/IP_Address> -t <Controller_Token>

MongoDB Atlas

Both App Chunk and RunAS_Credentials Migration

AlteryxServiceMigrator22_2.exe -p -c "mongodb+srv://{user}:{password}@{atlasCluster.cloudProvider.mongodb.net}/AlteryxService?retryWrites=true&w=majority" -i <host/IP_Address> -t <Controller_Token>

App Chunk Migration Only

AlteryxServiceMigrator22_2.exe –-appsonly -c "mongodb+srv://{user}:{password}@{atlasCluster.cloudProvider.mongodb.net}/AlteryxService?retryWrites=true&w=majority" -i <host/IP_Address> -t <Controller_Token>

RunAs_Credential Migration Only

AlteryxServiceMigrator22_2.exe --credonly -c "mongodb+srv://{user}:{password}@{atlasCluster.cloudProvider.mongodb.net}/AlteryxService?retryWrites=true&w=majority" -i <host/IP_Address> -t <Controller_Token>

Command Parameters

  • -h [ --help ] display help info

  • -q [ --quiet ] output log messages to the command line (progress messages ignore this flag)

  • -s [ --severity ] arg (=7) console logging severity level (migration progress reports are sent at level 5)

  • -p [ --perform ] perform migration

  • --appsonly perform chunk migration only, with no preflight check

  • --credonly perform preflight check with no chunk migration

  • -u [ --forcenoprogressupdates ] disable progress update messages from being written to the console (they are still written to the log file)

  • -c [ --connection ] arg connection string (AlteryxService database must be specified)

  • -i [ --hostname ] arg   HostName|ip Address of Controller

  •  -t [ --controllertoken ] arg   Controller Token to retrieve the Keys

  • -l [ --loggingpath ] arg (=C:\ProgramData\Alteryx) logging file path, must contain a %N for log rotation purposes

  • --loggingmaxfilesize arg (=64) maximum size in MB for a log file before it gets rotated

  • -d [ --stagingdirectory ] arg directory where decrypted workflows will be temporarily stored before getting re-encrypted

What Happens Next?

  • When the migration starts, it will prompt you to confirm you have made a backup of the database and your runtime settings file. 

  • Once you confirm the backups, the utility checks the current space usage. It gives you an estimate of the additional space needed for the migration. You must check your system and continue only if you are sure that you have sufficient free space available to proceed.

  • After you have confirmed that there is sufficient space available, the utility begins migrating the workflow data. You will see console messages indicating the start time and completion time, along with progress messages.

Résolution des problèmes

Si une erreur se produit pendant la migration, elle s'affiche dans la console et est également enregistrée dans le fichier journal.

Si vous rencontrez une erreur, procédez comme suit :

  1. Faites une capture d'écran de l'invite de commande.

  2. Masquez ou supprimez les données sensibles.

  3. Capturez le journal (voir les étapes de validation pour l'emplacement et le nom).

  4. Exécutez à nouveau la migration.

  5. Si la migration échoue à nouveau, contactez le support et incluez la capture d'écran et le fichier journal dans votre rapport.

Note

If the error Error during key initialization <Error importing keys to Microsoft\Crypto\RSA\MachineKeys\ directory in ProgramData: Access is denied. (5)> RunAS Migration failed occurs while running the migration command, navigate to C:\ProgramData\Microsoft\Crypto\RSA\MachineKeys. Then right-click on the MachineKeys folder and select Share with specific people. Select Everyone with Read/Write access. Then select Share.

Étape 3 : effectuer la mise à niveau vers Server 2024.1

Important

  • Avant de procéder à la mise à niveau, faites une copie de sauvegarde de votre base de données Mongo et du fichier RuntimeSettings.xml . Le chiffrement effectué pendant la fenêtre de maintenance est irréversible. La sauvegarde protège votre installation contre la perte de données ou les temps d'arrêt supplémentaires.

  • La progression de la migration n'est pas visible pendant la mise à niveau vers la version 2024.1.

  • Pour plus d'informations sur la mise à niveau, consultez la page  Installation ou mise à niveau de Server .

  1. Download Server 2024.1 from downloads.alteryx.com.

  2. Run the installer. Select Yes to continue the upgrade.

  3. Accept the License Agreement.

  4. Choose your installation path or accept the default path. Then select Next.

  5. Select Install to start the installation (upgrade).

  6. When installation is complete, select Configure Server Now, then select Finish.

  7. After the installation of Server 2024.1 is complete, select the Begin Backup and Migration option.

  8. After successful migration, select OK.

Note: After installation, there might be a delay in starting the service.

Next Steps After Installation

Alteryx System Settings opens. Navigate through System Settings to check that your settings are correct. Then select Finish and Done to start the service.

Once the service starts, Server enters maintenance mode to migrate RuntimeSettings and the database values that could not be migrated beforehand. During the maintenance mode, your Server instance will be unavailable.

The Migration Prep tool does a final check for database changes since the last run. Then it performs the migration (including any newfound changes) and moves the staged migration into use.

This final migration might take several hours. The time depends on the size of your configuration and if the Migration Prep Tool was run before the upgrade. Once this process is complete, Server will exit the maintenance mode and enter a functional state.

Résolution des problèmes

Si le service s'arrête au bout d'un certain temps, vérifiez les erreurs de migration dans les journaux suivants :

  • LastStartupError.txt

  • Journal AlteryxServiceMigrator_#.log créé par l'outil Préparation à la migration

  • Journal AlteryxServiceMigrator_#.log créé lors du démarrage du service

Si des erreurs de migration se sont produites, essayez de redémarrer AlteryxService. Une tentative de redémarrage d'AlteryxService peut résoudre le problème. Si le problème persiste, récupérez les journaux et contactez le service clientèle pour obtenir de l'aide. En fonction des erreurs, une tentative de redémarrage d'AlteryxService peut résoudre le problème, car il va réessayer d'effectuer toutes les étapes de migration incomplètes.

Étape 4 : valider la réussite de la migration

Pour vérifier que l'outil Préparation à la migration a été correctement exécuté, suivez l'une des options suivantes.

Valider le journal de l'outil Préparation à la migration

  1. Accédez à C:\ProgramData\Alteryx\Service\ .

  2. Ouvrez le journal AlteryxServiceMigrator_#.log .

  3. Vérifiez s'il contient des messages d'erreur ou d'échec. Rechercher l'état 3 affiché comme ' ;3; ' dans le journal.

Valider le journal de démarrage du service

  1. Accédez au dossier de journalisation défini par Alteryx Paramètres système > Contrôleur > Général > Journalisation .

  2. Ouvrez le journal AlteryxServiceMigrator_#.log .

  3. Vérifiez s'il contient des messages d'erreur ou d'échec. Rechercher l'état 3 affiché comme ' ;3; ' dans le journal.

Validation après la mise à niveau vers la version 2024.1 (après la migration finale)

  1. Connectez-vous à Server via l'URI Web.

  2. Vérifiez les éléments suivants :

    • Vous pouvez exécuter manuellement des workflows et des applications.

    • Les programmes sont actifs et s'exécutent en produisant les résultats attendus.

    • Vous pouvez afficher, modifier, créer et utiliser les informations d'identification du workflow.

    • Vous pouvez afficher, modifier, créer et utiliser les connexions aux données de Server.

    • Récupérez un package de workflow à partir de l'API, importez-le dans Designer et exécutez le workflow dans Designer.

Dans cette section​: