Formularliste - Plugins

Inhaltsverzeichnis

• Installation und Konfigurations
• Technische Schnittstelle für die Integration mit Drittsystemen
  • Mögliche Anwendungsfälle
  • Vorteile der Schnittstelle
• Beispiel-URLs:
• GET-Parameter
  • JSON-Ausgabe
  • Beschreibung der Felder in der JSON-Ausgabe
  • HTML-Ausgabe
  • Beispiel für eine JSON-Integration in einem CMS
• Zusammenfassung

Installation und Konfigurations

Das Plugin muss als System-Plugin installiert werden.

Technische Schnittstelle für die Integration mit Drittsystemen

Das FormList Plugin stellt eine leistungsfähige technische Schnittstelle zur Verfügung, die speziell für die Integration mit verschiedenen Drittsystemen entwickelt wurde. Diese Schnittstelle kann verwendet werden, um Informationen über Formulare in eine Vielzahl von Systemen zu integrieren, darunter Portale, Content-Management-Systeme (CMS), Business Process Model and Notation (BPMN) Systeme und andere Plattformen, die eine Auflistung und Präsentation von Formularinformationen benötigen.

Mögliche Anwendungsfälle

1. Portale:

   • Beispiel: Ein städtisches Bürgerportal kann die JSON-Ausgabe des FormList Plugins verwenden, um eine dynamische Liste von Online-Formularen bereitzustellen. Bürger können so einfach auf relevante Formulare zugreifen, um beispielsweise Anträge zu stellen oder Informationen einzureichen.

2. Content-Management-Systeme (CMS):

   • Beispiel: Ein CMS wie WordPress oder Drupal kann die Schnittstelle nutzen, um Formularinformationen auf Webseiten zu integrieren. Die JSON-Ausgabe kann durch ein Plugin oder ein Modul verarbeitet werden, um automatisch aktualisierte Formulare auf der Website anzuzeigen.

3. Business Process Model and Notation (BPMN) Systeme:

   • Beispiel: In einem BPMN-System kann die Schnittstelle verwendet werden, um Formulare in automatisierte Geschäftsprozesse einzubinden. Die Formularinformationen können abgerufen und als Teil eines Workflow-Prozesses verwendet werden, um Daten zu sammeln oder Benutzerinteraktionen zu ermöglichen.

4. Andere Systeme:

   • Beispiel: Andere Systeme wie Customer Relationship Management (CRM) Plattformen, Enterprise Resource Planning (ERP) Systeme oder individuelle Anwendungen können die Schnittstelle nutzen, um Formulare zu integrieren und so die Funktionalität und den Nutzen der Systeme zu erweitern.

Vorteile der Schnittstelle

• Automatisierung: Die Schnittstelle ermöglicht eine automatisierte Integration und Synchronisation von Formularinformationen, was manuelle Eingriffe minimiert und Fehler reduziert.
• Flexibilität: Durch die Unterstützung von JSON und HTML kann die Schnittstelle in verschiedenen Kontexten und mit unterschiedlichen Technologien verwendet werden.
• Aktualität: Die Verwendung der Schnittstelle stellt sicher, dass immer die aktuellsten Formularinformationen in den verbundenen Systemen angezeigt werden.
• Erweiterbarkeit: Neue Formulare können einfach hinzugefügt und bestehende Formulare aktualisiert werden, ohne dass Anpassungen an den Drittsystemen erforderlich sind.

Beispiel-URLs:

Das FormList Plugin stellt Informationen über Formulare bereit und unterstützt zwei verschiedene Ausgabeformate: JSON und HTML. Die Ausgabe wird durch die übergebenen GET-Parameter bestimmt.

1. JSON-Ausgabe: https://training.formcycle.eu/formcycle/plugin?name=FormListJson&xfc-rp-client=demo&group=none
2. HTML-Ausgabe: https://training.formcycle.eu/formcycle/plugin?name=FormListHtml&xfc-rp-client=demo&group=none

GET-Parameter

Die URLs akzeptieren verschiedene GET-Parameter, die das Verhalten und die Ausgabe des Plugins beeinflussen:

• name: Name des Plugins, der verwendet wird. Die Ausgabe erfolgt mit FormListJson oder FormListHtml.
• xfc-rp-client: Name des Clients, für den die Daten bereitgestellt werden. Beispiel: demo.
• group: Einschränkung der Daten anhand der Formulargruppe. Der Wert none stellt alle Daten zur Verfügung oder es wird der Name der Formulargruppe angegeben, z.B. Beispiele. Die Formulargruppen können auch kommasepariert angegeben werden.

Hinweis: Es werden nur Formulare zurückgeliefert, die online geschalten sind und über den Formularlink (.../form/provide/ID) geöffnet werden könnten.

JSON-Ausgabe

Die URL zur JSON-Ausgabe ruft detaillierte Informationen über die Formulare ab. Die JSON-Daten bestehen aus einer Liste von Objekten, die jeweils ein Formular repräsentieren.

Beispiel für ein JSON-Objekt:

{
    "thumbnail": "https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&client-id=553&pid=2304&type=thumbnail&format=gif",
    "fc_date": "24.04.2024",
    "change_date": 1718273292000,
    "form_id": 2306,
    "title": "Bürgerservice Team1",
    "url": "https://training.formcycle.eu:443/formcycle/form/provide/2304/1",
    "tags": [],
    "form_version": 3,
    "servers": {
        "frontend": [],
        "master": [
            {
                "name": "170cb0ed-cbdf-4199-ba0d-8d0f78a7c7ee",
                "type": "master",
                "url": "https://training.formcycle.eu:443/formcycle/"
            }
        ],
        "origin": {
            "name": "170cb0ed-cbdf-4199-ba0d-8d0f78a7c7ee",
            "type": "master",
            "url": "https://training.formcycle.eu/formcycle/"
        },
        "request": {
            "name": "170cb0ed-cbdf-4199-ba0d-8d0f78a7c7ee",
            "type": "master",
            "url": "https://training.formcycle.eu:443/formcycle/"
        }
    },
    "name": "form_2304",
    "online": true,
    "id": 2304,
    "client_name": "Hackathon",
    "actions": {
        "edit": "Hackathon/designer/2304",
        "provide": "form/provide/2304/1",
        "thumbnail": "plugin?name=FormListThumbnail&client-id=553&pid=2304&type=thumbnail&format=gif"
    },
    "desc": "",
    "form_date": 1718265275000
}

Beschreibung der Felder in der JSON-Ausgabe

• thumbnail: URL zum Vorschaubild des Formulars.
• fc_date: Datum der letzten Bearbeitung im Format "dd.MM.yyyy".
• change_date: Unix-Timestamp der letzten Änderung.
• form_id: Eindeutige ID des Formulars.
• title: Titel des Formulars.
• url: URL zur Bereitstellung des Formulars.
• tags: Liste von Tags des Formulars (kann leer sein).
• form_version: Versionsnummer des Formulars.
• servers: Informationen zu den Servern (Frontend, Master, Origin, Request).
• name: Interner Name des Formulars.
• online: Verfügbarkeit des Formulars (boolean).
• id: Eindeutige ID des Formulars (gleich form_id).
• client_name: Name des Clients, der das Formular bereitstellt.
• actions: Verfügbare Aktionen (edit, provide, thumbnail).
• desc: Beschreibung des Formulars (kann leer sein).
• form_date: Unix-Timestamp der Formularerstellung.

HTML-Ausgabe

Die URL zur HTML-Ausgabe listet die Titel der Formulare in einfacher HTML-Form auf. Die Ausgabe enthält nur die Namen der Formulare und bietet eine schnelle Übersicht.

Beispiel der HTML-Ausgabe:

<div class="xm-form-list-content">
   <div data-group="" class="xm-form-group">
      <h3 class="xm-form-list-header"></h3>
      <ul>
         <li><a data-form-id="2306" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2304&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2304/1">Bürgerservice Team1</a></li>
         <li><a data-form-id="2117" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2116&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="0" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2116/1">Challenge eBürgerdienst</a></li>
         <li><a data-form-id="2183" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2182&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2182/1">Challenge interner Prozess (Urlaubsantrag).</a></li>
         <li><a data-form-id="2309" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2307&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2307/1">Neues Formular</a></li>
         <li><a data-form-id="2357" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2345&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2345/1">Neues Formular (2)</a></li>
         <li><a data-form-id="2321" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2319&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2319/1">Neues Formular (3)</a></li>
         <li><a data-form-id="2370" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2358&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2358/1">Neues Formular (4)</a></li>
         <li><a data-form-id="2313" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2311&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2311/1">TESTBETRIEB</a></li>
         <li><a data-form-id="2307" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2305&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2305/1">Urlaubsantrag</a></li>
         <li><a data-form-id="2322" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2320&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="1" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2320/1">Urlaubsantrag (Kopie)</a></li>
         <li><a data-form-id="2312" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2310&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="3" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2310/1">Vorlage</a></li>
         <li><a data-form-id="2317" data-group="" data-thumbnail="https://training.formcycle.eu:443/formcycle/plugin?name=FormListThumbnail&amp;client-id=553&amp;pid=2315&amp;type=thumbnail&amp;format=gif" data-tags="[]" data-form-version="2" data-desc="" target="_blank" class="xm-form-list-link" href="https://training.formcycle.eu:443/formcycle/form/provide/2315/1">Vorlage (Kopie) (Kopie)</a></li>
      </ul>
   </div>
</div>

Beispiel für eine JSON-Integration in einem CMS

Ein CMS könnte ein Skript enthalten, das die JSON-Daten vom FormList Plugin abruft und diese Informationen in einer benutzerfreundlichen Oberfläche anzeigt:

fetch('https://training.formcycle.eu/formcycle/plugin?name=FormListJson&xfc-rp-client=demo&group=none')
  .then(response => response.json())
  .then(data => {
    let formList = document.getElementById('formList');
    data.forEach(form => {
      let listItem = document.createElement('li');
      listItem.innerHTML = `<a href="${form.url}">${form.title}</a>`;
      formList.appendChild(listItem);
    });
  });

In diesem Beispiel wird die JSON-Ausgabe des FormList Plugins verwendet, um eine Liste von Formularen in einem CMS anzuzeigen. Diese einfache Integration zeigt, wie flexibel und nützlich die Schnittstelle für verschiedene Anwendungen sein kann.

Zusammenfassung

Das FormList Plugin bietet eine technische Schnittstelle, die ideal für die Integration mit Drittsystemen wie Portalen, CMS, BPMN und anderen Plattformen geeignet ist. Es ermöglicht eine nahtlose Einbindung von Formularinformationen und unterstützt eine Vielzahl von Anwendungsszenarien, die von der automatisierten Prozessintegration bis zur dynamischen Inhaltsbereitstellung reichen.

Das Plugin bietet zwei Ausgabeformate: JSON und HTML. Die JSON-Ausgabe enthält detaillierte Informationen zu den Formularen, während die HTML-Ausgabe eine einfache Liste der Formularnamen bereitstellt. Die GET-Parameter steuern das Verhalten und die Ausgabe des Plugins.