Ceyoniq: Nscale-Plugin

Inhalt [ Verbergen ]

Über das kostenpflichtige ceyoniq Plugin ist es möglich das Nscale DMS System an Xima® Formcycle anzubinden.

Auf Seiten des Nscale Dokumenten Management Systems ist mindestens die Version 8.2 der REST Schnittstelle notwendig. Weiterhin muss die Nscale-Lizenz einen Zugriff auf die REST API zulassen.

Die Installation erfolgt unter Mandant > Plugins.

Konfiguration der Verbindungseinstellungen zum Nscale System

Die nachfolgenden Einstellungen sind durch einen Administrator, der die Rechte zum Konfigurieren von Plugins besitzt, vorzunehmen. Das Plugin kann nur im Bereich eines Mandanten installiert werden. 
Folgende Eigenschaften für die Anbindung des Nscale Systems können definiert werden:
Nscale REST-Endpoint URL
Absolute URL zu einem Webservice-Endpoint im Nscale DMS-System
Basic-Auth Account
Login für eine Basic-Auth Kommunikation
Basic-Auth Passwort
Passwort für eine Basic-Auth Kommunikation
KeyStore Name (.p12 Datei)
Name einer Datei-Ressource, welche einen Keystore im PKCS12 Format enthält. Dieser Keystore kann verwendet werden, um SSL-Zertifikate für die Kommunikation mit dem Nscale REST-Webservice verfügbar zu machen, wenn diese beispielsweise nicht im Standard-JAVA-Truststore verfügbar sind.
KeyStore Passwort
Passwort für den Zugriff auf den Keystore
Connection Timeout (Pflichtangabe)
Wert für ein Connection-Timeout Sekunden. (Standardwert: _10 s_)
Read Timeout (Read-Timeout)
Wert für ein Read-Timeout in Sekunden. (Standardwert: _30 s_)

Aktions-Plugin Nscale Upload

Für die Übermittlung von Dateien in das Nscale DMS steht das Aktions-Plugin Nscale Upload im Workflow zur Verfügung.
Im Vorfeld ist dafür innerhalb der Aktion ein Ablageordner aus dem Nscale-System zu definieren.
Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden.

Nscale System Konfiguration

In diesem Bereich wird die Festlegung für den Datei-Ablageordner im Nscale System getroffen. 
Dies erfolgt in drei Schritten

  1. Festlegung eines DocArea Name, welche den Zielablageordner beinhaltet muss. Die Werte innerhalb der DocArea-Auswahlliste werden
    automatisch beim der Anzeige der Workflow-Aktions-Eigenschaften ermittelt. Sollte keine Verbindung zum konfigurierten Nscale System möglich sein,
    erscheint eine entsprechende Fehlermeldung.
  2. Nach Auswahl einer DocArea erscheint automatisch eine Tabelle für die Auswahl der Suchparameter für Nscale Ablageordner.
    Diese Tabelle dient der Definition von Suchparametern zum Ausfinden eines konkretem Nscale Ablageordners.
    Dafür sind unter Umständen bereits Parameter vorgegeben, welche mit Werten belegt werden können, oder es können eigene Parameter über das  hinzugefügt werden

Ablageordner

Daten für die Übermittlung an das DMS

In der Tabelle Metadaten können zusätzliche Daten, welche als Eigenschaften an der hochgeladen Ressource hinterlegt werden, definiert werden.
Aktuell werden nur Nscale Eigenschaften vom Typ "String" unterstützt.

Mit dem Konfigurations-Parameter Dateien können die zu übertragenden Dateien festgelegt werden. 
Die Dateien können dabei aus folgenden Bereichen stammen:

  • Formular-Uploads
  • Dateien aus dateibereitstellenden Aktionen
  • Datei-Ressourcen des Mandanten
  • Datei-Ressourcen des Formulars
  • Dateien aus externen Quellen
  • Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden

Rückgabewerte

Wenn Dateien und Metadaten erfolgreich an das Nscale DMS übermittelt werden konnten, terminiert die Plugin-Aktion normal und liefert folgende Informationen aus dem Nscale System zurück:

  • Id: Id der hinzugefügten Resource aus dem Nscale System
  • AreaName: Name der Nscale DocArea, innerhalb derer die neue Resource auf dem System abgelegt wurde
  • Type: Der Typ der neu angelegten Dateiresource aus dem Nscale System

Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden:

  • AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am Nscale System durchgeführt werden konnte.
  • NO_PAYLOAD_DATA: Tritt auf, wenn zur Laufzeit keine Daten (Metadaten, Dateien) ermittelt werden konnten, die an den angebundenen Nscale Service übermittelt werden sollen.
  • NO_TARGET_FOLDER: Wenn kein Zielverzeichnis im Nscale System für die Ablage von Dateien definiert wurde.
  • SRV_CONNECTION_ERROR: Tritt auf, wenn keine Verbindung zum angebundenen Nscale System aufgebaut werden kann
  • SRV_METHOD_ERROR: Tritt auf, wenn der Nscale Webservice-Methode einen Fehler zurück lieferte.
  • INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde.