Multistep Form (mspp_webform) table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Defines the necessary properties and relationships to the other key entities in order to control the initialization of the form within a web portal.
Added by: Power Pages Apps 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 /mspp_webforms See Create |
CreateRequest or Create |
CreateMultiple | CreateMultipleRequest | |
Delete | DELETE /mspp_webforms(mspp_webformid) See Delete |
DeleteRequest or Delete |
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 /mspp_webforms(mspp_webformid) See Retrieve |
RetrieveRequest or Retrieve |
RetrieveEntityChanges | RetrieveEntityChangesRequest | |
RetrieveMultiple | GET /mspp_webforms See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
RollbackRetain | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. | |
Update | PATCH /mspp_webforms(mspp_webformid) See Update |
UpdateRequest or Update |
UpdateMultiple | UpdateMultipleRequest | |
ValidateRetentionConfig | This message is to be executed only by Dataverse to trigger registered plug-ins and flows. |
Properties
Property | Value |
---|---|
CollectionSchemaName | mspp_webforms |
DisplayCollectionName | Multistep Forms |
DisplayName | Multistep Form |
EntitySetName | mspp_webforms |
IsBPFEntity | False |
LogicalCollectionName | mspp_webforms |
LogicalName | mspp_webform |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | mspp_webformid |
PrimaryNameAttribute | mspp_name |
SchemaName | mspp_webform |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- mspp_authenticationrequired
- mspp_createdby
- mspp_createdon
- mspp_editexistingrecordpermitted
- mspp_editexpiredmessage
- mspp_editexpiredstatecode
- mspp_editexpiredstatuscode
- mspp_editnotpermittedmessage
- mspp_modifiedby
- mspp_modifiedon
- mspp_multiplerecordsperuserpermitted
- mspp_name
- mspp_progressindicatorenabled
- mspp_progressindicatorignorelaststep
- mspp_progressindicatorposition
- mspp_progressindicatorprependstepnum
- mspp_progressindicatortype
- mspp_provisionedlanguages
- mspp_savechangeswarningmessage
- mspp_savechangeswarningonclose
- mspp_startnewsessiononload
- mspp_startstep
- mspp_webformId
- mspp_websiteid
- statecode
- statuscode
mspp_authenticationrequired
Property | Value |
---|---|
Description | Redirect to sign in if the user is anonymous. |
DisplayName | Authentication Required |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_authenticationrequired |
RequiredLevel | None |
Type | Boolean |
mspp_authenticationrequired Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_createdby
Property | Value |
---|---|
Description | Shows who created the record. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_createdby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
mspp_createdon
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Shows the date and time when the record was created. |
DisplayName | Created On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_createdon |
RequiredLevel | None |
Type | DateTime |
mspp_editexistingrecordpermitted
Property | Value |
---|---|
Description | Determines if an existing record can be edited. This setting is ignored If the form mode on the form step is set to edit mode. Otherwise, an edit form wouldn't function properly. |
DisplayName | Edit Existing Record Permitted |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_editexistingrecordpermitted |
RequiredLevel | None |
Type | Boolean |
mspp_editexistingrecordpermitted Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 1
mspp_editexpiredmessage
Property | Value |
---|---|
Description | |
DisplayName | Edit Expired Message |
Format | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_editexpiredmessage |
MaxLength | 10000 |
RequiredLevel | None |
Type | Memo |
mspp_editexpiredstatecode
Property | Value |
---|---|
Description | |
DisplayName | Edit Expired State Code |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_editexpiredstatecode |
MaxValue | 2147483647 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
mspp_editexpiredstatuscode
Property | Value |
---|---|
Description | |
DisplayName | Edit Expired Status Code |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_editexpiredstatuscode |
MaxValue | 2147483647 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
mspp_editnotpermittedmessage
Property | Value |
---|---|
Description | |
DisplayName | Edit Not Permitted Message |
Format | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_editnotpermittedmessage |
MaxLength | 10000 |
RequiredLevel | None |
Type | Memo |
mspp_modifiedby
Property | Value |
---|---|
Description | Shows who last updated the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_modifiedby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
mspp_modifiedon
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
Description | Shows the date and time when the record was modified. |
DisplayName | Modified On |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_modifiedon |
RequiredLevel | None |
Type | DateTime |
mspp_multiplerecordsperuserpermitted
Property | Value |
---|---|
Description | |
DisplayName | Multiple Records Per User Permitted |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_multiplerecordsperuserpermitted |
RequiredLevel | None |
Type | Boolean |
mspp_multiplerecordsperuserpermitted Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 1
mspp_name
Property | Value |
---|---|
Description | The name of the custom entity. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_name |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
mspp_progressindicatorenabled
Property | Value |
---|---|
Description | |
DisplayName | Enabled |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_progressindicatorenabled |
RequiredLevel | None |
Type | Boolean |
mspp_progressindicatorenabled Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_progressindicatorignorelaststep
Property | Value |
---|---|
Description | |
DisplayName | Ignore Last Step In Progress Count |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_progressindicatorignorelaststep |
RequiredLevel | None |
Type | Boolean |
mspp_progressindicatorignorelaststep Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_progressindicatorposition
Property | Value |
---|---|
Description | Location of the progress indicator relative to the form |
DisplayName | Position |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_progressindicatorposition |
RequiredLevel | None |
Type | Picklist |
mspp_progressindicatorposition Choices/Options
Value | Label | Description |
---|---|---|
756150000 | Top | |
756150001 | Bottom | |
756150002 | Left | |
756150003 | Right |
mspp_progressindicatorprependstepnum
Property | Value |
---|---|
Description | |
DisplayName | Prepend Step Number to Step Title |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_progressindicatorprependstepnum |
RequiredLevel | None |
Type | Boolean |
mspp_progressindicatorprependstepnum Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_progressindicatortype
Property | Value |
---|---|
Description | |
DisplayName | Type |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_progressindicatortype |
RequiredLevel | None |
Type | Picklist |
mspp_progressindicatortype Choices/Options
Value | Label | Description |
---|---|---|
756150000 | Title | |
756150001 | Numeric (Step 1 of N) | |
756150002 | Progress Bar |
mspp_provisionedlanguages
Property | Value |
---|---|
Description | |
DisplayName | Provisioned Languages |
Format | Language |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_provisionedlanguages |
MaxValue | 2147483647 |
MinValue | 0 |
RequiredLevel | None |
Type | Integer |
mspp_savechangeswarningmessage
Property | Value |
---|---|
Description | Default message: Your changes have not been saved. To stay on the page so that you can save your changes, click Cancel. |
DisplayName | Save Changes Warning Message |
Format | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_savechangeswarningmessage |
MaxLength | 10000 |
RequiredLevel | None |
Type | Memo |
mspp_savechangeswarningonclose
Property | Value |
---|---|
Description | Displays a warning message to the user if they close the browser, or refresh the page, or click the previous button in a multiple step form and they have changes that haven't been saved. |
DisplayName | Display Save Changes Warning On Close |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_savechangeswarningonclose |
RequiredLevel | None |
Type | Boolean |
mspp_savechangeswarningonclose Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_startnewsessiononload
Property | Value |
---|---|
Description | |
DisplayName | Start New Session On Load |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_startnewsessiononload |
RequiredLevel | None |
Type | Boolean |
mspp_startnewsessiononload Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
mspp_startstep
Property | Value |
---|---|
Description | Unique identifier for Form Step associated with Multistep Form. |
DisplayName | Start Step |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_startstep |
RequiredLevel | None |
Targets | mspp_webformstep |
Type | Lookup |
mspp_webformId
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Multistep Form |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | mspp_webformid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
mspp_websiteid
Property | Value |
---|---|
Description | Unique identifier for Website entity associated with this record |
DisplayName | Website |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | mspp_websiteid |
RequiredLevel | ApplicationRequired |
Targets | mspp_website |
Type | Lookup |
statecode
Property | Value |
---|---|
Description | Status of the Multistep Form |
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 | Reason for the status of the Multistep Form |
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 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- mspp_createdbyName
- mspp_createdbyYomiName
- mspp_modifiedbyName
- mspp_modifiedbyYomiName
- mspp_startstepName
- mspp_websiteidName
mspp_createdbyName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_createdbyname |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
mspp_createdbyYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_createdbyyominame |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
mspp_modifiedbyName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_modifiedbyname |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
mspp_modifiedbyYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_modifiedbyyominame |
MaxLength | 200 |
RequiredLevel | None |
Type | String |
mspp_startstepName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_startstepname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
mspp_websiteidName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | mspp_websiteidname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
One-To-Many Relationships
Listed by SchemaName.
mspp_webform_webformmetadata_entityformforcreate
Same as the mspp_webform_webformmetadata_entityformforcreate many-to-one relationship for the mspp_webformmetadata table/entity.
Property | Value |
---|---|
ReferencingEntity | mspp_webformmetadata |
ReferencingAttribute | mspp_entityformforcreate |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | mspp_webform_webformmetadata_entityformforcreate |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: 10000 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
mspp_webformstep_webform
Same as the mspp_webformstep_webform many-to-one relationship for the mspp_webformstep table/entity.
Property | Value |
---|---|
ReferencingEntity | mspp_webformstep |
ReferencingAttribute | mspp_webform |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | mspp_webformstep_webform |
AssociatedMenuConfiguration | Behavior: UseLabel Group: Details Label: Steps Order: 103100 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
mspp_webpage_webform
Same as the mspp_webpage_webform many-to-one relationship for the mspp_webpage table/entity.
Property | Value |
---|---|
ReferencingEntity | mspp_webpage |
ReferencingAttribute | mspp_webform |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | mspp_webpage_webform |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 107000 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade 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.
- mspp_systemuser_mspp_webform_createdby
- mspp_systemuser_mspp_webform_modifiedby
- mspp_webform_startstep
- mspp_website_webform
mspp_systemuser_mspp_webform_createdby
Added by: System Solution Solution
See the mspp_systemuser_mspp_webform_createdby one-to-many relationship for the systemuser table/entity.
mspp_systemuser_mspp_webform_modifiedby
Added by: System Solution Solution
See the mspp_systemuser_mspp_webform_modifiedby one-to-many relationship for the systemuser table/entity.
mspp_webform_startstep
See the mspp_webform_startstep one-to-many relationship for the mspp_webformstep table/entity.
mspp_website_webform
See the mspp_website_webform one-to-many relationship for the mspp_website table/entity.
See also
Dataverse table/entity reference
Web API Reference
mspp_webform EntityType
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for