Skip to main content

Serverホスト復元ガイド

このガイドは、新しくアップグレードされたServerに移行する場合、オンプレミスからクラウドサーバーに移行する場合、インフラストラクチャが変更になるその他の場合に、元のホストに障害が発生したとき、Server管理者がServerのインスタンスを復元するための支援を目的としています。

  • Failure of the original host*

  • Migration to a new Server machine

  • Transition from an on-premises to a cloud Server

  • Other infrastructure changes

Serverの復元では、元のServerから次のものを取得することによって、元のユーザー、ワークフロー、スケジュールなどを使って新しいServerを稼働開始できます。

  • Controller Token (コントローラートークン)

  • コントローラーノードのRuntimeSettings.xml

  • 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.

この手続きの各ステップの詳細は次のとおりです。

1 - 準備

2 - Install Alteryx Server

2 - RuntimeSettings.xmlの復元

3 - MongoDBの復元

4 - 他のファイルと設定の復元

5 - Alteryx Serverの起動

6 - テスト

このガイドで扱う範囲と前提とする条件

  • 組み込みMongoDBを使用した、既定の単一Serverインストール の障害からの復元。

  • 必要な情報が破損していないバックアップがあること。

  • ターゲットマシンが上書き可能であること。

このガイドで扱わない事項

  • マルチノードServer環境、ユーザー管理MongoDB、またはユーザー管理SQL Serverの場合。カスタマーサポートにお問い合わせください。

  • ODBCドライバーのバックアップまたは復元。

  • ユーザーDSNまたはシステムDSNのバックアップまたは復元。

  • AlteryxではなくWindowsに保存されている他のエイリアスのバックアップまたは復元。

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.

このガイドで扱わない事項

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.

  • マルチノードServer環境、ユーザー管理MongoDB、またはユーザー管理SQL Serverの場合。カスタマーサポートにお問い合わせください。

  • 接続ファイルのデータベースのマージ。

    • Domain

    • Username

    • Password

  • ODBCドライバーのバックアップまたは復元。

  • ユーザーDSNまたはシステムDSNのバックアップまたは復元。

  • AlteryxではなくWindowsに保存されている他のエイリアスのバックアップまたは復元。

    • 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.

ステップ1: 準備

#

ステップ

詳細

1.1

マシンのタイムゾーンの設定

新しいマシンのWindowsタイムゾーンは、元のマシンと一致するように設定する必要があります。

1.2

Alteryxへのアクセスを確保する

Alteryxライセンシングシステムが使用する whitelist.alteryx.com にマシンが接続できる必要があります。

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.

ステップ2: RuntimeSettings.xmlの復元

#

ステップ

詳細

3.1

binフォルダーでコマンドプロンプト1を開く

管理者としてコマンドプロンプトを開き、Alteryx\binフォルダーに移動し、以下のコマンドを入力します(インストール場所に応じて調整します)。

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

3.2

サービスの停止

次のコマンドを入力します。

net stop alteryxservice

成功すると、「The AlteryxService service was stopped successfully.」と表示されます。

3.3

既存の RuntimeSettings.xml のバックアップ

次のコマンドを入力します。

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

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

3.4

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.

元のサーバーから現在の%ProgramData%\Alteryx\ディレクトリに RuntimeSettings.xml ファイルをコピーします。

Continue to step 3.5.

3.5

コントローラートークン のクリア

コピーしたRuntimeSettings.xmlを編集し、<ServerSecretEncrypted>タグ間のすべての文字列を削除します。タグは以下のように残します。

64ae505fe2c2c.png

ファイルを保存して閉じます。

3.6

コントローラートークン の復元

元のサーバーコントローラートークンを使用して、次のコマンドを入力します。

AlteryxService.exe setserversecret=CONTROLLER_TOKEN_FROM_ORIGINAL_SERVER

トラブルシューティング:

バージョン2021.3+では、このステップで次のエラーが発生する場合があります: 「サーバーシークレットの設定に失敗しました: CryptImportKey(3)のエラー: 不良なデータ。(-2146893819)」。これを修正するには、前のステップを参照し、タグ間から値が削除されたことを確認します。

3.7

暗号化されたストレージキーの復元

