| ... |
... |
@@ -3,7 +3,7 @@ |
| 3 |
3 |
Über das kostenpflichtige //ceyoniq// Plugin ist es möglich das //Nscale// DMS System an {{formcycle/}} anzubinden. |
| 4 |
4 |
|
| 5 |
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. |
|
6 |
+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. |
| 7 |
7 |
{{/info}} |
| 8 |
8 |
|
| 9 |
9 |
Die Installation erfolgt unter Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins]]. |
| ... |
... |
@@ -44,8 +44,8 @@ |
| 44 |
44 |
|
| 45 |
45 |
== Aktions-Plugin //Nscale Upload// == |
| 46 |
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. |
|
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 |
49 |
Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden. |
| 50 |
50 |
|
| 51 |
51 |
=== Nscale System Konfiguration === |
| ... |
... |
@@ -55,22 +55,28 @@ |
| 55 |
55 |
{{/figure}} |
| 56 |
56 |
|
| 57 |
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. |
|
58 |
+Beispielkonfiguration zum Ermitteln eines Ablageordners aus dem Nscale-System zur Laufzeit. In den Abfrage-Werten können Platzhalter verwendet werden. |
| 59 |
59 |
{{/figure}} |
| 60 |
60 |
|
| 61 |
61 |
In diesem Bereich wird die Festlegung für den Datei-Ablageordner im //Nscale //System getroffen. |
| 62 |
|
-Dies erfolgt in drei Schritten |
|
62 |
+Dies geschieht in folgenden Schritten: |
| 63 |
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. |
|
64 |
+* Festlegung eines **DocArea Name**, welche den Zielablageordner beinhaltet muss. |
|
65 |
+Die Werte innerhalb der DocArea-Auswahlliste werden automatisch beim der Anzeige der Workflow-Aktions-Eigenschaften ermittelt. |
|
66 |
+Sollte keine Verbindung zum konfigurierten //Nscale //System möglich sein, erscheint eine entsprechende Fehlermeldung. |
|
67 |
+ |
|
68 |
+* 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. |
|
69 |
+ |
|
70 |
+* Ist "**Ablageordner per Nscale-Abfrage festlegen?**" nicht ausgewählt, so ist der //Nscale //Ablageordner aus dem Feld **Ablageordner **auszuwählen. |
|
71 |
+Das Auswahlfeld wird automatisch bei der Festlegung der DocArea befüllt. |
|
72 |
+ |
|
73 |
+* Ist "**Ablageordner per Nscale-Abfrage festlegen?"** ausgewählt, so erscheint automatisch eine Tabelle für die Auswahl der **Suchparameter für Nscale Ablageordner**. |
|
74 |
+Diese Tabelle dient der Definition von Suchparametern zum Ausfinden eines konkreten //Nscale //Ablageordners zum Ausführungszeit der Plugin-Aktion. |
| 70 |
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 |
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. |
|
77 |
+Ein Klick auf den **Ablageordner suchen** Button führt eine Suche im //Nscale //System mit den definierten Parameter durch. |
|
78 |
+Damit lässt sich im Vorfeld ermitteln, ob zur Laufzeit auch ein Ordner aus dem //Nscale //System ermittelt werden kann. |
|
79 |
+\\{{info}}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.{{/info}} |
| 74 |
74 |
|
| 75 |
75 |
=== Daten für die Übermittlung an das DMS === |
| 76 |
76 |
|
| ... |
... |
@@ -95,15 +95,24 @@ |
| 95 |
95 |
|
| 96 |
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 |
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 |
|
104 |
+* **Ressourcen Zähler **(//[%$<Name der Aktion>.RESULT.resourceCount%]//): Anzahl der erfolgreich übermittelten Dateien |
|
105 |
+* **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. |
|
106 |
+** **Id **(//[%$<Name der Aktion>.RESULT.resources[i].id%]//): Id der hinzugefügten Ressource aus dem //Nscale// System |
|
107 |
+** **DisplayName **(//[%$<Name der Aktion>.RESULT.resources[i].displayName%]//): Name der hinzugefügten Ressource |
|
108 |
+* **Folder-Id **(//[%$<Name der Aktion>.RESULT.folder.id%]//): Id des //Nscale //Ordners, in den die übermittelte Ressource abgelegt wurde |
|
109 |
+* **Folder-DisplayName **(//[%$<Name der Aktion>.RESULT.folder.displayName%]//): Name des //Nscale //Ordners, in den die übermittelte Ressource abgelegt wurde |
| 101 |
101 |
|
| 102 |
102 |
Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden: |
| 103 |
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. |
|
113 |
+* **AUTHORIZATION_FAILED**: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am //Nscale //System durchgeführt werden konnte. |
|
114 |
+* **NO_PAYLOAD_DATA**: Tritt auf, wenn zur Laufzeit keine Daten (Metadaten, Dateien) ermittelt werden konnten, die an den angebundenen //Nscale //Service übermittelt werden sollen. |
|
115 |
+* **NO_TARGET_FOLDER**: Wenn kein Zielverzeichnis im //Nscale //System für die Ablage von Dateien definiert wurde. |
|
116 |
+* **SRV_CONNECTION_ERROR**: Tritt auf, wenn keine Verbindung zum angebundenen //Nscale //System aufgebaut werden kann |
|
117 |
+* **SRV_METHOD_ERROR**: Tritt auf, wenn der //Nscale// Webservice-Methode einen Fehler zurück lieferte. |
|
118 |
+* **INTERNAL_ERROR**: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde. |
|
119 |
+ |
|
120 |
+== Versionshistorie == |
|
121 |
+ |
|
122 |
+=== 1.2.0 === |
|
123 |
+ |
|
124 |
+* Initiale Version der Nscale-Anbindung |
