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

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

Die Installation erfolgt unter Mandant > Plugins.

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 geschieht in folgenden Schritten:

• 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.
   
• Festlegung über "Ablageordner per Nscale-Abfrage festlegen?", ob ein fest definierter Nscale Ordner als Ziel-Ordner definiert werden soll oder ob die Bestimmung des Zielordner zur Laufzeit erfolgt.
   
• Ist "Ablageordner per Nscale-Abfrage festlegen?" nicht ausgewählt, so ist der Nscale Ablageordner aus dem Feld Ablageordner auszuwählen.
  Das Auswahlfeld wird automatisch bei der Festlegung der DocArea befüllt.
   
• Ist "Ablageordner per Nscale-Abfrage festlegen?" ausgewählt, so erscheint automatisch eine Tabelle für die Auswahl der Suchparameter für Nscale Ablageordner.
  Diese Tabelle dient der Definition von Suchparametern zum Ausfinden eines konkreten Nscale Ablageordners zum Ausführungszeit der Plugin-Aktion.
  Dafür sind unter Umständen bereits Parameter vorgegeben, welche mit Werten belegt werden können, oder es können eigene Suchparameter über das hinzugefügt werden.Über den Button lassen sich Parameter aus der Abfrage entfernen. Auf die zu suchenden Ablageordner müssen alle definierten Sucheigenschaften zutreffen. Ein Klick auf den Ablageordner suchen Button führt eine Suche im Nscale System mit den definierten Parameter durch.
  Damit lässt sich im Vorfeld ermitteln, ob zur Laufzeit auch ein Ordner aus dem Nscale System ermittelt werden kann.
  
  

  Hinweise: Platzhalter in den Abfrage-Parametern können nur zur Laufzeit aufgelöst werden. Bei einer testweisen Suche im Vorfeld kann nur mit festen Abfragewerten gearbeitet werden.

  
  

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:

• Ressourcen Zähler ([%$.RESULT.resourceCount%]): Anzahl der erfolgreich übermittelten Dateien
• Ressources-Informationen: Der Zugriff auf die Informationen zu den übermittelten Ressourcen erfolgt über eine Zahlvariable ([i]). Ein möglicher Wert muss sich im Bereich von 0 bis zum Wert des Ressourcen Zähler-1 befinden.
  • Id ([%$.RESULT.resources[i].id%]): Id der hinzugefügten Ressource aus dem Nscale System
  • DisplayName ([%$.RESULT.resources[i].displayName%]): Name der hinzugefügten Ressource
• Folder-Id ([%$.RESULT.folder.id%]): Id des Nscale Ordners, in den die übermittelte Ressource abgelegt wurde
• Folder-DisplayName ([%$.RESULT.folder.displayName%]): Name des Nscale Ordners, in den die übermittelte Ressource abgelegt wurde

Fehler, während der Plugin-Verarbeitung, welche zu einem Abbruch der Workflow-Verarbeitungskette führen:

• AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am Nscale System durchgeführt werden konnte.
• NO_TARGET_FOLDER: Wenn kein Zielverzeichnis im Nscale System für die Ablage von Dateien definiert wurde. Wenn das Zielverzeichnis auf Grundlage einer Nscale-Abfrage ermittelt wird,
  so wird diese Abfrage für Analysezwecke im Protokoll vermerkt.
• 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.

Fehler, während der Plugin-Verarbeitung, welche nicht zu einem Abbruch der Workflow-Verarbeitungskette führen:

• NO_PAYLOAD_DATA: Tritt auf, wenn zur Laufzeit keine Daten (Metadaten, Dateien) ermittelt werden konnten, die an den angebundenen Nscale Service übermittelt werden sollen.
  Es wird eine Warnung über das Auftreten dieser Ausnahme im Protokoll erzeugt.

Versionshistorie

1.3.0

• Anpassung: Der Fehler "NO_PAYLOAD_DATA" wurde als "weicher" Fehler deklariert, wodurch ein Auftreten dieser Ausnahme standardmäßig nicht zum Abbruch der Workflow-Verarbeitungskette führt.
• Erweiterung der Ausschriften im Protokoll beim Auftreten spezieller Ausnahmen 

1.2.0

• Initiale Version der Nscale-Anbindung