regisafe DMS-Plugin
Über das 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.
Konfiguration der Verbindungseinstellungen zum regisafe System
- 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.
- 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
Ü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.
{{/info}
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:
Über den 
Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels Ctrl+V eingefügt werden.
- 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