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

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 Datei wird die Datei, 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.

Allgemeine Rückgabeparameter

In diesem Bereich werden die vom Plugin als Ergebnis des regisafe Service-Aufrufs zurück gelieferten Parameter aufgeführt.
Für die einzelnen Parameter kann ein Alias vergeben werden.
In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
Der Platzhalter wird dabei nach dem folgenden Muster gebildet:

ResultCode

Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode zurück geliefert. 

Dabei definiert der Statuscode "0", dass das Plugin fehlerfrei ausgeführt werden konnte. 

Im Fehlerfall werden unterschiedliche Statuscodes zurück geliefert, welche die folgenden Bedeutungen haben:

11: 

Es konnten keine Datei für eine Übermittlung an regisafe ermittelt werden.

(Prüfen Sie bitte die Einstellungen im Bereich Datei auf die Existenz einer Datei zum Zeitpunkt der Plugin-Ausführung) 

30:

Es konnte keine Verbindung zum Service unter dem URL '<URL des angefragten Service>' aufgebaut werden.

31:

Der Serviceaufruf lieferte folgenden Fehler: <Detaillierte Fehlerinformationen die vom Webservice zurück geliefert wurde>

40:

In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten: <Platzhalter für nähere Fehlerbeschreibung>

ResultMessage

Eine zum Statuscode zugehörige Meldung

ResultDocID

Die vom Webservice zurückgelieferte Dokument-ID, unter welcher die übertragene Datei im regisafe-System abgelegt wurde.  

Versionshistorie

1.0.0

• initiale Anbindung der regisafe Dokument-Upload-Schnittstelle
  {{/info}}