Skip to main content

Das Migration-Prep-Tool ausführen

Wichtig

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

Bevor Sie beginnen

Das Migration-Prep-Tool erstellt eine gestaffelte Kopie der Workflow-Daten, die in Ihrer Datenbank gespeichert sind. Während dieses Vorgangs zeigt das Migration-Prep-Tool eine Schätzung des Speicherplatzes an, der zum Fortfahren erforderlich ist. Setzen Sie den Prozess erst fort, wenn Sie ausreichend Speicherplatz zur Verfügung haben.

Warnung

Ob das der Fall ist, müssen Sie manuell überprüfen. Eine Überprüfung des verfügbaren Speicherplatzes durch das Migration-Prep-Tool ist nicht möglich.

Schritt 1: Das Migrationstool installieren

  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.

Schritt 2: Das Migrationstool starten

  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

Schritt

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.

Problembehandlung

Wenn während der Migration ein Fehler auftritt, wird er in der Konsole angezeigt und auch in der Protokolldatei erfasst.

Wenn ein Fehler auftritt, gehen Sie wie folgt vor:

  1. Machen Sie einen Screenshot der Eingabeaufforderung.

  2. Machen Sie vertrauliche Daten unkenntlich oder entfernen Sie sie.

  3. Erfassen Sie das Protokoll (siehe Validierungsschritte für Speicherort und Benennung).

  4. Führen Sie die Migration erneut aus.

  5. Wenn die Migration erneut fehlschlägt, wenden Sie sich an den Support und fügen Sie den Screenshot und die Protokolldatei in Ihre Nachricht ein.

Anmerkung

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.

Schritt 3: Upgrade auf Server 2024.1 durchführen

Wichtig

  • Erstellen Sie vor dem Upgrade eine Sicherungskopie Ihrer Mongo-Datenbank und der Datei RuntimeSettings.xml . Die während des Wartungsfensters durchgeführte Verschlüsselung kann nicht rückgängig gemacht werden. Die Sicherungskopie schützt Ihre Installation vor Datenverlust oder zusätzlichen Ausfallzeiten.

  • Während des Upgrades auf 2024.1 wird der Migrationsfortschritt nicht angezeigt.

  • Weitere Informationen zum Upgrade finden Sie unter Server installieren oder aktualisieren .

  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.

Problembehandlung

Wenn der Dienst nach einer gewissen Zeit herunterfährt, überprüfen Sie bitte die folgenden Protokolle auf Migrationsfehler:

  • LastStartupError.txt

  • AlteryxServiceMigrator_#.log erstellt vom Migration-Prep-Tool

  • AlteryxServiceMigrator_#.log erstellt während des Dienststarts

Wenn Migrationsfehler aufgetreten sind, versuchen Sie, den AlteryxService neu zu starten. Dadurch kann das Problem möglicherweise behoben werden. Wenn das Problem dennoch weiterhin besteht, sammeln Sie die Protokolle und wenden Sie sich an den Kundensupport. Abhängig von den Fehlern kann der Versuch, den AlteryxService neu zu starten, das Problem beheben. Denn so werden unvollständige Migrationsschritte in einem erneuten Versuch durchgeführt.

Schritt 4: Erfolgreiche Migration validieren

Um zu überprüfen, ob das Migration-Prep-Tool erfolgreich ausgeführt wurde, können Sie die folgenden Optionen nutzen.

Migration-Prep-Tool-Protokoll validieren

  1. Navigieren Sie zu C:\ProgramData\Alteryx\Service\ .

  2. Öffnen Sie AlteryxServiceMigrator_#.log .

  3. Prüfen Sie das Protokoll auf Fehlermeldungen oder Meldungen über ein Fehlschlagen. Suchen Sie nach Status 3, der im Protokoll als „ ;3; “ angezeigt wird.

Dienststart-Protokoll validieren

  1. Navigieren Sie zum Protokollordner, der von Alteryx Systemeinstellungen > Controller > Allgemein > Protokollierung festgelegt wurde.

  2. Öffnen Sie AlteryxServiceMigrator_#.log .

  3. Prüfen Sie das Protokoll auf Fehlermeldungen oder Meldungen über ein Fehlschlagen. Suchen Sie nach Status 3, der im Protokoll als „ ;3; “ angezeigt wird.

Validierung nach Upgrade auf 2024.1 (nach der endgültigen Migration)

  1. Melden Sie sich über die Web-URL bei Server an.

  2. Überprüfen Sie Folgendes:

    • Sie können Workflows und Apps manuell ausführen.

    • Zeitpläne sind aktiv und werden mit den erwarteten Ergebnissen ausgeführt.

    • Sie können Workflow-Anmeldedaten anzeigen, bearbeiten, erstellen und verwenden.

    • Sie können Server-Datenverbindungen anzeigen, bearbeiten, erstellen und verwenden.

    • Rufen Sie ein Workflow-Paket von der API ab, importieren Sie dieses Paket in Designer und führen Sie den Workflow in Designer aus.

In diesem Abschnitt: