... |
... |
@@ -1,80 +1,1 @@ |
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 |
|
- |
54 |
|
- |
55 |
|
-=== Daten für die Übermittlung an das DMS === |
56 |
|
- |
57 |
|
-Mit dem Konfigurations-Parameter **Dateien** können die zu übertragenden Dateien festgelegt werden. |
58 |
|
-Die Dateien können dabei aus folgenden Bereichen stammen: |
59 |
|
- |
60 |
|
-* Formular-Uploads |
61 |
|
-* Dateien aus dateibereitstellenden Aktionen |
62 |
|
-* Datei-Ressourcen des Mandanten |
63 |
|
-* Datei-Ressourcen des Formulars |
64 |
|
-* Dateien aus externen Quellen |
65 |
|
-* Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden |
66 |
|
- |
67 |
|
-=== Rückgabewerte === |
68 |
|
- |
69 |
|
-Wenn Dateien und Metadaten erfolgreich an das //Nscale// DMS übermittelt werden konnten, terminiert die Plugin-Aktion normal. |
70 |
|
- |
71 |
|
-Es wird dabei folgende Rückgabewerte durch die Plugin-Aktion zur Verfügung gestellt: |
72 |
|
- |
73 |
|
-Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden: |
74 |
|
- |
75 |
|
-* AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am //Nscale //System durchgeführt werden konnte. |
76 |
|
-* NO_PAYLOAD_DATA: Tritt auf, wenn zur Laufzeit keine Daten (Metadaten, Dateien) ermittelt werden konnten, die an den angebundenen //Nscale //Service übermittelt werden sollen. |
77 |
|
-* NO_TARGET_FOLDER: Wenn kein Zielverzeichnis im //Nscale //System für die Ablage von Dateien definiert wurde. |
78 |
|
-* SRV_CONNECTION_ERROR: Tritt auf, wenn keine Verbindung zum angebundenen //Nscale //System aufgebaut werden kann |
79 |
|
-* SRV_METHOD_ERROR: Tritt auf, wenn der //Nscale// Webservice-Methode einen Fehler zurück lieferte. |
80 |
|
-* INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde. |
|
1 |
+Beschreibung |