Alteryx Connectを導入したら最初にやるべき10のステップ

「カスタマーストーリー」を支えるツール特集

#ビッグデータ

#Alteryx Connect

#ビジネス・アナリティクス

#Alteryx

兼本侑始

2019.10.08

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

DA部の兼本です。

Alteryx Connectは面白い製品ですが、まだまだ情報量が少ないですね。
というわけで、今回はAlteryx Connectをインストールしたらやるべき10のステップをざっとまとめてみました。

1. 管理者アカウントの作成と管理

インストールが完了したら、ブラウザを起動してAlteryx Connectに接続します。アクセスURLは以下の通りです。

http://[Base URL]

サイトにアクセスするとログイン画面が表示されますので、デフォルトの管理者アカウントである「admin」ユーザとして「Sign In」します。（「Sign Up」ではないので注意。）

デフォルトパスワードは初回ログイン時に変更しましょう。
また、ビルトインの管理者アカウントを使いまわすのではなく、管理者として追加のユーザアカウントを作成することをお勧めします。

ユーザアカウントの作成手順は以下の通り：
- トップページに移動して「People」を選択します。

右下の青色の円の「追加」ボタンをクリックします。

「Create Entry」ダイアログで「Person」を選択し、「Name」フィールドに作成したいユーザアカウントの名前を入力して「Create」を押下します。なお、ここで設定する「Name」はConnect上でユーザアカウントを区別するために使用されるもので、ログイン時のユーザアカウント名は後述の「Credentials」で設定します。

ユーザのプロフィール情報として、プロフィール画像（サイズは500x500px.がちょうどいいです）、エイリアス名（オプション）、電子メール（必須）、電話（オプション）、ポジション（オプション）を指定します。

「Credentials」でログインに使用するユーザ名を入力します。Alteryx Connectのログインに使用するのは、最初に設定した「Name」ではなくて、Credentialsに設定した「Username」と「Password」なので、注意が必要です。

新しく作成したユーザアカウントに管理者権限を付与するには、ユーザをAdministratorsグループに所属させる必要があります。

トップページから「People」に移動して、「Group」を開きます。

「Administrators」グループを開く。

右上の「Edit」をクリックします。

[List of Users]>[Members]のテキストボックスをクリックし、メンバーに追加したいユーザをグループに追加して「SAVE」を押下します。

デフォルトの管理者ユーザをログアウトし、先ほど作ったユーザアカウントで再度ログインします。正しくログインでき、このユーザがAdministratorsグループに所属していることが確認できました。

2. ログインを許可するドメインの指定

Alteryx Connectでは、利用者自身がサービスにアカウント登録してサインアップする機能（セルフレジストレーション）を提供しています。
セルフレジストレーションはメールアドレスのドメイン単位で許可することができますので、新規インストールをしたら、この設定を行います。

Alteryx Connectに管理者アカウントでログインし、ページ上部の検索バーに「Allowed Domain」と入力して、「Allowed Domain」ページに移動します。

「Allowed Domains」ページの右上にある[EDIT]ボタンを押下します。
セルフサインアップを許可する電子メールアドレスのドメイン（通常は自社のドメイン）を追加します。デフォルトで不要なドメインが登録されている場合はドメイン名の右側にある「X」を押下して削除してから、右上の「SAVE」ボタンを押下して保存します。

ヒント！
セルフレジストレーションを無効にするには、「Allowed Domains」内のすべてのエントリを削除します。

3. 認証方法の設定

Alteryx Connectでは、いくつかの認証方法をサポートしています。それぞれについて簡単にご紹介します。

ビルトイン認証

ビルトイン認証では、管理者グループのメンバーが「People」セクション内に新しいユーザアカウントを作成します。
また、「Allowed Domains」で許可されたメールアドレスを持つユーザであれば、「Sign Up」からセルフレジストレーションでアカウントを作成できます。

Windows統合認証

Alteryx Connectは、Windows統合認証を使用して、Active Directoryに登録されたユーザ情報でログインするように設定できます。
設定を有効にするには、管理者グループのメンバーとしてログインし、Administration Consoleの[Connect Configuration > Single Sign-On]にあるチェックボックス「Use Windows Authentication for Single Sign-On」を有効にします。

手動認証とWindows認証は、同じアカウントに対して共存でき、ユーザはWindows認証セッションからログアウトし、ビルトインのアカウントでログインすることができます。
Windows統合認証では、SSL/TLSを使用するか、クライアントブラウザの「信頼済みサイト」にAlteryx Connectのサイトを追加する必要があります。
Alteryx Connect 2018.1以降のバージョンでは、Windows統合認証利用時に複数のADドメインをサポートしています。これらのドメインには双方向の信頼があることを前提としています。
このオプションの詳細はこちらをご確認ください。

SAML認証

Alteryx ConnectはSAML2.0をサポートしています。

SAMLの設定を行うには、管理者グループのメンバーとしてログインし、Administration Consoleの[Connect Configuration > Single Sign-On]の[+ADD]をクリックして、[New SAML]ウィンドウを開きます。

新しいIDPの名前、アイコン、説明を入力し、[Identity provider details]で、IDプロバイダの詳細を提供するために使用する方法を選択します。
SAMLの設定に関しては、使用するIDPごとに異なるため、それぞれのIDPが提供する設定方法をご確認ください。Auth0との連携に関しては、以下のエントリを参考にしていただくこともできます。

Alteryx ConnectとAuth0でSAML認証

4. ファイルとバックアップの設定

Alteryx Connectが使用するファイルやバックアップ方法について説明します。
以下の説明では、Alteryx Connectがデフォルトの「C：\Program Files\AlteryxConnect\」にインストールされているものとしています。

フォルダとファイル	説明
/ac_work/	H2データベースファイルを保持し、アップグレードの前に常にバックアップする必要があります。
/logs/catalina.out	アプリケーションのプライマリログであり、トラブルシューティングに役立ちます。
/conf/	構成を管理するXMLファイルが含まれています。このファイルは通常アプリケーションによって変更されますが、手動でオプションを設定することもできます。

注意！
バックアップを実行する際は「Alteryx Connect」サービスを停止してから「/AlteryxConnect/」フォルダをバックアップする必要があります。

H2データベースバックアップスクリプト

H2データベースには、Alteryx Connectが動作する上で必要なすべてのユーザデータとメタデータが保持されています。
すべてのアプリケーション構成設定が含まれているわけではありません。次のコマンドは、H2バックアップを実行します。

net stop alteryxconnect
"C:¥Program Files¥AlteryxConnect¥jre¥bin¥java.exe" -cp "C:¥Program Files¥AlteryxConnect¥webapps¥ROOT¥WEB-INF¥lib¥h2-1.4.196.jar" org.h2.tools.Shell -url jdbc:h2:"C:¥Program Files¥AlteryxConnect¥ac_work¥ac_data" -user sa -password <password> -sql "BACKUP TO ‘<path to backup location>';"
net start alteryxconnect

このコマンドの以下のパラメータに注意してください。

h2-1.4.196.jarは、ソフトウェアバージョンごとに変更されます。バージョンに合わせて変更する必要があります。
は、Alteryx Connexctのセットアップ時に設定したH2のパスワードを指定します。Connectの管理コンソールでリセットできます。
は、ネットワークフォルダへのパスであり、ファイル拡張子として.zipを指定する必要があります。

このコマンドを含むbatファイルを作成することで、任意のスケジューラーでバックアップ処理を定期実行することもできます。

完全なアプリケーションバックアップ

データベースのバックアップに加えて、すべての構成ファイルとバックエンドスクリプトを含むアプリケーション全体を定期的にバックアップすることをお勧めします。
以下のスクリプトは、アプリケーションの完全バックアップを作成する例です。

SET BackupDir=J:¥AutomatedBackups
FOR /f %%a IN ('WMIC OS GET LocalDateTime ^| FIND "."') DO SET DTS=%%a
SET DateTime=%DTS:~0,4%%DTS:~4,2%%DTS:~6,2%_%DTS:~8,2%%DTS:~10,2%%DTS:~12,2%
net stop alteryxconnect
xcopy "C:¥Program Files¥AlteryxConnect" "%BackupDir%¥ConnectBackup_%datetime%“ /s /e /h /i
net start alteryxconnect

