Serverseitige Funktionalität, wie sie der Integration Service über Webservices bietet, wird in Form einer EAR Datei paketiert, die auf einem Anwendungsserver wie WildFly oder JBoss als Deployment eingespielt werden muss. Details und Voraussetzungen zur Installation und Konfiguration können dem Installationshandbuch entnommen werden [IM ImageMaster].
Neben der systemnahen Konfiguration auf Ebene des Anwendungsservers, werden alle zentralen Systemkonfigurationsaspekte über den AdminClient abgehandelt (vgl. Kapitel ImageMaster AdminClient). Weitere spezielle und individuelle Anpassungen werden durch den Mechanismus von „Extensions“ ermöglicht (vgl. Kapitel Extensions). Extensions sind in einer projektspezifischen EAR Datei eines ImageMaster Releases integriert und brauchen nicht auf separate Art und Weise eingespielt werden.
Die folgenden Abschnitte präsentieren einen Überblick der Basis-Webservices, d.h. über System Management und Document Management Services, die mit hoher Wahrscheinlichkeit in jeder Integration Service Umgebung eingesetzt werden.
Die folgenden Webservices werden als System Management Services betrachtet:
-
Der ImaAuthorizationService bietet Methoden zur Verwaltung von Rollen, d.h. zur Auflistung existierender Rollen, Erzeugung von Rollen, Löschung von Rollen, Umbenennung von Rollen und zur Änderung von Rollendefinitionen.
-
Der ImaTypeService bietet Methoden zur Verwaltung von Dokumenttypen, d.h. zur Auflistung existierender Typen, Erzeugung von neuen Typen, Löschung von Typen, Änderung von Typendefinitionen und zur Anlage von Datenbankindizes zu einem Typen.
-
Der ImaUserlibService bietet Methoden zur Verwaltung von Anwendern, d.h. Methoden zur Anlage oder Löschung von Anwendern, zur Zuweisung existierender Rollen und zur Verwaltung von Benutzergruppen1.
-
Der ImaStatisticsService bietet Methoden zur Sammlung und zum Abruf von statistischen Daten über die Systemnutzung und Systemaktivitäten. Statistiken zu älteren Daten werden dabei automatisch verdichtet, sodass Trends über lange Zeiträume beobachtet werden können.
-
Der ImaAdminService, der in einer gesonderten Webservice Referenz-Dokumentation beschrieben wird [WS AdminClient], bietet Methoden zur Konfiguration einer ImageMaster-Umgebung. Diese Dienste können zur automatischen Einspielung einer initialen Konfiguration verwendet werden anstatt einer manuellen Einrichtung über den AdminClient (vgl. Kapitel ImageMaster AdminClient).
Einige der weiteren, optionalen Services und Dienste mit Querschnittsfunktionen können auch als „administrativ“ betrachtet werden (vgl. Optionale und interne Webservices weiter unten).
Abbildung 821: System Management Services zur Administration
Die folgenden Webservices werden als Document Management Services betrachtet:
-
Der ImaDocumentService bietet Methoden zur Handhabung von Dokumenten, deren Versionen und deren Inhalten (in Form von Dateianhängen) im Sinne der Erzeugung von Dokumenten und zum Retrieval von Versionen mit Dateianhängen (anhand von IDs).
-
Der ImaVersioningService bietet Methoden zur kontrollierten Veränderung von Dokumenten mit daraus resultierenden Versionen, d.h. zum Ein- und Auschecken von Dokumenten (Sperrung zur Bearbeitung) mit einem zugehörigen Update von Attributwerten oder mit Änderung oder Löschung von Dateianhängen in neu erzeugten Versionen.
-
Der ImaSearchService bietet die Möglichkeit für Suchanfragen basierend auf RAQL, um verschiedenste Arten von Ergebnismengen zurückzuliefern (z.B. Dokumentenmengen samt aller Versionen mit Dateianhängen und Attributwerden, oder Ergebnisse nur bezogen auf bestimmte Attributwerte, oder nur letzte Version eines Dokuments etc.)
-
Der ImaBatchService bietet Methoden zur Stapelverarbeitung und ist speziell zugeschnitten auf FIS (vgl. Kapitel ImageMaster File Interoperability Service (FIS)) für Massenimport/-export/-update/-löschung. Für FIS ist eine eigene, kommerzielle Lizenz nötig.
Abbildung 822: Document Management Services