Forms Plugins/Hooks

Diese Seite beschreibt die vom Modul angebotenen Plugins und Hooks.

Für allgemeine Informationen zu Plugins siehe Plugins.

Plugins

BPC Forms Plugin

Mit diesem Plugin kann ein BPC Forms innerhalb eines Hooks dargestellt werden.

Das darzustellende Form kann entweder eine bestehende BPC Forms Komponente (moduleId), ein Forms aus dem Repository (formId) oder eine externe Formularkonfiguration (formUrl) referenzieren. Es ist auch möglich direkt eine gültige Formularkonfiguration (formConfig) am Plugin zu hinterlegen.

Folgende Einstellungen können über die Plugin-Konfiguration vorgenommen werden.

moduleId: Referenziert eine bestehende BPC Forms Komponente über dessen ID.
Kann nicht mit formUrl, formConfig oder formId kombiniert werden.
formUrl: Referenziert eine externe Quelle für eine Formularkonfiguration. Die URL muss für den Endanwender aufrufbar sein. Bitte beachten Sie evtl. auftretende Anforderungen bezüglich CORS.
Kann nicht mit moduleId, formConfig oder formId kombiniert werden.
formConfig: Hier kann direkt eine gültige Formularkonfiguration im JSON Format hinterlegt werden.
Kann nicht mit moduleId, formUrl oder formId kombiniert werden.
formId: Referenziert ein Forms, dass im internen Forms Repository hinterlegt ist, über seine Repository ID. Zusätzlich kann über formVersion eine dedizierte Version referenziert werden. Ist formVersion nicht gegeben, so wird immer die letzte Version berücksichtigt.
Kann nicht mit moduleId, formUrl oder formConfig kombiniert werden.
formVersion: Dient zu referenzierung einer dedizierten Version eines Forms im Forms Repository. Kann nur in Verbindung mit formId genutzt werden.
debug: Wird dieser Parameter auf true gesetzt, so wird die Debug-Ansicht des Renderer aktiviert.
initialData: An dieser Stelle können Formular-Daten definiert werden. Mit den Daten wird der Datenbereich des Formulars initialisiert.

Mögliche Parameter für eine Plugin-Konfiguration

{
    "moduleId": null,
    "formUrl"     : null,
    "formConfig"  : null,
    "formId"      : null,
    "formVersion" : null,
    "debug"       : false,
    "initialData" : null
}

Hooks

Dieses Modul bietet keine Hooks an.

Keywords: