Configure web form metadata for portals

The Web Form Metadata contains additional behavior modification logic to augment or override the functionality of form fields that is otherwise not possible with Dynamics 365's native entity form editing capabilities.

Add a new record

  1. On the Web Form Step that has fields that you would like to modify, click the Metadata link in the top navigation.

Select metadata in Dynamics 365

  1. Click Add New Web Form Metadata.

Web form metadata properties

The following attributes provide additional styling and capabilities for elements on a form.

Name Description
Web Form Step The Web Form Step associated with the Web Form Metadata record.
Type Available options are:
  • Attribute
  • Section
  • Tab
Selecting Attribute as the Type value displays the appropriate options for modifying fields on the current form rendered for the related step. Selecting Section as the Type value displays the options available for modifying a section on the form. Selecting Tab as the Type value displays the options available for modifying a tab on a form.

Web form metadata type = Attribute

The following properties are displayed when the Type selected is 'Attribute'.

Name Description
Attribute Logical Name The logical name of the attribute field to be modified.
Label Replaces the default label assigned to the attribute on the entity with the text specified in this input. For each language pack installed and enabled for the Dynamics 365 organization a field will be available to enter the message in the associated language.

Control style

The following options modify the style and functionality of an attribute's field.

Name Description
Style One of the following:
  • Option Set as Vertical Radio Button List
  • Option Set as Horizontal Radio Button List
  • Single Line of Text as Geolocation Lookup Validator (requires Bing Maps Settings - details found here)
  • Group Whole Number as Constant Sum (requires Group Name)
  • Group Whole Number as Rank Order Scale No Ties (requires Group Name)
  • Group Whole Number as Rank Order Scale Allow Ties (requires Group Name)
  • Multiple Choice Matrix (requires Group Name)
  • Multiple Choice (requires Group Name)
  • Group Whole Number as Stack Rank (requires Group Name)
Group Name A name used to group controls together as a composite control.
Multiple Choice Minimum Required Selected Count This is the required minimum values selected in the multiple choice question. Only necessary if 'Multiple Choice' Control Style is selected.
Multiple Choice Max Selected Count This is the maximum number of values that is permitted to be selected in the multiple choice question. Only necessary if 'Multiple Choice' Control Style is selected.
Constant Sum Minimum Total This is the required minimum value applied to a constant sum response field. Only necessary if 'Group Whole Number as Constant Sum' Control Style is selected.
Constant Sum Maximum Total This is the maximum number of value that is permitted to be applied to a constant sum response field. Only necessary if 'Group Whole Number as Constant Sum' Control Style is selected.
Randomize Option Set Values Specifying Yes results in randomly ordered options listed for an Option Set control. Only applicable to attributes that are of type Option Set.
CSS Class Adds a custom CSS class name to the control.

Prepopulate field

The following options provide a default value for fields on the form.

Name Description
Ignore Default Value Ignores the default value of the specified attribute field. Useful for attributes that are Two Option fields that are rendered as Yes and No radio buttons. Because Dynamics 365 automatically assigns a value of yes or no by default, this option makes it possible to display Yes/No questions without a predefined response.
Type One of the following:
  • Value
  • Today's Date
  • Current User's Contact
Selecting Value requires a value to be specified in the Value field that will be assigned to the field when the form is loaded. Selecting Today's Date will assign the current date and time to the attribute field. Selecting Current User's Contact requires a From Attribute that is an attribute on the contact entity that will be retrieved from the current user's contact record and set on the attribute field specified.
Value A value to be assigned to the field when the form is loaded.
From Attribute An attribute on the contact entity that will be retrieved from the current portal user's record and assigned to the field when the form is loaded.

Set Value On Save

The following options specify a value to be set when the form is saved.

Name Description
Set Value On Save Yes indicates that a value should be assigned to the attribute using the input provided in the Value field.
Note: All attribute types are supported except the following: Unique Identifier.
Type One of the following:
  • Value
  • Today's Date
  • Current User's Contact
Selecting Value requires a value to be specified in the Value field that will be assigned to the field when the form is loaded. Selecting Today's Date will assign the current date and time to the attribute field. Selecting Current User's Contact requires a From Attribute that is an attribute on the contact entity that will be retrieved from the current user's contact record and set on the attribute field specified.
Value Value assigned to the attribute when the form is being saved.
For Two Option (Boolean) fields use true or false.
For Option Set field use the integer value for the option.
For Lookup (EntityReference) fields, use the GUID.
Note: If the attribute is also on the form the user's value will be overwritten with this value.
From Attribute An attribute on the contact entity that will be retrieved from the current portal user's record and assigned to the field during save.

Validation

The following section contains properties that modify various validation parameters and error messages.

For each language pack installed and enabled for the Dynamics 365 organization, a field will be available to enter the message in the associated language.

Name Description
Validation Error Message Overrides the default validation error message for the field.
Regular Expression A regular expression to be added to validate the field.
Regular Expression Validation Error Message The validation error message to display if the regular expression validated fails.
Field is Required Check to make the attribute field required to contain a value.
Required Field Validation Error Message Overrides the default required field error message if the field does not contain a value.
Range Validation Error Message Overrides the default range validation error message displayed if the field's value is outside of the appropriate minimum and maximum values specified on the entity attribute that are of type Whole Number, Decimal Number, Floating Point Number or Currency.
Geolocation Validator Error Message Applicable if the attribute is a Single Line of Text and the Control Style specified is Single Line of Text as Geolocation Lookup Validator then this will override the default error message displayed if input validation fails.
Constant Sum Validation Error Message Applicable if the attribute is a Whole Number type and the Control Style specified is Group Whole Number as Constant Sum then this will override the default error message displayed if input validation fails.
Multiple Choice Validation Error Message Applicable if the attribute is a Two Option type and the Control Style specified is Multiple Choice then this will override the default error message displayed if input validation fails.
Rank Order No Ties Validation Error Message Applicable if the attribute is a Whole Number type and the Control Style specified is Group Whole Number as Rank Order No Ties then this will override the default error message displayed if input validation fails.

Description and instructions

The following properties specify the location and content of custom description or instructions.

Name Description
Add Description Yes results in custom text being displayed on the form in the position specified.
Position One of the following:
  • Above the field
  • Below the field
  • Above the label
Use Attribute's Description Property Select 'Yes' to use the description assigned to the attribute metadata on the entity. Select 'No' to provide a custom description. Default is 'No'.
Description Custom text to be displayed on the form. Used in conjunction when Use Attribute's Description Property is set to 'No'. For each language pack installed and enabled for the Dynamics 365 organization a field will be available to enter the message in the associated language.

Web Form metadata type = Section

The following properties are displayed when the Type selected equals 'Section'.

Name Description
Section Name The name of the section on the entity's form in Dynamics 365 to be modified.
Label Replaces the default label assigned to the section on the entity with the text specified in this input. For each language pack installed and enabled for the Dynamics 365 organization a field will be available to enter the message in the associated language.

Web Form metadata type = Tab

The following properties are displayed when the Type selected equals 'Tab'

Name Description
Tab Name The name of the tab on the entity's form in Dynamics 365 to be modified.
Label Replaces the default label assigned to the tab on the entity with the text specified in this input. For each language pack installed and enabled for the Dynamics 365 organization a field will be available to enter the message in the associated language.

See also

Configure a Dynamics 365 portal
Define entity forms and custom logic within the Dynamics 365 portal
Web Form properties for portals
Web Form steps for portals
Web Form subgrid configuration for portals
Notes configuration for Web Forms for portals