Proactive Delivery Batch (msdyn_proactive_delivery_batch) table/entity reference (Microsoft Dynamics 365 Field Service)

Messages

The following table lists the messages for the Proactive Delivery Batch (msdyn_proactive_delivery_batch) 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
Assign Event: True	PATCH /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) Update the ownerid property.	AssignRequest
Associate Event: True	Associate records	Associate records
BulkRetain Event: True	BulkRetain	Learn to use messages with the SDK for .NET
Create Event: True	POST /msdyn_proactive_delivery_batches See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
GrantAccess Event: True	GrantAccess	GrantAccessRequest
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
ModifyAccess Event: True	ModifyAccess	ModifyAccessRequest
PurgeRetainedContent Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Retain Event: True	Retain	Learn to use messages with the SDK for .NET
Retrieve Event: True	GET /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /msdyn_proactive_delivery_batches See Query data	Query data
RetrievePrincipalAccess Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess Event: True	RevokeAccess	RevokeAccessRequest
RollbackRetain Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
SetState Event: True	PATCH /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /msdyn_proactive_delivery_batches(msdyn_proactive_delivery_batchid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest
ValidateRetentionConfig Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Proactive Delivery Batch (msdyn_proactive_delivery_batch) table.

Property	Value
DisplayName	Proactive Delivery Batch
DisplayCollectionName	Proactive Delivery Batches
SchemaName	msdyn_proactive_delivery_batch
CollectionSchemaName	msdyn_proactive_delivery_batchs
EntitySetName	msdyn_proactive_delivery_batches
LogicalName	msdyn_proactive_delivery_batch
LogicalCollectionName	msdyn_proactive_delivery_batchs
PrimaryIdAttribute	msdyn_proactive_delivery_batchid
PrimaryNameAttribute	msdyn_batch_id
TableType	Standard
OwnershipType	UserOwned

Writable columns/attributes

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

• ImportSequenceNumber
• IsCustomizable
• msdyn_batch_id
• msdyn_deliveries_created
• msdyn_delivery_creation_failures
• msdyn_error_code
• msdyn_error_message
• msdyn_file_format_errors
• msdyn_file_id
• msdyn_last_processed_line_index
• msdyn_proactive_delivery_batchId
• msdyn_proactive_engagement_config
• msdyn_status
• msdyn_total_lines_processed
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	importsequencenumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

IsCustomizable

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

msdyn_batch_id

Property	Value
Description	Unique identifier for the batch, used as journey id on deliveries
DisplayName	Batch Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_batch_id
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_deliveries_created

Property	Value
Description	Number of delivery task records successfully created
DisplayName	Tasks Created
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_deliveries_created
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_delivery_creation_failures

Property	Value
Description	Number of rows for which no delivery task could be created.
DisplayName	Failed Rows
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_delivery_creation_failures
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_error_code

Property	Value
Description
DisplayName	Error Code
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_error_code
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

msdyn_error_message

Property	Value
Description	Error message if batch processing failed
DisplayName	Error Message
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_error_message
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

msdyn_file_format_errors

Property	Value
Description	Number of file format errors
DisplayName	File Format Errors
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_file_format_errors
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_file_id

Property	Value
Description	Reference to the uploaded file
DisplayName	File Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_file_id
RequiredLevel	None
Type	Lookup
Targets	msdyn_fileupload

msdyn_last_processed_line_index

Property	Value
Description	Index of the last processed line
DisplayName	Last Processed Line Index
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_last_processed_line_index
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_proactive_delivery_batchId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Proactive Delivery Batch
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_proactive_delivery_batchid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_proactive_engagement_config

Property	Value
Description	Reference to the Proactive Engagement Configuration
DisplayName	Proactive Engagement Configuration
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_proactive_engagement_config
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_proactive_engagement_config

msdyn_status

Property	Value
Description	Status of the batch processing
DisplayName	Batch Status
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_status
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	192360000
GlobalChoiceName	msdyn_proactive_delivery_batch_msdyn_status

msdyn_status Choices/Options

Value	Label
192360000	Not Started
192360001	In Progress
192360002	Completed
192360003	Completed With Errors
192360004	Failed

msdyn_total_lines_processed

Property	Value
Description	Total number of lines processed
DisplayName	Total Lines Processed
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_total_lines_processed
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the Proactive Delivery Batch
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	msdyn_proactive_delivery_batch_statecode

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: Active
1	Label: Inactive DefaultStatus: 2 InvariantName: Inactive

statuscode

Property	Value
Description	Reason for the status of the Proactive Delivery Batch
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	msdyn_proactive_delivery_batch_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

• ComponentIdUnique
• ComponentState
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• IsManaged
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OverwriteTime
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• SolutionId
• SupportingSolutionId
• VersionNumber

ComponentIdUnique

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	componentstate

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	ismanaged
DefaultValue	False
True Label	Managed
False Label	Unmanaged

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	SystemRequired
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Type	Lookup
Targets	systemuser

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	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• msdyn_file_id_msdyn_proactive_delivery_batch
• msdyn_proactive_engagement_config_msdyn_proactive_delivery_batch

msdyn_file_id_msdyn_proactive_delivery_batch

One-To-Many Relationship: msdyn_fileupload msdyn_file_id_msdyn_proactive_delivery_batch

Property	Value
ReferencedEntity	msdyn_fileupload
ReferencedAttribute	msdyn_fileuploadid
ReferencingAttribute	msdyn_file_id
ReferencingEntityNavigationPropertyName	msdyn_file_id
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

msdyn_proactive_engagement_config_msdyn_proactive_delivery_batch

One-To-Many Relationship: msdyn_proactive_engagement_config msdyn_proactive_engagement_config_msdyn_proactive_delivery_batch

Property	Value
ReferencedEntity	msdyn_proactive_engagement_config
ReferencedAttribute	msdyn_proactive_engagement_configid
ReferencingAttribute	msdyn_proactive_engagement_config
ReferencingEntityNavigationPropertyName	msdyn_proactive_engagement_config
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

msdyn_proactive_delivery_batch_msdyn_proactive_delivery_batch_error

Many-To-One Relationship: msdyn_proactive_delivery_batch_error msdyn_proactive_delivery_batch_msdyn_proactive_delivery_batch_error

Property	Value
ReferencingEntity	msdyn_proactive_delivery_batch_error
ReferencingAttribute	msdyn_batch_id
ReferencedEntityNavigationPropertyName	msdyn_proactive_delivery_batch_msdyn_proactive_delivery_batch_error
IsCustomizable	False
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference