regisafe DMS-Plugin

Geändert am Mi, 20 Sep, 2023 um 1:31 NACHMITTAGS

Inhalt

Über das kostenpflichtige Regisafe DMS Plugin ist es möglich Dokumente aus FORMCYCLE an das Dokumenten Management System regisafe zu übergeben. Das Plugin nutzt dabei die vom regisafe System bereitgestellte Webservice-Schnittstelle.

Konfiguration der Verbindungseinstellungen zum regisafe System

Die nachfolgenden Einstellungen sind durch einen Administrator, der die Rechte zum Konfigurieren von Plugins besitzt, vorzunehmen. Folgende Eigenschaften für die Anbindung des regisafe Systems können definiert werden:

rest.srv.url (Pflichtangabe): Protokoll, Host und Pfadangabe zu einen regisafe REST Service. (Die hier erforderliche Angabe darf keine konkrete Funktionsreferenz auf eine Funktionsgruppe enthalten.)
rest.srv.connection.timeout: Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden)
rest.srv.read.timeout: Wert für ein Read-Timeout in Millisekunden. (Standardwert: 30 Sekunden)
rest.srv.proxy.host: Die Host-Angabe, bei Kommunikation über einen Proxy-Server.
rest.srv.proxy.port: Die Port-Angabe, bei Kommunikation über einen Proxy-Server.
rest.srv.keystore.name: Der Name Ihres Zertifikats für die sichere Kommunikation.
rest.srv.keystore: Das Passwort Ihres Zertifikats für die sichere Kommunikation.

Konfiguration der Authentifizierungsdaten

API ID (Pflichtangabe): Kennung zur Nutzung der IQ-API.
Login ID (Pflichtangabe): Die Login ID, wird vom regisafe-System vorgegeben.
Password (Pflichtangabe): Passwort für das zuvor definierte Login

Aktions-Plugin regisafe:Dokument hochladen

Für die Übermittlung von Dokumenten an das regisafe-DMS steht das Aktions-Plugin regisafe:Dokument hochladen zur Verfügung. Dieses ermöglicht es, Dateien und zugehörige Metadaten an das DMS zu übermitteln. Anhand der mitgelieferten Metadaten kann die entsprechende Datei dann auf Seiten von regisafe weiterverarbeitet werden. Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.

Festlegung der zu übertragenden Datei und ihrer Metadaten

Über den Parameter Dateien wird/werden die Datei/en, welche an das regisafe-System übertragen werden soll, festgelegt. Diese kann aus einer datei-bereitstellenden Aktion oder aus einem Formular-Upload-Element stammen. Werden zum Plugin Ausführungszeitpunkt mehrere Dateien ermittelt, beispielsweise weil ein zugeordnetes Formular-Upload-Element dynamisch ist, so werden alle ermittelten Dateien zu einer Zip-Datei zusammengefasst und diese wird an regisafe übermittelt. Über den Parameter Dokument ID kann eine eindeutige ID für das Dokument in regisafe definiert werden. Um für ein vorhandenes Dokument eine neue Version zu übermitteln, muss die "Dokument-ID" des zu ändernden Dokuments übergeben werden. Die Länge der ID darf maximal 128 Zeichen sein, wobei die Zeichen beliebig sein können.

Ist keine ID festgelegt, so wird das Dokument als neues Dokument im regisafe-System abgelegt und die dann im regisafe-System erzeugte ID zurück geliefert. In der Tabelle Metadaten Definition erfolgt die Festlegung der, mit dem Dokument, zu übermittelnden Metadaten.

Über den-Button können der Tabelle einzelne Metadaten Definitionen hinzugefügt werden. Für ein einzelnes Feld sind dabei Feld-ID, und (zu übermittelnder) Wert festzulegen.
Diese Einstellungen haben folgende Bedeutung:

Feld ID: Enthält den Namen der Variablen, wie er auf Seiten von regsiafe als übermitteltes Metadatum angesprochen werden kann.
Wert: Enthält den an regisafe zu übermittelnden Wert. Dieser kann aus Platzhalter(n) oder fest hinterlegten Werten bestehen. Wird zur Laufzeit kein Wert ermittelt, weil beispielsweise ein Platzhalter keinen Wert referenziert, dann wird dieses Feld von der Übermittlung ausgenommen.

Über den -Button können alle im aktuellen Formular vorhandenen Formular-Elemente als Metadaten Definitionen hinzugefügt werden, wenn Sie noch nicht vorhanden sind.Der Identifikator für bereits vorhandene Elemente ist dabei die Feld-ID, welche mit den Formular-Elementname abgeglichen wird.

Übersteuern der Serverkonfiguration

In diesem Bereich besteht die Möglichkeit die global am Plugin-Bundle registrierten Eigenschaften für den anzubindenden regisafe-Server und dessen Authentifizierungs-Informationen formular-prozess-spezifisch zu übersteuern. Es können Platzhalter (Auswahlmöglichkeit über Button ) für einzelne Einstellungen verwendet werden.

REST-Service URL: Protokoll und Host zum Zugriff auf die regisafe IQ-API. (z.B. https://my.regisafe-server.com/iqAPI); Übersteuert den global definierten Parameter rest.srv.url.
API-ID: Die ID, welche die Kennung zur Nutzung der regisafe-API repräsentiert.; Übersteuert den global definierten Parameter API ID.
Login-ID: Anmeldenamen des Nutzers über den der Zugriff auf den Web-Service erfolgen soll.; Übersteuert den global definierten Parameter Login ID.
Passwort: Passwort zur Login-ID. Übersteuert den global definierten Parameter Password.

Über den Button kann geprüft werden, ob der Web-Service prinzipiell erreicht werden kann, sowie ob eine Authentifizierung mit den hinterlegten Benutzer-Credentials möglich ist.

Rückgabewerte der Workflow-Aktion

[%$[Name der Aktion].RESULT.docId%]: Die vom Webservice zurückgelieferte Dokument-ID, unter welcher die übertragene Datei im regisafe-System abgelegt wurde.

[%$[Name der Aktion].RESULT.message%]: Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode sowie einer zugehörigen Meldung zurück geliefert.

0:
- Die Aktion wurde fehlerfrei ausgeführt.
11:
- Es konnten keine Datei für eine Übermittlung an regisafe ermittelt werden.
30:
- Es konnte keine Verbindung zum Service unter der URL aufgebaut werden.
31:
- Der Serviceaufruf lieferte folgende Fehler.
40:
- In formcycle ist ein nicht näher spezifizierter Fehler aufgetreten.

Versionshistorie

3.0.0

Anpassungen für Version 8.0.1

2.0.0

Anpassungen für Version 7.0.13

1.0.0

initiale Anbindung der regisafe Dokument-Upload-Schnittstelle