Insights にカスタム データを追加する

重要:

• For deployments exceeding 75 processes and/or queues with custom data added per tenant, you must either add your desired process and queue tables to an allowlist or Enable Table Grouping.
• A configurable alert is displayed warning you when you are approaching this limit.
• Table grouping may also need to be enabled based upon the total number of such tables across all tenants. Review the Hardware and Software Requirements for additional details.
• プロセスおよびキューのテーブルの列数は 40 に制限されています。

Insights のワークフロー デザイン

重要:

Unique case-insensitive names must be used for all custom variables (i.e. do not use successfulTransaction and SuccessfulTransaction). If your variables are not unique, you must set Insights to be case insensitive.

Insights での利用・分析を目的としたオートメーション ワークフローを設計する場合、これまで使用されてきたベスト プラクティスのアプローチにおいて、考慮すべき変更点があります。

Insights で分析できるようにするために、個別のアイテムおよび/またはデータ ポイントを「タグ付け」する必要はありません。カスタム フィールドを含むすべてのプロセスおよび/またはキューに対しては、それらのフィールドが利用可能なカスタム テーブルが自動生成されます。

目的のデータを取得するために、オートメーション ワークフローのデザインでは次のアクティビティを使用できます。

• Add Log Fields - all added log fields are ingested as a custom table in Insights. See [here] (doc:adding-custom-data-to-insights#logs) for more details.
• Add Queue Item - all data added via the ItemInformation property are ingested as a custom table in Insights. See here for more details.
• Set Transaction Status - all data added via the Analytics and Output properties are ingested as a custom table in Insights. See here for more details.

For complete details about all data ingested by Insights, see the Insights Data Model page.

注:

Insights で分析するワークフローについては、必要なすべてのデータを各ワークフローの最後でログ記録することをお勧めします。

Where previously you would use the RemoveLogFields activity at the end of any individual sequence to remove logs not needed in the rest of the workflow, removing all custom logs as such results in the process and data not being ingested into the Insights database.

ログ

Insights にデータを送信するためにログを活用する方法は次の 2 つです。

• メッセージをログ - ワークフローにエラーが発生した場合に、ログ イベントの形式で Insights に送信されるカスタム文字列メッセージを追加できます。
• ログ フィールドを追加 - 既定の Insights ダッシュボードにカスタム変数を追加できます。

ログ メッセージに [ログ フィールドを追加] アクティビティを介して追加されたカスタム ログ フィールドが含まれていることを Insights が検出すると、カスタム フィールドを含む新しいテーブル (タイトル: "Process-<your process name>”) が Insights に作成されます。これらのカスタム フィールドは、カスタム JSON パーサーを使用して生のメッセージから抽出され、RawMessage_CustomFieldName の形式でテーブルに追加されます。

カスタム フィールドでサポートされているデータ型は、Integer、String、Boolean、Double、および Float です。

注:

カスタム テーブルは OOTB データ スキーマと結合されないため、複数テーブルにまたがるウィジェットはリレーションシップを作成しない限り利用できません。複数テーブルにまたがるウィジェットが必要な場合は UiPath の担当者にお問い合わせください。

Insights は、成功したプロセスについてのみ最後のログ イベントを受信します。[ログ フィールドを削除] アクティビティを使用すると、カスタム フィールドはプロセスの完了前にワークフローによって削除されるため、Insights によってキャプチャされません。

また、トランザクションごとのデータをキャプチャするためにログを活用するトランザクション プロセスは、各トランザクション ログのデータを Insights に送信しません。トランザクションを反復処理するプロセスを使用しており、それぞれのトランザクションのカスタム データを保存したい場合は、UiPath のベスト プラクティスに従ってキューを使用する必要があります。キューを使用すれば、すべてのキュー アイテムのカスタム変数を Insights に送信できます。

キュー

各キュー アイテムには、カスタム変数を保存できる 3 つのセクションがあります。[キュー アイテムを追加] アクティビティでキュー アイテムを作成すると、[アイテム情報] フィールドが使用できるようになります。ここには任意のカスタム変数を格納できます。すべてのキュー データでサポートされているデータ型は、カスタム ログでサポートされている型と同じです (Integer、String、Boolean、Double、および Float)。

処理が完了したキュー アイテムにカスタム変数を追加するには、[トランザクションのステータスを設定] アクティビティを活用します。このアクティビティには、変数を格納できる 2 つの入力フィールド [分析] と [出力] があります。

Insights によってキュー内のカスタム フィールドが検出されると、データ モデル内にカスタム テーブル Queue-"your queue name” が作成されます。フィールドは、変数が格納された入力フィールドによって次のように識別されます。

• Analytics に格納した変数の名前は “AnalyticsData_<yourfieldname>” になります。
• Output に格納した変数の名前は “Output_<yourfieldname>” になります。
• ItemInformation に格納した変数の名前は “SpecificData_<yourfieldname>” になります。

注:

キューのカスタム テーブルは OOTB データ スキーマに追加されないため、複数テーブルにまたがるウィジェットはリレーションシップが作成されない限り利用できません。カスタム テーブルを作成する場合は UiPath の担当者にお問い合わせください。