Skip to main content

Guide de récupération de l'hôte de Server

Ce guide est destiné aux administrateurs Server pour la récupération d'une instance Server en cas de défaillance d'un ou plusieurs hôtes d'origine lors du passage à une nouvelle instance Server mise à niveau, du passage d'une instance Server locale à un serveur cloud et dans d'autres situations de changement de votre infrastructure.

  • Failure of the original host*

  • Migration to a new Server machine

  • Transition from an on-premises to a cloud Server

  • Other infrastructure changes

La récupération de Server vous permet d'exécuter une nouvelle instance de Server avec vos utilisateurs, workflows, planifications, etc. d'origine. Pour cela, vous devez disposer des éléments suivants de votre Server d'origine :

  • Jeton de contrôleur

  • Fichier RuntimeSettings.xml depuis le nœud du contrôleur

  • Sauvegarde MongoDB

* To fully recover a Server instance in a disaster recovery scenario where the original host is no longer accessible, the RuntimeSettings.xml must be prepared in advance, while the original host is in a fully functioning state. For more details refer to the Disaster Recovery Preparation help page.

Vous trouverez ci-dessous les détails de chaque étape du processus :

1 - Préparation

2 - Install Alteryx Server

2 - Récupération du fichier RuntimeSettings.xml

3 - Récupération de MongoDB

4 - Restauration d'autres fichiers et paramètres

5 - Lancement d'Alteryx Server

6 - Test

Champ d'application

  • Récupération à la suite de l'échec d'une installation unique et par défaut de Server en utilisant MongoDB intégré.

  • Sauvegarde disponible avec les informations nécessaires intactes.

  • Les machines cibles peuvent être écrasées.

Hors champ d'application

  • Environnement Server à plusieurs nœuds ou MongoDB ou SQL Server géré par l'utilisateur. Contactez le service clientèle pour obtenir de l'aide.

  • Sauvegarde ou restauration des pilotes ODBC.

  • Sauvegarde ou restauration des DSN utilisateur ou système.

  • Sauvegarde ou restauration d'autres alias stockés dans Windows qui existent en dehors d'Alteryx.

Prerequisites

  • Version Compatibility:

Original Host

Compatible Target Hosts

2021.4.2.47792 (Patch 5) or newer patch

2021.4.2.47884 (Patch 11) or newer patch of 2021.4 version

2022.1.1.42590 (Patch 3) or newer patch

2022.1.1.42691 (Patch 9) or newer patch of 2022.1 version

2022.3.1.430 (Server GA) or newer patch

2022.3.1.553 (Patch 6) or newer patch of 2022.3 version

2023.1.1.123 (Server GA) or newer patch

2023.1.1.247 (Patch 2) or newer patch of 2023.1 version

All newer and future versions of Alteryx Server

Any GA or patch release as long as the original host and target host are on the same version and patch.

  • Install all database drivers and necessary software for workflow operation before completing the steps outlined in this guide to ensure minimal downtime.

  • Administrator rights on the target host.

  • Access to all credentials used for impersonation including, the service account (if not Local System), the Run As user, and any defined/used workflow credentials.

  • Controller Token from the original host.

  • A direct line of sight is needed to restore your encryption key as part of the recovery. Your new Server will need access to the AlteryxService running on your original Server Controller node over your network. Contact Customer Support if you are unable to meet this prerequisite.

  • Backup of MongoDB from the original host. Learn how to perform a backup.

    For more information on Server Backup & Recovery, please see the Server Backup & Restore Best Practices: Part 1 and Part 2.

  • Verify the target host is set to the same time zone as the original host in Windows time zone settings. If not set to the same time zone, errors might occur in schedule views.

Hors champ d'application

