Multistep Form Session (adx_webformsession) table/entity reference

Artikel
11/09/2024

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.

Messages

The following table lists the messages for the Multistep Form Session (adx_webformsession) 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` /adx_webformsessions See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /adx_webformsessions(adx_webformsessionid) See Delete	Delete records
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`Restore` Event: True	Restore	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /adx_webformsessions(adx_webformsessionid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /adx_webformsessions See Query data	Query data
`SetState` Event: True	`PATCH` /adx_webformsessions(adx_webformsessionid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /adx_webformsessions(adx_webformsessionid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /adx_webformsessions(adx_webformsessionid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the Multistep Form Session (adx_webformsession) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
`BulkRetain`	BulkRetain	Learn to use messages with the SDK for .NET
`PurgeRetainedContent`	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Retain`	Retain	Learn to use messages with the SDK for .NET
`RollbackRetain`	RollbackRetain	Learn to use messages with the SDK for .NET
`ValidateRetentionConfig`	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Multistep Form Session (adx_webformsession) table.

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

Writable columns/attributes

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

adx_anonymousidentification
adx_contact
adx_currentstepindex
adx_name
adx_primaryrecordentitykeyname
adx_primaryrecordentitylogicalname
adx_primaryrecordid
adx_stephistory
adx_systemuser
adx_userhostaddress
adx_useridentityname
adx_webformsessionId
ImportSequenceNumber
mspp_webformid
mspp_webformstepid
OverriddenCreatedOn
statecode
statuscode
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

adx_anonymousidentification

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

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

adx_currentstepindex

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

adx_name

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

adx_primaryrecordentitykeyname

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

adx_primaryrecordentitylogicalname

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

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
IsValidForForm	True
IsValidForRead	True
LogicalName	`adx_primaryrecordid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	38

adx_stephistory

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

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

adx_userhostaddress

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

adx_useridentityname

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

adx_webformsessionId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Multistep Form Session
IsValidForForm	False
IsValidForRead	True
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
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

mspp_webformid

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

mspp_webformstepid

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

OverriddenCreatedOn

Property	Value
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
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

statecode

Property	Value
Description	Shows the status of the multistep form session.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`adx_webformsession_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 Multistep Form Session's status.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`adx_webformsession_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	Shows the 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.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OrganizationId
VersionNumber

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	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
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

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	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
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	Shows the organization.
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets	organization

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.

adx_webformsession_contact
adx_webformsession_systemuser
lk_adx_webformsession_createdby
lk_adx_webformsession_createdonbehalfby
lk_adx_webformsession_modifiedby
lk_adx_webformsession_modifiedonbehalfby
organization_adx_webformsession
powerpagecomponent_mspp_webformid_adx_webformsession
powerpagecomponent_mspp_webformstepid_adx_webformsession

adx_webformsession_contact

One-To-Many Relationship: contact adx_webformsession_contact

Property	Value
ReferencedEntity	`contact`
ReferencedAttribute	`contactid`
ReferencingAttribute	`adx_contact`
ReferencingEntityNavigationPropertyName	`adx_contact`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `Cascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

adx_webformsession_systemuser

One-To-Many Relationship: systemuser adx_webformsession_systemuser

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

lk_adx_webformsession_createdby

One-To-Many Relationship: systemuser lk_adx_webformsession_createdby

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

lk_adx_webformsession_createdonbehalfby

One-To-Many Relationship: systemuser lk_adx_webformsession_createdonbehalfby

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

lk_adx_webformsession_modifiedby

One-To-Many Relationship: systemuser lk_adx_webformsession_modifiedby

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

lk_adx_webformsession_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_adx_webformsession_modifiedonbehalfby

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

organization_adx_webformsession

One-To-Many Relationship: organization organization_adx_webformsession

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`

powerpagecomponent_mspp_webformid_adx_webformsession

One-To-Many Relationship: powerpagecomponent powerpagecomponent_mspp_webformid_adx_webformsession

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

powerpagecomponent_mspp_webformstepid_adx_webformsession

One-To-Many Relationship: powerpagecomponent powerpagecomponent_mspp_webformstepid_adx_webformsession

Property	Value
ReferencedEntity	`powerpagecomponent`
ReferencedAttribute	`powerpagecomponentid`
ReferencingAttribute	`mspp_webformstepid`
ReferencingEntityNavigationPropertyName	`mspp_webformstepid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

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

adx_webformsession_AsyncOperations
adx_webformsession_BulkDeleteFailures
adx_webformsession_MailboxTrackingFolders
adx_webformsession_PrincipalObjectAttributeAccesses
adx_webformsession_ProcessSession
adx_webformsession_SyncErrors

adx_webformsession_AsyncOperations

Many-To-One Relationship: asyncoperation adx_webformsession_AsyncOperations

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

adx_webformsession_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure adx_webformsession_BulkDeleteFailures

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

adx_webformsession_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder adx_webformsession_MailboxTrackingFolders

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

adx_webformsession_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess adx_webformsession_PrincipalObjectAttributeAccesses

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

adx_webformsession_ProcessSession

Many-To-One Relationship: processsession adx_webformsession_ProcessSession

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

adx_webformsession_SyncErrors

Many-To-One Relationship: syncerror adx_webformsession_SyncErrors

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

Dela via