Jitterbit Form Flow App

Übersicht

Jitterbit stellt die Form Flow App über Jitterbit Marketplace bereit. Sie wurde mit Jitterbit App Builder entwickelt und ist ein vorlagengestützter Formular-Builder und eine Datenerfassungs-App. Administratoren stellen wiederverwendbare Formularvorlagen aus Abschnitten, Formularen und Feldern zusammen, die Endbenutzer dann durch einen geführten, schrittweisen Assistenten ausfüllen. Einreichungen durchlaufen einen Überprüfungs- und Genehmigungsprozess mit E-Mail-Benachrichtigungen in jeder Phase.

Die App wird als App Builder-Release-Paket (eine .LP-Datei) aus dem Marketplace heruntergeladen und in einer eigenen App Builder-Instanz installiert, wo man sie für den eigenen Prozess konfigurieren und erweitern kann.

Diese Seite beschreibt wie die App funktioniert, ihre Kernfunktionen und das Datenmodell, behandelt die Voraussetzungen, wie man sie herunterlädt und installiert, wie man sie für die eigene Umgebung konfiguriert, wie der Zugriff kontrolliert wird, und häufige Schritte zur Fehlerbehebung.

Funktionsweise

Auf hoher Ebene verläuft Form Flow vom Erstellen einer Vorlage über das Ausfüllen von Einreichungen gegen diese Vorlage bis zur Überprüfung dieser Einreichungen:

