Define a load form and load tab step type

This step type allows the web form step to act as an entity form within the overall web form process. It loads a form from Dynamics 365 with a similar set of options available as an Entity Form.

Settings

Name Description
Name The descriptive name of the record. Required
Entity Name The name of the entity from which the form will be loaded from. Required
Form Name The name of the Form on the target entity that is to be rendered. Required
Tab Name The name of a Tab on a Form for a specified entity that is to be rendered. Optional
Mode One of the following values:
  • Insert
  • Edit
  • ReadOnly
Selecting Insert indicates the form should insert a new record upon submission. Specifying Edit indicates the form should edit an existing record. Selecting ReadOnly indicates the form should display an existing record's noneditable form. Edit and ReadOnly requires that a source record exist and parameters specified in the 'Record Source Type' and 'Record ID Query String Parameter Name' fields to select the appropriate record when the form is loaded in the portal.
Auto Generate Steps From Tabs Checked indicates that multiple tabs on an entity form will be displayed with each tab as a sequential step starting with the first tab and continue until all tabs have been navigated to and upon final submission a record is inserted. Unchecked is the default behavior. Unchecked value indicates that only one tab or form is to be rendered for the current step. If the Tab Name is not specified, the first tab is displayed.
Record Source Type One of the following values:
  • Query String
  • Current Portal User
  • Result From Previous Step
Selecting Query String requires a parameter name that must be provided in the query string of the URL to the form. This can be specified in the 'Record ID Query String Parameter Name' field. Selecting Current Portal User will retrieve the portal user record for the current authenticated user.
Selecting Result from previous step will retrieve the record that was the record source for a previous step of the web form.
Record ID Query String Parameter Name A parameter name provided in the query string of the URL to the Web Page containing this Entity Form.
Relationship Name Required when Record Source Type is Record Associated to Current Portal User. The logical name of the relationship between the current portal user record and the target record. This must return the same entity type specified by the Entity Name field.
Allow Create If Null An optional Boolean value available when Record Source Type is Record Associated to Current Portal User. Checked indicates that if the related record does not exist, allow the user to create it the first time, otherwise an exception will be thrown if the record does not already exist because the form needs a record to data-bind to.
Enable Entity Permissions Will cause the form to respect Entity Permissions. The default is false for backwards compatibility reasons. If set to true, explicit permissions are REQUIRED for any user wanting to access the form. Note that this only applies to the FIRST step of a form.

Additional settings

Name Description
Render Web Resources Inline Eliminates the iFrame that encompasses a web resource in a Dynamics 365 entity form.
ToolTips Enabled The tooltip is set using the description of the attribute on the target entity.
Show Unsupported Fields All fields are currently supported. This is reserved for potential changes Dynamics 365 may make to field types.
Set Recommended Fields as Required Makes all attributes required that have the field requirement level set to 'Business Recommended'.
Make All Fields Required Makes all fields required regardless of the field requirement level.
Validation Summary CSS Class CSS Class name assigned to the validation summary. Default: 'validation-summary alert alert-error alert-block'
Enable Validation Summary Links A Boolean value of true or false that indicates whether anchor links should be rendered in the validation summary to scroll to the field containing an error. Default: true
Validation Summary Link Text The label assigned to the validation summary links. Default: Click here
Instructions Display a block of text at the top of the form.
Record Not Found Message Message displayed when the source record cannot be loaded. Default: "The record you are looking for could not be found."

Form options

Name Description
Add Captcha reCAPTCHA is a free CAPTCHA service used by the portal to prevent malicious spam attacks. The service requires a unique key to authenticate requests for your portal application.
Validation Group The group name assigned to input controls for evaluating valid input of named groups.
Previous Button CSS Class CSS Class name assigned to the Previous button.
Previous Button Text Label on the previous button.
Next Button CSS Class CSS Class name assigned to the next button.
Submit Button Text Label on the next button.
Submit Button CSS Class CSS Class name assigned to the submit button. Default: button submit
Submit Button Text Label on the submit button. Default is 'Submit'
Submit Button Busy Text Label on the submit button during the running process. Default: Processing...