次のことに注意してください。

このスクリプトは、Alteryx Connectのサービスを停止します。
サービスを再起動すると、「AlteryxConnect」が再起動してからWebサイトが応答するまでに数分かかる場合があります。
は、ネットワーク上のバックアップフォルダを指定します。このフォルダは、スクリプトを実行するユーザがファイルを読み書きできる必要があります。
前述のH2データベースバックアップと組み合わせる場合、完全なアプリケーションバックアップを週次で実行することをお勧めします。

5. ライセンスのインストール

Alteryx Connectを購入もしくはトライアルを実施する場合、ライセンスキーは電子メールに添付する形で提供されます。
ライセンスをインストールするには、Alteryx Connectをインストールしたフォルダ配下の「ac_work」フォルダにライセンスファイル（.key）を配置します。
通常は「C：¥Program Files¥AlteryxConnect¥ac_work¥」です。
インストールされているライセンスの詳細は、管理者としてAlteryx Connectにログインしたのち、Administration Consoleの[System Info>License]で確認できます。

6. コンテンツの一括登録

テクニカルメタデータ以外のコンテンツは、右上にあるExport/Import機能を使用して一括登録できます。

以下はGlossary（用語集）を登録する例です - 管理者としてログインし、「Glossary」ページを開きます。エクスポートされたコンテンツはその場所に関連するため、目的のエンティティページからエクスポートすることが重要です。 - 右上のメニューから「Export to Excel」を選択します。

このファイルは、コンテンツをインポートする際に必要な構造になっているので、構成を変えないように注意して編集します。Glossaryは、実際の用語が定義されている3シート目の「term」を編集します。ここでは、「社員」と「案件」という2つの用語を新規に作成しています。
- 「xid」は空白のままにします
- 「parent」と「parent_field」にはほかと同じ値を指定します。
- 「description」、「entryName」、「entrySynonym」に独自の値を入力します。

管理者としてAlteryx Connectにログインし、Administrator Consoleの[Upload]から変更したファイルをシステムにアップロードします。

アップロードが正常に完了するとGlossaryに追記した用語が表示されます。

7. ユーザとグループの作成

ユーザの作成

ユーザアカウントは複数の方法で作成できます。

ユーザに「Sign Up」からのセルフレジストレーションでアカウントを作成できます。
管理者が個別のユーザアカウントを作成できます。
Tableua Metadata Loaderの実行時に、Tableau Serverからアカウントを収集できます。
Alteryx Metadata Loaderの実行時に、Alteryx Serverからアカウントを収集できます。

いずれの場合も、ユーザーアカウントは最初に既定のアクセス許可グループに配置されます。
Alteryx Connectは、作成されたアカウントをメールアドレスで統合しようとするので、上記のアカウント作成方法（Tableau Metadata Loader、Alteryx Metadata Loader、セルフレジストレーション）に関係なく、同一のメールアドレスがシステム内に既に存在する場合、ユーザアカウントは統合されます。

ベストプラクティス！
Alteryx Server（Gallery）またはTableau Serverに潜在的なConnectユーザが多数存在する場合は、手動でアカウントを作成するのではなく、セットアッププロセスの早い段階でそれぞれのMetadata Loaderを実行することをお勧めします。
また、Windows統合認証を使用する場合、メールアドレスがキーとなるため、ユーザアカウントを統合するためにはメールアドレスを揃える必要があります。

グループの作成

デフォルトユーザグループ

Alteryx Connectでは、権限は個別またはグループで管理できます。
デフォルトでは、ホームページの「ユーザー」の下にある4つのグループがあります。

デフォルトパーミッショングループ	役割
Administrators	- メタデータの追加/削除ができます。 - Administrator Consoleにアクセスできます。 - ユーザアカウントと権限の追加ができます。
Certifiers	- Connectに登録されているデータアセットを「認証済」または「使用しない」としてマークできます。
Contributors	- デフォルトでは新規ユーザの初期グループです。 - アセットの属性を編集できます。 - LikeやDislikeのようなリアクションができます。
Readers	- アイテムを表示できます。 - LikeやDislikeのようなリアクションができます。

