Plugin-Dokumentation - Offline-Client-Plugin 

Page / - zuletzt bearbeitet von gru am 21.10.2020, 17:18 

Offline-Client-Plugin 
zuletzt bearbeitet von gru
am 21.10.2020, 17:18

Inhaltsverzeichnis
Offline Apps
Konfiguration
Verwendung der App
Globale Plugineinstellungen

Plugin-Download (erfordert Anmeldung)
Bitte verwenden Sie für Xima® Formcycle Version 6 das Plugin ab Version 2.0.0.
Bitte verwenden Sie für Xima® Formcycle Versionen ab 6.6.3 das Plugin in der Version 2.2.2 oder höher.
Inhalt [ Verbergen ] 
•	Offline Apps
•	Konfiguration
•	Verwendung der App
•	Globale Plugineinstellungen
Mit dem kostenpflichtigen Offline-Client-Plugin ist es möglich mithilfe einer iOS-, Android- oder Desktop-App Formulardaten offline zu erfassen und diese zu einem späteren Zeitpunkt mit einem FORMCYCLE-Server zu synchronisieren.
Hinweis: Da die Formulare offline ausgefüllt werden und somit nicht vorausgesetzt werden kann, dass eine aktive Verbindung zum Internet besteht, gibt es einige Einschränkungen:
•	Der Terminfinder ist nicht in der Offline-App verfügbar.
•	JavaScript, welches dynamisch auf Ressourcen aus dem Internet zugreift (etwa auf CSV-Datenquellen), wird nicht unterstützt.
Offline Apps

Die FORMCYCLE Desktop-App zum Erfassen von Formulardaten. Rot markiert zu sehen sind die Anzahl der abgeschlossenen und die Anzahl der gespeicherten Vorgängen. Beim nächsten Synchronisiationsvorgang werden die abgeschlossenen Vorgänge an den konfigurierten FORMCYCLE-Server gesedet. In der Mitte ist die Konfiguration der App zu sehen. Im Falle der Desktop-App muss der Mandant mit im Benutzernamen angegeben werden.
 
Die FORMCYCLE Desktop-App zum Erfassen von Formulardaten. Rot markiert zu sehen sind die Anzahl der abgeschlossenen und die Anzahl der gespeicherten Vorgängen. Beim nächsten Synchronisiationsvorgang werden die abgeschlossenen Vorgänge an den konfigurierten FORMCYCLE-Server gesedet. In der Mitte ist die Konfiguration der App zu sehen. Im Falle der Desktop-App muss der Mandant mit im Benutzernamen angegeben werden.
 
Die FORMCYCLE Desktop-App zum Erfassen von Formulardaten. Rot markiert zu sehen sind die Anzahl der abgeschlossenen und die Anzahl der gespeicherten Vorgängen. Beim nächsten Synchronisiationsvorgang werden die abgeschlossenen Vorgänge an den konfigurierten FORMCYCLE-Server gesedet. In der Mitte ist die Konfiguration der App zu sehen. Im Falle der Desktop-App muss der Mandant mit im Benutzernamen angegeben werden.
Es gibt drei verschiedene Apps die genutzt werden können, um Formulardaten offline zu erfassen:
•	FORMCYCLE iOS-App-
•	FORMCYCLE Android-App-
•	Desktop-App (in Entwicklung, derzeit nur als Beta-Version verfügbar)
Um diese Apps verwenden zu können ist es nötig das Offline-Client-Plugin in FORMCYCLE zu installieren. Dieses Plugin ermöglicht die Synchronisation der Formulare zwischen App und Server.
Konfiguration
Beim Start der FORMCYCLE Offline App muss die Verbindung zum FORMCYCLE-Server konfiguriert werden. Diese Einstellungen können jederzeit unter dem Menüpunkt Einstellungen geändert werden.
Benutzername
Name des FORMCYCLE-Benutzers der mit der App Formulardaten erfasst.
Bei der Desktop-App muss der Mandant wie folgt am Benutzernamen angegeben werden: benutzer@mandant
Passwort
Passwort des FORMCYCLE-Benutzers
Mandant (nur iOS- und Android-App)
Angabe des Mandant, in dem sich der Benutzer befindet. 
Bei der Desktop-App wird der Mandant im Benutzernamen angegeben: benutzer@mandant
URL
Angabe der URL unter welcher das FORMCYCLE-System zu erreichen ist. 
Bei direktem Zugriff auf einen Xima® Formcycle Master-Server muss diese URL mit der Basis-URL des Mandanten übereinstimmen. Beim Zufriff auf einen  Frontend-Server muss eine URL angegeben werden, unter der dieser erreichbar ist wie z.B. https://fs.beispiel.de/frontend-server 
Sprache (nur Desktop-App)
Sprache der Anwendung
Logfile Level (nur Desktop-App)
Bestimmt welche Nachrichten im Anwendungslog auftauchen
Verwendung der App
Nach der Konfiguration der FORMCYCLE Offline App werden die zur Verfügung stehennden Formulare in die App geladen. Diese Formulare tauchen dann auf der Übersichtsseite der App auf und stehen jederzeit offline zur Verfügung. Welche Formulare vom Server geladen werden, hängt von der Berechtigung des Benutzers und der konfigurierten Formulargruppe im Offline-Client-Plugin ab.
Synchronisieren
Nach Betätigen dieser Schaltfläche werden alle Formulare vom FORMCYCLE-Server geladen und alle abgeschlossenen Vorgänge aus der App an den FORMCYCLE-Server geschickt.
Mit einem Klick/Tap auf ein Formular in der Formularübersicht wird dieses geöffnet. Das Formular kann nun ausgefüllt werden. Ist das Formular ausgefüllt, kann es über die Schaltflächen Absenden oder Speichern abgeschlossen oder zwischengespeichert werden. Abgeschlossene Vorgänge werden nicht direkt an den FORMCYCLE-Server gesendet. Erst mit einem Klick/Tap auf die Schaltfläche Synchronisieren in der Formularübersicht werden diese Vorgänge an den Server verschickt. Gespeicherte Vorgänge werden auf dem Gerät gespeichert, auf dem die App installiert wurde. Diese Vorgänge werden nicht an den FORMCYCLE-Server gesendet.
Abgeschlossene und zwischengespeicherte Vorgänge werden links neben dem Formular aufgelistet oder können über das Menü in der rechten oberen Ecke angezeigt werden. Gespeicherte Vorgänge können, sofern sie noch nicht abgeschlossen und mit FORMCYCLE synchronisiert wurden, nachträglich geändert werden.
Formularschaltflächen für das Speichern oder Absenden des Formulars stehen in den Offline-Apps nicht zur Verfügung, da Formularvorgänge nicht direkt abgesendet werden können. Stattdessen müssen die Schaltflächen der Apps Absenden und Speichern verwendet werden.

Globale Plugineinstellungen
Das Plugin-Bundle muss als System-Plugin installiert werden. Nach der Installation kann das Offline-Client-Plugin durch folgenden Parameter konfiguriert werden.
group-name
Wenn nicht alle Formulare auf der Offline-App zur Verfügen stehen sollen, kann hier eine Formularegruppe angegeben werden. In der Offline-App erscheinen dann nur Formulare dieser Gruppe.