¶ E-Mail Archivierung mit docuvita DMS
Das docuvita DMS stellt alle technischen Hilfsmittel zur Verfügung, um eine revisionssichere E-Mail Archivierung im Unternehmen einführen zu können. Um eingehende Nachrichten vor Manipulation zu schützen, werden sie bereits archiviert, bevor sie den Nutzer erreichen. Zudem steuert ein Berechtigungssystem den Zugriff auf die Daten und eine Zugriffsprotokollierung ermöglicht die Kontrolle der Datennutzung. Durch die Archivierung im docuvita DMS kann vor allem gewährleistet werden, dass E-Mails in ihrem betrieblichen Zusammenhang mit anderen Dokumenten an einem Ort zur Verfügung stehen.
Die Ablage in individuellen bzw. branchenspezifischen Aktenstrukturen und das schnelle Wiederauffinden von Dokumenten aus unterschiedlichen Quellen (Brief, Fax, E-Mail, etc.) erleichtert die Informationsgewinnung entscheidend. Archivierte E-Mails lassen sich ebenfalls in automatisierte Wiedervorlagen und Workflows einbetten. Damit stehen sämtliche Informationen bei der digitalen Bearbeitung dokumentenbasierter Geschäftsprozesse zur Verfügung.
¶ Systemvoraussetzungen
- Windows Server ab 2012 64-bit, alternativ Windows 10/11 64-bit
- docuvita Version 20.1.xx bis 22.1.xx
- .NET-Framework ab Version 4.8
- Eine Internetverbindung für die Aktivierung und die regelmäßige Validierung der Lizenz
- Postfach mit IMAP Zugriff ODER
- AMTANGEE CRM ODER
- Exchange Server mit EWS Funktionalität ab der Version 2012
- Offices 365 App Regisitrierung
- docuvita Zugriffslizenz
Docuvita Zugriffslizenz
Der EMailArchiver kann sich nur anmelden wenn mindestens eine freie Lizenz verfügbar ist.
Wenn alle Lizenzen belegt sind können E-Mails nicht archiviert werden bis eine Sitzung geschlossen wird.
¶ Installation
Um die E-Mail Archivierung verwenden zu können, sind folgende Schritte notwendig:
¶ Installationskomponenten
| Komponente | Erforderlich | Beschreibung |
|---|---|---|
| dvs.EmailArchiver | Ja | Der dvs.EMailArchiver ist ein eigenständiger Windows Dienst, der dafür zuständig ist E-Mails von Ihrem Postfach herunterzuladen und diese dann ordnungsgemäß in Ihrem docuvita zu archivieren. |
| dvs.EMailArchiver.Maintainer | Optional | Mit dem Maintainer können die AutoProfiler xml-Dateien erstellt werden. Ebenfalls ist es möglich die Zugriffsrechte (ACL) auf den archivierten E-Mails in docuvita zu löschen bzw. diese neu und individuell zu setzen. |
| dvs.EMailArchiver.Maintainer.Configurator | Optional | Mithilfe dieser graphischen Oberfläche können Sie mühelos eine Konfigurationsdatei für den dvs.Maintainer erstellen. |
| dvs.EMailArchiver.Monitoring | Optional | Monitoring ist ein eigenständiger Windowsdienst, der überprüfen kann, ob neue E-Mails im docuvita vorhanden sind. Bei Bedarf können mit diesem Dienst auch Benachrichtigungsmails versendet werden. |
| dvs.EMailArchiver.UpdateConfiguration | Optional | Mit diesem Programm können Sie eine bereits vorhandene Konfiguration des EMailArchiver aus der Version 1.0.x auf die aktuelle Version 19.x konvertieren. |
| fd.Password.Encrypt | Optional | Mit diesem Programm können Sie Ihre Passwörter verschlüsseln und diese dann in der Konfigurationsdatei speichern. |
Komponente
Nach erfolgreicher Installation sind die einzelnen Komponenten in dem Installationsverzeichnis zu finden. Bei der Installation können Sie auswählen, welche Komponenten mitinstalliert werden sollen.
¶ Installation des EMailArchiver
Dieses Kapitel enthält Informationen, die für eine erfolgreiche Installation des EMailArchiver durchzuführen sind.
Aministrator Rechte
Für die Installation des EMailArchiver sind Administratorrechte erforderlich.
Führen Sie die Datei fd.EMailArchiver xx.xx.xx.msi aus.
Zum Download...
Im nachfolgenden Schritt erscheint ein Fenster. Klicken Sie auf Weiter um mit der Installation zu beginnen.
Lesen Sie sich die Lizenzvereinbarung durch und bestätigen Sie diese.
Lizenzvertrag
Der Lizenzvertrag ist nach der Installation im help-Ordner zu finden.
Im nächsten Schritt werden Sie nach dem Lizenzschlüssel gefragt.
Lizenzdatei
Nach erfolgreicher Installation muss die Lizenzdatei noch direkt in das Installationsverzeichnis abgelegt werden.
Im nächsten Schritt haben Sie die Möglichkeit den Ablageort für die Log-Dateien anzupassen.
Im darauf folgenden Fenster können Sie den Installationsordner sowie die zu installierenden Komponenten auswählen.
Anschließend kann die Installation gestartet werden, in dem Sie auf Installieren klicken.
Nach einer erfolgreichen Installation erscheint abschließend folgendes Fenster.
¶ docuvita Einstellungen
In diesem Kapitel finden Sie alle notwendigen Einstellungen, die Sie in Ihrem docuvita vornehmen müssen.
¶ Archiv Ordner anlegen (optional)*
Für die Archivierung der E-Mails in docuvita empfehlen wir einen separaten Ordner in dem alle E-Mails abgelegt werden. Den Ordnernamen können Sie frei definieren (z.B. E-Mail Archiv).
Objekt ID
Notieren Sie die Objekt ID von diesem Ordner. Diese wird im späteren Verlauf für die Konfiguration noch benötigt.
Eigenständiger Objekttyp für E-Mail Ordner
Sie können selbstverständlich auch einen eigenständigen Objekttyp für den E-Mail Ordner definieren. Damit lassen sich Benutzerberechtigungen präziser einstellen.
¶ Objekttyp E-Mail erstellen *
Es empfiehlt sich für die E-Mail Archivierung einen neuen Objekttyp Mail bzw. E-Mail vom Typ Document anzulegen. Dieser Objekttyp muss bei Konfiguration der Ablagehierarchie mindestens den Objekttyp Ordner zugewiesen werden.
Achtung
Wird die Konfiguration der Ablagehierarchie nicht gesetzt, so können die E-Mails nur im Root-Verzeichnis abgelegt werden. Dies muss dann aber auch in der Konfiguration entsprechend angepasst werden.
Objekttype ID
Notieren Sie die Objekttype ID des erstellten Objekttypes. Diese wird im späteren Verlauf der Konfiguration noch benötigt.
¶ docuvita Benutzer anlegen *
Die komplette Kommunikation des EMailArchiver mit docuvita erfolgt über die docuvita API. Aus diesem Grund muss ein docuvita-Benutzer mit ausreichenden Berechtigungen im System vorhanden sein. Sie können den Benutzer Administrator für die E-Mail Archivierung verwenden. Wir empfehlen aber einen eigenständigen Benutzer zu verwenden. Eine Anleitung zum Anlegen eines neuen Benutzers finden Sie hier.
Vorteile eines eigenständigen Benutzers sind:
- Bei der Verlaufs-Protokollierung können Sie zwischen Zugriffen des EMailArchiver und des Administratorbenutzers unterscheiden.
- Sie können den Zugriff des Archivierungsbenutzers auf Benutzer, Gruppen, E-Mails und (E-Mail) Ordner beschränken.
Folgende Berechtigungen benötigt der Benutzer:
- Anlegen von (E-Mail) Ordnern
- Lesezugriff bei Benutzer und Benutzergruppen (wird verwendet für das Auslesen der benutzerbezogenen E-Mail Adressen)
- Freigabe beim Objekttyp E-Mail
- Mitglied in der Benutzergruppe Systemadministratoren (Überprüfung des Lizenzstatus)
Benutzer Anmeldung
API Authentifizierung für den EMailArchiver wird nicht unterstützt.
¶ E-Mail Adressen einem docuvita-Benutzer zuordnen *
¶ Manuelle Zuordnung
Für die Vergabe der Zugriffsrechte auf archivierte E-Mails müssen zunächst in docuvita beim Benutzer die für ihn gültigen E-Mail-Adressen in einem Eigenschaftenfeld hinterlegt werden. Normalerweise wird hierfür das Feld "E-Mail-Adresse" in den Benutzereigenschaften verwendet. Falls der Benutzer über mehrere E-Mail-Adressen verfügt, können diese als kommagetrennte Liste eingegeben werden. Sollten die E-Mail-Adressen mit einem ActiveDirectory synchronisiert werden (z.B. bei Einsatz des Moduls ActiveDirectorySync) enthalten diese Adressen u.U. das Prefix "smtp:" oder "SMTP:". Adressen in dieser Form sind ebenfalls gültig.
Hinweis bei mehreren E-Mail Adressen
Falls Sie mehrere E-Mail-Adressen verwenden, ist es anzuraten, ein zusätzliches Individualfeld für diese Liste zu verwenden und zusätzlich die primäre E-Mail Adresse im Feld E-Mail-Adresse zu hinterlegen. Hintergrund ist, dass beispielsweise docuvita Workflows das Feld E-Mail Adresse für den Versand von Mails an den Benutzer verwenden.
Hinweis zu Verteilergruppen
Falls der Benutzer auch E-Mails über eine Verteilerliste bekommt, so können Sie die E-Mail-Adresse dieser Liste auch in den Benutzer-E-Mail-Adressen hinterlegen, anstatt eigene Verteilergruppen in docuvita einzurichten. Der Benutzer erhält automatisch Zugriff auf alle E-Mails, die an eine seiner zum Archivierungszeitpunkt zugewiesenen E-Mail-Adressen gesendet wurden.
¶ ActiveDirectory Integration
Bei der Verwendung von ActiveDirectory können die E-Mail-Adressen direkt per LDAP Abfrage des AD-Servers gelesen werden. Diese so ermittelten Adressen werden dann auch für die Vergabe der Zugriffsrechte auf die archivierten E-Mails verwendet. Wird eine E-Mail archiviert und gibt es dazu keinen passenden Benutzer in docuvita, so kann dieser auch automatisch angelegt werden. Folgende Einstellungen werden für den docuvita Benutzer hinterlegt:
- Standardmäßig wird die primäre SMTP-Adresse als Benutzername verwendet. In der Konfigurationsdatei des EMailArchiver können weitere Konfigurationen zur Namens- und Passwortvergabe hinterlegt werden.
- Die primäre SMTP-Adresse des ActiveDirectory-Benutzers wird in das Feld E-Mail-Adresse eingetragen.
- Die Anlage des Benutzers erfolgt in der docuvita-Gruppe UserParentObjectId der jeweiligen Postbox-Konfiguration.
Bei der Verwendung der ActiveDirectory Integration müssen die E-Mail-Adressen nicht mehr im docuvita Benutzerstamm gepflegt werden. Es können hier aber zusätzliche E-Mail-Adressen eingetragen werden.
¶ Konfiguration
Im folgenden Abschnitt werden wir Ihnen zeigen, wie der EMailArchiver zu konfigurieren ist. Die Konfigurationsdatei befindet sich im Installationsodner im Unterordner Config. Sie verfügt über mehrere Sektionen, die hier der Reihenfolge nach beschrieben werden. Die hier beschriebene Konfiguration hat die Version 22.09.02.
Standardinstallationsordner
Der Standardinstallationsordner lautet C:\Program Files (x86)\docuvita\fd.EMailArchiver\
Änderung der Konfiguration
Nach einer Änderung der Konfigurationsdatei ist ein Neustart des Dienstes fd.EMailArchiver zwingend notwendig.
¶ docuvita
Klicken Sie hier, um die docuvita-Konfiguration zu sehen
"Docuvita": [
{
"FieldName": "DvServerAddress",
"FieldTyp": "S",
"FieldValue": "https://localhost/server/services",
"FieldDesription": "URL of the docuvita server"
},
{
"FieldName": "DvUseSingleSignOn",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "Use the docuvita ConfigPropertyegrated windows login instead of username/password for API-user"
},
{
"FieldName": "MailObjectType",
"FieldTyp": "N",
"FieldValue": 5,
"FieldDesription": "Objecttype for emails in docuvita"
},
{
"FieldName": "FolderObjectType",
"FieldTyp": "N",
"FieldValue": 6,
"FieldDesription": "Objecttype for mail folders in docuvita"
},
{
"FieldName": "UserObjectType",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "Objecttype for users in docuvita"
},
{
"FieldName": "AuthenticationConfigurationId",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "Id of the authentication modul"
},
{
"FieldName": "GroupObjectType",
"FieldTyp": "N",
"FieldValue": 2,
"FieldDesription": "Objecttype for groups in docuvita"
},
{
"FieldName": "UserSmtpAddressesField",
"FieldTyp": "S",
"FieldValue": "user_mailaddress",
"FieldDesription": "Name of the docuvita user field which contains the smtp addresses of the user. Default is \"User.Obj.Mailaddress\"."
},
{
"FieldName": "GroupSmtpAddressesField",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Name of the docuvita group field which contains the smtp addresses of the user."
},
{
"FieldName": "AutoCreateUsers",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "Create AD users in docuvita (OperationMode=0 only): The docuvita system of the first postbox will be used!!"
},
{
"FieldName": "UserNameMode",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "Wie soll der Benutzername in docuvita gebildet werden: 0 = ActiveDirectory Name (z.B. mydomain\\user1); 1 = Primäre SMTP-Adresse (damit können auch AD-Mails archiviert werden, wenn docuvita nicht in Domain) (default)"
},
{
"FieldName": "SearchMailMessageId",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "If true, then no search for the mailmessageid in docuvita is performed. Use loctype global and locvalue mailmessageid, mailsenddate "
},
{
"FieldName": "NewUserGeneratePassword",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": " If set docuvita will generate a random password for new users. If not the system's standard password will be used."
},
{
"FieldName": "NewUserPasswordStrength",
"FieldTyp": "N",
"FieldValue": 8,
"FieldDesription": "Length of generated passwords for new users"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| DvServerAddress | String | URL des docuvita-Servers |
| DvUseSingleSignOn | Boolean | Wenn true, wird die Windows-Anmeldung verwendet. Der Dienstebenutzer wird für die Anmeldung bei docuvita verwendet. |
| MailObjectType | Numeric | Objekttyp-Id der E-Mail in docuvita |
| FolderObjectType | Numeric | Objekttyp-Id des Ordners in docuvita |
| UserObjectType | Numeric | Objekttyp-Id des Benutzers in docuvita |
| AuthenticationConfigurationId | Numeric | Art der Benutzeranmeldung bzw. der zu verwendende Anmeldeprovider (Wird über die ID angegeben) |
| GroupObjectType | Numeric | Objekttyp-Id der Benutzergruppe in docuvita |
| UserSmtpAddressesField | String | Technischer Feldname des docuvita-Benutzerfeldes, das die zu archivierenden E-Mail-Adressen beinhaltet (kommagetrennte Liste). |
| GroupSmtpAddressesField | String | Technischer Feldname des docuvita-Gruppenfeldes, das die zu archivierenden E-Mail-Adressen beinhaltet. z.B. Verteilergruppen. |
| AutoCreateUsers | Boolean | Wenn true, dann werden ActiveDiretory-Benutzer in docuvita angelegt (bedingt OperationMode=0 ) sobald eine E-Mail archiviert wird. |
| UserNameMode | Numeric | Wie soll der Benutzername in docuvita gebildet werden:
|
| SearchMailMessageId | Boolean | Wenn true, wird nach der MailMessageId gesucht und ggf. die E-Mail kein weiteres mal archiviert. |
| NewUserGeneratePassword | Boolean | Wenn true, wird ein zufälliges Passwort für neu erstellte Benutzer automatisch generiert. |
| NewUserPasswordStrength | Numeric | Die Länge des automatisch generierten Passworts für neue Benutzer. |
Verwendung von Single Sign On
Bei der Verwendung von SSO muss in docuvita ein entsprechender Anmeldeprovider hinterlegt sein.
¶ ActiveDirectory
Klicken Sie hier, um die ActiveDirectory-Konfiguration zu sehen
"ActiveDirectory": [
{
"FieldName": "ActiveDirectoryServer",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": " Name of the Active Directory Domain. If set this domain will be used. If not all AD functions will be disabled."
},
{
"FieldName": "ActiveDirectoryUser",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Username for the active directory server"
},
{
"FieldName": "ActiveDirectoryPassword",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Password for the active directory server"
},
{
"FieldName": "UseNTLMAuth",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": " Use NTLM athentication for the AD-Server instead of username and password"
},
{
"FieldName": "IsDominoServer",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "If you use a dominoserver for ldap set this option true"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| ActiveDirectoryServer | String | Name oder IP-Adresse des ActiveDirectory-Servers. |
| ActiveDirectoryUser | String | Benutzername, mit dem die Authentifizierung beim AD-Server stattfindet. |
| ActiveDirectoryPassword | String | Passwort des angegebenen AD-Benutzers |
| UseNTLMAuth | Boolean | Wenn true, wird die NTLM-Authentifikation für den AD-Server statt Benutzername und Passwort verwendet. Es wird der Dienstebenutzer verwendet. |
| IsDominoServer | Boolean | Wenn true, dann handelt es sich um einen Domino-Server und nicht um einen ActiveDirectory-Server. (Beta-Status) |
¶ SMTP
Klicken Sie hier, um die SMTP-Konfiguration zu sehen
"Smtp": [
{
"FieldName": "SmtpHost",
"FieldTyp": "S",
"FieldValue": "localhost",
"FieldDesription": " Hostname or IP address of the SMTP server for sending mails"
},
{
"FieldName": "SmtpPassword",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "SMTP Passwort for sending mails"
},
{
"FieldName": "SmtpUser",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "SMTP username - or what do you think?"
},
{
"FieldName": "SmtpPort",
"FieldTyp": "N",
"FieldValue": 465,
"FieldDesription": "SMTP server port (eg. 465 for SSL SMTP)"
},
{
"FieldName": "SmtpSecure",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Use SMTP with SSL"
},
{
"FieldName": "AcceptAllCertificates",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Accept all SSl-certificates"
},
{
"FieldName": "MailNewUserNotification",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "Sent notification with username and password to newly created users? User has to change his password on first logon to docuvita"
},
{
"FieldName": "MailNewUserToAddress",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "If set a notification with username and password is sent to this mail address when a new user has been created."
},
{
"FieldName": "MailNewUserFromAddress",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "the mail address which should be used as sender address"
},
{
"FieldName": "LogImap",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "If true all IMAP activity will be logged to [workingDir]\\ImapLog\\imap.log"
},
{
"FieldName": "UserNotificationSubject",
"FieldTyp": "S",
"FieldValue": "Für Sie wurde ein docuvita-Benutzer angelegt",
"FieldDesription": "Subject text for admin notification mails. Placeholders can be used: @@Username@@, @@Password@@, @@docuvitaURL@@"
},
{
"FieldName": "UserNotificationBodyText",
"FieldTyp": "S",
"FieldValue": "Sehr geehrter doucvita Anwender,\r\n\r\n soeben wurde für Sie ein neuer docuvita - Benutzer angelegt.\r\n Hier sind Ihre Zugangsdaten:\r\n Benutzername: @@USERNAME@@\r\n Passwort: @@Password@@\r\n\r\n Hier können Sie sich direkt anmelden: @@docuvitaURL@@\r\n Bei der ersten Anmeldung müssen Sie Ihr Passwort ändern.\r\n\r\n Mit freundlichen Grüßen\r\n Ihr docuvita Team\r\n support@docuvita - online.de",
"FieldDesription": "Body text for admin notification mails. Placeholders can be used: @@Username@@, @@Password@@, @@docuvitaURL@@"
},
{
"FieldName": "AdminNotificationSubject",
"FieldTyp": "S",
"FieldValue": "docuvita-Benutzer @@USERNAME@@ wurde automatisch angelegt",
"FieldDesription": "Subject text for admin notification mails. Placeholders can be used: @@Username@@, @@Password@@, @@docuvitaURL@@"
},
{
"FieldName": "AdminNotificationBodyText",
"FieldTyp": "S",
"FieldValue": "Folgender docuvita-Benutzer wurde soeben neu angelegt: @@USERNAME@@",
"FieldDesription": "Body text for admin notification mails. Placeholders can be used: @@Username@@, @@Password@@, @@docuvitaURL@@"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| SmtpHost | String | Host oder IP-Adresse des SMTP-Server |
| SmtpPassword | String | SMTP-Passwort |
| SmtpUser | String | SMTP-Benutzer |
| SmtpPort | Numeric | SMTP-Port |
| SmtpSecure | Boolean | Wenn true, wird SSL beim Senden verwendet. |
| AcceptAllCertificates | Boolean | Akzeptiert alle SSL-Zertifikate (auch ungültige). |
| MailNewUserNotification | Boolean | Wenn true, wird eine Benachrichtigungs E-Mail, bei der Erstellung eines neuen Benutzer, an die Benutzer E-Mail-Adresse gesendet. |
| MailNewUserToAdress | String | Zusätzlich kann auch bei der Erstellung eines neuen Benutzers eine Benachrichtigung (Admin) an diese Adresse gesendet werden. |
| MailNewUserFromAdress | String | Absender-E-Mail-Adresse für die Benachrichtigungen |
| LogImap | Boolean | Wenn true, werden alle Imap-Aktivitäten mitprotokolliert. Das Log finden Sie im Work Ordner unter IMAPLOG. |
| UserNotificationSubject | String | E-Mail Betreff der Benutzerenachrichtigungs-E-Mail. Folgende Platzhalter können verwendet werden:
|
| UserNotificationBodyText | String | Nachricht der Benutzerbenachrichtigungs-E-Mail. Folgende Platzhalter können verwendet werden:
|
| AdminNotificationSubject | String | Subjekt der Benutzerbenachrichtigungs-E-Mail. Folgende Platzhalter können verwendet werden:
|
| AdminNotificationBodyText | String | Nachricht der Adminbenachrichtigungs-E-Mail. Folgende Platzhalter können verwendet werden:
|
¶ Settings
Klicken Sie hier, um die Settings-Konfiguration zu sehen
"Settings": [
{
"FieldName": "WorkingDir",
"FieldTyp": "S",
"FieldValue": "c:\\docuvita\\EMailArchiver\\Work",
"FieldDesription": " working directory for fetching mails"
},
{
"FieldName": "OperationMode",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "Operation mode of the archiver: 0 = Active Directory, 1 = docuvita"
},
{
"FieldName": "RunIntervall",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "Time between two batchrun in minutes"
},
{
"FieldName": "MaxBatches",
"FieldTyp": "N",
"FieldValue": 99999,
"FieldDesription": "Maximum batches of fetching mails: EMailArchiver will stop fetching and start archiving afterwards. After last batch EMailArchiver must be started again to fetch remaining mails"
},
{
"FieldName": "NumMessages",
"FieldTyp": "N",
"FieldValue": 250,
"FieldDesription": "Number of messages fetched per batch / Default: 250"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| WorkingDir | String | Arbeitsverzeichnis, in dem die E-Mails temporär zwischengespeichert werden. In diesem Ordner werden auch die Blacklist E-Mail Adressen gespeichert. |
| OperationMode | Numeric | Bertriebsmodus des EMailArchiver
|
| RunIntervall | Numeric | Zeit zwischen zwei Archivierungsläufen. Angabe in Minuten. |
| MaxBatches | Numeric | Maximale Anzahl der Verarbeitungsdurchgänge pro Archivierungslauf. |
| NumMessages | Numeric | Maximale Anzahl der Nachrichten, die pro Verarbeitungsdurchgang verarbeitet werden. |
¶ Monitoring
Klicken Sie hier, um die Monitoring-Konfiguration zu sehen
"Monitoring": [
{
"FieldName": "StartTime",
"FieldTyp": "S",
"FieldValue": "23:00",
"FieldDesription": "At this time monitoring wil be startet"
},
{
"FieldName": "ToAddress",
"FieldTyp": "S",
"FieldValue": "admin@yourcompany.de",
"FieldDesription": "Notification mails will be send to this address"
},
{
"FieldName": "UseDocuvitaSmtp",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "If true SMTP settings from docuvita is used. Otherwise use archiver SMTP settings"
},
{
"FieldName": "SendAlwaysNotification",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "If true,monitoring will send always a notification mail"
},
{
"FieldName": "HeaderError",
"FieldTyp": "S",
"FieldValue": "Warnung dvs.EMailArchvier",
"FieldDesription": "Subject text for notifivation mail at no archived mails in last 24hours."
},
{
"FieldName": "HeaderOk",
"FieldTyp": "S",
"FieldValue": "Report dvs.EMailArchiver",
"FieldDesription": "Subject text for notifivation mail if mails archived in last 24hours."
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| StartTime | String | Zu dieser Uhrzeit erfolgt die Überprüfung ob E-Mails in den letzten 24 Stunden archiviert worden sind. |
| ToAdress | String | E-Mail-Adresse des Empfängers der Benachrichtigungsemail. Bei mehreren E-Mails werden diese kommagetrennte Liste angegeben. |
| UseDocuvitaSmtp | Boolean | Wenn true: Werden die docuvita-SMTP Einstellungen verwendet. Wenn false: Die SMTP-Einstellungen aus der SMTP-Sektion in der Konfigurationsdatei werden verwendet. |
| SendAlwaysNotification | Boolean | Wenn true, sendet der Dienst nach jeder Überprüfung eine Benachrichtigungsmail. |
| HeaderError | String | Betreff der Benachrichtigungsmail wenn bei der Überprüfung keine neuen E-Mails gefunden wurden. |
| HeaderOk | String | Betreff der Benachrichtigungsmail, wenn bei der Überprüfung neuen E-Mails gefunden wurden. |
¶ Postboxes
Postboxes sind die letzte Sektion in der Konfigurationsdatei, die wiederum aus drei Sektionen besteht:
¶ IMAP
Klicken Sie hier, um die IMAP-Konfiguration zu sehen
"Imap": [
{
"FieldName": "ImapServer",
"FieldTyp": "S",
"FieldValue": "localhost",
"FieldDesription": "Hostname or IP address of the IMAP-Server"
},
{
"FieldName": "SecureOption",
"FieldTyp": "S",
"FieldValue": "Auto",
"FieldDesription": "SecureSocketOptions.None \r\n SecureSocketOptions.Auto: Allow the MailKit.IMailService to decide which SSL or TLS options to use (default).\r\n SecureSocketOptions.SslOnConnect: The connection should use SSL or TLS encryption immediately.\r\n SecureSocketOptions.StartTls: Elevates the connection to use TLS encryption immediately after reading the\r\n greeting and capabilities of the server. If the server does not support the\r\n STARTTLS extension, then the connection will fail and a System.NotSupportedException\r\n will be thrown.\r\n SecureSocketOptions.StartTlsWhenAvailable: Elevates the connection to use TLS encryption immediately after reading the\r\n greeting and capabilities of the server, but only if the server supports\r\n the STARTTLS extension."
},
{
"FieldName": "ImapPort",
"FieldTyp": "N",
"FieldValue": 993,
"FieldDesription": "Port of the IMAP-server (eg. 993 for SSL)"
},
{
"FieldName": "ImapUserName",
"FieldTyp": "S",
"FieldValue": "user@somedomain.com",
"FieldDesription": "Username for the imap account of the postbox"
},
{
"FieldName": "ImapPassword",
"FieldTyp": "S",
"FieldValue": "SomePassword",
"FieldDesription": "Guess - this is the password for the imap account!"
},
{
"FieldName": "AcceptAllCertificates",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Accept all SSL-certificates"
},
{
"FieldName": "DeleteMessages",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Delete messages from the imap server"
},
{
"FieldName": "ImapFolder",
"FieldTyp": "S",
"FieldValue": "INBOX",
"FieldDesription": "You can use a different folder for retrieving mails. Default is \"INBOX\" if not IncludeSubfolders"
},
{
"FieldName": "IncludeSubfolders",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Recurse all subfolders of ImapFolder"
},
{
"FieldName": "ExcludeFolders",
"FieldTyp": "S",
"FieldValue": "TRASH,JUNK,DRAFS,SPAM",
"FieldDesription": "Exlude content of folders with these names"
},
{
"FieldName": "UnreadMailsOnly",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Archive only mails marked as unread. Useful for testing with DeleteMessages=false"
},
{
"FieldName": "SharedMailBox",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "If office 365 shared mailbox is used, set to true"
},
{
"FieldName": "WhitelistDomain",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Filter for possible email domains which should be archived (e.g. @fakturdigital.de). Leave empty for all mails."
},
{
"FieldName": "UntilDate",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Mails with received date until this date will be selected. !! Effect only with NotArchivedFlag == true !! "
},
{
"FieldName": "FromDate",
"FieldTyp": "S",
"FieldValue": "",
"FieldDesription": "Mails with received date from this date will be selected. !! Effect only with NotArchivedFlag == true !! "
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| ImapServer | String | Hostname oder IP-Adresse des IMAP Servers |
| SecureOption | String | Ermöglicht dem MailKit die Entscheidung zu treffen, welche SSL oder TSL Einstellungen zu verwenden sind. |
| ImapPort | Numeric | Port des IMAP-Servers |
| ImapUsername | String | Benutzername des IMAP-Kontos |
| ImapPassword | String | Passwort des IMAP-Kontos |
| AcceptAllCetificates | Boolean | Alle SSL-Zertifikate akzeptieren (auch ungültige). |
| DeleteMessage | Boolean | Wenn true, wird die Nachricht nach dem erfolgreichen Download vom IMAP-Server gelöscht. |
| ImapFolder | String | IMAP Ordner: Standardmäßig heißt der Ordner Posteingang INBOX, ein anderer Ordner kann ebenfalls ausgewählt werden. Folgende Systemordner existieren: ARCHIVEROOT, CONVERSATIONHISTORY, DELETEDITEMS, DRAFTS, INBOX, JUNKEMAIL, OUTBOX, SENTITEMS Es können auch individuell angelegte Ordner, die parallel zu den Systemordnern liegen, mit ihrem Anzeigenamen eingetragen werden (z.B. Individueller Ordner). |
| IncludeSubfolders | Boolean | Wenn true dann werden auch die Unterverzeichnisse des IMAP-Ordners berücksichtigt. |
| ExcludeFolders | String | Die auszuschließenden Ordner: Angabe als kommagetrennte Liste. |
| UnreadMailsOnly | Boolean | Wenn true, werden nur die als ungelesen markierten E-Mails heruntergeladen. Die E-Mails werden nach dem erfolgreichen Download als gelesen markiert. |
| SharedMailBox | Boolean | Wenn true, dann wird ein freigegebenes Postfach von Office365 verwendet. |
| WhitelistDomain | String | Filter für E-Mail-Adressen die archiviert werden sollen. Wenn leer dann werden alle E-Mails archiviert. (z.B. @fakturdigital -> Es werden nur E-Mails archiviert, die von oder an die Maildomäne @fakturdigital gesendet wurden) |
| UntilDate | String | EMails, deren Empfangsdatum vor oder am angegebenen Datum liegt, werden archiviert. Wenn leer dann werden alle E-Mails archiviert. (Eingabeformat: yyyy-dd-MM) |
| FromDate | String | EMails, deren Empfangsdatum nach oder am angegebenen Datum liegt, werden archiviert. Wenn leer dann werden alle E-Mails archiviert. (Eingabeformat: yyyy-dd-MM) |
DeleteMessage
Wenn dieser Wert auf true gesetzt ist werden E-Mails vom Postfach gelöscht nachdem sie heruntergeladen wurden.
Schlägt die Archivierung in docuvita fehl sind die E-Mails nur noch lokal im work Verzeichnis gespeichert.
¶ docuvita
Klicken Sie hier, um die docuvita-Konfigurationen
"Docuvita": [
{
"FieldName": "DvApiUsername",
"FieldTyp": "S",
"FieldValue": "EMailArchiver",
"FieldDesription": "Username of the docuvita API user to be used for archiving"
},
{
"FieldName": "DvApiPassword",
"FieldTyp": "S",
"FieldValue": "geheim",
"FieldDesription": "Password for the API user"
},
{
"FieldName": "AuthenticationConfigurationId",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "ID of the Authentication module responsible for newly created Users"
},
{
"FieldName": "ArchiveParentObjectId",
"FieldTyp": "N",
"FieldValue": 6,
"FieldDesription": "ObjectId of the parent object under which mails will be archived. -1 is used to archive mails hidden"
},
{
"FieldName": "UseDateFolders",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Use folder structure Year/Month/Day for archiving"
},
{
"FieldName": "MoveExistingMails",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "Move already archived mails to the target folder. This can be helpful if you want to rearrange your mail archive by archiving old mails once again with the EmailArchiver (MailMessageId must be set to do so!)"
},
{
"FieldName": "DvSystemId",
"FieldTyp": "N",
"FieldValue": 1,
"FieldDesription": "ID if the docuvita system"
},
{
"FieldName": "DvSystemAlias",
"FieldTyp": "S",
"FieldValue": "default",
"FieldDesription": "System alias of the docuvita system"
},
{
"FieldName": "UserParentObjectId",
"FieldTyp": "N",
"FieldValue": 0,
"FieldDesription": "ID of the parent object for new users."
},
{
"FieldName": "AccessRight",
"FieldTyp": "N",
"FieldValue": 15,
"FieldDesription": "With this option, you can set the users access rights for archived mail. Default:15 Standard access right configurations: Approve = 65535, FullAccess = 63999, FullWithOutDelete = 63871, Read = 63503, ReadWithLimits = 15"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| DvApiUsername | String | Benutzername des docuvita-Benutzers, der für die Archivierung verwendet wird. (Das Feld: Benutzerlogin Erlaubt muss auf Ja gesetzt sein damit der EMailArchiver sich anmelden kann.) |
| DvApiPassword | String | Passwort des docuvita-Benutzers, der für die Archivierung verwendet wird. (Der Benutzer muss sich mindestens ein mal anmelden, da bei der ersten Anmeldung dazu aufgefordert wird das von docuvita zugewiesene Passwort zu ändern.) |
| AuthenticationConfigurationId | Numeric | ID der Authentifizierungsmethode bzw. des zu verwendenden Anmeldeproviders, der in docuvita hinterlegt ist. (Authentifizierungsmethoden mit API-Schlüssel werden nicht unterstützt.) |
| ArchiveParentObjectId | Numeric | Objekt-Id des übergeordneten Objekts, in dem die E-Mails archiviert werden. (Objekttyp muss in der Ablagehierarchie des E-Mail-Objekts angehakt sein damit die E-Mails archiviert werden können.) |
| UseDateFolders | Boolean | Wenn true, wird folgende Struktur für die Archivierung verwendet: Jahr/Monat/Tag. |
| MoveExistingMails | Boolean | Ablegen bereits archivierter E-Mails in der von Ihnen gewünschten Ordnerstruktur. Sinnvoll für die Archivierung alter E-Mails mit dem EMailArchiver. |
| DvSystemId | Numeric | System ID Ihres docuvita-Systems |
| DvSystemAlias | String | Systemalias Ihres docuvita-Systems |
| UserParentObjectId | Numeric | ID der Benutzergruppe, in der neue docuvita Benutzer angelegt werden. |
| AccessRight | Numeric | Mit dieser Option können die Zugriffsrechte für die archivierten E-Mails vergeben werden. |
¶ Setting
Klicken Sie hier, um die Setting-Konfiguration zu sehen
"Settings": [
{
"FieldName": "IsActive",
"FieldTyp": "B",
"FieldValue": true,
"FieldDesription": "Fetch and archive this postbox"
},
{
"FieldName": "ArchiveMode",
"FieldTyp": "N",
"FieldValue": 0,
"FieldDesription": " 0 = As received, 1 = MS Exchange Journal (archive attached mail), 2 = Only attached mails (do not use envelope mail), 3 = Amtangee"
},
{
"FieldName": "BackupFiles",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "If true all messages and XML-files will be backed up in the working directory's subfolder 'backup'"
},
{
"FieldName": "CreateAutoprofilerXml",
"FieldTyp": "B",
"FieldValue": false,
"FieldDesription": "Create a XML file for autoprofiler (in subfolder autoprofiler of postbox's working directory)"
},
{
"FieldName": "BlacklistFolder",
"FieldTyp": "S",
"FieldValue": "Blacklist",
"FieldDesription": "Blacklisted mails will be moved to this folder.If empty, blacklisted mails will be deleted."
}
],
"BlacklistSender": [
{
"FieldName": "BlacklistSender",
"FieldTyp": "S",
"FieldValue": "healthmailbox*",
"FieldDesription": "All mails from exchange healthmailbox"
},
{
"FieldName": "BlacklistSender",
"FieldTyp": "S",
"FieldValue": "*@*.ru",
"FieldDesription": "All mails with russian domain"
}
],
"BlacklistSubject": [
{
"FieldName": "BlacklistSubject",
"FieldTyp": "S",
"FieldValue": "{\\wv[il1][a@]gr[a@]}\\w",
"FieldDesription": "All mails with subject viagra"
}
],
"BlacklistRecipient": [
{
"FieldName": "BlacklistRecipient",
"FieldTyp": "S",
"FieldValue": "blacklist.recipient@domain.gov",
"FieldDesription": "If a recipient contains this emailaddres, mail is blacklist"
}
]
| Feldname | Typ | Beschreibung |
|---|---|---|
| IsActive | Boolean | Wenn true, werden E-Mails aus dem Postfach geholt und archiviert. |
| ArchiveMode | Numeric | Archivierungsmodus :
|
| BackupFiles | Boolean | Wenn true, werden alle Nachrichten und XML-Dateien in dem Ordner backup gesichert. |
| CreateAutoprofilerXml | Boolean | Wenn true, werden XML-Dateien für den Autoprofiler erstellt. Die Ablage erfolgt im Work-Verzeichnis im Unterordner Autoprofiler. |
| BlacklistFolder | String | Die als Blacklistmails markierten/erkannten E-Mails werden in diesen Ordner verschoben. Wenn kein BlacklistFolder hinterlegt ist, wird die E-Mails direkt gelöscht. Die Angabe des Pfade erfolgt relativ zum Workverzeichnis. |
| BlacklistSender | String | Alle E-Mails, deren Absender dem angegebenen Muster entsprechen, werden in den Blacklist-Ordner verschoben. Es kann hier mit Wildcards und RegEx gearbeitet werden. |
| BlacklistSubject | String | Alle E-Mails, deren Betreff dem angegebenen Muster entsprechen, werden in den Blacklist-Ordner verschoben. Es kann hier mit Wildcards und RegEx gearbeitet werden. |
| BlacklistRecipient | String | Alle E-Mails, deren Empfänger dem angegebenen Muster entsprechen, werden in den Blacklist-Ordner verschoben. Es kann hier mit Wildcards und RegEx gearbeitet werden. |
Archivierungshinweis
E-Mails im Blacklist-Ordner werden nicht archiviert.
¶ Beispiel Konfiguration
Nachfolgend finden Sie Beispielkonfigurationen zur Verdeutlichung verschiedener Anwendungsfälle, die durch die Konfigurationsdatei abgedeckt werden.
¶ Einstellung der Authentifizierung in Office 365
¶ 1. Einrichtung einer App-Registrierung in Microsoft Azure AD
Im ersten Schritt muss eine App-Registrierung in Microsoft Azure-AD angelegt werden.
Hierzu auf folgende Website gehen: https://aad.portal.azure.com/
- Mit einem Administrator-Account anmelden
- In der Linken Leiste Alle Dienste auswählen
- Azure Active Directory auswählen
In der zweiten Leiste von links gibt es nun den Menüpunkt App-Registrierungen (relativ Mittig)
- App-Registrierungen anklicken
- + Neue Registrierung anklicken
- Name: docuvita (z.B.)
- Unterstützte Kontotypen: Nur Konten in diesem Organisationsverzeichnis (i.d.R.)
- Umleitungs-URI darf i.d.R. leer bleiben
- Registrieren anklicken#
Nun landet man in der App-Registrierung mit sofort zwei benötigte Eigenschaften für den
Autoprofiler und spätere Schritte:
- Anwendungs-ID (Client)
- Verzeichnis-ID (Mandant)
¶ 2. Einrichtung des geheimen Schlüssels
In dem aktuellen Fenster, muss nun unter Zertifikat und Geheimnisse eine
Clientanmeldeinformation hinzugefügt werden
- Mittleren Reiter Geheime Clientschlüssel auswählen
- + Neuer geheimer Clientschlüssel anklicken
- Beschreibung eingeben: docuvita Autoprofiler Server1 (z.B.)
- Gültig bis: 24 Monate (z.B.)
Nach der Anlage sieht man den geheimen Clientschlüssel. Dieser Wert sollte nun
weggesichert werden, da dieser NUR UNMITTELBAR NACH ANLAGE sichtbar ist. Bei
Verlust muss ein neuer Clientschlüssel angelegt werden!
¶ 3. Vergabe der API-Berechtigungen
Damit die Anwendung nun auch auf ein oder mehrere Postfächer zugreifen kann, müssen unter
API-Berechtigungen entsprechende Berechtigungen gesetzt werden.
Wichtig: Diese gelten erstmal für alle E-Mail Postfächer und sollten später eingeschränkt werden!!
- Klick auf API-Berechtigung in der zweiten Linken Leiste innerhalb meiner App-Registrierung (z.B. docuvita)
- + Berechtigung hinzufügen anklicken
- Microsoft Graph auswählen
- Anwendungsberechtigungen auswählen
- Mail.ReadWrite auswählen (i.d.R.)
- Berechtigungen hinzufügen klicken
Nun ist die Berechtigung erstmal da, aber noch nicht erteilt.
- Auf Administraorzustimmung für „<Firma>“ erteilen klicken
- Dialog mit Ja bestätigen
So sollte es aussehen:
¶ 4. Anpassungen dvs.EMailArchiver.config
Um die neue Authtenifizierungzu nutzen müssen noch folgende Anpassungen in der Konfigurationsdatei vorgenommen werden.
| Konfigurationswert | Region | Beschreibung |
|---|---|---|
| AzureApplicationClientId | Postbox | Anwendungs-ID (Client) aus Kapitel 1 |
| AzureClientSecret | Postbox | Wert aus Kaptiel 2 |
| AzureTenantId | Postbox | Verzeichnis-ID (Mandant) aus Kapitel1 |
| ImapUserName | Postbox | MailAdresse des Postfaches. |
¶ 5. Einrichtung Autoprofiler
¶ Changelog und Download
Version 22.9 oder höher
Um die Version 22.9. oder höher zu verwenden wird mindestens die docuvita Version 22.1 benötigt.
| Version | Anmerkungen |
|---|---|
| 24.5.3 | Bugfix: Unterverzeichnisse in Office365-Postfächern werden korrekt verarbeitet Bugfix: Individuelle Ordner mit Unterverzeichnissen in Office365-Postfächern werden korrekt verarbeitet |
| 24.4.16 | Verarbeitung des Archived-Flags in Office365-Postfächern analog zu IMAP-Postfächern Verarbeitung des Empfangsdatum-Bereiches in Office365-Postfächern analog zu IMAP-Postfächern |
| 24.4.13 | Bugfix: Es wird nicht nur das letzte konfigurierte Office365-Postfach verarbeitet, wenn mehrere Postfächer aus unterschiedlichen Tenants konfiguriert sind |
| 24.4.8 | Downgrade auf log4net 2.0.12 wegen Abgängigkeiten zu internen dlls |
| 24.4.4 | Update WixToolset auf Version 4.0.5 Bugfix: Korrektur des Dienstnamens |
| 24.2.1 | Update WixToolset auf Version 4.0.3 Bugfix: Korrektur im Template für die Konfigurationseigenschaft AzureApplicationClientId |
| 23.2.0 | Verbesserung des Fehlerhandlings beim "defekten" Mail Headers |
| 22.9.34 | Umstellung OAuth2.0 für Offices 365 |
| 21.10.5 | Bugfix bei der Monitoring Benachrichtigung |
| 21.10.4 | Erweiterung um die Funktion WhitelistDomain |
| 20.9.0 | Anpassen der Konfiguration an den neuen Lizenzserver. |
| 20.5.0 | Mailmetadaten werden beim Import nicht mehr beschrieben. Dies erfolgt durch den docuvita.Documentservices |
| 20.3.1 | Unterschiedliche Ablagestrukturen beim selben Postfach sind jetzt möglich. |
| 20.1.6 | * Update DevExpress auf Version 19.2.5 * Bugfix: Bei einer fehlerhafte XML Datei bzw. EML Header wird diese Datei übersprungen |
| 19.6.3 | * Beim Erstellen neuer E-Mails werden die Standardwerte mit beschrieben. * Update dvs.tools auf Version 18.8.34 * Update dvs.tools.docuvita auf 19.1.0 |