Server使用状況レポート
Server使用状況レポートを使用すると、ユーザー、アプリ、権限、スケジュール、ジョブのメトリクスを把握し、パフォーマンス、監査、コンプライアンスに関する問題を迅速に評価できます。MongoDBとServer APIに接続することで、Alteryx Serverから関連するデータと分析を簡単に抽出できます。Tableauダッシュボード、個別のファイル、データベース、または下流のプロセスで使用するマクロ出力など、好みの出力を選択できます。
Server使用状況レポートは、Alteryx Marketplaceからダウンロードできます。
要件
Server使用状況レポートは、Designerのバージョン2023.2以降に対応します。お使いのDesignerバージョンで利用可能な最新のパッチを使用してください。
Server使用状況レポートユーティリティと依存関係をインストールする
Server使用状況レポートと関連する依存関係をインストールするには、次の手順を実行します。
YXIのインストール
Alteryx Marketplaceから
Server_Usage_Report.yxiをダウンロードします。YXIファイルをダブルクリックして、ユーティリティとDesignerをインストールします。
以下のプロンプトに従います。
マイアカウントのためにインストール: 自分のユーザーアカウントからのみ、マシン上のユーティリティにアクセスできます。インストール先:
%AppData%\Alteryx\。すべてのユーザーにインストールする: すべてのユーザーがマシン上のユーティリティにアクセスできます。インストール先:
%ProgramData%\Alteryx\。
完了したら、[開始する]ワークフローを開きます。Designerで、[ヘルプ] > [サンプルワークフロー] > [エンタープライズユーティリティ] > [Server使用状況レポート] > [開始する]の順に移動します。
Tableau出力コネクタのインストール
注記
これはオプションの項目です。Tableau出力コネクタは、出力をTableauに書き込む場合にのみ必要です。Tableauに書き込むオプションを選択しない限り、ワークフローはTableau出力なしでも機能します。
Alteryx MarketplaceからTableau出力コネクタをダウンロードします。
YXIファイルをダブルクリックし、Designerを使用してコネクタをインストールします。
以下のプロンプトに従います。
マイアカウントのためにインストール: 自分のユーザーアカウントからのみマシン上のツールにアクセスできます。インストール先:
%AppData%\Alteryx\。すべてのユーザーにインストールする: すべてのユーザーがマシン上のツールにアクセスできます。インストール先:
%ProgramData%\Alteryx\。
MongoDB用Simbaドライバーのインストール
AlteryxライセンスポータルからSimbaドライバーをダウンロードします。
[製品ダウンロード]セクションの一番下までスクロールし、[ドライバ―]エントリの右側にある[ダウンロード]を選択します。
バージョンリストから[MongoDB]を選択し、[次へ]を選択します。
[Simba MongoDB 2.3.22.1024 64ビット]エントリの右側にある[ダウンロード]を選択します。
MSIファイルをダブルクリックして、マシンにドライバーをインストールします。これで、ODBC管理者ユーティリティでドライバーにアクセスできるようになります。
MongoDB接続用のDSNを設定する
次に、MongoDB接続用のDSNを設定します。以下の手順に従います。
マシン上で[ODBCデータソースアドミニストレーター(64ビット)]を開きます。
Simba MongoDB ODBCドライバー(バージョン2.03.22.1024)を使用して、新しいデータソースを作成します。次のフィールドを入力します。
Data Source Name (データソース名): この名前は何でもかまいませんが、ODBC接続を一時的に使用する場合でも、入力する必要があります。
Server (サーバー): お使いのサーバー名です。
Port (ポート): お使いのサーバーのポート(組み込みMongoDBの場合は27018)。
Database (データベース): AlteryxService (または更新するデータベースに応じてAlteryxGallery)。
Mechanism (メカニズム): SCRAM-SHA-256
Authentication Source (認証ソース): 上記の入力「d」のデータベース名と一致させます。
Username (ユーザー名): DBユーザー名。通常はユーザーです。
Password (パスワード): DBパスワード。[Alteryxシステム設定]で、組み込みMongoDBのパスワードを確認します。
[Test... (テスト)]を選択して、正常に接続できていることを確認します。
[Advanced Options... (詳細オプション)]を選択します。
[Binary Column Size (バイナリ列サイズ)]の値を
2147483647に変更します。[Mechanism (メカニズム)]の下の[Metadata (メタデータ)]セクションで、[Local File (ローカルファイル)]を選択します。
[Browse... (参照)]を選択し、次にMongoDBバージョン固有のスキーマフォルダーに格納されている以下の対応するスキーマファイルを選択します。
2023.2までのバージョンの場合
スキーマファイル:
MongoDB_Schema_23.2.jsonユーザーインストール場所:
%appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json管理者インストール場所:
%ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_23.2.json
バージョン2024.1以降の場合
スキーマファイル:
MongoDB_Schema_24.1Plus.jsonユーザーインストール場所:
%appdata%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json管理者インストール場所:
%ProgramData%\Alteryx\Samples\data\Enterprise Utilities\Server Usage Report\supporting_macros\SimbaMongoDB_SchemaFiles\MongoDB_Schema_24.1Plus.json
[Open (開く)]を選択し、[OK]を選択してからもう一度[OK]を選択します。
AlteryxServiceデータベースにも上記の手順を繰り返します。
MongoDB用のDCM接続を作成する
次のステップに従って、データ接続マネージャー(DCM)でMongoDB用の接続を作成します。
DCMを開きます。Designerで、[ファイル] > [接続を管理]の順に移動します。
[データソース]タブで、[+新規]を選択し、MongoDBタイルを選択します。
[テクノロジー]ドロップダウンから、[MongoDB ODBC]を選択します。
データソース名: 上記の「MongoDB接続用のDSNを設定する」セクションでMongo
AlteryxServiceデータソース名を入力します。ODBC DSN: 先ほど作成したMongoDB
AlteryxServiceODBC DSNを選択します。
[保存]を選択してから、[資格情報の接続]を選択します。
次のフィールドを入力します。
認証方法: MongoDBユーザー名とパスワード
資格情報: 新しい資格情報の作成
資格情報名: 任意の名前(例: MongoDB_AlteryxService_Local)。
保管庫: DCM
ユーザー名: ユーザー
パスワード: パスワード。
認証メカニズム: SCRAM-SHA-256
認証ソース: AlteryxService
SDKへの接続を許可: オフ
[接続テスト]を選択します。正常に完了したら、[作成とリンク]を選択します。
AlteryxGalleryデータベースで上記の手順を再び行います。
Server APIへのDCM接続を作成する
DCMを開きます。Designerで、[ファイル] > [接続を管理]の順に移動します。
[データソース]タブで、[+新規]を選択し、[ダウンロード]タイルを選択します。
データソース名: 任意の名前(Server APIなど)。
ベースURL: サーバーAPIのベースURLを入力します。これは
/webapi/で終了するURLです。例:
https://CompanyServerName/webapi/
[保存]を選択します。
[資格情報の接続] を選択します。
[認証方法]ドロップダウンから、[ユーザー名とパスワード]を選択します。
[資格情報]ドロップダウンから、[新しい資格情報の作成]を選択します。
資格情報名: 任意の名前(例: Server API Keys)。
保管庫: [DCM]を選択します。
ユーザー名: GalleryプロファイルにあるAPIアクセスキーを入力します。
パスワード: GalleryプロファイルにあるAPIアクセスシークレットを入力します。
[作成/リンク] を選択します。
(オプション) DCM接続キャッシュと出力データベースを作成する
DCMを開きます。Designerで、[ファイル] > [接続を管理]の順に移動します。
[+新規]を選択し、[MongoDB]タイルを選択します。
[テクノロジー]ドロップダウンから、目的のデータベースを選択し、接続の設定を完了します。
(オプション)出力データベースで必要なテーブルを作成する
次のアプリを実行して、出力データベースに必要なテーブルを作成します。このステップは、好みに応じて実行してください。また、キャッシュデータベースが使用されていない場合、またはデータがデータベーステーブルに出力されていない場合も、このステップはオプションです。どちらかが使用されている場合は、対応するアプリを実行してください。
データベースを使用して、Galleryからダウンロードしたワークフローパッケージをキャッシュする場合は、[キャッシュデータベーステーブルの作成] (アプリ)を実行します。
データベースを使用して最終データをテーブルに出力する場合は、[出力データベーステーブルの作成] (アプリ)を実行します。
Alteryx Server使用状況レポートを実行する
Server使用状況レポートを実行するには、次の手順に従います。
前の手順で作成した資格情報を入力します。
Alteryx Gallery: AlteryxGalleryデータベースへのDCM接続。
Alteryx Service: AlteryxServiceデータベースへのDCM接続。
API資格情報: Server API資格情報へのDCM接続。
ジョブと結果を日付でフィルタリング: AS_Queue (ジョブ)およびAS_Results (結果メッセージ)テーブルのクエリを、指定した日付に遡って取得するよう制限します。
キャッシュしたワークフローデータベースを使用する(オプション): API呼び出しからダウンロードしたアプリパッケージをキャッシュします。Designerに多くのワークフローが含まれている場合は、実行のたびにダウンロードすると時間がかかることがあるためこのオプションを使用します。
Tableau Hyperファイルに出力: Tableau Hyperファイルを出力する場所を定義します。Tableauワークブックのテスト用に初めて実行する場合は、既定のままにします。
データベーステーブルに出力(オプション): DCM接続を使用して、データを独自のデータベース内の別々のテーブルに出力します。
個別のファイルに出力(オプション):
(オプション)個別のファイルを保存する場所(フォルダー)を選択します。空 =
.\Outputフォルダー。(オプション)接頭辞を入力します。空 = 接頭辞なし。
ファイルの種類(CSVまたはYXDB)を選択します。
ワークフローを実行します。
提供されたフォルダーに移動してTableauワークブックを開き、データを表示します。Hyperファイルが別の場所に出力された場合は、Tableau内のデータソースを再接続してデータを表示します。
トラブルシューティング
このセクションでは、一般的な問題とトラブルシューティング手順についてご確認いただけます。
権限の確認
まず最初に、Alteryx Server UIでワークフローをダウンロードするための正しい権限が設定されていることを確認します。
Serverで、[管理者パネル] > [設定] > [アセット]の順に移動します。[直接ダウンロードを無効にする]がオフになっていることを確認します。
ユーザーは、各ワークフローの設定で[他のユーザーもこのワークフローをダウンロードできます]チェックボックスをオンにする必要があります。これは既定でオンになっているため、このチェックボックスを明示的にオフにしない限り、ワークフローパッケージには正しい権限が設定されているはずです。
Server使用状況レポートを実行するユーザーは、APIトークンを取得するためにAPIアクセスがオンになっている必要があります。
その他のトラブルシューティングに関する注意
以下の一般的なエラーと推奨される解決手順をご覧ください。
- 500 Not Found応答
- Alteryx Server使用状況レポート(8): PullServiceDetails(1483): ツール#147:内部エラー: 読み取りの試行がBlobの末尾を超えています。
- Alteryx Server使用状況レポート(8): Alteryx Serverからワークフローの詳細を取得できませんでした: HTTP/1.1 500 Internal Server Error
- Alteryx Server使用状況レポート(8): Alteryx Serverからワークフローの詳細を取得できませんでした: HTTP/1.1 403 Forbidden
- HTTP/1.1 404またはHTTP/1.1 401、または「RetrieveServerOAuthToken: テスト『DownloadSucceeded』に失敗しました」
500 Not Found応答 | |
こちらのコミュニティ記事をご確認ください。 | |
Alteryx Server使用状況レポート(8): PullServiceDetails(1483): ツール#147:内部エラー: 読み取りの試行がBlobの末尾を超えています。 | |
ODBC DSNの詳細設定を確認してください。[Binary Column Size (バイナリ列サイズ)]は2147483647である必要があります。 | |
Alteryx Server使用状況レポート(8): Alteryx Serverからワークフローの詳細を取得できませんでした: HTTP/1.1 500 Internal Server Error | |
ワークフローが破損していないかどうかを確認してください。Serverで実行できることを確認してください。 | |
Alteryx Server使用状況レポート(8): Alteryx Serverからワークフローの詳細を取得できませんでした: HTTP/1.1 403 Forbidden | |
ワークフローをダウンロードできること、およびグローバル設定でワークフローがダウンロードできるようになっていることを確認します。次に、Serverの[管理者] > [設定]の[直接ダウンロードを無効にする]設定を確認してください。 | |
HTTP/1.1 404またはHTTP/1.1 401、または「RetrieveServerOAuthToken: テスト『DownloadSucceeded』に失敗しました」 | |
DCM接続のベースURLが「http://localhost/webapi/」であることを確認します( DCM接続のアクセスキー(ユーザー名)とアクセスシークレット(パスワード)が正しいことを確認します。 AlteryxServiceが実行されており、GalleryまたはSwagger (API)ドキュメントにアクセスできることを確認します。そうでない場合は、「services」でAlteryxServiceを再起動してみてください。 |