The following items might not have been leveraged in the original Server. Check if the functionality is being used on your original Server and if so, complete the corresponding steps marked (Optional) in this guide.

  • Environnement Server à plusieurs nœuds ou MongoDB ou SQL Server géré par l'utilisateur. Contactez le service clientèle pour obtenir de l'aide.

  • Fusion de bases de données de fichiers de connexion.

    • Domain

    • Username

    • Password

  • Sauvegarde ou restauration des pilotes ODBC.

  • Sauvegarde ou restauration des DSN utilisateur ou système.

  • Sauvegarde ou restauration d'autres alias stockés dans Windows qui existent en dehors d'Alteryx.

    • System In-DB Data Connections see %ProgramData%\Alteryx\Engine\SystemConnections.xml

    • System Data Connections see%ProgramData%\Alteryx\Engine\SystemAlias.xml

  • Alteryx User-Based and In-DB Connection Aliases from the original Server – the below might be relevant for each run-as or workflow credential user account

    • User Data Connections see C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserConnections.xml

    • User In-DB Data Connections see C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserAlias.xml

  • Alteryx Predictive Tools and any R libraries used by workflows in the original Server.

    Predictive Tools should be installed as part of the initial Alteryx Server installation (Step 2) to ensure proper version is installed.

Étape 1 : préparation

#

Étape

Détails

1.1

Définir le fuseau horaire de la machine

Le fuseau horaire Windows de la nouvelle machine doit correspondre à celui de la machine d'origine.

1.2

Assurer l'accès à Alteryx

Assurez-vous que la machine peut contacter whitelist.alteryx.com, utilisé par le système de licences Alteryx.

Step 2: Install Alteryx Server

#

Step

Details

2.1

Is the version of Alteryx Server on your original host any of the following versions?

  • 2022.1.1.40869 (Patch 2) or any earlier patch

  • 2021.4.2.47792 (Patch 4) or any earlier patch

  • 2021.3 and all earlier versions

YES: Install or upgrade the target host to the exact same major and patch version that exists on the original host. Use the full install file opposed to the patch install.

If needed, please contact fulfillment@alteryx.com to request the needed install file.

Go to step 2.4.

NO: Continue to step 2.2.

2.2

Is the version of Alteryx Server on your original host listed in the Compatible Target Hosts columns of the Version Compatibility table in the Prerequisites section?

YES: Install or upgrade the target host to the exact same major and patch version that exists on the original host. Use the full install file opposed to the patch install.

If needed, please contact fulfillment@alteryx.com to request the needed install file.

Go to step 2.4.

NO: Continue to step 2.3.

2.3

Install the newest patch version of Alteryx Server on target host

Install or upgrade the target host to the newest patch available for the major version the original host is on (for example, if original host is on 2022.3 Patch 3, install the newest patch of 2022.3 on the target host).

2.4

Configure Alteryx Server

Configure Alteryx Server using default settings and confirm the Server UI appears in a browser.  You do not need to log in.

2.5

Troubleshoot

License key "in use" error

If your license key is still tied to your old server, you will need to deactivate it on that machine. If that machine is inaccessible, contact your License Administrator to release the license.

Étape 2 : récupération du fichier RuntimeSettings.xml

#

Étape

Détails

3.1

Ouvrir l'invite de commande 1 dans le dossier « bin »

Ouvrez une invite de commande en tant qu'administrateur et accédez au dossier Alteryx\bin, saisissez les commandes ci-dessous (à ajuster en fonction de votre emplacement d'installation).

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

3.2

Arrêter le service

Saisissez la commande

net stop alteryxservice

En cas de succès, vous devriez voir le message « The AlteryxService service was stopped successfully. »

3.3

Sauvegarder le fichier RuntimeSettings.xml existant

Saisissez la commande

c: cd \ProgramData\Alteryx ren RuntimeSettings.xml RuntimeSettings_BACKUP.xml

c: cd \ProgramData\Alteryx ren RuntimeSettings.xml RuntimeSettings_BACKUP.xml

3.4

Restaurer le fichier RuntimeSettings.xml

YES: Your RuntimeSettings.xml from the Disaster Recovery Process should already be located in your target host’s %ProgramData%\Alteryx\ directory. If not, copy the prepared RuntimeSettings.xml to %ProgramData%\Alteryx\.

Go to step 3.13.

Copiez le fichier RuntimeSettings.xml depuis votre Server d'origine dans le répertoire %ProgramData%\Alteryx\.

