Desktop flow action logs configuration

This page provides configuration guidance for desktop flow logs, located under the environment's feature section in the Power Platform admin center.

The Activation status of run action logs setting defines when desktop flow run action logs should be captured and even allows you to turn them off completely.

Configure desktop flow action log version (preview)

The Action logs version allows you to choose V1, V2, or both.

The FlowLogs entity time to live in minutes (Preview) value determines how long action logs should be retained in the Flow Logs elastic table. Dataverse automatically deletes records that are older than the specified time-frame. Here are some example values for your convenience.

Key differences of desktop flow logs V1 and V2

The following table describes the differences between desktop flow logs V1 and V2:

Logs V2 offers significant enhancements over the previous version, V1. V2 uses the elastic tables feature, which is great for handling large data volumes, like action log scenarios, and has built-in data retention (TTL). Ideal for organizations needing to access significant amount of data for reporting, governance, and integration with automatic data retention control.

Dataverse capacity demand calculations for logs V2 (preview)

The following table shows sample Dataverse database storage consumption estimates per desktop flow run when using logs V2. It outlines the approximate storage demand for different numbers of actions, assuming an average of 3 KB of storage per action.

Querying logs V2 (preview) data

Accessing desktop flow action logs data can be achieved by making an API call to the Dataverse backend, either using the traditional API call syntax or using the new ExecuteCosmosSqlQuery method. This method allows you to execute a SQL query against Dataverse, enabling the retrieval and filtering of data.

The data model of logs V2 is based on a parent-child relationship between the Flow Session and Flow Log tables. Every record inherits permissions from its parent flow session record. In order to query action logs of a specific desktop flow run, you can use the following query syntax.

Traditional Dataverse API call syntax

The following API call retrieves a specific flow session by its ID (9d51aa1f-315e-43ab-894f-bc445dfb049b) and then accesses the associated action logs using the flowsession_flowlog_parentobjectid relationship.

[Organization URI]/api/data/v9.0/flowsessions(9d51aa1f-315e-43ab-894f-bc445dfb049b)/flowsession_flowlog_parentobjectid  

New ExecuteCosmosSqlQuery API call syntax using FlowLogs table

    [Organization URI]/api/data/v9.2/ExecuteCosmosSqlQuery(
    QueryText=@p1,EntityLogicalName=@p2,PartitionId=@p3,QueryParameters=@p4,PageSize=@p5)?
    @p1: 'SELECT c.props.flowlogid as flowlogid, c.props.createdon as createdon, c.props.data as data, c.props.level as level, c.props.type as type, c.ttl as ttlinseconds, c.props.cloudflowid as cloudflowid, c.props.cloudflowrunid as cloudflowrunid, c.props.desktopflowid as desktopflowid, c.props.flowmachineid as flowmachineid, c.props.flowmachinegroupid as flowmachinegroupid, c.props.flowsessionid as flowsessionid, c.props.workqueueid as workqueueid, c.props.workqueueitemid as workqueueitemid FROM c WHERE c.props.type IN (100000001) ORDER BY c.props.data.startTime DESC'
    @p2: 'flowlog'
    @p3: 'flowsession_40590757-a9c0-4f4c-abfc-e2f389049d90'
    @p4: {"Keys":["@referencingParentId","@referencingParentLogicalName"],"Values":[{"Type":"System.Guid","Value":"40590757-a9c0-4f4c-abfc-e2f389049d90"},{"Type":"System.String","Value":"flowsession"}]}
    @p5: 50

Learn more about querying JSON columns in elastic tables.

Breaking down the call into individual pieces

• The base URL (https://[my org].api.crm[my region].dynamics.com/api/data/v9.2/) is the endpoint for the Dataverse Web API.
• ExecuteCosmosSqlQuery is the method being called. This method allows the execution of a SQL query against Dataverse.
• The parameters for the ExecuteCosmosSqlQuery method are provided in parentheses following the method name. These are:
  • QueryText=@p1: The SQL query to be executed. In this case, the query selects various properties from a table where the type is 100000001 (desktop flow action log type) and orders the results by the startTime property in descending order.
  • EntityLogicalName=@p2: This is the logical name of the table (flowlog) that stores the action logs.
  • PartitionId=@p3: This parameter is used to identify the partition within Azure Cosmos DB where the query is to be executed. It's set to flowsession_[flowsessionid].
  • QueryParameters=@p4: This is a JSON object specifying parameters for the query. In the previous example, it's specifying a key-value pair where the keys are @referencingParentId and @referencingParentLogicalName with values of flowsessionid (GUID) and type of the table flowsession.
  • PageSize=p5: This is the query page size.

Known limitations

• Logs V2 (preview) are only available for desktop flow runs that are launched from a cloud flow through the desktop flow connector action.
• Changing action log version doesn't migrate previous desktop flow action logs to the new log storage type.