New Process (NewProcess) table/entity reference

Artikel
11/09/2024

New Process Business Process Flow

Messages

The following table lists the messages for the New Process (NewProcess) 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
`Create` Event: True	`POST` /newprocesses See Create	Create records
`Delete` Event: True	`DELETE` /newprocesses(businessprocessflowinstanceid) See Delete	Delete records
`Retrieve` Event: False	`GET` /newprocesses(businessprocessflowinstanceid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: False	`GET` /newprocesses See Query data	Query data
`SetState` Event: True	`PATCH` /newprocesses(businessprocessflowinstanceid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /newprocesses(businessprocessflowinstanceid) See Update	Update records
`Upsert` Event: False	`PATCH` /newprocesses(businessprocessflowinstanceid) See Upsert a table row	UpsertRequest

Properties

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

Property	Value
DisplayName	New Process
DisplayCollectionName	New Process
SchemaName	`NewProcess`
CollectionSchemaName	`NewProcesses`
EntitySetName	`newprocesses`
LogicalName	`newprocess`
LogicalCollectionName	`newprocesses`
PrimaryIdAttribute	`businessprocessflowinstanceid`
PrimaryNameAttribute	`name`
TableType	`Standard`
OwnershipType	`OrganizationOwned`

Writable columns/attributes

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

ActiveStageId
ActiveStageStartedOn
BusinessProcessFlowInstanceId
CompletedOn
ImportSequenceNumber
KnowledgeArticleId
Name
OverriddenCreatedOn
ProcessId
StateCode
StatusCode
TransactionCurrencyId
TraversedPath

ActiveStageId

Property	Value
Description	Unique identifier of the active stage for the Business Process Flow instance.
DisplayName	Active Stage
IsValidForForm	True
IsValidForRead	True
LogicalName	`activestageid`
RequiredLevel	None
Type	Lookup
Targets	processstage

ActiveStageStartedOn

Property	Value
Description	Date and time when current active stage is started.
DisplayName	Active Stage Started On
IsValidForForm	True
IsValidForRead	True
LogicalName	`activestagestartedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

BusinessProcessFlowInstanceId

Property	Value
Description	Unique identifier for New Process bpf entity instances
DisplayName	New Process Instance Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`businessprocessflowinstanceid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

CompletedOn

Property	Value
Description	Date and time when current active stage is started.
DisplayName	Completed On
IsValidForForm	True
IsValidForRead	True
LogicalName	`completedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

ImportSequenceNumber

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

KnowledgeArticleId

Property	Value
Description	Unique identifier of the Knowledge Article associated to the Business Process Flow instance.
DisplayName	Knowledge Article
IsValidForForm	True
IsValidForRead	True
LogicalName	`knowledgearticleid`
RequiredLevel	None
Type	Lookup
Targets	knowledgearticle

Name

Property	Value
Description	Process Name.
DisplayName	Process Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	200

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

ProcessId

Property	Value
Description	Unique identifier of the workflow associated to the Business Process Flow instance.
DisplayName	Process
IsValidForForm	True
IsValidForRead	True
LogicalName	`processid`
RequiredLevel	None
Type	Lookup
Targets	workflow

StateCode

Property	Value
Description	Shows whether the Delve action record is pending, completed, or tracking.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue	0
GlobalChoiceName	`newprocess_statecode`

StateCode Choices/Options

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

StatusCode

Property	Value
Description	Select the delve action record status.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue	-1
GlobalChoiceName	`newprocess_statuscode`

StatusCode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Finished State:1 TransitionData: None
3	Label: Aborted State:1 TransitionData: None

TransactionCurrencyId

Property	Value
Description	Choose the local currency for the record to make sure budgets are reported in the correct currency.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	`transactioncurrencyid`
RequiredLevel	None
Type	Lookup
Targets	transactioncurrency

TraversedPath

Property	Value
Description	Traversed Path
DisplayName	Comma delimited string of process stage ids that represent visited stages of the Business Process Flow instance.
IsValidForForm	True
IsValidForRead	True
LogicalName	`traversedpath`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Active
IsLocalizable	False
MaxLength	1250

Read-only columns/attributes

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

CreatedBy
CreatedOn
CreatedOnBehalfBy
Duration
ExchangeRate
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
VersionNumber

CreatedBy

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
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	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

Duration

Property	Value
Description	Duration the business process flow was active.
DisplayName	Duration
IsValidForForm	True
IsValidForRead	True
LogicalName	`duration`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

ExchangeRate

Property	Value
Description	Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.
DisplayName	Exchange Rate
IsValidForForm	True
IsValidForRead	True
LogicalName	`exchangerate`
RequiredLevel	None
Type	Decimal
ImeMode	Disabled
MaxValue	100000000000
MinValue	1E-12
Precision	12
SourceTypeMask	0

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
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	Shows who last updated the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier of the organization with which the SDK message request is associated.
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	SystemRequired
Type	Lookup
Targets	organization

VersionNumber

Property	Value
Description	Version number of the business process instance.
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.

lk_newprocess_activestageid
lk_newprocess_createdby
lk_newprocess_createdonbehalfby
lk_newprocess_knowledgearticleid
lk_newprocess_modifiedby
lk_newprocess_modifiedonbehalfby
lk_newprocess_processid
organization_newprocess
transactioncurrency_newprocess

lk_newprocess_activestageid

One-To-Many Relationship: processstage lk_newprocess_activestageid

Property	Value
ReferencedEntity	`processstage`
ReferencedAttribute	`processstageid`
ReferencingAttribute	`activestageid`
ReferencingEntityNavigationPropertyName	`activestageid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_createdby

One-To-Many Relationship: systemuser lk_newprocess_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdbyname`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_createdonbehalfby

One-To-Many Relationship: systemuser lk_newprocess_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfbyname`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_knowledgearticleid

One-To-Many Relationship: knowledgearticle lk_newprocess_knowledgearticleid

Property	Value
ReferencedEntity	`knowledgearticle`
ReferencedAttribute	`knowledgearticleid`
ReferencingAttribute	`knowledgearticleid`
ReferencingEntityNavigationPropertyName	`knowledgearticleid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_modifiedby

One-To-Many Relationship: systemuser lk_newprocess_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedbyname`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_newprocess_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfbyname`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_newprocess_processid

One-To-Many Relationship: workflow lk_newprocess_processid

Property	Value
ReferencedEntity	`workflow`
ReferencedAttribute	`workflowid`
ReferencingAttribute	`processid`
ReferencingEntityNavigationPropertyName	`processid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

organization_newprocess

One-To-Many Relationship: organization organization_newprocess

Property	Value
ReferencedEntity	`organization`
ReferencedAttribute	`organizationid`
ReferencingAttribute	`organizationid`
ReferencingEntityNavigationPropertyName	`organizationid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

transactioncurrency_newprocess

One-To-Many Relationship: transactioncurrency transactioncurrency_newprocess

Property	Value
ReferencedEntity	`transactioncurrency`
ReferencedAttribute	`transactioncurrencyid`
ReferencingAttribute	`transactioncurrencyid`
ReferencingEntityNavigationPropertyName	`transactioncurrencyid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

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

lk_newprocess_workflowlogs
NewProcess_ProcessSessions
NewProcess_SyncErrors

lk_newprocess_workflowlogs

Many-To-One Relationship: workflowlog lk_newprocess_workflowlogs

Property	Value
ReferencingEntity	`workflowlog`
ReferencingAttribute	`asyncoperationid`
ReferencedEntityNavigationPropertyName	`workflowlogs_newprocess`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

NewProcess_ProcessSessions

Many-To-One Relationship: processsession NewProcess_ProcessSessions

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`NewProcess_ProcessSessions`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 110 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

NewProcess_SyncErrors

Many-To-One Relationship: syncerror NewProcess_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`NewProcess_SyncErrors`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Dela via