重要！
新しいグループを追加したとしても、上記のデフォルトグループは削除しないでください。

デフォルトパーミッション

新しく作成されたアカウントには、単一のデフォルトパーミッションが与えられます。デフォルトでは、そのグループは「Contributors」です。

デフォルトグループを変更するには：

「Contributors」グループを編集し、フィールド「Integration Code」から値「defaultGroup」を削除します。この変更後に保存します。
デフォルトグループとして設定するグループを編集し、値「defaultGroup」をフィールド「Integration Code」に追加して保存します。

ヒント！
セルフレジストレーションを有効にしている時、新規ユーザがアクセスできるコンテンツを制限したいのであれば、「NoAccess」という新しいグループを作成し、デフォルトグループに設定することをお勧めします。
ホームページで「NoAccess」グループに「Viewer」権限を付与しなければ、新しく登録されたユーザはデフォルトでコンテンツにアクセスする権限を持ちません。

カスタムユーザグループ

管理者は新しいグループを作成し、グループに対してパーミッションを設定することができます。

「People」内の「Groups」ページに移動し、右下の青色のプラスボタンを押下して、新しいグループを追加します。

グループに名前と説明をつけて保存します。

保存後、グループを編集して既存のユーザをグループに追加できます。ひとりのユーザが複数のグループに所属することもできます。

ヒント！
Alteryx Connectでは制限するパーミッションはなく、許可するパーミッションのみ提供されています。
例えば、ユーザがアセットの「Viewer」権限を持つグループに所属している場合、ユーザはアセットを表示できます。

8. パーミッション

個人またはグループに対して、Alteryx Connectに登録された様々なエンティティにアクセスするためのパーミッションを設定できます。
特定のグループのみにページを表示するには、次の手順でパーミッションを設定します。

カスタムグループがまだ定義されていない場合は、[People]>[Groups]で作成します。グループに少なくとも1人のユーザを追加して保存します。
データベーステーブルなど、パーミッションを設定したいアセットを表示します。
右上の縦長の楕円アイコンをクリックして、メニューから「Permissions」を押下します。

パーミッションの詳細が表示されます。最上部の表には、アクションごとのパーミッション（親ページからの継承を含む）がリストされており、このリストは必要に応じて変更することができます。

指定したグループまたは個人に「VIEWEWR」権限を付与には、対応するアクションにグループまたは個人を追加して保存します。

動作を確認するには、表示権限を持つグループにログインしているユーザを追加または削除して、そのアセットのページを再読み込みします。
許可はリアルタイムで検索結果にも影響することに注意してください。
パーミッションは階層的に適用されることに注意してください。データベーススキーマへのアクセスを許可すると、そのスキーマ内のすべてのテーブル、ビュー、およびフィールドもアクセスが許可されます。

ヒント！
管理者は管理コンソールの[Administration Console]>[Permission Overview]で、すべての権限を表示・編集できます。

9. リレーションシップ

リレーションシップには複数のタイプがあります。

自動生成されたリレーションシップ
- メタデータの読み込みプロセス中にデータアセットが結合されることで決定します。
- リンケージ（ファイル入出力など）
手動で生成されたリレーションシップ
- システム内のユーザアクションによって決定されます。
- 所有権、タグ、参照リンクを含みます。

リレーションシップは「Nexus」ビュー内で表示できます。上部のドロップダウンフィルタを使用すると、リレーションシップの表示を切り替えできます。

自動生成されるリレーションシップは、ソースシステムとロードプロセスによって決定されます。
手動で生成されたリレーションシップは、右上にある縦の楕円アイコンにあるエクスポート/インポート機能によって一括変更できます。
エクスポートしたデータを再インポートのために変更する場合、データを上書きし、同じページに表示するには親IDを維持する必要があります。

10. メタデータのロード

Alteryx Connectが管理するテクニカルメタデータは、Alteryx Serverにインストールされたメタデータローダーによって取得され、ローダーが取得したデータがAlteryx Connectにプッシュされます。