<StorageKeysEncrypted>値は、ステップ2.6でコントローラートークンをリセットした際に変更された可能性があります。その場合、元のRuntimeSettings.xmlファイルの対応する値で置き換える必要があります。つまり、ステップ2.3で作成したRuntimeSettings_BACKUP.xmlファイルです。タグはコピーした方が、元のRuntimeSettings.xmlファイルからタグ間の値全体を確実に簡単にコピーできます。RuntimeSettings.xmlをテキストエディターで開いたままにして、ステップ3 でさらに変更を加えることができます。

Step 2.7 Restore Encryption Keys

3.8

Run Asユーザー の復元

元のServerにRun Asユーザーが存在する場合は、次のコマンドを入力します。存在しない場合は、この手順をスキップします。AlteryxService.exe setexecuteuser=NAME,DOMAIN,PASSWORD

3.9

SMTPパスワード の復元

[Alteryxシステム設定] > [Server UI] > [SMTP ] > [Password]に入力した場合(SMTPチェックボックスがオフになっていても)、次のコマンドを入力します。入力しなかった場合は、この手順をスキップします。AlteryxService.exe setsmtppassword=PASSWORD

3.10

RuntimeSettings.xmlを保存

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

暗号化キーの転送

この機能は、次のバージョンでのみ使用できます。

  • 2021.4.2パッチ11以降

  • 2022.1パッチ9以降

  • 2022.3パッチ6以降

  • 2023.1パッチ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.

暗号化キーの転送プロセス」の手順を使用すると、既存のコントローラーから新しいコントローラーに暗号化キーを転送できます。

3.13

そのままコマンドラインに留まる

ステップ3では、\Alteryx\binフォルダーで管理者コマンドラインが使用されていることを前提にしています。

ステップ3: MongoDBの復元

#

ステップ

4.1

MongoDBバックアップの取得

元のサーバーから新しいサーバーのMONGO_BACKUPフォルダーにMongoバックアップをコピーします。

4.2

新しいフォルダへの復元

バックアップフォルダーから新しい復元フォルダーにMongoデータベースを復元します。以下に示すようにmongoRestore.logを参照して、復元が正常に行われたことを確認します。

使用しているServerのバージョンに適した復元コマンドを見つけるには、MongoDBのバックアップドキュメントの「MongoDBバックアップからの復元」セクションを参照してください。

4.3

正常に復元が完了したことを確認する

正常に復元が完了したことを確認します。

注意

復元が失敗した場合も前の手順では報告されず、Server上でのデータの欠落につながる恐れがあるため、この手順が必要です。これを行うには、データが復元されたMongoDBフォルダーの mongoRestore.log ファイルを確認します。mongoRestore.log を開き、次の手順を実行します。

  • 最後の行に、「#### document(s) restored successfully, 0 document(s) failed to restore (####個のドキュメントを復元、0個のドキュメントの復元に失敗)」と報告されていることを確認します。

  • errorcriticalfatalfailed を検索します。failed を確認する際には、その結果が前の項目で示した「0 document(s) failed」を含む文ではないことを確認してください。

復元に失敗した場合、または上記のキーワードの検索で該当する結果が見つかった場合は、収集したすべての情報を サポートに連絡 してください。

MongoDBの復元が失敗した場合は、続行しないでください。

4.4

RuntimeSettings.XMLでMongoパスを設定

RuntimeSettings.xmlを編集し、<EmbeddedMongoDBRootPath>タグにMONGO_RESTORE_FOLDERへのパスを入力します。

例:

Set Mongo path in RuntimeSettings.XML

保存してテキストエディターを閉じます。

4.5

MongoDBの起動

次のコマンドを入力します。

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

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

コマンドプロンプトウィンドウを閉じないでください。

ステップ3.5でウィンドウを閉じた場合、以降のステップはどれも機能しなくなります。

<<2番目のコマンドプロンプトセクションの開始>>

4.6

2番目のコマンドプロンプトをbinフォルダーで開く

管理者として 2番目のコマンドプロンプトを開き、Alteryx\binフォルダーに移動して、以下のコマンドを入力します(インストール場所に応じて調整します)。

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

4.7

管理者以外のMongoパスワードの取得

次のコマンドを入力して、非管理者のMONGOパスワード をメモ帳にコピーします。

AlteryxService.exe getemongopassword

4.8

Mongoコマンドラインの開始

次のコマンドを入力します。

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

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

成功すると、「>」プロンプトが表示されます。

