Nationale Feedback-Komponente (NFK-Plugin)

Geändert am Mo, 26 Mai um 3:24 NACHMITTAGS

Hinweis: Das Plugin ist ab Version 8.3.7 verfügbar.

Mit dem NFK-Plugin kann die Nationale Feedback-Komponente des Bundes in formcycle-Formularen eingebunden werden.

Das kostenpflichtige Plugin stellt dazu verschiedene Möglichkeiten bereit, um einen Link oder einen Button zum Öffnen des Feedback-Dialogs an verschiedenen Stellen im Formular oder in HTML-Abschlussseiten einzubinden.

Formular mit geöffnetem Feedback-Dialog

Inhalt

Voraussetzungen

Version 8.3.7 oder höher von formcycle
Installation des Plugins Nationale Feedback-Komponente (NFK)

Plugin installieren & konfigurieren

Das Plugin Nationale Feedback-Komponente (NFK) im Plugin-Store auswählen und installieren.
Nach der Installation erscheint das Plugin in der Liste der Plugins.
Basis-URL des NFK-Diensts gegebenenfalls noch anpassen

Konfiguration des NFK-Plugins in formcycle

Folgende Werte können am Plugin noch konfiguriert werden:

Feedback-URL (Pflichtfeld)
- Basis-URL zum NFK-Dienst. Der Schrägstrich am Ende ist optional.
- Standard-Wert: https://feedback.gov.de/
- Testsystem: https://stage.feedback.gov.de/
Portal-ID (optional)
- Standardwert für die Portal-ID, welcher für alle Formulare verwendet wird. Wird hier kein Wert eingetragen, muss die Portal-ID bei jedem Formular separat konfiguriert werden. Ist hier ein Wert eingetragen, kann dieser später immer noch pro Formular bei Bedarf überschrieben werden.

Funktionsweise

Zuerst muss im Formular die NFK-Anbindung aktiviert werden, indem rechts bei den Eigenschaften im Tab Formular das Häkchen gesetzt wird.

Konfiguration der NFK-Anbindung im Formular-Designer. Wurde in den Plugineinstellungen eine Portal-ID hinterlegt, muss diese nicht mehr konfiguriert werden.

Anschließend müssen noch der amtliche Regionalschlüssel und die ID des Anliegens (LeiKa-Schlüssel) eingetragen werden. Das Plugin unterstützt hier mit einem Autocomplete: Beim Eintragen einer ID oder eines Namens werden passende Treffer angezeigt. Der Typ des Anliegens ist optional und kann bei Bedarf noch eingetragen werden.

Nun kann ein Link oder Button für den Feedback-Dialog im Formular platziert werden. Hierzu gibt es 3 verschiedene Möglichkeiten.

Als Button: Ziehen Sie eine Button-Leiste ins Formular und wählen Sie Feedback anzeigen als Aktion aus.
Als Link im Footer: Klicken Sie auf den Footer und aktivieren Sie rechts die Checkbox.
Manuell an beliebiger Stelle per Platzhalter. Mit einem Text-Element und dem Platzhalter [%$nfk.link%] bzw. [%$nfk.button%] kann ein Link oder Button auch an einer anderen Stelle eingefügt werden.

Die Konfiguration für die NFK muss vollständig und korrekt sein. Ansonsten wird kein Link oder Button angezeigt beziehungsweise öffnet sich kein Feedback-Dialog. Dies dient dazu, fehlerhaft erhobene Daten zu vermeiden.

Auf HTML-Abschlussseiten kann die Möglichkeit 3 (Platzhalter) verwendet werden, um auch dort einen Feedback-Link oder -Button zu platzieren.

Ein Button zum Öffnen des Feedback-Dialogs kann über die entsprechende Button-Aktion in das Formular eingefügt werden.

Am Element "Footer" kann rechts in den Eigenschaften über die Checkbox ein Link zum Öffnen des Feedback-Dialogs als Footer-Link eingefügt werden.

Über die Platzhalter[%$nfk.link%] und [%$nfk.button%] lässt sich ein Link oder Button an beliebiger Stelle platzieren. Diese Platzhalter ermöglichen auch die Einbindung des Feedback-Dialogs auf HTML-Abschlussseiten.

Platzhalter für Button und Link

Mit diesen Platzhaltern kann ein Link oder Button auf den Feedback-Dialog eingefügt werden. Optional kann ein eigener Text für den Link oder Button angegeben werden. Wird kein eigener Text eingegeben, wird der Standardwert verwendet (siehe Lokalisierung unten).

Platzhalter	Beschreibung
[%$NFK.link%]	Link mit Standardtext
[%$NFK.link(Feedback anzeigen)%]	Link mit individuellem Text
[%$NFK.button%]	Button mit Standardtext
[%$NFK.button(Feedback anzeigen)%]	Button mit individuellem Text

Platzhalter im Formular

Das Plugin unterstützt folgende Platzhalter, um auf die benötigten Daten für die NFK-Einbindung zuzugreifen. Dies kann in fortgeschrittenen Anwendungsfällen helfen, wenn die Anbindung manuell per Script erfolgen soll.

Platzhalter	Beschreibung
[%$NFK.data.portalId%]	ID des Portals
[%$NFK.data.instrumentId%]	ID des Instruments
[%$NFK.data.issueType%]	Typ der Meldung
[%$NFK.data.issue%]	Konkrete Beschreibung des Feedbacks
[%$NFK.data.region%]	Region, aus der das Feedback stammt
[%$NFK.data.baseUrl%]	Basis-URL aus der Konfiguration
[%$NFK.data.scriptUrl%]	JavaScript-URL (widget)
[%$NFK.data.language%]	Spracherkennung

Zugriff auf Plugin-Daten per JavaScript

Im Formular können die Daten für die NFK-Anbindung auch über JavaScript ausgelesen werden:

window.XFC_METADATA.pluginResults['de.xima.fc.plugin.national_feedback_component.plugin.NfkFormPreRenderPlugin']

In einer HTML-Abschlussseite sind die Daten über folgenden Pfad verfügbar:

window.xfc_nfk

Lokalisierung

Die verwendeten Texte können über die I18N-Variablen im Backend angepasst werden. Der Schlüssel für die I18N-Variable lautet:

nfkFeedback - Standardtext für Link und Buttons, die den Feedback-Dialog öffnen.

Der Standardtext für den Link und Button kann in den I18N-Variablen angepasst werden.

Debug & Hinweise

Die Skript-URL wird dynamisch aus der Feedback URL zusammengesetzt
Nur wenn die Konfiguration vollständig ist, wird das NFK-Skript eingebunden

Zusammenfassung

Mit wenigen Schritten kann die Nationale Feedback-Komponente eingebunden werden:

Plugin installieren
Regionalschlüssel und LeiKa-Schlüssel im Formular eintragen
Button-Aktion verwenden oder Footer-Link aktivieren