Associate the current portal user with the creation of a record

These options are used to keep track of which portal contact creates a record through the portal UI

Name Description
Associate Current Portal User Checked indicates the currently logged in user's record should be associated with the target entity record.
Target Entity Portal User Lookup Attribute The logical name of the attribute on the target entity that stores the portal user.
Is Activity Party Boolean value indicating whether the Target Entity Portal User Lookup Attribute is an Activity Party type. See ActivityParty entity

Entity reference

The following parameters pertain to setting an entity reference when the form is saved.

This provides a way to associate the current record being created or updated by the form with another target record. This is useful if you have multiple steps with multiple entity types and wish to relate the resulting records or if the page is passed a query string of a record ID that you would like associated. For example we have a careers page that lists job postings, each with a link to an application for the job that contains the id of the job posting to the application form so that when the application is created the job posting is associated with the record.

Name Description
Set Entity Reference On Save Yes or No. A value of yes indicates that an entity reference should be assigned when the form is saved, otherwise none will be set.
Relationship Name The Relationship Definition Name for a given relationship between two entity types.
Note: Do not specify a relationship name if you specify a Target Lookup Attribute Logical Name.
Entity Logical Name The logical name of the reference entity.
Target Lookup Attribute Logical Name Logical name of the lookup attribute on the target entity being created or updated.
Note: Do not specify a relationship name if you specify a Target Lookup Attribute Logical Name.
Populate Lookup Field If the lookup regarding the reference entity is on the form, checking this value will populate the field on the form with the value retrieved using the setting below.
Source Type One of the following values:
  • Query String
  • Current Portal User
  • Result From Previous Step
Selecting Query String requires a parameter name that must be provided in the query string of the URL to the form. This can be specified in the Query String Name field. If this parameter is the primary key then select Yes for the Query String Is Primary Key, otherwise select No and provide the logical name of the attribute on the target entity to query by specified in the Query Attribute Logical Name field. Selecting Current Portal User will retrieve the contact record for the current authenticated user. Selecting Result From Previous Step will retrieve the record created as a result of the step prior to the current step or from a specific step based on the step associated with the Entity Source Step.
Reference Entity Step The Web Form Step record of a previous step to retrieve the entity created or edited in that step to associate it with the record for this current step.
Query String Name Parameter name provided in the Query String of the URL to the Web Page containing the Web Form.
Query String Is Primary Key Yes indicates the Query String value is the Primary Key value. No indicates the Query String value is an attribute type other than the Primary Key.
Query Attribute Logical Name Logical name of the attribute to query the record.
Show ReadOnly Details Checked indicates that a form should be rendered at the top of the page displaying read-only information pertaining to the reference record. Requires a Form Name.
Form Name The name of the form on the reference entity that should be used to display read-only details.

Additional functionality

Name Description
Attach File Check to have the form include a file upload control to the bottom of the form to allow a file to be attached to the record.
Allow Multiple Files A Boolean value that indicates whether the user can upload more than one file.
Accept The accept attribute specifies the MIME types of files that the server accepts through file upload. To specify more than one value, separate the values with a comma (for example, audio/*,video/*,image/*).
Label The text displayed next to the file upload control. 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.
Is Required Checked makes the attachment of a file required to proceed.
Required Error Message The message displayed during form validation if Is Required is true and the user has not attached a file. 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.
Custom JavaScript A custom block of JavaScript that will added to the bottom of the page just before the closing form tag element. The HTML input id of an entity field is set to the logical name of the attribute. This makes selecting a field, setting values, or other client side manipulation easy with jQuery. $(document).ready(function() { $("#address1_stateorprovince").val("Saskatchewan"); });

See also

Configure a Dynamics 365 portal
Define entity forms and custom logic within the Dynamics 365 portal
Web Form steps for portals
Redirect step type
Conditional step type
Add custom JavaScript