flowchart TD A["Administrator builds
a form template"] --> B["Define sections, forms,
fields, and visibility rules"] B --> C["Template available
for submissions"] C --> D["User starts
a submission"] D --> E["Complete the
guided wizard"] E --> F["Submit"] F --> G{"Reviewer
decision"} G -->|Approve| H["Submission locked,
approval email sent"] G -->|Request revision| I["Submission reopened,
revision email sent"] I --> E

Kernfunktionen

Bei der Installation und Konfiguration von Form Flow stehen folgende Funktionen zur Verfügung:

Vorlagen-Builder: Erstelle benutzerdefinierte Fragebögen, die in Abschnitte und Formulare unterteilt sind, mit einer Reihe von Feldtypen wie Text, Textbereich, Zahl, Datum, Kontrollkästchen, Optionsschaltfläche, Dropdown und HTML-Inhalt.
Geführte Dateneingabe: Endbenutzer füllen eine Einreichung durch einen Assistenten mit einem Navigationsbaum auf der linken Seite aus, der Abschnitte und Formulare nacheinander gruppiert und den Fortschritt verfolgt.
Bedingte Sichtbarkeit: Regeln bewerten die Antworten eines Benutzers in Echtzeit, um einzelne Felder oder ganze Formulare anzuzeigen oder auszublenden, und um Felder basierend auf früheren Antworten erforderlich zu machen.
Überprüfungs- und Genehmigungsprozess: Jede Vorlage bestimmt einen Prüfer. Wenn ein Benutzer einen Eintrag einreicht, wechselt dieser in einen Überprüfungsstatus, in dem nur dieser Prüfer ihn genehmigen oder ablehnen kann. Die Genehmigung sperrt die Einreichung; die Ablehnung öffnet sie zur Bearbeitung erneut.
E-Mail-Benachrichtigungen: Die App sendet E-Mails bei wichtigen Lebenszyklusereignissen (Einreichung, Genehmigung und Ablehnung). Der Nachrichteninhalt wird durch konfigurierbare Vorlagendatensätze gesteuert, sodass Administratoren den Text ändern können, ohne die Logik der App zu ändern.

Lebenszyklus und Status

Form Flow verfolgt den Status für jede Endbenutzer-Einreichung (Instanz) auf zwei Ebenen: den Gesamtstatus der Einreichung und den Fortschritt der einzelnen Abschnitte, Formulare und Felder darin.

Einreichungsstatus

Eine Einreichung durchläuft drei Gesamtzustände von der Erstellung bis zur Genehmigung:

In Bearbeitung: Der Startzustand für eine neue Einreichung. Wenn der Prüfer einen eingereichten Eintrag ablehnt, kehrt dieser in diesen Zustand zurück, damit der Benutzer Änderungen vornehmen kann.
Zur Überprüfung: Wird festgelegt, wenn der Benutzer einreicht. Die Einreichung wird an den zugewiesenen Prüfer weitergeleitet.
Abgeschlossen: Wird festgelegt, wenn der Prüfer genehmigt, was die Einreichung sperrt.

Abschnitts- und Formularstatus

Während ein Benutzer eine Einreichung durcharbeitet, durchlaufen ihre Abschnitte und Formulare diese Zustände:

Abschnitte und Formulare beginnen als Nicht gestartet.
Ein Abschnitt wechselt zu In Bearbeitung, wenn der Benutzer ihn öffnet, und ein Formular wechselt zu In Bearbeitung, wenn der Benutzer sein erstes Feld beantwortet.
Bei der Einreichung werden Abschnitte und Formulare, die In Bearbeitung sind, zu Eingereicht, und alle noch Nicht gestartet werden zu Übersprungen.
Wenn der Prüfer genehmigt, wechselt der Gesamtstatus der Einreichung zu Abgeschlossen, aber die Abschnitts- und Formularstatus ändern sich nicht: Sie bleiben Eingereicht oder Übersprungen.
Wenn der Prüfer die Einreichung ablehnt, kehren Eingereichte Abschnitte und Formulare zu In Bearbeitung zurück und übersprungene kehren zu Nicht gestartet zurück, damit der Benutzer bearbeiten und erneut einreichen kann.

Datenmodell

Form Flow ist vollständig eigenständig: Es speichert alle Vorlagen, Einreichungen und Antworten in eigenen Tabellen und benötigt keine externe Datenbankverbindung.

Jede Tabelle hat einen Datennutzungstyp, der durch ihre Installationsoption festgelegt wird und steuert, wie ihre Daten bei der Installation der App in einer neuen Umgebung behandelt werden: Developer-Daten werden bei der Installation ersetzt, Shared-Daten werden einmalig initialisiert, und User-Daten bleiben für jede Umgebung zum Ausfüllen übrig.

Tabelle	Nutzungstyp	Zweck
`FieldType`	Developer	Registry unterstützter Eingabefeldtypen.
`TemplateStatus`	Developer	Lebenszyklusstatus der Einreichung (`In Progress`, `Under Review`, `Completed`).
`SectionStatus`	Developer	Abschnittnavigation und Sperrstatus.
`FormStatus`	Developer	Formulareintrag und Berechtigungsstatus.
`Operator`	Developer	Vergleichsoperatoren, die von Sichtbarkeitregeln verwendet werden.
`VisibilityAction`	Developer	Sichtbarkeitsergebnisse (`Hidden`, `Visible`).
`Template`	Shared	Stammdatensatz für eine wiederverwendbare Formularvorlage.
`Section`	Shared	Eine Gruppierung von Formularen innerhalb einer Vorlage.
`Form`	Shared	Ein einzelner Schritt innerhalb eines Abschnitts.
`FormField`	Shared	Ein einzelnes Eingabefeld und seine Einstellungen.
`FieldOption`	Shared	Auswahlwerte für Radio- und Dropdown-Felder.
`FormVisibility`	Shared	Regeln, die ganze Formulare anzeigen oder ausblenden.
`FieldVisibility`	Shared	Regeln, die einzelne Felder anzeigen oder ausblenden.
`Parameter`	Shared	Globale Einstellungen und Umgebungswerte.
`WorkflowTemplate`	Shared	E-Mail-Betreff- und Textvorlagen.
`TemplateInstance`	User	Eine einzelne Ausführung einer Vorlage durch einen Endbenutzer.
`SectionInstance`	User	Fortschrittsstatus für einen Abschnitt innerhalb einer Ausführung.
`FormInstance`	User	Fortschrittsstatus für ein Formular innerhalb einer Ausführung.
`FieldResponse`	User	Eine einzelne von einem Benutzer erfasste Antwort.

Hinweis

Das Löschen eines Template kaskadiert zu seinen untergeordneten Section-, Form-, FormField- und FieldOption-Datensätzen; das Löschen eines TemplateInstance kaskadiert zu seinen untergeordneten SectionInstance-, FormInstance- und FieldResponse-Datensätzen. Diese Löschvorgänge sind auf Administratoren beschränkt.

Voraussetzungen

Um Form Flow zu verwenden, benötigen Sie Folgendes:

Eine Jitterbit Harmony-Lizenz mit Zugriff auf App Builder. Dies ermöglicht den Marketplace-Download; wenn Ihre Organisation nicht für App Builder lizenziert ist, wird die Aktion App herunterladen durch eine Anforderungsaktion App abrufen ersetzt (siehe Herunterladen und installieren).
Eine App Builder-Instanz, auf der App Builder 4.63 ausgeführt wird, die Version, für die das aktuelle Paket erstellt wurde. Jedes Paket wird nur auf seiner exakten App Builder-Version installiert; wenn sich Ihre Instanz auf einer anderen Version befindet, wenden Sie sich an den Jitterbit-Support, um ein passendes Paket anzufordern.
Eine PostgreSQL-Datenbank für Ihre App Builder-Instanz.
Ein ausgehender SMTP-Mailserver, der in Ihrer App Builder-Instanz konfiguriert ist. Die Benachrichtigungen der App sind darauf angewiesen; ohne SMTP-Routing werden E-Mail-Benachrichtigungen nicht versendet.

Herunterladen und installieren

Melden Sie sich beim Harmony-Portal unter https://login.jitterbit.com an und öffnen Sie Marketplace.
Suchen Sie die App mit dem Namen Form Flow. Sie können die Suchleiste verwenden oder im Bereich Filter unter Typ die Option App auswählen, um nur Apps anzuzeigen.
Klicken Sie auf die App-Karte, um das Panel Details zu öffnen. Überprüfen Sie die Anforderungen der App (die App Builder-Version und die Datenbank, die sie benötigt).
Klicken Sie auf den Link Zur Dokumentation der App, um diese Dokumentation in einem separaten Tab zu öffnen, und halten Sie ihn als Referenz offen.
Führen Sie je nach Lizenzierung Ihrer Organisation für App Builder einen der folgenden Schritte aus:
- App herunterladen: Wenn Ihre Organisation für App Builder lizenziert ist, klicken Sie auf App herunterladen, entweder auf der App-Karte oder im Panel Details. Ihr Browser speichert die .LP-Datei an ihrem Download-Speicherort, und eine Benachrichtigung App Builder-Datei erfolgreich heruntergeladen bestätigt den Download.
App abrufen: Wenn Ihre Organisation nicht für App Builder lizenziert ist, wird die Aktion als App abrufen bezeichnet. Das Panel Details zeigt eine Meldung an, dass eine App Builder-Lizenz erforderlich ist, zusammen mit einer Schaltfläche Absenden. Klicken Sie auf Absenden, um eine Anfrage zu senden, damit sich ein Vertreter mit Ihnen über App Builder in Verbindung setzt. Eine Benachrichtigung Nachricht erfolgreich gesendet bestätigt dies.

App in App Builder installieren

Installieren Sie die heruntergeladene .LP-Datei in Ihrer App Builder-Instanz:

Melden Sie sich bei App Builder an und gehen Sie zur IDE.
Klicken Sie unter Deploy auf Install Release.
Klicken Sie auf + Package, dann auf Browse und wählen Sie die heruntergeladene .LP-Datei aus.
Klicken Sie auf Save. Das Panel Release zeigt die Paketinformationen an und schließt dann das Dialog Package.
Bestätigen Sie, dass die Details korrekt sind, und klicken Sie auf Install.

Um den Inhalt eines Pakets vor der Installation in der Vorschau anzuzeigen, klicken Sie auf die Schaltfläche Manifest.

App in einer Entwicklungsumgebung ändern

Die Datenquelle der App wird versiegelt installiert. Wenn Sie die App in einer Entwicklungsumgebung bereitstellen und beabsichtigen, sie zu ändern, heben Sie die Versiegelung der Datenquelle auf, um die Objekte der App bearbeiten zu können. Lassen Sie sie in QA und Produktion versiegelt, um die Äquivalenz zwischen Umgebungen zu bewahren. Siehe Datenquelle versiegeln oder Versiegelung aufheben.

Konfiguration und Setup

Nach der Installation der App in einer neuen Umgebung führen Sie die folgenden Schritte aus, um sie einsatzbereit zu machen:

Benutzer Gruppen zuweisen. Fügen Sie Ihre Benutzer zur entsprechenden Zugriffsgruppe hinzu, entweder Form Flow Administrator oder Form Flow User. Siehe Sicherheit und Zugriff.
E-Mail-Formate von Benutzern überprüfen. Die Ablehnungsmitteilung wird an das Konto des Einreichenden gesendet. Bestätigen Sie, dass Benutzerkonten gültige E-Mail-Adressen verwenden, damit Benachrichtigungen korrekt zugestellt werden. Siehe zugehörige Fehlerbehebung.
Umgebungs-URL festlegen. Aktualisieren Sie in den Parameter-Einstellungen den Wert AppBuilderURL, um die Root-URL Ihrer Umgebung zu entsprechen, damit Links in E-Mail-Benachrichtigungen korrekt aufgelöst werden.
Reviewer der Beispielvorlage aktualisieren. Die App wird mit einer Beispielvorlage „Employee Onboarding Template" ausgeliefert. Öffnen Sie diese und ersetzen Sie die Platzhalter-E-Mail des Reviewers im Feld ApproverEmail durch eine gültige, überwachte Adresse.

Die App wird auch mit Beispiel-Lookup-Daten und einer Beispielvorlage ausgeliefert, damit ihre Funktionen unmittelbar nach der Installation funktionieren.

Sicherheit und Zugriff

Form Flow verwendet rollenbasierte Sicherheit von App Builder mit zwei Zugriffsgruppen: Form Flow Administrator und Form Flow User. Der Zugriff auf die einzelnen Bereiche ist wie folgt:

Bereich	Form Flow Administrator	Form Flow User
Template Builder	Vollzugriff	Vorlagen erstellen und ändern
Submissions Workspace	Vollzugriff	Einreichungen anzeigen und starten
Live-Einreichungsformulare	Vollzugriff	Formulareinträge ausfüllen
Seite zur Ablehnungsbehebung	Vollzugriff	Schreibgeschützt, erreichbar über Workflow-Aktionen
Lookup-Daten und Einstellungen	Vollzugriff	Kein Zugriff (Menüs ausgeblendet)
Datensatzlöschung	Vollzugriff	Nicht zulässig

Genehmigungs- und Ablehnungsaktionen sind nur für den Reviewer verfügbar, dessen E-Mail mit ApproverEmail in der Vorlage übereinstimmt. Für alle anderen Benutzer sind diese Aktionen deaktiviert. Wenn eine Einreichung eingereicht wird, werden ihre Felder schreibgeschützt. Eine Ablehnungsaktion durch einen Reviewer öffnet sie erneut zum Bearbeiten.

Geschäftsregeln

Die Logik von Form Flow wird als Geschäftsregeln von App Builder implementiert. Regelnamen folgen der Konvention Target (Purpose or Subtype) Descriptor von App Builder, daher identifiziert das erste Wort die Tabelle, auf die die Regel angewendet wird. Die folgenden Tabellen listen die Regeln nach Funktionsbereichen auf, um Ihnen zu helfen, sie zu finden und zu verstehen, wenn Sie die App erweitern.

Regeln zur Template-Konfiguration

Regel	Zweck
`Template (Business Object)`	Verwaltet übergeordnete Template-Konfigurationsdatensätze.
`Template (List)`	Ausahlliste aktiver Templates.
`Section (Business Object)`	Verwaltet Abschnittslayout-Datensätze.
`Section (List)`	Ausahlliste konfigurierter Abschnitte.
`Form (Business Object)`	Verwaltet einzelne Formularschritt-Datensätze innerhalb eines Abschnitts.
`Form (List)`	Strukturelle Liste für Template-Zuordnung.
`FormField (Form Fields)`	Fügt Formularfelder im Template Builder hinzu und steuert das Feld-Optionen-Panel.
`FormField (List)`	Feldauswahl bei der Definition von Sichtbarkeitsregeln, gruppiert nach Abschnitt und Formular.
`FieldOption (Business Object)`	Verwaltet Ausahllisten für Auswahlfelder.
`FieldOption (List)`	Referenzliste von Ausahlwerten.

Laufzeit-Regeln (Instanz)

Regel	Zweck
`TemplateInstance (Business Object)`	Verwaltet die Einreichungsausführung eines Benutzers.
`TemplateInstance (Default) Status`	Setzt den Status einer neuen Instanz auf „In Bearbeitung".
`TemplateInstance (Navigation)`	Ordnet aktive Abschnitte und Formulare im Arbeitsbereich.
`TemplateInstance (Reject Submission)`	Unterstützt die Ablehnungsseite und erfasst den Ablehnungsgrund.
`TemplateInstance (Subquery) Navigation Steps`	Aggregiert Navigationsindizes für die Fortschrittsverfolgung.
`TemplateInstance (Subquery) Navigation Union`	Vereinigt Abschnitts- und Formularnavigation in einer Liste.
`TemplateInstance (Update) Status Completed`	Setzt den Instanzstatus auf „Abgeschlossen".
`TemplateInstance (Update) Status In Progress`	Setzt den Instanzstatus auf „In Bearbeitung" zurück.
`TemplateInstance (Update) Status Under Review`	Eskaliert den Instanzstatus auf „Zur Überprüfung".
`FormInstance (Business Object)`	Verfolgt einen Formularschritt innerhalb einer Ausführung.
`FormInstance (Insert) Forms`	Klont Live-Formularinstanzen aus der Vorlage.
`FormInstance (Subquery) Form Navigation`	Ordnet Formulare für die Navigationsliste.
`FormInstance (Update) Status Change On Reject`	Bei Ablehnung wird „Eingereicht" auf „In Bearbeitung" und „Übersprungen" auf „Nicht gestartet" gesetzt.
`FormInstance (Update) Status Change On Submit`	Bei Einreichung wird „In Bearbeitung" auf „Eingereicht" und „Nicht gestartet" auf „Übersprungen" gesetzt.
`FormInstance (Update) Status In Progress`	Markiert ein Formular als „In Bearbeitung" bei der ersten Bearbeitung.
`SectionInstance (Business Object)`	Verfolgt einen Abschnitt innerhalb einer Ausführung.
`SectionInstance (Insert) Section`	Klont Live-Abschnittinstanzen aus der Vorlage.
`SectionInstance (Subquery) Section Navigation`	Erstellt die Abschnittsebene der Navigationsliste.
`SectionInstance (Update) Status Change On Reject`	Bei Ablehnung werden Abschnittszustände zurückgesetzt.
`SectionInstance (Update) Status Change On Submit`	Bei Einreichung werden Abschnittszustände vorangebracht.
`SectionInstance (Update) Status In Progress`	Markiert einen Abschnitt als „In Bearbeitung", wenn dieser geöffnet wird.
`FieldResponse (Responses)`	Erfasst Benutzerantworten auf der Einreichungsseite und wendet Anzeigelogik und erforderliche Logik an.
`FieldResponse (Insert) Fields`	Klont Antwortsätze aus den Feldern der Vorlage.
`FieldResponse (Validation) Required Response`	Prüft erforderliche Felder vor dem Wechsel zum nächsten Formular oder Abschnitt.
`FieldResponse (Validation) Template Required Response`	Prüft alle erforderlichen Felder vor der endgültigen Einreichung.

Sichtbarkeitregeln

Regel	Zweck
`FormVisibility (Business Object)`	Verwaltet Regeln, die ganze Formulare anzeigen oder ausblenden.
`FormVisibility (Subquery) Count By Template`	Gibt die Anzahl der Formular-Sichtbarkeitregeln pro Vorlage zurück.
`FieldVisibility (Business Object)`	Verwaltet Regeln, die einzelne Felder anzeigen oder ausblenden.
`FieldVisibility (Subquery) Count By Template`	Gibt die Anzahl der Feld-Sichtbarkeitregeln pro Vorlage zurück.
`FieldResponse (Visibility)`	Markiert ein Feld basierend auf den Benutzerantworten als erforderlich oder verfügbar.
`FieldResponse (Subquery) Field Visibility Action`	Löst den Sichtbarkeitszustand auf Feldebene auf.
`FieldResponse (Subquery) Form Visibility Action`	Löst den Sichtbarkeitszustand auf Formularebene auf.

Nachschlage- und Einstellungsregeln

Regel	Zweck
`FieldType (Business Object)` / `FieldType (List)`	Verwalten unterstützte Feldtypen.
`TemplateStatus (Business Object)` / `TemplateStatus (List)`	Verwalten Lebenszyklusstatus von Einreichungen.
`SectionStatus (Business Object)` / `SectionStatus (List)`	Verwalten Abschnittszustände.
`SectionStatus (List) Form and Section Statuses`	Kombinierte Liste von Formular- und Abschnittszuständen.
`SectionStatus (Subquery) Navigation Statuses`	Vereinigt Abschnitts- und Formularstatus für das Navigationsfenster.
`FormStatus (Business Object)` / `FormStatus (List)`	Verwalten Formularstatus.
`FormStatus (Subquery) Form and Section Status Union`	Konsolidiert Formular- und Abschnittsstatus für die Indizierung.
`FormStatus (Subquery) Navigation Statuses`	Vereinigt Formular- und Abschnittsstatus für das Navigationsfenster.
`Operator (Business Object)` / `Operator (List)`	Verwalten Vergleichsoperatoren für Sichtbarkeitregeln.
`VisibilityAction (Business Object)` / `VisibilityAction (List)`	Verwalten Sichtbarkeitsergebnisse (`Hidden`, `Visible`).
`Parameter (Business Object)`	Bietet Laufzeitzugriff auf globale Einstellungen.
`Parameter (Application Settings)`	Unterstützt die Einstellungsseite, auf der Administratoren globale Parameter bearbeiten.

Benachrichtigungsregeln

Regel	Zweck
`Email (Submission Under Review)`	Sendet die Benachrichtigung, wenn eine Einreichung eingereicht wird.
`Email (Submission Approved)`	Sendet die Benachrichtigung, wenn eine Einreichung genehmigt wird.
`Email (Submission Requires Revision)`	Sendet die Benachrichtigung, wenn eine Einreichung abgelehnt wird.
`WorkflowTemplate (Business Object)`	Verwaltet die Definitionen für Nachrichtenbetreff und -text.
`WorkflowTemplate (List)`	Ausahlliste von Benachrichtigungsvorlagen.

Sichtbarkeitsregeln konfigurieren

Sichtbarkeitsregeln (in den Tabellen FormVisibility und FieldVisibility) steuern, was ein Benutzer basierend auf seinen Antworten sieht. Jede Regel wird durch die folgenden Eigenschaften definiert:

Quellformularfeld: Das Feld, dessen Wert überwacht wird.
Feldoption: Eine bestimmte Auswahl in einem Auswahlfeld (eine Schaltfläche oder Dropdown-Option).
Operator: Der Vergleich, der zur Auswertung der Eingabe verwendet wird.
Vergleichswert: Der Wert, der mit der Live-Eingabe verglichen wird.
Sichtbarkeitsaktion: Das Ergebnis, das angewendet wird, wenn die Regel erfüllt ist, entweder Ausgeblendet oder Sichtbar.
Abhängiges Formular oder Feld: Das Ziel, dessen Anzeige und Anforderung durch die Regel geändert werden.

Beim Konfigurieren einer Regel werden zwei Verhaltensweisen erzwungen:

Direkte Auswahl und Ausdruck schließen sich gegenseitig aus. Man kann entweder eine bestimmte Feldoption oder einen Operator mit Vergleichswert auswerten, aber nicht beides. Wenn man eine Feldoption auswählt, werden der Operator und der Vergleichswert gelöscht und gesperrt.
Ein ausgeblendetes Feld kann nicht erforderlich sein. Wenn die Sichtbarkeitsaktion Ausgeblendet ist, wird die erforderliche Einstellung deaktiviert, deaktiviert und gesperrt. Ein Feld kann nur bedingt erforderlich gemacht werden, wenn seine Aktion Sichtbar ist.