Service 'mailstorage'

Gültig für: enaio® Version 9.10

Der EMS service 'mailstorage' ist Bestandteil der E-Mail-Verwaltung und hat folgende Funktionen:

  • Standortinformationen
  • Jede E-Mail benötigt ein Indexdatenfeld mit Informationen für die Standortbestimmung. Der Service 'mailstorage' trägt diese Informationen beim Anlegen von E-Mails in ein Standardfeld oder in ein konfiguriertes Indexdatenfeld ein. E-Mails ohne diese Informationen können vom Service 'mailstorage' nachträglich um diese Informationen ergänzt werden.

  • Indexierung
  • E-Mails können beim Anlegen automatisch indexiert werden. Der Microservice 'extraction' extrahiert Daten aus E-Mails, der Microservice 'mailstorage' ordnet diese Daten Standardfeldern oder konfigurierten Indexdatenfeldern zu.

  • Workflow-Anbindung
  • Über enaio® Outlook-Add-In NG können Workflows mit der Übergabe von Daten und der E-Mail gestartet werden. Dazu werden den Eingangsparametern des Workflows extrahiert Daten aus E-Mails zugeordnet.

  • Deduplizierung
  • Falls E-Mails bereits angelegt wurden, können bei einer erneuten Anlage über enaio® Outlook Add-In NG stattdessen Verweisdokumente oder weiter Standorte angelegt werden.

  • Anlagen abschmelzen
  • Falls Benutzer E-Mail-Anlagen über enaio® Outlook Add-In NG als Dokument in enaio® anlegen, dann kann administrativ vorgegeben werden, dass die E-Mail-Anlage in Outlook durch eine enaio®-Verweisdatei ersetzt wird.

  • E-Mails aus Outlook löschen
  • E-Mails können nach der Anlage von E-Mails optional diese in Outlook in den Ordner für gelöschte Objekte verschieben. Diese Funktion kann administrativ vorgegeben werden.

Die Konfigurationen erfolgen über die Konfigurationsdatei ems-prod.yml aus dem Verzeichnis \services\service-manager\config\.

Eine Konfigurationsdatei als Vorlage stellen wir zum Download zur Verfügung.

Standortinformationen

Jeder Dokumenttyp, über den E-Mails und E-Mail-Elemente verwaltet werden, benötigt ein Indexdatenfeld für Standortinformationen. enaio® editor legt ab der Version 9.0 ein entsprechendes Feld beim Erstellen von E-Mail-Dokumenttypen automatisch mit an: Textfeld, 100 Zeichen, interner Name: MAIL_DIGEST. Für modulübergreifenden Dokumenttypen und E-Mail-Dokumenttypen aus vorhergehenden Versionen muss ein entsprechendes Feld erstellt werden, damit E-Mails über diese Dokumenttypen angelegt werden können.

E-Mail-Dokumenttypen, die ein Feld mit dem internen Namen 'MAIL_DIGEST' haben, benötigen keine Konfiguration des Services 'mailstorage'. Für E-Mail-Dokumenttypen ohne ein Feld mit dem internen Namen 'MAIL_DIGEST' und für modulübergreifenden Dokumenttypen muss das Feld für die Standortinformationen in der Konfiguration des Services 'mailstorage' angegeben werden.

Konfiguration des Indexdatenfelds für die Standortinformation

Der Service 'mailstorage' wird über die Konfigurationsdatei ems-prod.yml aus dem Verzeichnis \services\service-manager\config\ konfiguriert.

Die Konfiguration eines Indexdatenfelds für die Standortinformation hat folgende Struktur:

mapping  
emsTypes:  
- name: "E-Mail"

Konfigurationsabschnitt für den Dokumenttyp

internalName: "EMAILTYP" Interner Name des Dokumenttyps
deduplicationContext:  
internalName: "INDEX_DIGEST" Interner Name des Indexdatenfelds für die Standortinformation
mappingFields: Abschnitt mit Angaben für die automatische Indexierung von Feldern
- name: "Mail" Konfigurationsabschnitt für einen weiteren Dokumenttyp

Konfiguration der nachträglichen Standort-Indexierung

Der Service 'mailstorage' überprüft nach Standardeinstellungen regelmäßig, ob E-Mail ohne Standortinformation vorliegen und trägt die Standortinformationen nach. Geprüft werden alle E-Mail-Dokumenttypen und alle modulübergreifenden Dokumenttypen, für die eine Konfiguration des Indexdatenfelds für die Standortinformation vorliegt.

Standardeinstellung: Jeden Tag zwischen 23 Uhr und 3 Uhr werden in Läufen von 1.000 Objekten die Standortinformationen für alle E-Mail-Dokumenttypen ohne Wert nachgetragen. Bei einem Fehler wird der Wert NO_MAIL_DIGEST in das Feld für die Standortbestimmung eingetragen.

Die Standardeinstellung kann über die Konfigurationsdatei ems-prod.yml aus dem Verzeichnis \services\service-manager\config\ geändert werden:

config:  
healthCheck:"*/5 * * * * *"

Zeitpunkt, zu dem der Status geprüft wird im Cron-Format

cronZone:"Europe/Berlin" Zeitzone, auf die die Zeitangaben bezogen sind
autoUpdate:  
activated: true false: Funktion ist deaktiviert
maxItems: 1000 maximale Anzahl der E-Mails, die bei einem Durchlauf verarbeitet werden
cron:"0+*/1+23,0,1,2+?+*+*+*"

Zeitraum, in dem die Funktion durchgeführt wird im Cron-Format

updateTargetValue:""

Wenn ein Wert angegeben wird, dann wird die Funktion nur für E-Mails durchgeführt, die im Indexdatenfeld für die Standortinformation diesen Wert enthalten. Werte können mit Platzhaltern angegeben werden.

includeAutoMapped:true

true: Alle E-Mail-Dokumenttypen werden geprüft

false: Nur konfigurierte Dokumenttypen werden geprüft

errorHash:"NO_MAIL_DIGEST" Wert, der bei Fehlern in das Indexdatenfeld für die Standortinformation eingetragen wird

Indexierung

E-Mails mit folgenden internen Namen der Standardfelder werden beim Anlegen automatisch mit Daten aus dem Service 'extraction' indexiert:

Interner Name

Name

Extraction-Name

MAIL_FROM

Von:

OS:MailFrom

MAIL_TO

An:

OS:MailTo

MAIL_CC

Cc:

OS:MailCc

MAIL_SUBJECT

Betreff:

OS:Subject

MAIL_SUBMIT_TIME

Datum:

OS:MailDate

MAIL_BODY

Nachricht:

OS:MailBody

Standard-Zuordnungen gelten nur für E-Mail-Dokumenttypen ohne Konfiguration.

E-Mail-Objekttypen, für die die Standard-Zuordnungen gültig sind, können so eingesehen werden:

http://<Service mailstorage-IP>/maintenance/report > application > runtime > mappedTypes

Sie können die Extraktion von E-Mail-Elementen testen:

  1. Administrationsseite der Microservices per URL http://<service-manager-admin-IP>:<port> öffnen.

    Standard-Port: 7273

  2. Auf EXTRACTION > Details klicken.
  3. Auf den Link zur Swagger-UI in der oberen Zeile klicken.
  4. Aus der Liste in der Kopfzeile extraction-api auswählen.
  5. Auf Expand Operations klicken.
  6. Nach unten zum Bereich POST /extraction/api/xmp scrollen und im Abschnitt Parameters auf Durchsuchen klicken.
  7. E-Mail-Element aus Dateisystem wählen.
  8. Mit einem Klick auf Try it out! Extraktion starten.

Die Daten werden unmittelbar extrahiert und das Ergebnis angezeigt.

Konfiguration der Indexierung

Eine Konfiguration ist in folgenden Fällen notwendig:

  • Wenn modulübergreifende Dokumenttypen für die E-Mail-Verwaltung zur Verfügung gestellt werden.
  • Wenn Felder andere interne Namen haben und Sie diese nicht in enaio® editor anpassen wollen.
  • Wenn beim Anlegen einer E-Mail Felder der Indexdatenmaske schreibgeschützt werden sollen.
  • Beim Anlegen mehrerer E-Mails in einer Aktion über enaio® client wird die Indexdatenmaske nur einmal geöffnet. Einträge in Extraktionsfelder sind geschützt, Einträge in anderen Feldern werden für alle E-Mails übernommen.

  • Wenn Daten aus dem Service 'extraction' nicht übernommen werden sollen.
  • Wenn Fest- oder Default-Werte in Felder eingetragen werden sollen.

Die Konfiguration erfolgt über die Konfigurationsdatei ems-prod.yml aus dem Verzeichnis \services\service-manager\config\.

Prüfen Sie, ob die Konfiguration über die Konfigurationsdatei servicewatcher-sw.yml eingebunden ist: Der Parameter profiles benötigt den Wert eml.

name: mailstorageservice

type: microservice

profiles: prod,cloud,blue,eml

Konfigurationsbeispiele

Konfigurationen müssen das Indexdatenfeld für Standortinformationen und alle Zuordnungen angegeben.

Funktion Beispiel

Modulübergreifender Dokumentyp:

Interner Name 'mtyp'

Haupttyp 6: E-Mails werden beim Öffnen nicht ausgecheckt

Indexdatenfeld für die Standortinformation 'MAIL_DIGEST'

 

