Edit

Sdk Message Processing Step (SdkMessageProcessingStep) table/entity reference (Microsoft Dataverse)

Stage in the execution pipeline that a plug-in is to execute.

Messages

The following table lists the messages for the Sdk Message Processing Step (SdkMessageProcessingStep) 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
Associate
Event: True
Associate records Associate records
Create
Event: False
POST /sdkmessageprocessingsteps
See Create
Create records
Delete
Event: False
DELETE /sdkmessageprocessingsteps(sdkmessageprocessingstepid)
See Delete
Delete records
Disassociate
Event: True
Disassociate records Disassociate records
Retrieve
Event: False
GET /sdkmessageprocessingsteps(sdkmessageprocessingstepid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: False
GET /sdkmessageprocessingsteps
See Query data
Query data
SetState
Event: False
PATCH /sdkmessageprocessingsteps(sdkmessageprocessingstepid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: False
PATCH /sdkmessageprocessingsteps(sdkmessageprocessingstepid)
See Update
Update records
Upsert
Event: False
PATCH /sdkmessageprocessingsteps(sdkmessageprocessingstepid)
See Upsert a table row
UpsertRequest

Properties

The following table lists selected properties for the Sdk Message Processing Step (SdkMessageProcessingStep) table.

Property Value
DisplayName Sdk Message Processing Step
DisplayCollectionName Sdk Message Processing Steps
SchemaName SdkMessageProcessingStep
CollectionSchemaName SdkMessageProcessingSteps
EntitySetName sdkmessageprocessingsteps
LogicalName sdkmessageprocessingstep
LogicalCollectionName sdkmessageprocessingsteps
PrimaryIdAttribute sdkmessageprocessingstepid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

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 Asynchronous Automatic Delete
IsValidForForm True
IsValidForRead True
LogicalName asyncautodelete
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sdkmessageprocessingstep_asyncautodelete
DefaultValue False
True Label Yes
False Label No

CanBeBypassed

Property Value
Description
DisplayName
IsValidForForm True
IsValidForRead True
LogicalName canbebypassed
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sdkmessageprocessingstep_canbebypassed
DefaultValue False
True Label Yes
False Label No

CanUseReadOnlyConnection

Property Value
Description Identifies whether a SDK Message Processing Step type will be ReadOnly or Read Write. false - ReadWrite, true - ReadOnly
DisplayName Intent
IsValidForForm False
IsValidForRead True
LogicalName canusereadonlyconnection
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName isoperationintentreadonly
DefaultValue False
True Label Yes
False Label No

Category

Property Value
Description For internal use only.
DisplayName Category
IsValidForForm True
IsValidForRead True
LogicalName category
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

Configuration

Property Value
Description Step-specific configuration for the plug-in type. Passed to the plug-in constructor at run time.
DisplayName Configuration
IsValidForForm True
IsValidForRead True
LogicalName configuration
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

Description

Property Value
Description Description of the SDK message processing step.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 256

EnablePluginProfiler

Property Value
Description EnablePluginProfiler
DisplayName EnablePluginProfiler
IsValidForForm True
IsValidForRead True
LogicalName enablepluginprofiler
RequiredLevel None
Type Boolean
GlobalChoiceName sdkmessageprocessingstep_enablepluginprofiler
DefaultValue False
True Label Yes
False Label No

EventExpander

Property Value
Description Configuration for sending pipeline events to the Event Expander service.
DisplayName EventExpander
IsValidForForm True
IsValidForRead True
LogicalName eventexpander
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

EventHandler

Property Value
Description Unique identifier of the associated event handler.
DisplayName Event Handler
IsValidForForm True
IsValidForRead True
LogicalName eventhandler
RequiredLevel SystemRequired
Type Lookup
Targets plugintype, serviceendpoint

EventHandlerTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName eventhandlertypecode
RequiredLevel None
Type EntityName

FilteringAttributes

Property Value
Description Comma-separated list of attributes. If at least one of these attributes is modified, the plug-in should execute.
DisplayName Filtering Attributes
IsValidForForm True
IsValidForRead True
LogicalName filteringattributes
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100000

FxExpressionId

Property Value
Description Unique identifier for fxexpression associated with SdkMessageProcessingStep.
DisplayName fxexpressionid
IsValidForForm True
IsValidForRead True
LogicalName fxexpressionid
RequiredLevel None
Type Lookup
Targets fxexpression

ImpersonatingUserId

Property Value
Description Unique identifier of the user to impersonate context when step is executed.
DisplayName Impersonating User
IsValidForForm True
IsValidForRead True
LogicalName impersonatinguserid
RequiredLevel None
Type Lookup
Targets systemuser

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
IsValidForForm False
IsValidForRead True