Historical execution data overview
Edge and Media Tier version:
- 1.0.0.15220 or later. For more information, see Media Tier release notes.
To enable or disable historical execution data storage:
- Directory > Organization > Admin
- Settings > Execution Data > Edit permission
- Settings > Execution Data > View permission
To set the historical execution data level for flows for the organization:
- Architect > Flow Default Log Level > Delete permission
- Architect > Flow Default Log Level > Edit permission
- Architect > Flow Default Log Level > View permission
To set the historical execution data level for a specific flow:
- Architect > Flow Log Level > Add permission
- Architect > Flow Log Level > Delete permission
- Architect > Flow Log Level > Edit permission
- Architect > Flow Log Level > View permission
To see execution data for a flow:
- Architect > Flow Instance Execution Data > Edit permission
- Architect > Flow Instance Execution Data > View permission
Genesys Cloud offers access to comprehensive historical execution data for all Architect flow types. With advanced capabilities in historical data analysis, users can manage and analyze historical execution data effectively, and gain insights into user journeys to make improvements and troubleshoot. Users can enable or disable execution data storage and select from four distinct levels of execution data granularity:
- Base: understand high-level user journeys through Architect actions and navigated menus, errors, and events.
- Notes: optimize Architect flows using variable values (includes the Base level).
- Verbose Notes: access conversation content with communication values (includes the Notes level).
- All: troubleshoot through action input and output values (includes the Verbose Notes level).
- Historical execution data counts toward your organization’s data storage limit under the Genesys Cloud fair use policy. For more information, see Genesys Cloud fair use policy.
- Execution data storage is disabled by default. To start capturing execution data, you must enable it and republish flows.
The following examples are possible scenarios that consumers of historical execution data can use the execution data for:
- フローがエラーに遭遇したときなど、特定のフローイベントをリッスンする
- 特定のフローのイベントを監視し、特定のフローの実行項目を分析します。たとえば、フローが特定のアクションを実行し、アクションが失敗またはタイムアウトの経路を取った場合などです。
- どのフローが他より多く流れているかを確認する
Genesys Cloud disables historical execution data storage by default. To enable storage, follow these steps:
- 管理をクリックします。
- アカウント設定で、組織設定をクリックします。
- On the Settings tab, scroll down to the Execution Data section.
- Under Execution Data, use the toggle to enable execution data storage for your organization.
- A disclaimer message appears that informs you that Genesys Cloud may store sensitive information. Click Yes to enable storage.
To navigate to Admin > Account Settings > Organization Settings > Settings from Architect, click Help and select Execution Data Settings.
To configure what data types to store historical execution data for, follow these steps:
- 管理をクリックします。
- アカウント設定で、組織設定をクリックします。
- On the Settings tab, scroll down to the Execution Data section.
- Under Execution Data Storage, use the Architect Flows toggle to enable execution data storage for the data type.
To navigate to Admin > Account Settings > Organization Settings > Settings from Architect, click Help and select Execution Data Settings.
{ "flow": { "conversationId": "49dbd0ea-c3ee-4568-ab5b-1fac76a5b81c", "division": { "id": "d62836e8-ff2a-43ee-bcf6-dc9d8b9e89a0" }, "endDateTime": "2023-10-12T09:09:50.495Z", "execution": [ { "startedFlow": { "dateTime": "2023-10-12T09:09:17.642Z", "languageTag": "en-us", "variables": [] } }, { "startedBotState": { "dateTime": "2023-10-12T09:09:17.642Z", "executionId": "433aad21-9b89-4c4c-aa46-3c2a23459a68", "stateId": "26d285b4-fdc8-4978-9d33-b9eb46a10cf9", "variables": [] } }, { "actionAskForIntent": { "actionId": "c5f05c45-f683-4ea5-ab0b-93ca101c0d66", "dateTime": "2023-10-12T09:09:17.642Z", "execution": [], "executionId": "00c0597c-7810-4425-b079-91bd680b9a8b", "outputPathId": "b12f6d65-5f4c-4702-843a-c753885fd57b", "outputVariables": [], "trackingId": 11 } }, { "actionAskForSlot": { "actionId": "a6846b61-7736-42ef-ada2-05643078bef5", "dateTime": "2023-10-12T09:09:24.708Z", "execution": [], "executionId": "02f44452-7883-4ea4-a854-973121fb6020", "outputPathId": "__DEFAULT__", "outputVariables": [], "trackingId": 12 } }, { "actionDecision": { "actionId": "efa25778-0b01-4e78-ab66-b5893cbfa72c", "dateTime": "2023-10-12T09:09:34.462Z", "executionId": "6e39cc7f-4701-4b9e-b0d0-f2b4adf80752", "outputPathId": "__NO__", "trackingId": 15 } }, { "actionDecision": { "actionId": "bcfc8a36-b4e4-4cb1-a9cf-f1fe9ec084cd", "dateTime": "2023-10-12T09:09:34.462Z", "executionId": "e6b8644a-d4ab-4743-a447-31b0e198ef60", "outputPathId": "__NO__", "trackingId": 23 } }, { "actionCommunicate": { "actionId": "137e8a9b-de39-4641-9304-2905548d4112", "dateTime": "2023-10-12T09:09:34.462Z", "executionId": "a1f21445-9841-43fb-8bf0-ba9111bb27b5", "trackingId": 17 } }, { "actionClearSlot": { "actionId": "768304ea-6aae-4a29-9f17-a708dcaba087", "dateTime": "2023-10-12T09:09:34.900Z", "executionId": "809640f3-5d0e-461e-9a6a-468e6afcc9c3", "outputVariables": [], "trackingId": 22 } }, { "actionLoopAnythingElse": { "actionId": "a6b6d035-f291-4c4b-bf8f-d6a9becc43e8", "dateTime": "2023-10-12T09:09:34.900Z", "execution": [], "executionId": "7a18178e-a65e-4bb4-abd7-5c2cf5ad78a7", "outputPathId": "__LOOP__", "outputVariables": [], "trackingId": 18 } }, { "actionCommunicate": { "actionId": "4bb7d902-57ad-4183-924d-02e03a03c1f3", "dateTime": "2023-10-12T09:09:50.229Z", "executionId": "b1574b6a-cc2b-4a56-87ad-46b1430c2f0b", "trackingId": 19 } }, { "actionExitBotFlow": { "actionId": "8d2f40dc-9269-41b4-bf8e-d7ac4d631fe3", "dateTime": "2023-10-12T09:09:50.495Z", "executionId": "8f97d86c-cd6a-4c14-aa4b-bf5bcd60f89c", "trackingId": 14 } }, { "endedBotState": { "dateTime": "2023-10-12T09:09:50.495Z" } }, { "endedFlow": { "dateTime": "2023-10-12T09:09:50.495Z", "flowExitReason": "FLOW_EXIT", "naturalLanguageUnderstanding": { "intent": { "intentName": "Check Account Balance" } }, "outputVariables": [] } } ], "executionId": "9ce12079-8e45-42ad-8130-2f104b258777", "flowId": "7df71c06-4d63-43ef-8db7-d90e68d037f2", "flowIsDebug": false, "flowName": "Bank Bot", "flowType": "bot", "flowVersion": "7.0", "startDateTime": "2023-10-12T09:09:17.642Z" } }
名前 | タイプ | 説明 |
---|---|---|
名前 | タイプ | 説明 |
フロー:conversationId | 文字列 | ジェネシス・クラウドにおける会話の一意の識別子。 会話は複数のフローやエージェントを含むことができる。 |
フロー:部門:ID | 文字列 |
フローの実行が完了した後、Genesys Cloudが実行データを保存するときにフローがいる部門。
|
フロー:終了日時 | 文字列 |
The date and time when the flow execution was completed.
|
フロー:実行 | 配列 | フローが実行されたときに何が起こったかを記述するフロー実行項目の配列。 |
フロー:実行:開始フロー | オブジェクト | フローの開始日時、およびフローが実行された言語を記述するフロー実行項目。 |
フロー:実行:startedBotState | オブジェクト |
A flow execution item that describes:
|
flow:execution:actionAskForIntent(フロー:実行:アクションAskForインテント | オブジェクト |
Ask for Intent アクション の実行データを保持するフロー実行項目:
|
flow:execution:actionAskForスロット | オブジェクト |
Ask for Slot アクション の実行データを保持するフロー実行項目:
|
フロー:実行:アクション決定 | オブジェクト |
決定アクション の実行データを保持するフロー実行項目:
|
flow:execution:actionコミュニケーション | オブジェクト |
Communicate アクション の実行データを保持するフロー実行項目:
|
flow:execution:actionクリアスロット | オブジェクト |
クリアスロットアクション の実行データを保持するフロー実行項目:
|
flow:execution:actionLoopAnythingElse | オブジェクト |
|
flow:execution:actionExitBotFlow(フロー:実行:アクションエグジットボットフロー | オブジェクト |
ボットフロー終了アクション の実行データを保持するフロー実行項目:
|
フロー:実行:endedBotState | オブジェクト |
フロー実行項目。
|
フロー:実行:終了フロー | オブジェクト |
を記述するフロー実行項目。
|
flow:executionId | 文字列 |
実行されたアーキテクトフローの一意のインスタンスを識別する一意の識別子。 |
flow:flowId | 文字列 |
Architectにおけるフローの一意な識別子。 |
flow:flowIsDebug | ブール型 |
実行されたフローがデバッグモードであったかどうかを指定する。 |
flow:flowName(フロー名 | 文字列 |
走った流れの名前。 |
flow:flowType(フロータイプ | 文字列 |
実行されたフローのアーキテクトフロータイプ。 |
flow:フローバージョン | 文字列 |
実行されたフローのバージョン。 |
フロー:開始日時 | 文字列 |
フローの実行が開始された日時。 |
- Genesys Cloudは、過去のフロー実行データを10日間保存します。
- Genesys Cloud supports returning a maximum of 200 execution data instances per query. It is important to note that Genesys Cloud cannot guarantee that the query returns the most recent 200 execution instances.
- Genesys Cloudは、3日間を超えるフローの実行履歴データを保存しません。
- In call flows, Genesys Cloud reports only the first 4,500 action executions.
- If a value of the following data types exceeds the size limit that Genesys Cloud can store in execution data, Genesys Cloud reports
valueIsTooLarge:true
:- JSON – maximum 1,000 characters
- String – maximum 253 characters
- Collection data types – maximum 20 items
- Genesys Cloud does not currently report execution data for secure call flows. Genesys Cloud only allows reporting data at the Base level for execution instances of secure flows, for example, bot flows that ran in a secure session, regardless of the execution data setting of your organization or the specific secure bot flows.
- It is not possible to query execution data for flow instances by start or end date time. To narrow the scope of responses, Genesys Cloud recommends that you rely on conversationId instead.
The following video walks you through how to enable and configure historical execution data. The video also demonstrates how you can use the various data settings for advanced troubleshooting.
アーキテクトの特徴
Historical execution data is retrievable via the public API and the notification service for third-party access. For more information about the relevant endpoints in the public API, see Start a process (job) to prepare a download of a singular flow execution data instance by Id and Get the status and/or results of an asynchronous flow execution data retrieval job in the Genesys Cloud Developer Center.
- フロー中にアクションが実行された回数などの集計データはサポートされていません。
- フロー実行データを表示できるのは、公開されているフローのみです。 最新の実行データを確実に取得するには、クエリーを実行する前にフローを再パブリッシュし、そのフローを通じてインタラクションを送信するようにしてください。