SdkMessageProcessingStep entity reference
- आलेख
-
-
Stage in the execution pipeline that a plug-in is to execute.
Messages
Properties
Property |
Value |
CollectionSchemaName |
SdkMessageProcessingSteps |
DisplayCollectionName |
Sdk Message Processing Steps |
DisplayName |
Sdk Message Processing Step |
EntitySetName |
sdkmessageprocessingsteps |
IsBPFEntity |
False |
LogicalCollectionName |
sdkmessageprocessingsteps |
LogicalName |
sdkmessageprocessingstep |
OwnershipType |
OrganizationOwned |
PrimaryIdAttribute |
sdkmessageprocessingstepid |
PrimaryNameAttribute |
name |
SchemaName |
SdkMessageProcessingStep |
Writable attributes
These 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 |
AsyncAutoDelete Choices/Options
Value |
Label |
Description |
1 |
Yes |
|
0 |
No |
|
DefaultValue: 0
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 |
IsValidForUpdate |
False |
LogicalName |
canusereadonlyconnection |
RequiredLevel |
SystemRequired |
Type |
Boolean |
CanUseReadOnlyConnection Choices/Options
Value |
Label |
Description |
1 |
Yes |
|
0 |
No |
|
DefaultValue: 0
Configuration
Property |
Value |
Description |
Step-specific configuration for the plug-in type. Passed to the plug-in constructor at run time. |
DisplayName |
Configuration |
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
configuration |
MaxLength |
1073741823 |
RequiredLevel |
None |
Type |
String |
Description
Property |
Value |
Description |
Description of the SDK message processing step. |
DisplayName |
Description |
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
description |
MaxLength |
256 |
RequiredLevel |
None |
Type |
String |
EventExpander
Property |
Value |
Description |
Configuration for sending pipeline events to the Event Expander service. |
DisplayName |
EventExpander |
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
eventexpander |
MaxLength |
1073741823 |
RequiredLevel |
None |
Type |
String |
EventHandler
Property |
Value |
Description |
Unique identifier of the associated event handler. |
DisplayName |
Event Handler |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
eventhandler |
RequiredLevel |
SystemRequired |
Targets |
plugintype,serviceendpoint |
Type |
Lookup |
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 |
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
filteringattributes |
MaxLength |
100000 |
RequiredLevel |
None |
Type |
String |
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 |
Targets |
systemuser |
Type |
Lookup |
IntroducedVersion
Property |
Value |
Description |
Version in which the form is introduced. |
DisplayName |
Introduced Version |
FormatName |
VersionNumber |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
IsValidForUpdate |
False |
LogicalName |
introducedversion |
MaxLength |
48 |
RequiredLevel |
None |
Type |
String |
InvocationSource
Property |
Value |
Description |
Identifies if a plug-in should be executed from a parent pipeline, a child pipeline, or both. |
DisplayName |
Invocation Source |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
invocationsource |
RequiredLevel |
SystemRequired |
Type |
Picklist |
InvocationSource Choices/Options
Value |
Label |
Description |
-1 |
Internal |
|
0 |
Parent |
|
1 |
Child |
|
IsCustomizable
Property |
Value |
Description |
Information that specifies whether this component can be customized. |
DisplayName |
Customizable |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
iscustomizable |
RequiredLevel |
SystemRequired |
Type |
ManagedProperty |
IsHidden
Property |
Value |
Description |
Information that specifies whether this component should be hidden. |
DisplayName |
Hidden |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
ishidden |
RequiredLevel |
SystemRequired |
Type |
ManagedProperty |
Mode
Property |
Value |
Description |
Run-time mode of execution, for example, synchronous or asynchronous. |
DisplayName |
Execution Mode |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
mode |
RequiredLevel |
SystemRequired |
Type |
Picklist |
Mode Choices/Options
Value |
Label |
Description |
0 |
Synchronous |
|
1 |
Asynchronous |
|
Name
Property |
Value |
Description |
Name of SdkMessage processing step. |
DisplayName |
Name |
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
name |
MaxLength |
256 |
RequiredLevel |
SystemRequired |
Type |
String |
PluginTypeId
Property |
Value |
Description |
Unique identifier of the plug-in type associated with the step. |
DisplayName |
Plug-In Type |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
plugintypeid |
RequiredLevel |
SystemRequired |
Targets |
sdkmessagefilter |
Type |
Lookup |
Rank
Property |
Value |
Description |
Processing order within the stage. |
DisplayName |
Execution Order |
Format |
None |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
rank |
MaxValue |
2147483647 |
MinValue |
-2147483648 |
RequiredLevel |
SystemRequired |
Type |
Integer |
SdkMessageFilterId
Property |
Value |
Description |
Unique identifier of the SDK message filter. |
DisplayName |
SdkMessage Filter |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
sdkmessagefilterid |
RequiredLevel |
None |
Targets |
sdkmessagefilter |
Type |
Lookup |
SdkMessageId
Property |
Value |
Description |
Unique identifier of the SDK message. |
DisplayName |
SDK Message |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
sdkmessageid |
RequiredLevel |
SystemRequired |
Targets |
sdkmessage |
Type |
Lookup |
SdkMessageProcessingStepId
Property |
Value |
Description |
Unique identifier of the SDK message processing step entity. |
DisplayName |
|
IsValidForForm |
False |
IsValidForRead |
True |
IsValidForUpdate |
False |
LogicalName |
sdkmessageprocessingstepid |
RequiredLevel |
SystemRequired |
Type |
Uniqueidentifier |
SdkMessageProcessingStepSecureConfigId
Property |
Value |
Description |
Unique identifier of the Sdk message processing step secure configuration. |
DisplayName |
SDK Message Processing Step Secure Configuration |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
sdkmessageprocessingstepsecureconfigid |
RequiredLevel |
ApplicationRequired |
Targets |
sdkmessageprocessingstepsecureconfig |
Type |
Lookup |
Stage
Property |
Value |
Description |
Stage in the execution pipeline that the SDK message processing step is in. |
DisplayName |
Execution Stage |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
stage |
RequiredLevel |
SystemRequired |
Type |
Picklist |
Stage Choices/Options
Value |
Label |
Description |
5 |
Initial Pre-operation (For internal use only) |
|
10 |
Pre-validation |
|
15 |
Internal Pre-operation Before External Plugins (For internal use only) |
|
20 |
Pre-operation |
|
25 |
Internal Pre-operation After External Plugins (For internal use only) |
|
30 |
Main Operation (For internal use only) |
|
35 |
Internal Post-operation Before External Plugins (For internal use only) |
|
40 |
Post-operation |
|
45 |
Internal Post-operation After External Plugins (For internal use only) |
|
50 |
Post-operation (Deprecated) |
|
55 |
Final Post-operation (For internal use only) |
|
StateCode
Property |
Value |
Description |
Status of the SDK message processing step. |
DisplayName |
Status |
IsValidForCreate |
False |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
statecode |
RequiredLevel |
SystemRequired |
Type |
State |
StateCode Choices/Options
Value |
Label |
DefaultStatus |
InvariantName |
0 |
Enabled |
1 |
Enabled |
1 |
Disabled |
2 |
Disabled |
StatusCode
Property |
Value |
Description |
Reason for the status of the SDK message processing step. |
DisplayName |
Status Reason |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
statuscode |
RequiredLevel |
None |
Type |
Status |
StatusCode Choices/Options
Value |
Label |
State |
1 |
Enabled |
0 |
2 |
Disabled |
1 |
SupportedDeployment
Property |
Value |
Description |
Deployment that the SDK message processing step should be executed on; server, client, or both. |
DisplayName |
Deployment |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
supporteddeployment |
RequiredLevel |
SystemRequired |
Type |
Picklist |
SupportedDeployment Choices/Options
Value |
Label |
Description |
0 |
Server Only |
|
1 |
Microsoft Dynamics 365 Client for Outlook Only |
|
2 |
Both |
|
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
ComponentState
Property |
Value |
Description |
For internal use only. |
DisplayName |
Component State |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
componentstate |
RequiredLevel |
SystemRequired |
Type |
Picklist |
ComponentState Choices/Options
Value |
Label |
Description |
0 |
Published |
|
1 |
Unpublished |
|
2 |
Deleted |
|
3 |
Deleted Unpublished |
|
CreatedBy
Property |
Value |
Description |
Unique identifier of the user who created the SDK message processing step. |
DisplayName |
Created By |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
createdby |
RequiredLevel |
None |
Targets |
systemuser |
Type |
Lookup |
CreatedByName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
createdbyname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
CreatedOn
Property |
Value |
DateTimeBehavior |
UserLocal |
Description |
Date and time when the SDK message processing step was created. |
DisplayName |
Created On |
Format |
DateAndTime |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
createdon |
RequiredLevel |
None |
Type |
DateTime |
CreatedOnBehalfBy
Property |
Value |
Description |
Unique identifier of the delegate user who created the sdkmessageprocessingstep. |
DisplayName |
Created By (Delegate) |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
createdonbehalfby |
RequiredLevel |
None |
Targets |
systemuser |
Type |
Lookup |
CreatedOnBehalfByName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
createdonbehalfbyname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
CreatedOnBehalfByYomiName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
createdonbehalfbyyominame |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
CustomizationLevel
Property |
Value |
Description |
Customization level of the SDK message processing step. |
DisplayName |
|
Format |
None |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
customizationlevel |
MaxValue |
255 |
MinValue |
-255 |
RequiredLevel |
SystemRequired |
Type |
Integer |
EventHandlerName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
eventhandlername |
MaxLength |
256 |
RequiredLevel |
None |
Type |
String |
ImpersonatingUserIdName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
impersonatinguseridname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
IsManaged
Property |
Value |
Description |
Information that specifies whether this component is managed. |
DisplayName |
State |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
ismanaged |
RequiredLevel |
SystemRequired |
Type |
Boolean |
IsManaged Choices/Options
Value |
Label |
Description |
1 |
Managed |
|
0 |
Unmanaged |
|
DefaultValue: 0
ModifiedBy
Property |
Value |
Description |
Unique identifier of the user who last modified the SDK message processing step. |
DisplayName |
Modified By |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
modifiedby |
RequiredLevel |
None |
Targets |
systemuser |
Type |
Lookup |
ModifiedByName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
modifiedbyname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
ModifiedOn
Property |
Value |
DateTimeBehavior |
UserLocal |
Description |
Date and time when the SDK message processing step was last modified. |
DisplayName |
Modified On |
Format |
DateAndTime |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
modifiedon |
RequiredLevel |
None |
Type |
DateTime |
ModifiedOnBehalfBy
Property |
Value |
Description |
Unique identifier of the delegate user who last modified the sdkmessageprocessingstep. |
DisplayName |
Modified By (Delegate) |
IsValidForForm |
True |
IsValidForRead |
True |
LogicalName |
modifiedonbehalfby |
RequiredLevel |
None |
Targets |
systemuser |
Type |
Lookup |
ModifiedOnBehalfByName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
modifiedonbehalfbyname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
ModifiedOnBehalfByYomiName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
modifiedonbehalfbyyominame |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
OrganizationId
Property |
Value |
Description |
Unique identifier of the organization with which the SDK message processing step is associated. |
DisplayName |
|
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
organizationid |
RequiredLevel |
SystemRequired |
Targets |
organization |
Type |
Lookup |
OverwriteTime
Property |
Value |
DateTimeBehavior |
UserLocal |
Description |
For internal use only. |
DisplayName |
Record Overwrite Time |
Format |
DateOnly |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
overwritetime |
RequiredLevel |
SystemRequired |
Type |
DateTime |
PluginTypeIdName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
plugintypeidname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
SdkMessageIdName
Property |
Value |
Description |
|
DisplayName |
|
FormatName |
Text |
IsLocalizable |
False |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
sdkmessageidname |
MaxLength |
100 |
RequiredLevel |
None |
Type |
String |
SdkMessageProcessingStepIdUnique
Property |
Value |
Description |
Unique identifier of the SDK message processing step. |
DisplayName |
|
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
sdkmessageprocessingstepidunique |
RequiredLevel |
SystemRequired |
Type |
Uniqueidentifier |
SolutionId
Property |
Value |
Description |
Unique identifier of the associated solution. |
DisplayName |
Solution |
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
solutionid |
RequiredLevel |
SystemRequired |
Type |
Uniqueidentifier |
SupportingSolutionId
Property |
Value |
Description |
For internal use only. |
DisplayName |
Solution |
IsValidForForm |
False |
IsValidForRead |
False |
LogicalName |
supportingsolutionid |
RequiredLevel |
None |
Type |
Uniqueidentifier |
VersionNumber
Property |
Value |
Description |
Number that identifies a specific revision of the SDK message processing step. |
DisplayName |
|
IsValidForForm |
False |
IsValidForRead |
True |
LogicalName |
versionnumber |
MaxValue |
9223372036854775807 |
MinValue |
-9223372036854775808 |
RequiredLevel |
None |
Type |
BigInt |
One-To-Many Relationships
Listed by SchemaName.
SdkMessageProcessingStep_AsyncOperations
Same as the SdkMessageProcessingStep_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property |
Value |
ReferencingEntity |
asyncoperation |
ReferencingAttribute |
owningextensionid |
IsHierarchical |
False |
IsCustomizable |
False |
ReferencedEntityNavigationPropertyName |
SdkMessageProcessingStep_AsyncOperations |
AssociatedMenuConfiguration |
Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration |
Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
sdkmessageprocessingstepid_sdkmessageprocessingstepimage
Same as the sdkmessageprocessingstepid_sdkmessageprocessingstepimage many-to-one relationship for the sdkmessageprocessingstepimage entity.
Property |
Value |
ReferencingEntity |
sdkmessageprocessingstepimage |
ReferencingAttribute |
sdkmessageprocessingstepid |
IsHierarchical |
False |
IsCustomizable |
False |
ReferencedEntityNavigationPropertyName |
sdkmessageprocessingstepid_sdkmessageprocessingstepimage |
AssociatedMenuConfiguration |
Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration |
Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
plugintype_sdkmessageprocessingstep
See the plugintype_sdkmessageprocessingstep one-to-many relationship for the plugintype entity.
sdkmessagefilterid_sdkmessageprocessingstep
See the sdkmessagefilterid_sdkmessageprocessingstep one-to-many relationship for the sdkmessagefilter entity.
serviceendpoint_sdkmessageprocessingstep
See the serviceendpoint_sdkmessageprocessingstep one-to-many relationship for the serviceendpoint entity.
lk_sdkmessageprocessingstep_createdonbehalfby
See the lk_sdkmessageprocessingstep_createdonbehalfby one-to-many relationship for the systemuser entity.
organization_sdkmessageprocessingstep
See the organization_sdkmessageprocessingstep one-to-many relationship for the organization entity.
impersonatinguserid_sdkmessageprocessingstep
See the impersonatinguserid_sdkmessageprocessingstep one-to-many relationship for the systemuser entity.
lk_sdkmessageprocessingstep_modifiedonbehalfby
See the lk_sdkmessageprocessingstep_modifiedonbehalfby one-to-many relationship for the systemuser entity.
modifiedby_sdkmessageprocessingstep
See the modifiedby_sdkmessageprocessingstep one-to-many relationship for the systemuser entity.
sdkmessageid_sdkmessageprocessingstep
See the sdkmessageid_sdkmessageprocessingstep one-to-many relationship for the sdkmessage entity.
sdkmessageprocessingstepsecureconfigid_sdkmessageprocessingstep
See the sdkmessageprocessingstepsecureconfigid_sdkmessageprocessingstep one-to-many relationship for the sdkmessageprocessingstepsecureconfig entity.
createdby_sdkmessageprocessingstep
See the createdby_sdkmessageprocessingstep one-to-many relationship for the systemuser entity.
plugintypeid_sdkmessageprocessingstep
See the plugintypeid_sdkmessageprocessingstep one-to-many relationship for the plugintype entity.
See also
About the Entity Reference
Web API EntityType Reference