Skip to main content

Ejecutar la herramienta Preparación de migración

Importante

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

Antes de comenzar

La herramienta de preparación para migración crea una copia por etapas de los datos de los flujos de trabajo almacenados en tu base de datos. Durante este proceso, la herramienta de preparación para migración te dará una estimación del espacio necesario para continuar. No continúes, a menos que tengas suficiente espacio disponible.

Aviso

Debes verificar manualmente que tienes suficiente espacio disponible para completar este proceso. La herramienta de preparación para migración no puede verificar el espacio disponible.

Paso 1: Instalar la herramienta Preparación de migración

  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.

Paso 2: Iniciar la herramienta Preparación de migración

  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

Paso

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.

Resolución de problemas

Si se produce un error durante la migración, el error se muestra en la consola y también se captura en el archivo log.

Si se produce un error, sigue estos pasos:

  1. Realiza una captura de pantalla del símbolo del sistema.

  2. Oculta o quita cualquier dato confidencial.

  3. Captura el archivo log (consulta los pasos de validación para conocer la ubicación y el nombre).

  4. Vuelve a ejecutar la migración.

  5. Si la migración vuelve a fallar, comunícate con el equipo de soporte e incluye la captura de pantalla y el archivo log en el informe.

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.

Paso 3: Actualizar a Server 2024.1

Importante

  • Antes de actualizar, haz una copia de seguridad de tu MongoDB y de RuntimeSettings.xml . El cifrado realizado durante la ventana de mantenimiento no es reversible. La copia de seguridad protege tu instalación de la pérdida de datos o de tiempos de inactividad adicionales.

  • El progreso de la migración no es visible durante la actualización de la versión 2024.1.

  • Para obtener más información acerca de la actualización, ve a Instalar o actualizar 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.

Resolución de problemas

Si el servicio se apaga después de cierto tiempo, comprueba los siguientes logs para ver si hay errores de migración:

  • LastStartupError.txt

  • AlteryxServiceMigrator_#.log creado con la herramienta de preparación para migración

  • AlteryxServiceMigrator_#.log creado durante el inicio del servicio

Si se encontraron errores de migración, intenta reiniciar AlteryxService. Después de intentar reiniciar AlteryxService puede que se resuelva el problema. Si el problema continúa, recopila los archivos log y comunícate con el Servicio de asistencia al cliente para obtener ayuda. Según los errores, es posible que se resuelva el problema si se intenta reiniciar AlteryxService, ya que se volverán a intentar los pasos de migración incompletos.

Paso 4: Validar el éxito de la migración

Para validar que la herramienta de preparación para migración se ha completado correctamente, sigue cualquiera de las siguientes opciones.

Validar el registro de la herramienta de preparación para migración

  1. Navega hasta C:\ProgramData\Alteryx\Service\ .

  2. Abre AlteryxServiceMigrator_#.log .

  3. Revisa el log para ver si hay mensajes de error o falla. Busca el estado tres que aparece como ' ;3; ' en el log.

Validar el registro de inicio del servicio

  1. Ve a la carpeta de registro establecida mediante Configuración del sistema de Alteryx > Controlador > General > Registro .

  2. Abre AlteryxServiceMigrator_#.log.

  3. Revisa el log para ver si hay mensajes de error o falla. Busca el estado tres que aparece como ' ;3; ' en el log.

Validación tras la actualización a 2024.1 (después de la migración final)

  1. Inicia sesión en Server a través del URI web.

  2. Verifica lo siguiente:

    • Puedes ejecutar manualmente flujos de trabajo y aplicaciones.

    • Las programaciones están activas y funcionan con los resultados esperados.

    • Puedes ver, editar, crear y utilizar credenciales de flujos de trabajo.

    • Puedes ver, editar, crear y utilizar conexiones de datos de Server.

    • Recupera un paquete de flujo de trabajo de la API, importa dicho paquete a Alteryx Designer y ejecuta el flujo de trabajo en Designer.

En esta sección: