Administratorhandbuch IPA-RA-MICRO-Service

1. Zweck des Dokuments

Dieses Administratorhandbuch beschreibt die Installation, Inbetriebnahme, Konfiguration und den Betrieb des IPA-RA-MICRO-Service als Bestandteil der IPA-Suite Serverkomponenten.

Der IPA-RA-MICRO-Service überwacht konfigurierte RA-MICRO Prozessordner, verarbeitet eingehende Dokumente, liest Inhalte aus unterstützten Dateiformaten aus, übergibt die Daten an die konfigurierte KI-Auswertung und erzeugt anschließend die für RA-MICRO erforderlichen Dateien.

Das Handbuch richtet sich an Administratoren, IT-Dienstleister und technisch verantwortliche Personen, die den Dienst installieren, konfigurieren, überwachen oder Fehler analysieren.

Der IPA-RA-MICRO-Service steht ab der Version 9.4.x.x zur Verfügung.

2. Systemüberblick

Der IPA-RA-MICRO-Service ist ein Windows-Dienst innerhalb der IPA-Suite Serverkomponenten. Er arbeitet dateibasiert mit den RA-MICRO Prozessordnern zusammen.

Typischer Basisordner:

C:\ra\e-fach

Innerhalb dieses Basisordners befinden sich die RA-MICRO Prozessordner wie:

00
01
02
...
99

Jeder Prozessordner kann einem Verarbeitungstyp zugeordnet werden, zum Beispiel:

• Scan

• E-Mail / eMessage

• beA

Die Zuordnung erfolgt über die zentrale Prozessordner-Konfiguration.

3. Funktionsweise des Dienstes

Der Dienst überwacht die konfigurierten Prozessordner. Unterstützte Hauptdokumente sind insbesondere:

.pdf
.docx (eingeschränkt)
.eMessage

Je nach Dokumenttyp wird der Textinhalt ausgelesen. Bei eMessage-Dateien werden zusätzlich die enthaltenen Anhänge extrahiert und analysiert, sofern sie ein unterstütztes Analyseformat besitzen.

4.2 Installationsablauf

Schritt 1: IPA-Suite Serverkomponenten herunterladen

Laden Sie die aktuelle Version der IPA-Suite Serverkomponenten aus der vorgesehenen Bezugsquelle herunter.

Speichern Sie das Setup lokal auf dem Server oder Administrationsrechner, auf dem der Dienst betrieben werden soll.

Schritt 2: Setup als Administrator ausführen

Führen Sie das Setup mit erhöhten Rechten aus.

Vorgehen:

1. Rechtsklick auf die Setup-Datei.

2. Als Administrator ausführen auswählen.

3. Den Installationsdialog vollständig durchlaufen.

4. Installation abschließen.

Nach erfolgreicher Installation ist der Windows-Dienst IPA-RA-MICRO-Service auf dem System registriert.

Schritt 3: Dienststartart ändern und Dienst starten

Nach der Installation ist der Dienst zunächst auf die Startart Manuell eingestellt.

Diese Einstellung muss für den produktiven Betrieb auf Automatisch geändert werden.

Vorgehen über die Windows-Diensteverwaltung:

1. services.msc öffnen.

2. Dienst IPA-RA-MICRO-Service suchen.

3. Eigenschaften öffnen.

4. Starttyp von Manuell auf Automatisch ändern.

5. Einstellung übernehmen.

6. Dienst starten.

Alternativ über PowerShell als Administrator:

Set-Service -Name "IPA-RA-MICRO-Service" -StartupType Automatic
Start-Service -Name "IPA-RA-MICRO-Service"

Falls der Dienst auf Netzwerkpfade zugreifen muss, muss der Dienst mit einem entsprechend berechtigten Account gestartet werden.
Per Standard wird der Dienst als "Local System" gestartet. Per Standard gehen wir davon aus, dass der Dienst auf dem Server installiert ist, auf dem auch das Verzeichnis c:\ra-e-fach lokalisiert ist.

5. Wichtige Verzeichnisse und Dateien

5.1 RA-MICRO Basisordner

Standardmäßig wird folgender Basisordner verwendet:

C:\ra\e-fach

Darin befinden sich die einzelnen Prozessordner:

C:\ra\e-fach\00
C:\ra\e-fach\01
C:\ra\e-fach\02
...
C:\ra\e-fach\99

Jeder Prozessordner kann separat konfiguriert werden.

5.2 Serialized-Ordner

Zu den Prozessordnern gehören .Serialized-Ordner, in denen die erzeugten .dat-Dateien abgelegt werden.

Beispiel:

C:\ra\e-fach\05\.Serialized

Der Dienst muss Schreibrechte auf diese Ordner besitzen.

5.3 IPA-Suite Konfigurationsordner

Typischer Pfad:

C:\it-scom\IPA-Suite\ra-micro\

Dort liegen die zentralen Konfigurationsdateien und Templates.

Wichtige Dateien können sein:

RA-MICRO_ProzessordnerKonfiguration.json
RA-MICRO_SerializedDocumentTemplate.json
RA-MICRO_SqlKonfiguration.json
ra-micro-template.xml

Die tatsächlich verwendeten Dateien ergeben sich aus der jeweiligen Installation und Konfiguration.

5.4 Temporäres Verarbeitungsverzeichnis

Der Dienst verwendet ein temporäres Verzeichnis, um Dokumente sicher außerhalb des Prozessordners zu verarbeiten.

Typischer Pfad:

C:\it-scom\ipa-suite\temp\ra-micro-temp

Dort werden Dokumente während der Verarbeitung zwischengespeichert. Nach erfolgreicher Verarbeitung werden die Originaldateien wieder in den passenden Prozessordner zurückgelegt.

6. Prozessordner-Konfiguration

Die Prozessordner-Konfiguration liegt typischerweise in folgender Datei:

C:\it-scom\IPA-Suite\ra-micro\RA-MICRO_ProzessordnerKonfiguration.json

7. Dokumenttypen und Verarbeitung

7.1 PDF-Dokumente

PDF-Dokumente werden ausgelesen und analysiert. Der erkannte Text wird an die KI-Auswertung übergeben.

Übergabe an das RA-MICRO e-Postfach.

7.2 DOCX-Dokumente

DOCX-Dokumente werden ebenfalls textuell ausgelesen und analysiert.

Aktuell läuft die .docx-Verarbeitung im Betamode.

7.3 eMessage-Dateien

eMessage-Dateien werden als E-Mail-Dokumente behandelt.

Der Dienst führt hierbei mehrere Schritte aus:

1. eMessage-Datei erkennen.

2. Nachrichtentext auslesen.

3. Anhänge extrahieren.

4. Unterstützte Anhänge auslesen.

5. E-Mail-Text und Anhangstexte an die KI-Auswertung übergeben.

6. Übergabe an das RA-MICRO e-Postfach

Anhänge werden dabei nur zur Analyse extrahiert. Maßgeblich für die Übergabe an RA-MICRO bleibt die ursprüngliche eMessage-Datei.

8. Konfigurationstool

Das Konfigurationstool dient zur komfortablen Verwaltung der Prozessordner-Konfiguration.

Typische Aufgaben im Konfigurationstool:

• Basisordner festlegen

• Prozessordner aktivieren oder konfigurieren

• Typ je Ordner auswählen

• Templates erstellen

• bestehende Konfiguration laden und bearbeiten

Nach Änderungen an der Konfiguration sollte der Dienst neu gestartet werden, damit alle Einstellungen sicher neu geladen werden.

Vorgehen:

Restart-Service -Name "IPA-RA-MICRO-Service"

9. Dienstkonto und Berechtigungen

Der Windows-Dienst benötigt ausreichende Berechtigungen auf alle beteiligten Pfade.

Erforderlich sind mindestens:

• Lesen im RA-MICRO Basisordner

• Schreiben im RA-MICRO Basisordner

• Ändern/Löschen in den Prozessordnern

• Schreiben in den .Serialized-Ordnern des e-Postfach

• Lesen der IPA-Suite Konfigurationsdateien

• Schreiben im temporären Verarbeitungsverzeichnis

• Schreiben im Logverzeichnis

Empfohlen wird der Betrieb als Local System (wenn e-fach Pfade lokal), oder ein dediziertes administratives Dienstkonto, sofern die Umgebung dezentral.

Bei Betrieb mit Lokales System muss sichergestellt sein, dass alle benötigten lokalen Pfade erreichbar sind. Bei Netzlaufwerken oder UNC-Pfaden ist ein Domänen-Dienstkonto vorzuziehen.

10. Start, Stopp und Neustart des Dienstes

10.1 Dienst starten

Start-Service -Name "IPA-RA-MICRO-Service"

10.2 Dienst stoppen

Stop-Service -Name "IPA-RA-MICRO-Service"

10.3 Dienst neu starten

Restart-Service -Name "IPA-RA-MICRO-Service"

10.4 Dienststatus prüfen

Get-Service -Name "IPA-RA-MICRO-Service"

11. Logging

Der Dienst schreibt ein Arbeitsprotokoll, über das Verarbeitungsschritte und Fehler nachvollzogen werden können.

Typische Logdatei:

IPA-RA-MICRO-Service-WorkingLog.txt

Typische Logeinträge:

INFO
DEBUG

Starten Sie den Dienst mit dem Start-Parameter "debug" um den Dienst im Debugmode zu überwachen.

Im Log werden unter anderem folgende Ereignisse protokolliert:

• Dienststart

• erkannte Dateien

• verschobene Dateien

• gelesene Dokumente

• verarbeitete eMessage-Dateien

• extrahierte Anhänge

• erzeugte .dat-Dateien

• gelöschte/veraltete Processed-Marker

• Fehler beim Lesen oder Schreiben

• Fehler bei der KI-Auswertung

12. Processed-Marker

Der Dienst verwendet .processed-Marker, um bereits verarbeitete Dateien zu erkennen und doppelte Verarbeitung zu vermeiden.

Beispiel:

Dokument.pdf.processed

Wenn die zugehörige Originaldatei durch RA-MICRO oder eine Drittsoftware aus dem Prozessordner entfernt wurde, wird der nicht mehr benötigte Marker automatisch bereinigt.

Dadurch bleiben die Prozessordner sauber und es entstehen keine dauerhaft verwaisten Markerdateien.

Die Markerdateien dürfen nicht manuell gelöscht werden, da der Dienst sonst Dokumente in einer Schleife verarbeitet.

13. Betrieb und empfohlene Kontrollen

Für den laufenden Betrieb sollten regelmäßig folgende Punkte geprüft werden:

1. Läuft der Dienst?

2. Ist die Startart auf Automatisch gesetzt?

3. Werden neue Dokumente verarbeitet?