Continue to step 3.5.

3.5

Effacer le jeton contrôleur

Modifiez le fichier RuntimeSettings.xml que vous venez de copier et supprimez tout ce qui se trouve entre les balises <ServerSecretEncrypted>, en ne laissant que les balises comme indiqué ci-dessous :

64ae505fe2c2c.png

Enregistrez et fermez le fichier.

3.6

Restaurer le jeton contrôleur

Saisissez la commande à l'aide du jeton contrôleur de votre Server d'origine.

AlteryxService.exe setserversecret=CONTROLLER_TOKEN_FROM_ORIGINAL_SERVER

Dépannage :

La version 2021.3+ peut produire une erreur à cette étape : « Set server secret failed: Error in CryptImportKey(3): Bad Data. (-2146893819) ». Pour corriger ce problème, reportez-vous à l'étape précédente pour vous assurer que la valeur a bien été retirée entre les balises.

3.7

Restaurer les clés de stockage chiffrées

La valeur <StorageKeysEncrypted> a peut-être changé lorsque le jeton contrôleur a été réinitialisé à l'étape 2.6. Si c'est le cas, elle doit être remplacée par la valeur correspondante du fichier RuntimeSettings.xml d'origine, c'est-à-dire le fichier RuntimeSettings_BACKUP.xml créé précédemment à l'étape 2.3. Il est également plus facile de copier les balises pour s'assurer que la valeur entière entre elles est copiée à partir du fichier RuntimeSettings.xml d'origine. Vous pouvez laisser RuntimeSettings.xml ouvert dans un éditeur de texte lorsque vous apportez d'autres modifications à l'étape 3.

Step 2.7 Restore Encryption Keys

3.8

Restaurer la fonction Exécuter en tant qu'utilisateur

Si vous disposiez de la fonction Exécuter en tant qu'utilisateur sur le Server d'origine, saisissez la commande ci-après. Sinon, ignorez cette étape.AlteryxService.exe setexecuteuser=NAME,DOMAIN,PASSWORD

3.9

Restaurer le mot de passe SMTP

Si vous avez renseigné Paramètres système Alteryx > Server UI (Interface utilisateur Server) > SMTP > Password (Mot de passe) (même si la case à cocher SMTP n'a pas été cochée), saisissez la commande suivante. Sinon, ignorez cette étape.AlteryxService.exe setsmtppassword=PASSWORD

3.10

Enregistrer RuntimeSettings.xml

Enregistrez le fichier RuntimeSettings.xml.

3.11

Is the version of Alteryx Server on your original host any of the following versions?

  • 2022.1.1.40869 (Patch 2) or any earlier patch

  • 2021.4.2.47792 (Patch 4) or any earlier patch

  • 2021.3 and all earlier versions

YES: Go to step 3.13.

NO: Continue to step 3.12.

3.12

Transférer la clé de chiffrement

Cette fonctionnalité n'est disponible que dans les versions suivantes :

  • 2021.4.2 Correctif 11+

  • 2022.1 Correctif 9+

  • 2022.3 Correctif 6+

  • 2023.1 Correctif 2+

  • 2023.2 GA+

Important: Please note that this requires the AlteryxService to be running on your original host and your target host will need to be able to access it over the network.

Les étapes décrites dans la section Processus de transfert de la clé de chiffrement vous permettent de transférer la clé de chiffrement de votre contrôleur existant vers votre nouveau contrôleur.

3.13

Rester sur la ligne de commande

Pour l'étape 3, vous devez vous trouver dans une ligne de commande Administrateur dans le dossier \Alteryx\bin.

Étape 3 : récupération de MongoDB

#

Étape

4.1

Obtenir la sauvegarde MongoDB

Copiez la sauvegarde Mongo du Server d'origine vers un dossier MONGO_BACKUP sur votre nouveau Server.

4.2

Restaurer dans un nouveau dossier

Restaurez la base de données Mongo depuis le dossier de sauvegarde vers un nouveau dossier de restauration. Consultez le fichier mongoRestore.log comme décrit ci-dessous pour vérifier que la restauration s'est correctement effectuée.

Reportez-vous à la section Effectuer une restauration à partir d'une sauvegarde MongoDB dans le document Sauvegardes MongoDB pour trouver la commande de restauration correspondant à votre version de Server.

4.3

Vérifier que la restauration a réussi

Vérifiez que la restauration a réussi.

Attention

Il s'agit d'une étape nécessaire, car un échec de restauration ne sera pas signalé à l'étape précédente et peut entraîner une perte de données sur votre Server. Pour vérifier la restauration, consultez le fichier mongoRestore.log dans le dossier MongoDB où les données ont été restaurées. Ouvrez le fichier mongoRestore.log et procédez comme suit :

  • Vérifiez que le fichier indique #### document(s) restored successfully, 0 document(s) failed to restore à la dernière ligne.

  • Recherchez les termes error, critical, fatal et failed. Si vous recherchez le terme failed, assurez-vous que le résultat ne correspond pas à la phrase du point précédent, qui contient 0 document(s) failed.

Si la récupération a échoué, ou si vous trouvez des résultats lorsque vous recherchez les mots clés énumérés ci-dessus, veuillez contacter le support avec toutes les informations que vous avez recueillies.

Ne poursuivez pas si la restauration MongoDB a échoué.

4.4

Définir le chemin Mongo dans RuntimeSettings.XML

Modifiez le fichier RuntimeSettings.xml et saisissez le chemin d'accès au dossier MONGO_RESTORE_FOLDER dans la balise <EmbeddedMongoDBRootPath>.

Exemple :

Set Mongo path in RuntimeSettings.XML

Enregistrez et fermez l'éditeur de texte.

4.5

Démarrer MongoDB

Saisissez la commande

mongod ––dbpath "MONGO_RESTORE_FOLDER" ––auth ––port 27018

Exemple

mongod ––dbpath "%ProgramData%\Alteryx\Service\Persistence\Mongo_Restore" ––auth ––port 27018

Ne fermez pas la fenêtre d'invite de commande.

Si vous fermez la fenêtre à partir de l'étape 3.5, aucune des étapes suivantes ne fonctionnera.

<< Début de la section de la deuxième invite de commande >>

4.6

Ouvrir la deuxième invite de commande dans le dossier « bin »

Ouvrez une DEUXIÈME invite de commande en tant qu'administrateur et accédez au dossier Alteryx\bin, saisissez les commandes ci-dessous (à ajuster en fonction de votre emplacement d'installation).

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

4.7

Obtenir le mot de passe Mongo non administrateur

Saisissez la commande et copiez votre MOT DE PASSE MONGO NON ADMINISTRATEUR dans Notepad

AlteryxService.exe getemongopassword

4.8

Démarrer la ligne de commande Mongo

Saisissez la commande

mongosh mongodb://SERVER:PORT/AlteryxGallery -u user -p NON_ADMIN_MONGO_PASSWORD

Exemple

mongosh mongodb://localhost:27018/AlteryxGallery -u user -p CCEC***33C0

En cas de succès, vous devriez voir l'invite « > ».

4.9

Supprimer les verrous définis par le Server d'origine

Saisissez la commande Mongo

db.locks.remove({})

En cas de succès, le message suivant devrait s'afficher : « writeResult({ “nRemoved” : N }) », où N est un nombre compris entre 0 et 3.

4.10

Switch to AlteryxService database

Enter the Mongo command

use AlteryxService

4.11

Delete AlteryxService locks set by original Server

Enter the Mongo command

db.locks.remove({})

On success you should see: "writeResult({ “nRemoved” : N })", where N is a number between 0 and 3.

4.12

Quitter la ligne de commande Mongo et l'invite de commande 2

Saisissez la commande

exit

Fermez Command_Prompt_2

<<Fin de la section de la deuxième invite de commande >>

4.13

Arrêter la base de données Mongo

Dans l'invite de commande d'origine, saisissez la commande clavier

ctrl-c

une ou plusieurs fois jusqu'à ce que vous quittiez MongoDB et reveniez à une invite de commande normale.

Fermez l'invite de commande.

