Reporting properties

If your design has simple variables that will store reporting data, or sensitive information, you can mark these variables with a reporting property: either Attribute, Dimension, Metric, or Sensitive.

For complex variables, you can mark sensitive fields in the schema upon which they are based.

The predefined variables lastCollectionResultObject, and lastConfirmationResultObject are always considered sensitive.

You can mark complex variables based on the DynamicMessageReference schema as sensitive, individually.

Property Description
Attribute Information or indicators that can be used for analysis (for example, authentication status, transaction execution status, intents matched during a call)—available for all types of simple variables, except for List and Dynamic Entity Data
Dimension Information that can be used as filter criteria (for example, customer type, brand name)—available for simple variables of types string and Boolean
Metric Numerical data that can be aggregated (for example, to keep track of the value of merchandise sold through a virtual assistant, or the number of complaints that were filed)—available for simple variables of types integer and decimal
Sensitive Sensitive information to be masked in application logs; for example, date of birth, account balance—available for all types of simple variables, for complex variables based on the DynamicMessageReference schema, and for schema fields

At runtime, variables marked with a reporting property are written to event logs as key-value pairs with additional metadata, at session start (names and types), and whenever they are set or updated (names and values).

See Dialog payloads, in the runtime event logs documentation, for more information.