Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Defines the necessary properties and relationships to the other key entities in order to control the initialization of the form within a web portal.
Messages
The following table lists the messages for the Multistep Form (mspp_webform) 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 |
|---|---|---|
AssociateEvent: True |
Associate records | Associate records |
CreateEvent: True |
POST /mspp_webformsSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /mspp_webforms(mspp_webformid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
RetrieveEvent: True |
GET /mspp_webforms(mspp_webformid)See Retrieve |
Retrieve records |
RetrieveEntityChangesEvent: True |
RetrieveEntityChangesRequest | |
RetrieveMultipleEvent: True |
GET /mspp_webformsSee Query data |
Query data |
UpdateEvent: True |
PATCH /mspp_webforms(mspp_webformid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /mspp_webforms(mspp_webformid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
Events
The following table lists the events for the Multistep Form (mspp_webform) 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 (mspp_webform) table.
| Property | Value |
|---|---|
| DisplayName | Multistep Form |
| DisplayCollectionName | Multistep Forms |
| SchemaName | mspp_webform |
| CollectionSchemaName | mspp_webforms |
| EntitySetName | mspp_webforms |
| LogicalName | mspp_webform |
| LogicalCollectionName | mspp_webforms |
| PrimaryIdAttribute | mspp_webformid |
| PrimaryNameAttribute | mspp_name |
| TableType | Virtual |
| OwnershipType | OrganizationOwned |
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 |
| GlobalChoiceName | mspp_webform_mspp_authenticationrequired |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_createdby
| Property | Value |
|---|---|
| Description | Shows who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
mspp_createdon
| Property | Value |
|---|---|
| Description | Shows the date and time when the record was created. |
| DisplayName | Created On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_createdon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
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 |
| GlobalChoiceName | mspp_webform_mspp_editexistingrecordpermitted |
| DefaultValue | True |
| True Label | Yes |
| False Label | No |
mspp_editexpiredmessage
| Property | Value |
|---|---|
| Description | |
| DisplayName | Edit Expired Message |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_editexpiredmessage |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 10000 |
mspp_editexpiredstatecode
| Property | Value |
|---|---|
| Description | |
| DisplayName | Edit Expired State Code |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_editexpiredstatecode |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | 0 |
mspp_editexpiredstatuscode
| Property | Value |
|---|---|
| Description | |
| DisplayName | Edit Expired Status Code |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_editexpiredstatuscode |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | 0 |
mspp_editnotpermittedmessage
| Property | Value |
|---|---|
| Description | |
| DisplayName | Edit Not Permitted Message |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_editnotpermittedmessage |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 10000 |
mspp_modifiedby
| Property | Value |
|---|---|
| Description | Shows who last updated the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
mspp_modifiedon
| Property | Value |
|---|---|
| Description | Shows the date and time when the record was modified. |
| DisplayName | Modified On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_modifiedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | True |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
mspp_multiplerecordsperuserpermitted
| Property | Value |
|---|---|
| Description | |
| DisplayName | Multiple Records Per User Permitted |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_multiplerecordsperuserpermitted |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webform_mspp_multiplerecordsperuserpermitted |
| DefaultValue | True |
| True Label | Yes |
| False Label | No |
mspp_name
| Property | Value |
|---|---|
| Description | The name of the custom entity. |
| DisplayName | Name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_name |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
mspp_progressindicatorenabled
| Property | Value |
|---|---|
| Description | |
| DisplayName | Enabled |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_progressindicatorenabled |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webform_mspp_progressindicatorenabled |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_progressindicatorignorelaststep
| Property | Value |
|---|---|
| Description | |
| DisplayName | Ignore Last Step In Progress Count |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_progressindicatorignorelaststep |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webform_mspp_progressindicatorignorelaststep |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
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 |
| DefaultFormValue | 756150000 |
| GlobalChoiceName | mspp_webform_mspp_progressindicatorposition |
mspp_progressindicatorposition Choices/Options
| Value | Label |
|---|---|
| 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 |
| GlobalChoiceName | mspp_webform_mspp_progressindicatorprependstepnum |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_progressindicatortype
| Property | Value |
|---|---|
| Description | |
| DisplayName | Type |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_progressindicatortype |
| RequiredLevel | None |
| Type | Picklist |
| DefaultFormValue | 756150000 |
| GlobalChoiceName | mspp_webform_mspp_progressindicatortype |
mspp_progressindicatortype Choices/Options
| Value | Label |
|---|---|
| 756150000 | Title |
| 756150001 | Numeric (Step 1 of N) |
| 756150002 | Progress Bar |
mspp_provisionedlanguages
| Property | Value |
|---|---|
| Description | |
| DisplayName | Provisioned Languages |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_provisionedlanguages |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | 0 |
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 |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_savechangeswarningmessage |
| RequiredLevel | None |
| Type | Memo |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 10000 |
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 |
| GlobalChoiceName | mspp_webform_mspp_savechangeswarningonclose |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
mspp_startnewsessiononload
| Property | Value |
|---|---|
| Description | |
| DisplayName | Start New Session On Load |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | mspp_startnewsessiononload |
| RequiredLevel | None |
| Type | Boolean |
| GlobalChoiceName | mspp_webform_mspp_startnewsessiononload |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
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 |
| Type | Lookup |
| Targets | mspp_webformstep |
mspp_webformId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Multistep Form |
| IsValidForForm | False |
| IsValidForRead | True |
| 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 |
| Type | Lookup |
| Targets | mspp_website |
statecode
| Property | Value |
|---|---|
| Description | Status of the Multistep Form |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | mspp_webform_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 Multistep Form |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | mspp_webform_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- mspp_systemuser_mspp_webform_createdby
- mspp_systemuser_mspp_webform_modifiedby
- mspp_webform_startstep
- mspp_website_webform
mspp_systemuser_mspp_webform_createdby
One-To-Many Relationship: systemuser mspp_systemuser_mspp_webform_createdby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | mspp_createdby |
| ReferencingEntityNavigationPropertyName | mspp_createdby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
mspp_systemuser_mspp_webform_modifiedby
One-To-Many Relationship: systemuser mspp_systemuser_mspp_webform_modifiedby
| Property | Value |
|---|---|
| ReferencedEntity | systemuser |
| ReferencedAttribute | systemuserid |
| ReferencingAttribute | mspp_modifiedby |
| ReferencingEntityNavigationPropertyName | mspp_modifiedby |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
mspp_webform_startstep
One-To-Many Relationship: mspp_webformstep mspp_webform_startstep
| Property | Value |
|---|---|
| ReferencedEntity | mspp_webformstep |
| ReferencedAttribute | mspp_webformstepid |
| ReferencingAttribute | mspp_startstep |
| ReferencingEntityNavigationPropertyName | mspp_startstep |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
mspp_website_webform
One-To-Many Relationship: mspp_website mspp_website_webform
| Property | Value |
|---|---|
| ReferencedEntity | mspp_website |
| ReferencedAttribute | mspp_websiteid |
| ReferencingAttribute | mspp_websiteid |
| ReferencingEntityNavigationPropertyName | mspp_websiteid |
| IsHierarchical | |
| CascadeConfiguration | Archive: NoCascadeAssign: NoCascadeDelete: NoCascadeMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
mspp_webform_webformmetadata_entityformforcreate
Many-To-One Relationship: mspp_webformmetadata mspp_webform_webformmetadata_entityformforcreate
| Property | Value |
|---|---|
| ReferencingEntity | mspp_webformmetadata |
| ReferencingAttribute | mspp_entityformforcreate |
| ReferencedEntityNavigationPropertyName | mspp_webform_webformmetadata_entityformforcreate |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplayGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_webformstep_webform
Many-To-One Relationship: mspp_webformstep mspp_webformstep_webform
| Property | Value |
|---|---|
| ReferencingEntity | mspp_webformstep |
| ReferencingAttribute | mspp_webform |
| ReferencedEntityNavigationPropertyName | mspp_webformstep_webform |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseLabelGroup: DetailsLabel: Steps MenuId: null Order: 103100 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
mspp_webpage_webform
Many-To-One Relationship: mspp_webpage mspp_webpage_webform
| Property | Value |
|---|---|
| ReferencingEntity | mspp_webpage |
| ReferencingAttribute | mspp_webform |
| ReferencedEntityNavigationPropertyName | mspp_webpage_webform |
| IsCustomizable | False |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 107000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
mspp_webform