Étape 4 : restauration d'autres fichiers et paramètres

#

Étape

Détails

5.1

Aviez-vous un utilisateur de connexion au service sur le Server d'origine ?

Définissez l'utilisateur de connexion au service sur le nouveau Server.

Application Windows Services > clic droit sur AlteryxService > Propriétés > Connexion

5.2

Ajouter des pilotes de données et des DSN système

Ajoutez des pilotes de même version et des DSN système de même nom pour correspondre au Server d'origine, https://downloads.alteryx.com/.

Problèmes avancés qui peuvent ne pas s'appliquer à votre récupération :

5.3

Dans des environnements plus sécurisés, configurez les autorisations Exécuter en tant qu'utilisateur requises.

Toutes les informations d'identification utilisées pour exécuter les workflows (Exécuter en tant que, Connexion au service ou l'ensemble d'informations d'identification lors de l'enregistrement du workflow) doivent disposer d'un accès suffisant. Configurer les autorisations d'exécution utilisateur requises.

5.4

Restaurer les alias de connexion basés sur le système et en base de données

Connexion aux données système :

%ProgramData%\Alteryx\Engine\SystemAlias.xml

Connexion aux données en base de donnée système :

%ProgramData%\Alteryx\Engine\SystemConnections.xml

5.5

Restaurer les alias de connexion basés sur l'utilisateur et en base de données

Connexion aux données utilisateur :

C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserConnections.xml

Connexion aux données utilisateur en base de données :

C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserAlias.xml

5.6

Les workflows utilisent-ils des connecteurs ?

Copiez les dossiers de connecteurs de votre Server d'origine vers

%ProgramData%\Alteryx\Tools

Contactez le service clientèle pour activer les connecteurs sur votre nouveau Server.

5.7

Les workflows utilisent-ils l'outil Python ?

Réinstallez tous les packages Python que les workflows avaient installés. Voir Server Upgrade Python Tool Environment Checklist.

5.8

Utilisez-vous SSL ?

Si vous effectuez une récupération vers un Server Sandbox pour des tests, utilisez HTTP pour les tests.

Si vous migrez vers un nouveau Server, rétablissez votre SSL :

Configurer SSL/TLS pour Server

Configuration d'Alteryx Server pour SSL : obtention et installation de certificats (15577)

Étape 5 : lancement d'Alteryx Server

#

Étape

Détails

6.1

Vérifier les paramètres système Alteryx et suspendre les Planifications, si souhaitable

Exécutez les paramètres système Alteryx et parcourez chaque page pour vérifier que les paramètres (comme le jeton contrôleur) contiennent les valeurs attendues.

Si vous ne souhaitez pas que les Planifications s'exécutent au démarrage du service, décochez :

Worker > General (Général) > Allow machine to run scheduled Alteryx workflows (Autoriser la machine à exécuter les workflows Alteryx planifiés)

Lorsque vous sélectionnez Finish (Terminer), AlteryxService doit démarrer et le Server doit être disponible dans un navigateur.

Important

Portez une attention particulière aux paramètres de configuration de l'interface utilisateur de Server, car un nouveau Server peut avoir une URL différente ou ne pas avoir de certificat SSL.

System Settings, the Server UI configuration section.

Étape 6 : test

#

Étape

Détails

7.1

Tests de base

AlteryxService est-il en cours d'exécution ?

Pouvez-vous :

  • Accéder à l'URL de l'interface utilisateur Server ?

  • Parcourir les pages Administrateur et afficher les Utilisateurs, les Collections, etc. ?

  • Publier un workflow depuis Designer sur le Server ?

  • Exécuter le workflow ?

  • Si votre configuration le permet, enregistrez et exécutez un workflow en spécifiant vos informations d'identification.

7.2

Tests spécifiques aux workflows

Pouvez-vous exécuter des workflows contenant des extensions ou des connexions externes, telles que :

  • Entrée/sortie vers un chemin UNC réseau

  • Connexions à des bases de données

  • Outils Connecteur

  • Jeux de données d'insights concernant la géolocalisation ou le métier

  • Outil Python

  • Outil R