4.9

元のServerによって設定されたロックの削除

次のMongoコマンドを入力します

db.locks.remove({})

成功すると、「writeResult({ “nRemoved” : N })」が表示されます。ここで、Nは0から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

Mongoコマンドラインと コマンドプロンプト2 を終了

次のコマンドを入力します。

exit

コマンドプロンプト2 を閉じます。

<<2番目のコマンドプロンプトセクションの終了>>

4.13

Mongoデータベースの停止

元のコマンドプロンプトで、キーボードコマンド

ctrl-c

を1回以上、MongoDBを終了して通常のコマンドプロンプトに戻るまで入力します。

コマンドプロンプトを閉じます。

ステップ4: その他のファイルと設定の復元

#

ステップ

詳細

5.1

元のServerに サービスログオンユーザー がいたか

新しいServerに サービスログオンユーザー を設定します。

[Windowsサービスアプリ] > [AlteryxService] を右クリック> [プロパティ] > [ログオン]

5.2

データドライバーとシステムDSNの追加

元のServerと一致するように、同じバージョン のドライバーと 同じ名前 のシステムDSNを追加します(https://downloads.alteryx.com/)。

復元で発生しない可能性のある高度な問題:

5.3

より安全な環境では、必要なRun Asユーザー権限を設定

ワークフローの実行に使用されるすべての資格情報(Run As、サービスログオン、ワークフロー保存時の資格情報セット)に適切なアクセス権があることを確認し、必要な実行ユーザー権限を設定 します。

5.4

システムベースエイリアスおよびIn-DB接続エイリアスの復元

システムデータ接続:

%ProgramData%\Alteryx\Engine\SystemAlias.xml

システムIn-DBデータ接続:

%ProgramData%\Alteryx\Engine\SystemConnections.xml

5.5

ユーザベースエイリアスおよびユーザーIn-DB接続エイリアスの復元

ユーザーデータ接続:

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

ユーザーIn-DBデータ接続:

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

5.6

ワークフローでコネクタを使用しているか

コネクタフォルダーを元のサーバーから以下にコピー

%ProgramData%\Alteryx\Tools

新しいServerでコネクタを有効にするには、カスタマーサポートにお問い合わせください。

5.7

ワークフローでPythonツールを使用しているか

ワークフローがインストールしたPythonパッケージがあれば、再インストールします。Server Upgrade Python Tool Environment Checklistを参照してください。

5.8

SSLを使用しているか

テスト用にサンドボックスServerに復元する場合は、HTTPを使用してテストします。

新しいServerに移行する場合は、SSLを再確立します。

Server SSL/TLSを設定

Alteryx ServerのSSL用設定: 証明書の取得とインストール(15577)

ステップ5: Alteryx Serverの起動

#

ステップ

詳細

6.1

Alteryxシステム設定を確認し、必要に応じてスケジュールを一時停止します。

Alteryxシステム設定 を実行し、各ページの手順を実行して、設定(コントローラートークンなど)に期待される値が含まれていることを確認します。

サービスの開始時にスケジュールを実行しない場合は、次のチェックボックスをオフにします。

Worker(ワーカー) > General(一般) > Allow machine to run scheduled Alteryx workflows(スケジュール設定されたAlteryxワークフローの実行をマシンに許可する)

[Finish] (完了) を選択すると、AlteryxServiceが起動し、ブラウザでServerが使用可能になります。

重要

新しいServerのURLが異なる場合や、SSL証明書がない場合があるため、Server UI Configuration (Server UI 設定) に特に注意してください。

System Settings, the Server UI configuration section.

ステップ6: テスト

#

ステップ

詳細

7.1

基本テスト

AlteryxService は実行されていますか?

次のことができるか確認します。

  • Server UI URLへのアクセス

  • 管理ページ内で移動して、ユーザーやコレクションなどを表示

  • DesignerからServerへのワークフロー公開

  • ワークフローの実行

  • 設定で許可されている場合は、資格情報を指定してワークフローを保存し実行すること

7.2

ワークフロー固有のテスト

次のような拡張機能や外部接続を含むワークフローを実行できますか?

  • ネットワークUNCパスへの入出力

  • データベース接続

  • コネクタツール

  • Location InsightsまたはBusiness Insightsデータセット

  • Pythonツール

  • Rツール