Multistep Form Session (adx_webformsession) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Serves as a mechanism to log the occurrence of an incomplete multistep form entry for a given user so they can return and complete it later.

Added by: Power Pages Runtime Core Solution

Messages

Message Web API Operation SDK class or method
BulkRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create POST /adx_webformsessions
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /adx_webformsessions(adx_webformsessionid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
PurgeRetainedContent This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve GET /adx_webformsessions(adx_webformsessionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /adx_webformsessions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RollbackRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState PATCH /adx_webformsessions(adx_webformsessionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /adx_webformsessions(adx_webformsessionid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest
ValidateRetentionConfig This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property Value
CollectionSchemaName adx_webformsessions
DisplayCollectionName Multistep Form Sessions
DisplayName Multistep Form Session
EntitySetName adx_webformsessions
IsBPFEntity False
LogicalCollectionName adx_webformsessions
LogicalName adx_webformsession
OwnershipType OrganizationOwned
PrimaryIdAttribute adx_webformsessionid
PrimaryNameAttribute adx_name
SchemaName adx_webformsession

Writable columns/attributes

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

adx_anonymousidentification

Property Value
Description
DisplayName Anonymous Identification
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_anonymousidentification
MaxLength 200
RequiredLevel None
Type String

adx_contact

Property Value
Description Unique identifier for Contact associated with Multistep Form Session.
DisplayName Contact
IsValidForForm True
IsValidForRead True
LogicalName adx_contact
RequiredLevel Recommended
Targets contact
Type Lookup

adx_currentstepindex

Property Value
Description The index of the current step the user last visited.
DisplayName Current Step Index
Format None
IsValidForForm True
IsValidForRead True
LogicalName adx_currentstepindex
MaxValue 2147483647
MinValue 0
RequiredLevel Recommended
Type Integer

adx_name

Property Value
Description Type the name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_name
MaxLength 100
RequiredLevel None
Type String

adx_primaryrecordentitykeyname

Property Value
Description
DisplayName Primary Record Entity Primary Key Logical Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_primaryrecordentitykeyname
MaxLength 100
RequiredLevel None
Type String

adx_primaryrecordentitylogicalname

Property Value
Description
DisplayName Primary Record Table name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_primaryrecordentitylogicalname
MaxLength 100
RequiredLevel None
Type String

adx_primaryrecordid

Property Value
Description Shows the ID of the primary record created by the multistep form. Used to retrieve the appropriate session record.
DisplayName Primary Record ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_primaryrecordid
MaxLength 38
RequiredLevel None
Type String

adx_stephistory

Property Value
Description History of steps in JSON
DisplayName Step History
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_stephistory
MaxLength 20000
RequiredLevel None
Type Memo

adx_systemuser

Property Value
Description Unique identifier for User associated with Multistep Form Session.
DisplayName System User
IsValidForForm True
IsValidForRead True
LogicalName adx_systemuser
RequiredLevel None
Targets systemuser
Type Lookup

adx_userhostaddress

Property Value
Description
DisplayName User Host Address
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_userhostaddress
MaxLength 100
RequiredLevel None
Type String

adx_useridentityname

Property Value
Description
DisplayName User Identity Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName adx_useridentityname
MaxLength 200
RequiredLevel None
Type String

adx_webformsessionId

Property Value
Description Unique identifier for entity instances
DisplayName Multistep Form Session
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName adx_webformsessionid
RequiredLevel SystemRequired
Type Uniqueidentifier

ImportSequenceNumber

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

mspp_webformid

Added by: Power Pages Runtime Extensions Solution

Property Value
Description Unique identifier for Web Form associated with Web Form Session.
DisplayName Multistep Form
IsValidForForm True
IsValidForRead True
LogicalName mspp_webformid
RequiredLevel None
Targets powerpagecomponent
Type Lookup

mspp_webformstepid

Added by: Power Pages Runtime Extensions Solution

Property Value
Description Unique identifier for entity instances
DisplayName Multistep Form Session
IsValidForForm True
IsValidForRead True
LogicalName mspp_webformstepid
RequiredLevel None
Targets powerpagecomponent
Type Lookup

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was migrated. The date and time are displayed in the time zone selected in the solution options.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

statecode

Property Value
Description Shows the status of the multistep form session.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

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

statuscode

Property Value
Description Select the Multistep Form Session's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

adx_contactName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName adx_contactname
MaxLength 160
RequiredLevel None
Type String

adx_contactYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName adx_contactyominame
MaxLength 450
RequiredLevel None
Type String

adx_systemuserName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName adx_systemusername
MaxLength 200
RequiredLevel None
Type String

adx_systemuserYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName adx_systemuseryominame
MaxLength 200
RequiredLevel None
Type String

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in the solution options.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was updated. The date and time are displayed in the time zone selected in the solution options.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

mspp_webformidName

Added by: Power Pages Runtime Extensions Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName mspp_webformidname
MaxLength 400
RequiredLevel None
Type String

mspp_webformstepidName

Added by: Power Pages Runtime Extensions Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName mspp_webformstepidname
MaxLength 400
RequiredLevel None
Type String

OrganizationId

Added by: Active Solution Solution

Property Value
Description Shows the organization.
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Targets organization
Type Lookup

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

adx_webformsession_SyncErrors

Added by: System Solution Solution

Same as the adx_webformsession_SyncErrors many-to-one relationship for the syncerror table/entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

adx_webformsession_AsyncOperations

Added by: System Solution Solution

Same as the adx_webformsession_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

adx_webformsession_MailboxTrackingFolders

Added by: System Solution Solution

Same as the adx_webformsession_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

adx_webformsession_ProcessSession

Added by: System Solution Solution

Same as the adx_webformsession_ProcessSession many-to-one relationship for the processsession table/entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

adx_webformsession_BulkDeleteFailures

Added by: System Solution Solution

Same as the adx_webformsession_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

adx_webformsession_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the adx_webformsession_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName adx_webformsession_PrincipalObjectAttributeAccesses
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 table. Listed by SchemaName.

lk_adx_webformsession_createdby

Added by: System Solution Solution

See the lk_adx_webformsession_createdby one-to-many relationship for the systemuser table/entity.

lk_adx_webformsession_createdonbehalfby

Added by: System Solution Solution

See the lk_adx_webformsession_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_adx_webformsession_modifiedby

Added by: System Solution Solution

See the lk_adx_webformsession_modifiedby one-to-many relationship for the systemuser table/entity.

lk_adx_webformsession_modifiedonbehalfby

Added by: System Solution Solution

See the lk_adx_webformsession_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

organization_adx_webformsession

Added by: System Solution Solution

See the organization_adx_webformsession one-to-many relationship for the organization table/entity.

adx_webformsession_contact

Added by: System Solution Solution

See the adx_webformsession_contact one-to-many relationship for the contact table/entity.

adx_webformsession_systemuser

Added by: System Solution Solution

See the adx_webformsession_systemuser one-to-many relationship for the systemuser table/entity.

powerpagecomponent_mspp_webformid_adx_webformsession

Added by: Power Pages Core Base Solution

See the powerpagecomponent_mspp_webformid_adx_webformsession one-to-many relationship for the powerpagecomponent table/entity.

powerpagecomponent_mspp_webformstepid_adx_webformsession

Added by: Power Pages Core Base Solution

See the powerpagecomponent_mspp_webformstepid_adx_webformsession one-to-many relationship for the powerpagecomponent table/entity.

See also

Dataverse table/entity reference
Web API Reference
adx_webformsession EntityType