Edit

Process (Workflow) table/entity reference (Microsoft Dataverse)

Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

Messages

The following table lists the messages for the Process (Workflow) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
AddRequiredDesktopFlowComponentsToSolutions
Event: False		 AddRequiredDesktopFlowComponentsToSolutions Learn to use messages with the SDK for .NET
Assign
Event: False		 PATCH /workflows(workflowid)
Update the ownerid property.		 AssignRequest
Associate
Event: True		 Associate records Associate records
CancelAllCloudFlowRuns
Event: False		 CancelAllCloudFlowRuns Learn to use messages with the SDK for .NET
Create
Event: False		 POST /workflows
See Create		 Create records
CreateWorkflowFromTemplate
Event: False		 CreateWorkflowFromTemplate CreateWorkflowFromTemplateRequest
Delete
Event: False		 DELETE /workflows(workflowid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
ExecuteWorkflow
Event: False		 ExecuteWorkflow ExecuteWorkflowRequest
GrantAccess
Event: False		 GrantAccess GrantAccessRequest
InitializeModernFlowFromAsyncWorkflow
Event: False		 InitializeModernFlowFromAsyncWorkflow InitializeModernFlowFromAsyncWorkflowRequest
install
Event: False		 install Learn to use messages with the SDK for .NET
ListChildDesktopFlows
Event: False		 ListChildDesktopFlows Learn to use messages with the SDK for .NET
ListConnectionReferences
Event: False		 ListConnectionReferences Learn to use messages with the SDK for .NET
ModifyAccess
Event: False		 ModifyAccess ModifyAccessRequest
Retrieve
Event: False		 GET /workflows(workflowid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /workflows
See Query data		 Query data
RetrievePrincipalAccess
Event: False		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: False		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RetrieveUnpublished
Event: True		 RetrieveUnpublished RetrieveUnpublishedRequest
RetrieveUnpublishedMultiple
Event: True		 RetrieveUnpublishedMultiple RetrieveUnpublishedMultipleRequest
RevokeAccess
Event: False		 RevokeAccess RevokeAccessRequest
RunDesktopFlow
Event: False		 RunDesktopFlow Learn to use messages with the SDK for .NET
SaveAsDesktopFlow
Event: False		 SaveAsDesktopFlow Learn to use messages with the SDK for .NET
SetState
Event: True		 PATCH /workflows(workflowid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: False		 PATCH /workflows(workflowid)
See Update		 Update records
Upsert
Event: False		 PATCH /workflows(workflowid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Process (Workflow) table.

Property Value
DisplayName Process
DisplayCollectionName Processes
SchemaName Workflow
CollectionSchemaName Workflows
EntitySetName workflows
LogicalName workflow
LogicalCollectionName workflows
PrimaryIdAttribute workflowid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AsyncAutoDelete

Property Value
Description Indicates whether the asynchronous system job is automatically deleted on completion.
DisplayName Delete Job On Completion
IsValidForForm False
IsValidForRead True
LogicalName asyncautodelete
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName workflow_asyncautodelete
DefaultValue False
True Label Yes
False Label No

BillingContext

Property Value
Description Billing context this flow is in.
DisplayName BillingContext
IsValidForForm True
IsValidForRead True
LogicalName billingcontext
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

BusinessProcessType

Property Value
Description Business Process Type.
DisplayName Business Process Type
IsValidForForm True
IsValidForRead True
LogicalName businessprocesstype
RequiredLevel None
Type Picklist
DefaultFormValue 0
GlobalChoiceName workflow_businessprocesstype

BusinessProcessType Choices/Options

Value Label
0 Business Flow
1 Task Flow

Category

Property Value
Description Category of the process.
DisplayName Category
IsValidForForm True
IsValidForRead True
LogicalName category
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName workflow_category

Category Choices/Options

Value Label
0 Workflow
1 Dialog
2 Business Rule
3 Action
4 Business Process Flow
5 Modern Flow
6 Desktop Flow
7 AI Flow

Claims

Property Value
Description Claims related to this workflow.
DisplayName Claims
IsValidForForm True
IsValidForRead True
LogicalName claims
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

ClientData

Property Value
Description Business logic converted into client data
DisplayName Client Data
IsValidForForm False
IsValidForRead True
LogicalName clientdata
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

ConnectionReferences

Property Value
Description Connection References related to this workflow.
DisplayName Connection references
IsValidForForm True
IsValidForRead True
LogicalName connectionreferences
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

CreateMetadata

Property Value
Description Create metadata for this workflow.
DisplayName Create metadata
IsValidForForm True
IsValidForRead True
LogicalName createmetadata
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

CreateStage

Property Value
Description Stage of the process when triggered on Create.
DisplayName Create Stage
IsValidForForm False
IsValidForRead True
LogicalName createstage
RequiredLevel None
Type Picklist
DefaultFormValue -1
GlobalChoiceName workflow_stage

CreateStage Choices/Options

Value Label
20 Pre-operation
40 Post-operation

Credentials

Property Value
Description Credentials related to this workflow.
DisplayName Credentials
IsValidForForm True
IsValidForRead True
LogicalName credentials
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

Definition

Property Value
Description Definition of the business logic of this workflow instance.
DisplayName Definition
IsValidForForm True
IsValidForRead True
LogicalName definition
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 16777216

DeleteStage

Property Value
Description Stage of the process when triggered on Delete.
DisplayName Delete stage
IsValidForForm False
IsValidForRead True
LogicalName deletestage
RequiredLevel None
Type Picklist
DefaultFormValue -1
GlobalChoiceName workflow_stage

DeleteStage Choices/Options

Value Label
20 Pre-operation
40 Post-operation

Dependencies

Property Value
Description Soft dependencies of this workflow instance.
DisplayName Dependencies
IsValidForForm True
IsValidForRead True
LogicalName dependencies
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

Description

Property Value
Description Description of the process.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable True
MaxLength 100000

DesktopFlowModules

Property Value
Description Desktop flow modules related to this workflow.
DisplayName Desktop flow modules
IsValidForForm True
IsValidForRead True
LogicalName desktopflowmodules
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

DynamicsSolutionContext

Property Value
Description comma separated list of one or more Dynamics First Party Solution Unique names that this workflow is in context of.
DisplayName DynamicsSolutionContext
IsValidForForm True
IsValidForRead True
LogicalName dynamicssolutioncontext
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 10000

EntityImage

Property Value
Description Shows the default image for the record.
DisplayName Default Image
IsValidForForm False
IsValidForRead True
LogicalName entityimage
RequiredLevel None
Type Image
CanStoreFullImage False