mapping:
    emsTypes:
    - name: "M-Typ"
    internalName: "mtyp"
    mainType: 6
    deduplicationContext:
       internalName: "MAIL_DIGEST"
    mappingFields:
    ...

Zuordnung: Extraction-Name - Interner Name

Die extrahierten Daten 'OS:MailFrom' werden dem Feld 'FROM' zugeordnet.

mapping:
    ...
    mappingFields:
    - internalName: "FROM"
      extractionName: "OS:MailFrom"

Indexdatenblatt öffnen

Das Datenblatt des Dokumentyps 'etyp' wird beim Anlegen eines Objekts als Standard geöffnet.

Extrahierte Daten sind voreingetragen und können vom Benutzer überschrieben werden.

 

Extrahierte Daten können geschützt werden:

mappingFields:
    - internalName: "MAIL_FROM"
    extractionName: "OS:MailFrom"
    overrideIndexdata: true

Änderungen durch den Benutzer im Feld 'MAIL_FROM' werden so nicht übernommen.

mapping:
    emsTypes:
    - name: "E-Typ"
    internalName: "etyp"
    showIndexdata: true
    deduplicationContext:
        internalName: "MAIL_DIGEST"
    mappingFields:
    ...

Fest-Werte

Festwerte können jedem Feld des Dokumenttyps zugeordnet werden.

mapping:
    ...
    mappingFields:
    - internalName: "MAIL_CC"
      fixedValue: "CC hidden"

Default-Werte

Default-Werte werden nur eingetragen, wenn zugeordnete Daten der Extraktion nicht vorliegen.

mapping:
    ...
    mappingFields:
    - internalName: "MAIL_SUBJECT"
      extractionName: "OS:Subject"
      defaultValue: "No Subject"

Standard-Zuordnungen

Standard-Zuordnungen gelten nur für E-Mail-Dokumenttypen ohne Konfiguration.

Für konfigurierte Dokumenttypen müssen alle gewünschten Zuordnungen angegeben werden.

mapping:
    ...
    mappingFields:
    - internalName: "MAIL_FROM"
      extractionName: "OS:MailFrom"
    - internalName: "MAIL_TO"
      extractionName: "OS:MailTo"
    - internalName: "MAIL_CC"
      extractionName: "OS:MailCc"
    - internalName: "MAIL_SUBJECT"
      extractionName: "OS:Subject"
    - internalName: "MAIL_BODY"
      extractionName: "OS:MailBody"
    - internalName: "MAIL_SUBMIT_TIME"
      extractionName: "OS:MailDate"

Workflow-Anbindung

Über die Konfigurationsdatei ems-prod.yml aus dem Verzeichnis \services\service-manager\config\ wird die Workflow-Anbindung für enaio® Outlook-Add-In NG konfiguriert.

Die Konfiguration einer Workflow-Anbindung hat folgende Struktur:

mapping  
emsTyps:  
.....  
workflows:  
- name: "wfname"

Konfigurationsabschnitt für das Workflowmodell.

familyId: "GUID"

Angabe der GUID der Workflowfamilie.

Die GUID ist im Eigenschaftsdialog der Workflowfamilie in enaio® editor-for-workflow angegeben.

fileTaget: INFO

Angabe für die Akte:

INFO: Die E-Mail wird in die Akte gelegt.

NONE: Die E-Mail wird nicht in die Akte übernommen.

inputVariables: Liste von Eingangsparametern des Workflows, denen Daten zugeordnet werden
-name: "parameter1" Bezeichnung des Eingangsparameters
 extractionName:  "OS:Subject" Bezeichnung der zuzuordnenden Daten des Services 'extraction'.
-name: "parameter2" Bezeichnung eines weiteren Eingangsparameters
 extractionName: "OS:MailFrom" Bezeichnung der zuzuordnenden Daten des Services 'extraction'
-name: "parameter3" Bezeichnung eines weiteren Eingangsparameters.
 extractionName: "OS:MailCc" Bezeichnung der zuzuordnenden Daten des Services 'extraction'
 defaultValue: "noCc" Zuordnung eines Default-Werts, der nur eingetragen, wenn zugeordnete Daten der Extraktion nicht vorliegen.
-name: "parameter4" Bezeichnung eines weiteren Eingangsparameters.
 fixedValue: "fix" Zuordnung eines Festwerts statt eines Extraktions-Werts.

Mindestens ein Parameter muss angegeben werden, Parameter müssen in enaio® editor-for-workflow als Eingangsparameter oder Ein-/Ausgangsparameter angelegt sein.

Kontextbezogene Standortvorschläge

Das enaio® Outlook-Add-In NG schlägt dem Benutzer automatisch kontextbezogen Standorte vor. Diese Funktion kann im Projekt spezifisch angepasst oder systemweit über die Konfigurationsdatei ems-prod.yml deaktiviert werden. Wenn die Funktion aktiviert ist, dann kann der Benutzer über die Add-In-Optionen von enaio® Outlook-Add-In NG diese Funktion deaktivieren.

