Collect Flow Information with Custom Logging

The Log building block lets you capture custom information about an application or Flow and make it available in Analytics for reporting and troubleshooting.

You can use the Log block to capture two types of information:

• Key-value pairs: Store data collected during the dialog so it can be tracked later in Analytics.

• Enforced status: Record a custom success or failure status for a Flow or application.

  • Use Failure with a Custom Fail Reason to log a controlled failure status.

  • Use Success to mark a Flow or application as successful, even if a FailExitReason occurs later in the Flow. This is useful when success depends on specific business criteria rather than the final technical outcome.

You can review the collected values and enforced statuses in Analytics for statistical analysis. For example, you can log a custom failure status for an application or Flow even when the application or Flow does not technically fail.

You can reuse field names and values that already exist in the dialog, or enter custom text when you need to substitute a specific field or value.

To configure the Log building block:

1. From the Dialog Control panel, drag the Log building block onto the canvas and connect it to another building block.

2. Click the Settings button in the upper-right corner of the Log building block.

   

3. Select the logging option that matches the information you want to capture.

   

Log key-value pairs

To add a key-value pair:

1. Click + Add a Field.

2. Enter the key and value you want to log.

3. To add more pairs, click + Add more.

4. Click Save.

Enforce a status

To enforce a status:

1. Toggle Enforce Status.

2. Select Success or Failure from the dropdown list.

3. If you select Failure, enter a Custom Fail Reason.

4. Click Save.