... |
... |
@@ -1,74 +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 |
|
-~{~{panel title="Konfiguration der Verbindungseinstellungen zum Nscale System" initial="hidden" triggerable="true"}} |
13 |
|
- |
14 |
|
- |
15 |
|
-~(~(~( |
16 |
|
-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. |
17 |
|
-~)~)~) |
18 |
|
- |
19 |
|
-~(~(~( |
20 |
|
-Folgende Eigenschaften für die Anbindung des Nscale Systems können definiert werden: |
21 |
|
- |
22 |
|
- |
23 |
|
-~)~)~) |
24 |
|
- |
25 |
|
-~; Nscale REST-Endpoint URL ~{~{id name="bundle_prop_endpoint_url"/}} |
26 |
|
-~: Absolute URL zu einem Webservice-Endpoint im ~/~/Nscale~/~/ DMS-System |
27 |
|
-~; Basic-Auth Account |
28 |
|
-~: Login für eine Basic-Auth Kommunikation |
29 |
|
-~; Basic-Auth Passwort |
30 |
|
-~: Passwort für eine Basic-Auth Kommunikation |
31 |
|
-~; KeyStore Name (.p12 Datei) |
32 |
|
-~: 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. |
33 |
|
-~; KeyStore Passwort |
34 |
|
-~: Passwort für den Zugriff auf den Keystore |
35 |
|
-~; Connection Timeout (Pflichtangabe) |
36 |
|
-~: Wert für ein Connection-Timeout Sekunden. (Standardwert: _10 s_) |
37 |
|
-~; Read Timeout (Read-Timeout) |
38 |
|
-~: Wert für ein Read-Timeout in Sekunden. (Standardwert: _30 s_) |
39 |
|
- |
40 |
|
-~{~{/panel}} |
41 |
|
- |
42 |
|
-~== Aktions-Plugin ~/~/Nscale Upload~/~/ == |
43 |
|
- |
44 |
|
-Für die Übermittlung von Dateien in das Nscale DMS steht das Aktions-Plugin ~*~*Nscale Upload~*~* im Workflow zur Verfügung. |
45 |
|
-Im Vorfeld ist dafür innerhalb der Aktion ein Ablageordner aus dem Nscale-System zu definieren. |
46 |
|
-Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden. |
47 |
|
- |
48 |
|
-~=== Nscale System Konfiguration === |
49 |
|
- |
50 |
|
- |
51 |
|
-~=== Daten für die Übermittlung an das DMS === |
52 |
|
- |
53 |
|
-Mit dem Konfigurations-Parameter ~*~*Dateien~*~* können die zu übertragenden Dateien festgelegt werden. |
54 |
|
-Die Dateien können dabei aus folgenden Bereichen stammen: |
55 |
|
- |
56 |
|
-~* Formular-Uploads |
57 |
|
-~* Dateien aus dateibereitstellenden Aktionen |
58 |
|
-~* Datei-Ressourcen des Mandanten |
59 |
|
-~* Datei-Ressourcen des Formulars |
60 |
|
-~* Dateien aus externen Quellen |
61 |
|
-~* Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden |
62 |
|
- |
63 |
|
-~=== Rückgabewerte === |
64 |
|
- |
65 |
|
-Wenn Dateien und Metadaten erfolgreich an das ~/~/Nscale~/~/ DMS übermittelt werden konnten, terminiert die Plugin-Aktion normal. |
66 |
|
- |
67 |
|
-Es wird dabei folgende Rückgabewerte durch die Plugin-Aktion zur Verfügung gestellt: |
68 |
|
- |
69 |
|
-Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden: |
70 |
|
- |
71 |
|
-~* AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am ~/~/Nscale~/~/System durchgeführt werden konnte. |
72 |
|
-~* NO_FORM_TYPE: Tritt auf, wenn der ~*~*FormType~*~* zur Laufzeit nicht ermittelt werden konnte. Beispielsweise, wenn dieser aus einem Platzhalter stammt, welcher zur Laufzeit nicht ermittelt werden konnte oder keinen Wert enthielt. |
73 |
|
-~* SERVICE_ERROR: Tritt auf, wenn der ~/~/Nscale~/~/ Webservice einen Fehler zurück lieferte. |
74 |
|
-~* 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 |