Configure Optimizely Forms
This topic explains how to configure Optimizely Forms.
Optimizely Forms is only supported by MVC-based websites and HTML5-compliant browsers.
Optimizely Forms stores its fundamental configuration in the _protected/EPiServer.Forms/Forms.config file.
Restrict access to data
The following configuration restricts who is able to view submitted form data. Edit is the default; an editor should at least have Edit access rights on the form content to view
Suitable values for
minimumAccessRightLevelToReadFormData are as follows:
NoAccess = 0, Read = 1, Create = 2, Edit = 4, Delete = 8, Publish = 16, Administer = 32, FullAccess = 63
For example, if you change the access rights to Publish, only a user who has
FullAccess access rights on that form can see the
To send email after a site visitor submits a form, you must modify the appSettings.json settings for your website as described in Configuring your email server.
Send email in HTML format, otherwise, it uses plain text.
By default, the
FileUploadElement does not let a visitor upload the following types of file extensions.
defaultUploadExtensionBlackList="asp,aspx,asa,ashx,asmx, bat, chm,class,cmd,com,config, dll, exe, hta,htm,html,htr,htw, jar,js,jse,json, lnk, mda,mdb,msc,msh, pif,printer,ps1,ps2, reg,rem, scf,scr,sct,shtm,shtml,soap,stm,svc, url, vb,vbe,vbs,vsix, ws,wsc,wsf,wsh, xamlx"
EPiServer.Forms.Controllers.DataSubmitController is the default
CoreController, which is a normal ASP.NET MVC controller. If you want to use your own controller, you must map the route in Global.asax to your controller, and tell Forms to submit data to your controller by changing the following configuration.
Default location for view templates
Specify the default location to search for
ElementBlocks' view templates. A developer also can override this behavior by implementing
ICustomViewLocation or inheriting from
Forms and jQuery
Optimizely Forms requires jQuery 1.7.2+ to provide a better experience in view mode (interaction, steps navigation, validation, save/load data to localStorage, etc). If your website already has jQuery 1.7.2+, you can save some payload and network transmission for your visitors by telling Optimizely Forms to not inject its jQuery instance. Forms uses the site’s jQuery instance without problem.
Disable the default stylesheet
Optimizely Forms has a default stylesheet (EPiServerForms.less), using BEM methodology to name CSS classes and decorate HTML element tags; it is a very fundamental, minimal .less file, and easy to modify. If you do not want this, you can turn it off by using the following configuration.
Configure the submit cookie timeout
Configuration for number of days that Forms keeps the state of relation (in visitor's cookie) between Visitor-Forms-Submission. This affects the progressive submission cookie, and the visitor identification cookie.
Render forms as a <div> tag
By default, a form is rendered as a <form> tag in view mode. From version 3.1, if you want to render form as a <div> tag, set this configuration to true.
Use Webhook receivers
From version 4.3, you can set up the kind of data format used before sending data to a webhook receiver by using:
The default value of this key is true, meaning you should use that json object data-type to communicate with webhook receivers. The key-value dictionary data format is used if you use the value false.
Disable form cookies for GDPR
DisableFormCookies was introduced into Forms configuration to provide better GDPR compliance for our sites. Enable this option to prevent cookies from being added to users accessing to the site.
Allow anonymous submissions are required for Forms submitted when
DisableFormCookiesis enabled because a user without cookies is not identified and is treated as anonymous.
Hide Partial Submissions from Admin/Edit View (GDPR Compliance)
HidePartialSubmissions was introduced into Forms configuration in version 5.5.0 to provide better GDPR compliance for our sites. Enable this option to hide partial submissions data from external UI views such as form submissions history, exported data, and also to disable all partial execution from actors. Also, enable this option to set the retention policy of partial data to a minimum period of one day.
Enabling this option will disable all actors partial execution in multi-step forms except base SaveDataToStorageActor to ensure basic functionality
Related blog posts
Updated 25 days ago