Configuration of Forms

The various configuration options of the Forms module are presented and described below.

General module configuration

You can access the setting options via the administration area in the tab Forms > General tab.

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: module
Module_ForceLoad (`moduleForceLoad`)	bool	If this value is active, the module is also loaded when the BPC interface is loaded. This also applies if the value `moduleLoadStrategy` is set to "onDemand".
Module_Icon (`module_iconCls`)	text	Icon of the respective module in the tab of the administration area
Module_RestrictInstanceAccess (`module_restrictInstanceAccess`)	bool	Access can be restricted for the use of module components. If the configuration for restricted access is set (true), the corresponding right must be assigned separately for each component, so that the user can access the component.
Group: plugin
PluginConfiguration (`plugin_configuration`)	json	If the module is plugin-enabled, the configuration of the plugin can be set here Plugin can be entered or refined here.
Group: general
RendererUrl (`rendererUrl`)	text	The url for the renderer can be entered here Renderer can be defined here. This is necessary to be able to display forms.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	If activated, javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Group: module

Module_ForceLoad
(moduleForceLoad)

bool

If this value is active, the module is also loaded when the BPC interface is loaded.
This also applies if the value moduleLoadStrategy is set to "onDemand".

Module_Icon
(module_iconCls)

text

Icon of the respective module in the tab of the administration area

Module_RestrictInstanceAccess
(module_restrictInstanceAccess)

bool

Access can be restricted for the use of module components. If the configuration for restricted access is set (true), the corresponding right must be assigned separately for each component, so that the user can access the component.

Group: plugin

PluginConfiguration
(plugin_configuration)

json

If the module is plugin-enabled, the configuration of the plugin can be set here Plugin can be entered or refined here.

Group: general

RendererUrl
(rendererUrl)

text

The url for the renderer can be entered here Renderer can be defined here. This is necessary to be able to display forms.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

If activated, javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Component configuration

You can access the setting options via the administration area in the tab Forms > Components.

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: general
debug (`debug`)	bool	Opens the form in debug mode.
embeddedForm (`embeddedForm`)	json	Possible source for the content of a form. The JSON for the form is specified directly.
formId (`formId`)	text	Possible source for the content of a form. The ID of a form from the Forms Repository is specified here. Different versions of the same form have the same formId.
formUrl (`formUrl`)	text	Possible source for the content of a form. The form is loaded via the specified url.
formVersion (`formVersion`)	number	Version of the form to be loaded from the forms repository. The default value is -1, which means that the latest version is loaded. This is always the version with the highest number.
Group: module
Module_Description (`moduleHeader_description`)	text	Enables a short description of the module to be stored. Is displayed as a tooltip of the module header.
Module_Header (`moduleHeader_enabled`)	bool	Enables the activation/deactivation of an additional display and function area in the header of the module.
Module_Icon (`module_iconCls`)	text	Defines the display icon of the module. The icons of the FontAwesome library are available for selection.
Module_Name (`module_name`)	text	Defines the display name of the form.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	If activated, Javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Group: general

debug
(debug)

bool

Opens the form in debug mode.

embeddedForm
(embeddedForm)

json

Possible source for the content of a form. The JSON for the form is specified directly.

formId
(formId)

text

Possible source for the content of a form. The ID of a form from the Forms Repository is specified here. Different versions of the same form have the same formId.

formUrl
(formUrl)

text

Possible source for the content of a form. The form is loaded via the specified url.

formVersion
(formVersion)

number

Version of the form to be loaded from the forms repository. The default value is -1, which means that the latest version is loaded. This is always the version with the highest number.

Group: module

Module_Description
(moduleHeader_description)

text

Enables a short description of the module to be stored. Is displayed as a tooltip of the module header.

Module_Header
(moduleHeader_enabled)

bool

Enables the activation/deactivation of an additional display and function area in the header of the module.

Module_Icon
(module_iconCls)

text

Defines the display icon of the module. The icons of the FontAwesome library are available for selection.

Module_Name
(module_name)

text

Defines the display name of the form.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

If activated, Javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Live Editor

Forms can be edited via the Live Editor. Changes are implemented live. You can access the Live Editor via the administration area in the tab Forms > Live Editor.

Any form can be loaded via the 'Load from existing form' field. Changes are not saved.

The debug field can be used to load the form in debug mode.

Forms Repository

The Forms Repository makes it easy to save and version forms. You can access the Forms Repository via the administration area in the tab Forms > Forms Repository.

Forms can be edited using the pencil icon and viewed using the eye icon.

After a change, the form is saved with an incremented version. The different versions can be viewed and edited individually. The last saved version is displayed first as the most recent form.

Keywords: