Wiki-Quellcode von Ceyoniq: Nscale-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Über das kostenpflichtige //ceyoniq// Plugin ist es möglich das //Nscale// DMS System an {{formcycle/}} anzubinden.
4
5 {{info}}
6 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.
7 {{/info}}
8
9 Die Installation erfolgt unter Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins]].
10
11
12
13 {{panel title="Konfiguration der Verbindungseinstellungen zum Nscale System" initial="hidden" triggerable="true"}}
14
15
16
17 (((
18 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. 
19 )))
20
21 (((
22 Folgende Eigenschaften für die Anbindung des Nscale Systems können definiert werden:
23
24
25
26 )))
27
28 ; Nscale REST-Endpoint URL {{id name="bundle_prop_endpoint_url"/}}
29 : Absolute URL zu einem Webservice-Endpoint im //Nscale// DMS-System
30 ; Basic-Auth Account
31 : Login für eine Basic-Auth Kommunikation
32 ; Basic-Auth Passwort
33 : Passwort für eine Basic-Auth Kommunikation
34 ; KeyStore Name (.p12 Datei)
35 : 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.
36 ; KeyStore Passwort
37 : Passwort für den Zugriff auf den Keystore
38 ; Connection Timeout (Pflichtangabe)
39 : Wert für ein Connection-Timeout Sekunden. (Standardwert: 10 s)
40 ; Read Timeout (Read-Timeout)
41 : Wert für ein Read-Timeout in Sekunden. (Standardwert: 30 s)
42
43 {{/panel}}
44
45 == Aktions-Plugin //Nscale Upload// ==
46
47 Für die Übermittlung von Dateien in das Nscale DMS steht das Aktions-Plugin **Nscale Upload** im Workflow zur Verfügung.
48 Im Vorfeld ist dafür innerhalb der Aktion ein Ablageordner aus dem Nscale-System zu definieren.
49 Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden.
50
51 === Nscale System Konfiguration ===
52
53 {{figure image="nscale_system_config.png"}}
54 Beispielkonfiguration mit fest definierten Ablageordner aus dem Nscale-System
55 {{/figure}}
56
57 {{figure image="nscale_system_config_2.png"}}
58 Beispielkonfiguration zum Ermitteln eines Ablageordners aus dem Nscale-System zur Laufzeit. Als Query-Werte können Platzhalter verwendet werden.
59 {{/figure}}
60
61 In diesem Bereich wird die Festlegung für den Datei-Ablageordner im //Nscale //System getroffen. 
62 Dies erfolgt in drei Schritten
63
64 1. Festlegung eines **DocArea Name**, welche den Zielablageordner beinhaltet muss.
65 Die Werte innerhalb der DocArea-Auswahlliste werden
66 automatisch beim der Anzeige der Workflow-Aktions-Eigenschaften ermittelt. Sollte keine Verbindung zum konfigurierten //Nscale //System möglich sein,
67 erscheint eine entsprechende Fehlermeldung.
68 1. Nach Auswahl einer DocArea erscheint automatisch eine Tabelle für die Auswahl der **Suchparameter für Nscale Ablageordner**.
69 Diese Tabelle dient der Definition von Suchparametern zum Ausfinden eines konkretem Nscale Ablageordners.
70 Dafür sind unter Umständen bereits Parameter vorgegeben, welche mit Werten belegt werden können, oder es können eigene Suchparameter über das [[image:icon_add.png]] hinzugefügt werden.
71 Über den Button [[image:icon_del.png]] lassen sich Parameter aus der Abfrage entfernen. Auf die zu suchenden Ablageordner müssen alle definierten Sucheigenschaften zutreffen. 
72 Ein Klick auf den **Ablageordner suchen** Button führt eine Suche im Nscale System mit den definierten Parameter durch. Mit den Ergebnissen wird die Auswahlliste **Ablageordner **befüllt.
73 1. Auswahl eines **Ablageordners**. Der ausgewählte Ordner wird zum Ausführungszeitpunkt der Workflow-Aktion als Ablageordner für die übermittelten Dateien herangezogen.
74
75 === Daten für die Übermittlung an das DMS ===
76
77 {{figure image="daten_config.png"}}
78 Konfiguration zum Übermitteln mehrerer Formular-Upload Dateien mit Angabe eines eigenen Displaynamens für die neue Ressource.
79 {{/figure}}
80
81 In der Tabelle **Metadaten **können zusätzliche Daten, welche als Eigenschaften an der hochgeladen Ressource hinterlegt werden, definiert werden.
82 Aktuell werden nur //Nscale //Eigenschaften vom Typ "String" unterstützt.
83
84 Mit dem Konfigurations-Parameter **Dateien** können die zu übertragenden Dateien festgelegt werden. 
85 Die Dateien können dabei aus folgenden Bereichen stammen:
86
87 * Formular-Uploads
88 * Dateien aus dateibereitstellenden Aktionen
89 * Datei-Ressourcen des Mandanten
90 * Datei-Ressourcen des Formulars
91 * Dateien aus externen Quellen
92 * Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden
93
94 === Rückgabewerte ===
95
96 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:
97
98 * Id: Id der hinzugefügten Resource aus dem //Nscale// System
99 * AreaName: Name der //Nscale //DocArea, innerhalb derer die neue Resource auf dem System abgelegt wurde
100 * Type: Der Typ der neu angelegten Dateiresource aus dem //Nscale //System
101
102 Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden:
103
104 * AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am //Nscale //System durchgeführt werden konnte.
105 * NO_PAYLOAD_DATA: Tritt auf, wenn zur Laufzeit keine Daten (Metadaten, Dateien) ermittelt werden konnten, die an den angebundenen //Nscale //Service übermittelt werden sollen.
106 * NO_TARGET_FOLDER: Wenn kein Zielverzeichnis im //Nscale //System für die Ablage von Dateien definiert wurde.
107 * SRV_CONNECTION_ERROR: Tritt auf, wenn keine Verbindung zum angebundenen //Nscale //System aufgebaut werden kann
108 * SRV_METHOD_ERROR: Tritt auf, wenn der //Nscale// Webservice-Methode einen Fehler zurück lieferte.
109 * INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde.