Skip to main content

Esecuzione dello strumento Preparazione alla migrazione

Importante

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

Prima di iniziare

Lo strumento Preparazione alla migrazione crea una copia in fasi dei dati del flusso di lavoro memorizzati nel database. Durante questo processo, lo strumento Preparazione alla migrazione fornirà una stima dello spazio necessario per procedere. Continua solo se disponi di spazio sufficiente.

Avvertimento

È necessario verificare manualmente che lo spazio disponibile sia sufficiente per completare il processo. Lo strumento Preparazione alla migrazione non è in grado di verificare lo spazio disponibile.

Passaggio 1: installazione dello strumento Preparazione alla migrazione

  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.

Passaggio 2: avvio dello strumento Preparazione alla migrazione

  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

Passaggio

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.

Risoluzione dei problemi

Se si verifica un errore durante la migrazione, questo viene visualizzato nella console e acquisito nel file di log.

In caso di errore, attieniti alla procedura di seguito:

  1. Acquisisci uno screenshot del prompt dei comandi.

  2. Oscura o rimuovi i dati sensibili.

  3. Acquisisci il log (consulta la procedura di convalida per la posizione e la denominazione).

  4. Esegui nuovamente la migrazione.

  5. Se la migrazione ha di nuovo esito negativo, contatta l'assistenza e includi lo screenshot e il file di log nel report.

Nota

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.

Passaggio 3: aggiornamento a Server 2024.1

Importante

  • Prima di eseguire l'aggiornamento, crea una copia di backup del database Mongo e del file RuntimeSettings.xml . La crittografia eseguita durante la finestra di manutenzione non è reversibile. Il backup protegge l'installazione da perdite di dati o tempi di inattività aggiuntivi.

  • Lo stato della migrazione non è visibile durante l'aggiornamento alla versione 2024.1.

  • Per ulteriori informazioni sull'aggiornamento, consulta Installazione o aggiornamento di 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.

Risoluzione dei problemi

Se il servizio si arresta dopo un certo periodo di tempo, controlla la presenza di errori di migrazione nei seguenti log.

  • LastStartupError.txt

  • AlteryxServiceMigrator_#.log creato dallo strumento Preparazione alla migrazione

  • AlteryxServiceMigrator_#.log creato durante l'avvio del servizio

Se riscontri errori di migrazione, prova a riavviare AlteryxService. Il riavvio di AlteryxService potrebbe risolvere il problema. Se il problema persiste, raccogli i log e contatta l'assistenza clienti. A seconda degli errori, il riavvio di AlteryxService potrebbe essere risolutivo, poiché tenterà di eseguire di nuovo eventuali passaggi di migrazione incompleti.

Passaggio 4: convalida della migrazione

Per confermare l'esecuzione dello strumento Preparazione alla migrazione, procedi in uno dei seguenti modi.

Convalida il log dello strumento Preparazione alla migrazione

  1. Vai a C:\ProgramData\Alteryx\Service\ .

  2. Apri AlteryxServiceMigrator_#.log .

  3. Verifica l'eventuale presenza di messaggi di errore nel log. Cerca lo stato 3 visualizzato come " ;3; " nel log.

Convalida il log di avvio del servizio

  1. Accedi alla cartella di registrazione configurata in Alteryx System Settings > Controller > Generale > Registrazione .

  2. Apri AlteryxServiceMigrator_#.log.

  3. Verifica l'eventuale presenza di messaggi di errore nel log. Cerca lo stato 3 visualizzato come " ;3; " nel log.

Convalida dopo l'aggiornamento alla versione 2024.1 (in seguito alla migrazione finale)

  1. Accedi a Server tramite l'URI Web.

  2. Verifica quanto segue:

    • Puoi eseguire manualmente flussi di lavoro e app.

    • Le pianificazioni sono attive e in esecuzione e producono i risultati previsti.

    • Puoi visualizzare, modificare, creare e utilizzare le credenziali del flusso di lavoro.

    • Puoi visualizzare, modificare, creare e utilizzare connessioni dati di Server.

    • Recupera un pacchetto del flusso di lavoro dall'API, importalo in Designer ed esegui il flusso di lavoro in Designer.