Systemweites Deaktivieren der Standortvorschläge:

suggestion:
    activated: false
mapping:
    emsTypes:
    ...

Nach Änderungen an der Konfigurationsdatei ems-prod.yml muss der Service 'mailstorage' über enaio® services-admin neu gestartet werden.

Deduplizierung

Bei der E-Mail-Anlage über enaio® Outlook Add-In NG kann geprüft werden, ob eine E-Mail, die ein Benutzer anlegen will, bereits angelegt wurde. Ist das der Fall, dann kann dem Benutzer angeboten werden, stattdessen ein Verweisdokument anzulegen bzw. einen weitereren Standort hinzuzufügen oder die E-Mail erneut anzulegen.

Die Konfiguration erfolgt dokumenttypspezifisch über die Konfigurationsdatei ems-prod.yml.

Die Konfiguration der Deduplizierung für die E-Mail-Anlage in der ems-prod.yml wird von enaio® client sowie von enaio® Outlook Add-In NG in Verbindung mit enaio® client nicht ausgewertet. In beiden Fällen wird ausschließlich die Konfiguration über die Datei \etc\as.cfg des Datenverzeichnisses verwendet

Struktur der ems-prod.yml:

mapping  
emsTypes:  
- name: "E-Mail"

Konfigurationsabschnitt für den Dokumenttyp

internalName: "EMAILTYP" Interner Name des Dokumenttyps
deduplicationContext:  
internalName: "INDEX_DIGEST" Interner Name des Indexdatenfelds für die Standortinformation
mode: GLOBAL

Modi:

  • NONE: Es wird nicht geprüft (Standard)
  • TYPE: Geprüft wird, ob die E-Mail bereits mit dem gewählten Objekttyp angelegt wurde.
  • GLOBAL: Geprüft wird, ob die E-Mail bereits mit einem beliebigen Objekttyp angelegt wurde.

Hierbei prüft der EMS service 'mailstorage' alle E-Mails mit ihm bekannten Objekttypen: Diejenigen, die explizit in der Datei ems-prod.yml konfiguriert sind sowie die Objekttypen, die durch das Standard-Mappingmit dem Feld 'INDEX_DIGEST' bekannt sind.

handling: LINK

Vorgehen:

  • LINK: Ein Verweisdokument wird angelegt.
  • COPY: Ein weiterer Standort wird angelegt.

Eine Kombination von mode: GLOBAL und handling: COPY führt zu Fehlern, wenn ein weiterer Standort in einem anderen Schrank angelegt werden soll. Benutzer erhalten in diesem Fall einen entsprechenden Hinweis.

mappingFields: Abschnitt mit Angaben für die automatische Indexierung von Feldern
- name: "Mail" Konfigurationsabschnitt für einen weiteren Dokumenttyp

Anlagen abschmelzen

Benutzer können über enaio® Outlook Add-In NG E-Mail-Anlagen als Dokument in enaio® anlegen. Über die Add-In-Optionen kann der Benutzer einstellen, dass zugleich die E-Mail-Anlage in Outlook durch eine enaio®-Verweisdatei ersetzt wird.

Administrativ kann das Ersetzen der E-Mail-Anlage durch eine enaio®-Verweisdatei nach dem Anlegen in enaio® vorgegeben werden. Der Benutzer kann dann diese Option nicht deaktivieren. Die Konfiguration gilt für alle Dokumenttypen.

config  
 administrativeTemplates:  
  forceReplaceAttachments: true false: Keine Vorgabe (Standard)

E-Mails nach der Anlage aus Outlook löschen

Benutzer können über enaio® Outlook Add-In NG E-Mails optional nach der Anlage in enaio® aus Outlook löschen. Die E-Mails werden in den Ordner für gelöschte Objekte verschoben. Administrativ kann dieses Verhalten vorgegeben werden. Der Benutzer kann dann diese Option nicht deaktivieren. Die Konfiguration gilt für alle Dokumenttypen.

config  
 administrativeTemplates:  
  forceDeleteMailAfterStore: true false: Keine Vorgabe (Standard)

Eigenschaft 'zur Archivierung freigegeben'

Als Standard werden E-Mails mit der Eigenschaft 'zur Archivierung nicht freigegeben' angelegt.

Mit folgenden Eintrag ändern Sie diese Einstellung für einen Objekttyp:

- name: "E-Mail"
  internalName: "email01"
  insertOptions: "ARCHIVABLE=1"

Für 'insertOptions' sind alle Optionen des Jobs DMS.XMLInsert möglich. Wenn eine Option angegeben wird, dann werden alle nicht angegebenen Optionen mit den Default-Werten verwendet.