環境変数による使用状況サービスの制御

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

環境変数を使用して使用状況サービスを制御したり、報告されるイベントを変更したりする方法に関する情報

Not for use with personal data

この記事には、環境変数を介して使用状況サービスを制御する方法に関する情報が含まれています。以下のことができます：

これら4つの環境変数を使用すると、使用状況サービスを制御できます。使用状況メトリクスの収集を有効または無効にしたり、使用状況イベントにテスト結果を含めたり、結果が報告されるURLを変更したり、ユーザーの一意のIDを変更したりできます。

名前	説明
AXE_DISTINCT_ID	ログインユーザーに対して同じままのUUID識別子（再生成されない限り）
AXE_INCLUDE_TEST_RESULTS	テスト結果を applicationProperties オブジェクトにポピュレートして含める testResults オブジェクト
AXE_METRICS_URL	REST使用状況エンドポイントのURL
AXE_TRACK_USAGE	使用状況サービスの報告を有効にする（デフォルトは false）

note

クライアントが使用状況サービスに連絡できない場合、 https を http に置き換えてURLを再試行します（AXE_METRICS_URL環境変数を使用して設定）。

環境変数を使用して報告されるイベントの変更

以下の環境変数を使用すると、使用状況サービスに報告されるイベントを変更できます。たとえば、 department や organization プロパティを使用して、APIまたはCLIの使用を特定の部門や組織に関連付けることができます。

以下の表では、 Can Override 列は、環境変数に設定された値がメトリクスライブラリへの呼び出しで設定された値を上書きできるかどうかを示しています。 Data Name は、使用状況サービスに送信されるイベントオブジェクトでのプロパティ名です。

これらの値は、 true または falseであることが期待されています。

名前	データ名	上書き可能性	説明
AXE_DEV_INSTANCE	devInstance	true	このイベントがソフトウェア開発者の操作から発生したかどうかを示します。開発やテスト中にログに記録されたイベントをマークし、後で削除するために便利です。
AXE_LOGGED_IN	loggedIn	false	テスト中のアプリケーションにユーザーがログインしているかどうかを記録します。

これらの値は文字列として解釈されます。

名前	データ名	上書き可能	説明
AXE_APPLICATION	application	false	アクセシビリティエラーをチェックするために使用されたアプリケーション
AXE_DEPARTMENT	department	true	ユーザーの組織内での部署（AXE_ORGANIZATION）
AXE_KEYCLOAK_ID	keycloakId	false	ユーザーの Keycloak ID
AXE_ORGANIZATION	organization	true	ユーザーの組織
AXE_SESSION_ID	sessionId	false	ユーザーのセッションを識別するUUID
AXE_USER_ID	userId	false	特定のユーザーのアイデンティティ（名前やログインIDなど）
AXE_USER_JOB_ROLE	userJobRole	false	ユーザーの職務
AXE_USER_STATUS	userStatus	false	ユーザーに関連付けたいステータス情報

これらの環境変数を使用するためのチュートリアルについては、使用サービスとAPIの使用開始と Usage ServiceおよびCLIの使い始め。

Usage Serviceに関する一般情報は、 Axe DevTools for Web Usage Serviceをご覧ください。