Plugin-Dokumentation - IMAP-Plugin

Page / - zuletzt bearbeitet von MKO am 24.03.2020, 15:55

IMAP-Plugin

zuletzt bearbeitet von MKO

am 24.03.2020, 15:55

Inhaltsverzeichnis

Funktionalitäten

Installation

Konfiguration des Plugins

Konfiguration der Mail-Server

Konfiguration der Mail Nachrichten

Konfiguration der Synchronisation

Konfiguration des Caches

Konfiguration der E-Mail-Inhalte und Felder

Konfiguration des E-Mail-Programms

Beispielskonfiguration für Thunderbird

Versionshistorie

Plugin-Download (erfordert Anmeldung)

Inhalt [ Verbergen ]

Funktionalitäten

Installation

Konfiguration des Plugins

Konfiguration der Mail-Server

Konfiguration der Mail Nachrichten

Konfiguration der Synchronisation

Konfiguration des Caches

Konfiguration der E-Mail-Inhalte und Felder

Konfiguration des E-Mail-Programms

Beispielskonfiguration für Thunderbird

Versionshistorie

Mit dem kostenpflichtigen Imap-Plugin für Xima® Formcycle besteht die Möglichkeit, Daten von Formular-Eingängen innerhalb eines E-Mail-Programms anzuzeigen, diese zu verwalten und sich sofort über neue Eingänge informieren zu lassen. Hierfür stellt dieses Plugin einen Imap- und Smtp-Server zur Verfügung, welcher in jedem gängigen E-Mail-Programm angebunden werden kann.

Funktionalitäten

Sofortige Benachrichtigung

Über die Imap-Schnittstelle wird der Bneutzer sofort über neue oder geänderte Formulareingänge informiert.

Konfigurierbarer Inhalt

Über entsprechende Vorlagen ist der Inhalt der Benachrichtigungen sowie deren Betreff-, Absender- und Empfänger-Felder frei konfigurierbar. Da hier Platzhalter benutzt werden können, können neben einzelnen Werten oder Metadaten des Formulareingangs auch Links zur Wiederanzeige direkt innerhalb des Postfachs erzeugt werden.

Bereitstellung von Dateien

Im Formular können Dateien hochgeladen werden und während der Statusverarbeitung werden ebenfalls manchmal Dateien erzeugt. Diese Dateien werden automatisch der versendeten Nachricht angehangen. Somit stehen diese Dateien direkt im E-Mail-Programm zur Verfügung. Ab Version 2.1.0+ ist es alternativ auch möglich Limits festzulegen, ab welchem Dateien nur in einer angehangenen Textdatei aufgelistet werden sollen.

Abbildung der verfügbaren Postfachstruktur

Da für die Abbildung der Xima® Formcycle-Postfächer innerhalb des E-Mail-Programms entsprechende Ordner angelegt werden, hat der Benutzer auch hier nur Zugriff auf Formulareingänge, die er je nach Benutzergruppenkonfiguration haben darf. Zusätzlich wird der Ordner Posteingang als Sammelpostfach zur Darstellung aller ihm zugänglichen Formulareingänge benutzt.

Verwalten von Formulareingängen

Neben der eigentlichen Anzeige stehen auch Möglichkeiten zur Verwaltung von Formulareingängen zur Verfügung. So wird ein Formulareingang beim Verschieben eines Ordners in das entsprechende Xima® Formcycle-Postfach verschoben. Ferner wird der Gelesen-Status ebenso synchronisiert. Das Löschen von Formulareingängen ist bei entsprechender Berechtigung ebenso durch das Löschen der zugehörigen Nachricht oder durch das Verschieben in den Papierkorb möglich. Fehlt diese Berechtigung, taucht die Nachricht nach wenigen Sekunden wieder im E-Mail-Programm auf.

Der zur Verfügung gestellte Smtp-Server ist aktuell ohne Funktionalität, sodass abgesendete Nachrichten von diesem komplett verworfen werden.

Installation

Die Installation des Plugins ist über die dafür vorgesehene Verwaltungsoberfläche von Plugins durchzuführen. Hierbei muss lediglich die entsprechende Jar-Datei eingespielt werden. Ferner kann die erste Installation je nach Anzahl von Formulareingängen auf Grund einer kompletten Aufbereitung der Daten für den Imap-Server mehrere Minuten andauern.

