Configuring Forms

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

General Module Configuration

You can access the settings via the administration area under the Forms > General.

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: module
Module_ForceLoad (`moduleForceLoad`)	bool	If this setting is enabled, the module is loaded when the BPC interface is loaded. This also applies if the value `moduleLoadStrategy` is set to "onDemand."
Module_Icon (`module_iconCls`)	text	Icon for the respective module in the administration area tab
Module_RestrictInstanceAccess (`module_restrictInstanceAccess`)	bool	Access to module components can be restricted. If the configuration for restricted access is set _ to true,_ the corresponding permission must be granted separately for each component, so that You can access the component.
Group: plugin
PluginConfiguration (`plugin_configuration`)	json	If the module supports plugins, the plugin configuration can be entered or refined here.
Group: general
RendererUrl (`rendererUrl`)	text	The URL for the renderer can be specified here. This is required to display forms.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Group: module

Module_ForceLoad
(moduleForceLoad)

bool

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

Module_Icon
(module_iconCls)

text

Icon for the respective module in the administration area tab

Module_RestrictInstanceAccess
(module_restrictInstanceAccess)

bool

Access to module components can be restricted. If the configuration for restricted access is set _ to true,_ the corresponding permission must be granted separately for each component, so that You can access the component.

Group: plugin

PluginConfiguration
(plugin_configuration)

json

If the module supports plugins, the plugin configuration can be entered or refined here.

Group: general

RendererUrl
(rendererUrl)

text

The URL for the renderer can be specified here. This is required to display forms.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Component Configuration

You can access the settings via the administration area under the 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 form content. The JSON for the form is specified directly.
formId (`formId`)	text	Possible source for form content. 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 a form’s content. 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 loads the latest version. This is always the version with the highest number.
Group: module
Module_Description (`moduleHeader_description`)	text	Allows you to enter a short description of the module. Displayed as a tooltip for the module header.
Module_Header (`moduleHeader_enabled`)	bool	Enables or disables an additional display and function area in the module header.
Module_Icon (`module_iconCls`)	text	Defines the module’s display icon. You can choose from the icons in the FontAwesome library.
Module_Name (`module_name`)	text	Defines the display name of the form.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	When enabled, JavaScript 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 form content. The JSON for the form is specified directly.

formId
(formId)

text

Possible source for form content. 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 a form’s content. 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 loads the latest version. This is always the version with the highest number.

Group: module

Module_Description
(moduleHeader_description)

text

Allows you to enter a short description of the module. Displayed as a tooltip for the module header.

Module_Header
(moduleHeader_enabled)

bool

Enables or disables an additional display and function area in the module header.

Module_Icon
(module_iconCls)

text

Defines the module’s display icon. You can choose from the icons in the FontAwesome library.

Module_Name
(module_name)

text

Defines the display name of the form.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Live Editor

Forms can be edited using the Live Editor. Changes are applied in real time. You can access the Live Editor via the administration area under the Forms > Live Editor.

You can load any form using the 'Load from existing form' field. Changes are not saved.

You can load the form in debug mode using the Debug field.

Forms Repository

The Forms Repository allows for easy storage and versioning of forms. You can access the Forms Repository via the administration area under the Forms > Forms Repository.

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

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

Keywords: