Anlage 6 - Schnittstelle VIS - VAPI_Überblick.pdf

[Seite 1]

VIS VAPI

Überblick

Version: 6.5

Stand: 28. März 2024

[Seite 2]

© Copyright by PDV GmbH Haarbergstraße 73 99097 Erfurt

Alle Rechte vorbehalten. Sämtliche Angaben vorbehaltlich technischer Änderungen. Trotz sorgfältiger Prüfung wird für den Inhalt keine Haftung übernommen. Alle aufgeführten Warennamen sind eingetragen und als solche zu behandeln.

Im Interesse der besseren Lesbarkeit des Textes wird auf geschlechterspezifische Formulierungen verzichtet. Die männliche Form wird als generisches Maskulinum und damit ausdrücklich als Sammelbezeichnung für beide Geschlechter verwendet.

Nachdruck und Vervielfältigung – auch auszugsweise – nur mit Genehmigung der PDV GmbH, Erfurt

[Seite 3]

Inhaltsverzeichnis

Inhaltsverzeichnis

1 Einleitung ................................................................................................................ 4 1.1 Begleitende Dokumente ........................................................................................ 4 2 VAPI im Überblick ................................................................................................... 5 2.1 XML als Datenaustauschformat ............................................................................ 6 2.2 Software Development Kits ................................................................................... 7 3 Die bereitgestellten Funktionen des VAPI-Webservices ...................................... 8 3.1 Geschäftsobjekt-Funktionen .................................................................................. 8 3.2 Repository-Funktionen .......................................................................................... 8

3

[Seite 4]

Einleitung

1 Einleitung

1.1 Begleitende Dokumente

Tabelle 1: Begleitende Dokumente

4

[Seite 5]

VAPI im Überblick

2 VAPI im Überblick

VAPI steht für Verwaltungs Application Programming Interface und stellt eine universelle Verwaltungs-API für die Fernsteuerung von VIS-Funktionalitäten bereit. Es handelt sich dabei um eine freigegebene Schnittstelle zur Automation und Integration. Sie kann verwendet werden, um komplexe Operationen auszuführen oder verwaltungsspezifische Fachapplikationen anzubinden. Das Abstraktionsniveau wird auf die Ebene der Anwendungsschicht gehoben, wo die geltenden VIS-Geschäftsregeln für die Einhaltung der VIS-Geschäftslogik sorgen. Somit wird sichergestellt, dass nur transaktionssichere Operationen ausgeführt werden.

Der Zugriff auf die Funktionen der Schnittstelle erfolgt mit Hilfe des SOAP-Protokolls über den VAPI-Webservice. Dadurch wird ein hoher Grad an Plattformunabhängigkeit garantiert. Die Authentizität und Integrität der VAPI-Aufrufe wird durch den Einsatz von WS-Security sichergestellt.

In der nachfolgenden Abbildung ist die Kommunikation zwischen VIS und externen Anwendungen bzw. Fachverfahren der elektronischen Schriftgutverwaltung über den VAPI-Webservice schematisch dargestellt.

Abbildung 1: Schematische Darstellung der Funktionsweise von VAPI

5

[Seite 6]

VAPI im Überblick

XML als Datenaustauschformat

2.1 XML als Datenaustauschformat

Der Datenaustausch zwischen VAPI und der externen Applikation erfolgt im XML-Format, wobei die gleiche Grammatik wie bei Import und Export Verwendung findet. Der Aufbau wird im Folgenden an einigen konkreten Beispielen gezeigt.

Übergabe eines Betreffs

Übergabe eines Betreffs und des Aktenplanschlüssels

Hinzufügen von Primärdaten zu einem Dokument

6

[Seite 7]

VAPI im Überblick

Software Development Kits

2.2 Software Development Kits

Für eine einfache Nutzung des VAPI-Webservice stellt die PDV GmbH clientseitige Software Development Kits (SDK) bereit. Diese stellen eine Sammlung von Programmierwerkzeugen und Programmbibliotheken dar, welche die Arbeit mit VAPI erleichtern. Die Development Kits werden jeweils in einer .NET- und in einer Java-Version zur Verfügung gestellt.

Über die VAPI-Clients haben Sie die Möglichkeit, eine VapiWS-Instanz zu erzeugen. Mit dem Vapi-Client-CXF kann zusätzlich jeweils ein Client für die Oauth2-Authentifierung und ein Client für die Kerberos-Authentifizierung erzeugt werden. Beim Vapi-.NET-Client erfolgt eine Unterscheidung bezüglich der Authentifizierung innerhalb der VapiWS- bzw. der VapiWSMTOM-Instanz.

Bis auf die VapiWSMTOM-Instanz können alle erzeugten Client-Objekte Datei-Attachments über die addRequestAttachment-Methode hinzufügen. Beim VapiWSMTOMClient ist dies bereits innerhalb des Aktions- bzw. Methodenaufrufs möglich. Für die VAPI-Clients wird VapiWSMTOM als Endpunkt verwendet.

Die nachfolgende Abbildung zeigt eine schematische Darstellung der Verknüpfungen zwischen den VAPI-Clients, Methoden und Endpoints.

Abbildung 2: Schematische Abbildung der VAPI-Clients, Methoden und Endpoints

7

[Seite 8]

Die bereitgestellten Funktionen des VAPI-Webservices

Geschäftsobjekt-Funktionen

3 Die bereitgestellten Funktionen des VAPI-Webservices

Der VAPI-Webservice stellt Ihnen die folgenden Funktionen bereit: • Erzeugen, Suchen und Bearbeiten von Geschäftsobjekten • Ermitteln von Repository-Konfigurationen (Spracheinstellungen etc.)

In den nachfolgenden Kapiteln enthalten Sie eine tabellarische Übersicht zu den verfügbaren Geschäftsobjekt- und Repository-Funktionen.

3.1 Geschäftsobjekt-Funktionen

Die nachfolgende Tabelle bietet Ihnen einen Überblick zu den Funktionen auf Geschäftsobjekte, die über den VAPI-Webservice bereitgestellt werden:

Tabelle 2: Funktionen zu Geschäftsobjekten

3.2 Repository-Funktionen

Eine Übersicht über die bereitgestellten Repository-Funktionen des VAPI-Webservices erhalten Sie in der nachfolgenden Tabelle:

Tabelle 3: Funktionen zum Repository

8

[Seite 9]

Die bereitgestellten Funktionen des VAPI-Webservices

Repository-Funktionen

9