Das Imap-Plugin trifft bei der Anmeldung und dem Ausliefern von Nachrichten keine Unterscheidung, in welchem Mandanten es installiert ist. Es steht somit immer allen Benutzern zur Verfügung steht. Daher ist es anzuraten, das Plugin als System-Plugin zu installieren. Dies umgeht auch mögliche Probleme mit doppelt belegten Ports und ermöglicht eine zentrale Konfiguration.

Konfiguration des Plugins

Die Konfigurationsoberfläche des Plugins. Hier werden Einstellungen zur Verbindung mit dem Mail-Server getroffen. Weiterhin wird festgelegt, wie die versendeten E-Mails aussehen sollen.

Nach der Installation des Plugins stehen die in der Abbildung dargestellten Konfigurationsparameter zur Verfügung. Folgende Einstellungsmöglichkeiten gibt es dabei:

Konfiguration der Mail-Server

smtp.binding.address

Standardwert: 0.0.0.0. Gibt die zu verwendende ip-Adresse des Smtp-Servers an. Der Standardwert ist 0.0.0.0 und verwendet damit eine automatisch ermittelte ip. Eine Änderung dieses Wertes ist nur nötig, falls mehrere Netzwerkadapter im Einsatz sind oder die automatische Ermittlung fehlschlägt.

smtp.binding.port

Standardwert: 25. Gibt den zu verwendenten Port des Smtp-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.

imap.binding.address

Standardwert: 0.0.0.0. Gibt die zu verwendende IP-Adresse des Imap-Servers an. Der Standardwert ist 0.0.0.0 und verwendet damit ebenfalls eine automatisch ermittelte ip. Eine Änderung dieses Wertes ist nur nötig, falls mehrere Netzwerkadapter im Einsatz sind oder die automatische Ermittlung fehlschlägt.

imap.binding.port

Standardwert: 143. Gibt den zu nutzenden Port des Imap-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.

imap.batch.size (ab 2.1.0+ )

Standardwert: 50. Gibt die Anzahl der gleichzeitig auszuliefernden Nachrichten an. Ein geringerer Wert reduziert die Speicherlast, verringert aber ebenso die Performance.

Konfiguration der Mail Nachrichten

mail.to.template

Standard: mail_to.txt. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Empfänger benutzt werden soll.

mail.from.template

Standard: mail_from.txt. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Absender benutzt werden soll.

mail.subject.template

Standard: mail_subject.txt. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Betreff benutzt werden soll.

mail.body.template

Standard: mail_body.txt. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Inhalt benutzt werden soll.

mail.attachment.limit (ab 2.1.0+ )

Standard: 10. Maximale Größe einer Datei (in MB), ab welcher dieser nicht angehangen, sondern in einer Textdatei aufgelistet werden soll (-1 = deaktiviert, 0 = listet alle Anhänge).

mail.attachment.sum.limit (ab 2.1.0+ )

Standard: -1. Maximale Summe aller Dateigrößen (in MB), ab welcher diese nicht angehangen, sondern in einer Textdatei aufgelistet werden sollen (-1 = deaktiviert, 0 = alle Anhänge immer auflisten).

Konfiguration der Synchronisation

sync.max.threads (ab 2.1.0+ )

Standard: 4. Anzahl der Threads mit welcher die Synchronisation von Nachrichten durchgeführt werden soll.

sync.page.size (ab 2.1.0+ )

Standard: 50. Anzahl der Nachrichten mit welcher ein Threads die Synchronsiation durchführen soll.

Konfiguration des Caches

cache.heap.size (ab 2.1.0+ )

Standard: 200. Größe des zu verwendeten Arbeitsspeichers in MB.

cache.disk.size (ab 2.1.0+ )

Standard: 500. Größe des zu verwendeten Festplatten-Speichers in MB.

cache.tti (ab 2.1.0+ )

Standard: 900. Maximales Alter eines Cache-Eintrags in Sekunden.

Konfiguration der E-Mail-Inhalte und Felder