現在サポートされているデータソースは次のとおりです。詳細は、Alteryx オンラインヘルプの現在サポートされているソースのリストをご覧ください。

Alteryx Gallery
Amazon Redshift
Amazon S3
DB2
ファイル（CSV、XLS、YXDB、TDE）
HDFS
Hive
Exasol
Oracle
Microsoft Azure Data Lake store
Microsoft Power BI
Microsoft SQL Server
MySQL
Qlik Sense
QlikView
SalesForce
SAP HANA
Snowflake
Tableau Server
Teradata

メタデータローダーのインストール

メタデータローダーを使用するには、Alteryx ServerがインストールされているサーバにAlteryx Connect Loaderをインストールする必要があります。

Alteryx Server（Alteryx Connectではない）に、「Alteryx Connect Loader」をインストールします。インストーラは、licenses.alteryx.com の「Connect」セクションからダウンロードできます。
インストールが正常に完了したら、サーバのAlteryx Designerを起動して、メニューから、[Designerヘルプ>サンプルワークフロー> Alteryx Connect Loader]を辿り、Connect メタデータローダーがインストールされていることを確認します。

メタデータローダーを実行するには、Predictive Toolsのインストール（管理者バージョン）が必要です。インストーラは、licenses.alteryx.com の「Designer」セクションにあります。
Alteryx Serverが複数のワーカーサーバを使用する環境の場合、Predictive Tools（管理者バージョン）はすべてのワーカー環境にインストールする必要があります。

Alteryx Galleryのメタデータ収集

「Alteryx Loader」を使用すると、Alteryx Galleryからメタデータを収集することができます。 Alteryx Connectを使用すると、各ワークフローのデータ入出力先をリネージとして表示できます。
詳細と要件については、Maintain Data Lineageを参照してください。

Alteryx Gallery からワークフローのメタデータを収集するには、Galleryに接続するユーザがAdmin Gallery APIを実行できる必要があります。
アクセスを確認するには、管理者アカウントでAlteryx Galleryに接続し、右上のメニューをクリックして「My Profile」を表示します。次に「キー」タブを表示して「Admin API」を有効にし、キーとシークレットの両方をテキストエディターにコピーします。

Alteryx Server上のDesignerを起動して、メニューから「Designerヘルプ>サンプルワークフロー>Alteryx Connect Loader> Alteryx Loader」を選択します。
分析アプリとしてワークフローを実行し、Alteryx Galleryタブの設定を行います。

Alteryx ConnectタブでAlteryx Connectへの認証情報を設定します。

分析アプリ値（.YXWV）ファイルをAlteryx Loaderワークフローと同じフォルダに保存します。デフォルトのインストールパスの場合、「C:\ProgramData\Alteryx\AlteryxConnect\Alteryx_Loader」です。
メタデータのロードが完了したら、「出力ログの表示」内で結果を確認します。

Alteryx Connect のWebサイトを開き、Analytic Workflowsを表示してメタデータが正しく収集できていることを確認します。

ほかにもメタデータをロードしたいサービスがあれば同様の手順を繰り返して、メタデータローダーの設定を行います。

スケジュール実行

Alteryx Connect Loaderをインストールすると「ConnectScheduler」という名前の特別なワークフローもインストールされます。

Alteryx ServerのDesignerを起動して「Designerヘルプ>サンプルワークフロー>Alteryx Connect Loader>ConnectScheduler」を開きます。
Connect Schedulerワークフローを開き、最左のディレクトリツールがメタデータローダーのルートディレクトリを指すように構成します（デフォルトのインストールパスの場合は、「C:\ProgramData\Alteryx\AlteryxConnect\Alteryx_Loader」です。）
Connect Schedulerワークフローを手動で実行して動作を確認します。ワークフローを実行すると、YXWZとYXWVのペアを見つけて各ローダーを実行します。
Connect SchedulerをAlteryx Serverにデプロイし、スケジュール設定を行います。

注意！
マルチノードサーバを使用している場合は、ローダーディレクトリ構造全体を、すべてのワーカーノードがアクセスできるファイル共有に保存する必要があります。