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

重要:

• デプロイにおいて、テナント単位で追加されたカスタム データを持つプロセスおよび/またはキューの数が 75 を超えた場合、必要なプロセスとキューのテーブルを許可リストに追加するか、テーブルのグループ化を有効化する必要があります。
• この制限に近づくと、設定可能なアラートによって警告が表示されます。
• テーブルのグループ化は、すべてのテナントにおけるテーブルの総数に基づいて有効化が必要になる場合もあります。詳細については、「ハードウェアとソフトウェアの要件」をご確認ください。
• プロセスおよびキューのテーブルの列数は 40 に制限されています。

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

重要: カスタム変数に使用する名前はすべて、大文字と小文字の区別なく一意である必要があります (例: successfulTransaction と SuccessfulTransaction は同時に使用できません)。変数名が一意でない場合は、こちらの手順に従って Insights が大文字と小文字を区別しないように設定してください。

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

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

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

• ログ フィールドを追加 - 追加するすべてのログ フィールドが Insights にカスタム テーブルとして取り込まれます。詳細については、こちらをご覧ください。
• キュー アイテムを追加 - ItemInformation プロパティを使用して追加するすべてのデータが Insights にカスタムの表として取り込まれます。詳細についてはこちらをご覧ください。
• トランザクションのステータスを設定 - Analytics および Output プロパティを使用して追加するすべてのデータが Insights にカスタムの表として取り込まれます。詳細については、こちらをご覧ください。詳細についてはこちらをご覧ください。

Insights によって取り込まれるすべてのデータの詳細については、「Insights データ モデル」ページをご覧ください。

注:

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

従来どおりに個別のシーケンスの最後で、残りのワークフローで不要なログを削除するために [ログ フィールドを削除] アクティビティを使用すると、すべてのカスタム ログが削除されるため、プロセスやデータが Insights データベースに取り込まれなくなります。

ログ

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 の担当者にお問い合わせください。