Die Konfiguration der Inhalte und Felder der eigentlichen Nachricht benutzt einen Vorlagenmechanismus. Dieser basiert auf den vier Dateien, die unter Konfiguration der E-Mail-Nachricht eingestellt wurden. Diese werden bei der Installation des Plugins als Mandantdatei eingespielt und bei der Synchronisation der Nachrichten benutzt. Um eine formularspezifische Anzeige zu gewährleisten, ist es möglich, gleich benannte Dateien manuell als Formulardatei anzulegen und somit die Mandantdateien zu überlagern. In allen Dateien ist es möglich, Platzhalter zu verwenden, sodass hier abgesendete Formulardaten ausgegeben werden können. Ebenso ist es damit möglich, etwa einen Link zur Anzeige des ausgefüllten Formulars zu erzeugen.

Inhalt

Standardwert: mail_body.txt. Gibt den Inhalt der E-Mail-Nachricht an. Nur hier besteht die Möglichkeit, Html zu hinterlegen. Beispiel:

<html>
<head></head>
<body>
<p><a href="[%$FORM_INBOX_LINK%]">Link</a> zum Vorgang ([%$PROCESS_ID%]).</p>
</body>
</html>

Betreff

Standardwert: mail_subject.txt. Gibt den Betreff der Nachricht an. Beispiel:

ID: [%$RECORD_ID%] - [%$STATUS_NAME%]

Empfänger

Standardwert: mail_to.txt. Gibt den Empfänger der Nachricht an. Dieser ist nach dem Muster Name <user@example.com> anzugeben und hat keinerlei Auswirkungen auf den eigentlichen Empfang der Nachricht. Beispiel:

XIMA FORMCYCLE <no-reply@example.com>

Absender

Standardwert: mail_from.txt. Gibt den Absender der Nachricht an. Dieser ist nach dem Muster Name <user@example.com> anzugeben und hat keinerlei Auswirkungen auf das Absenden der Nachricht. Beispiel:

[%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com>

Konfiguration des E-Mail-Programms

Für die Konfiguration des E-Mail-Programms sind neben der Adresse des E-Mail-Servers die unter Konfiguration des E-Mail-Server-Services hinerlegten Ports zu verwenden. Die kompletten zu verwendenden Anmeldedaten setzen sich demnach wie folgt zusammen:

SMPT-Server

<Server-Adresse>

SMPT-Port

siehe Konfiguration Mail-Server Service

Imap-Server

<Server-Adresse>

Imap-Port

siehe Konfiguration Mail-Server Service

Benutzername

<FORMCYCLE-Benutzer>@<FORMCYCLE-Mandantname>

Passwort

<FORMCYCLE-Benutzer-Passwort>

Authentifizierung

Passwort, normal

SSL-Verschlüsselung und Verbindungssicherheit

keine

Beispielskonfiguration für Thunderbird

Die Verwaltung der E-Mail-Konten über Extras > Konto-Einstellungen öffnen.

Über Konto-Aktionen > E-Mail-Konto hinzufügen... den Dialog zum Konfigurieren eines neuen Kontos öffnen.

Initial versucht Thunderbird, anhand der eingetragenen E-Mail-Adresse (hier user@imap.de) einen Server automatisch zu ermitteln. Da dies hier nicht möglich ist, kann dies über die Schaltfläche Manuell bearbeiten abgebrochen werden.

In der darauf folgenden Oberfläche der Server-Konfiguration können nun die entsprechenden Daten eingetragen werden. Im Beispiel lautet der Mandantname imap.de und der Benutzername user und es werden die Standardports benutzt.

Nach Fertigstellung der Konfiguration erscheinen nun die Postfächer des Benutzers als Ordner (hier Zentrales Postfach und Demopostfach) und die darin enthaltenen Nachrichten der vorhandenen Formulareingänge.

Versionshistorie

Version 2.1.0

Umstellung auf die Xima® Formcycle Version 6.5.5

Aktualisierung der verwendeten Bibliotheken

Optimierungen des Speicherverbrauchs und der Datenbank-Queries

Einbau eines Caches für den Header und Body von Nachrichten

Fehlerbehebung beim Auslesen der IMAP BODYSTRUCTURE

Wiedereinbau der Konfiguration der Anhang-Limits

Erweiterung der Konfigurierbarkeit der IMAP Batch-Größe und der Synchronisation

Version 2.0.0

Anpassungen für die Kompatibilität mit Xima® Formcycle Version 6.0.2

Version 1.0.1

Optimierungen und Erweiterungen der Konfigurierbarkeit

Version 1.0.0

Initialer Release