| ... |
... |
@@ -1,3
+1,5 @@ |
|
1 |
+[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-d3&fileid=2596||target="_blank"]] (erfordert Anmeldung) |
|
2 |
+ |
| 1 |
1 |
{{content/}} |
| 2 |
2 |
|
| 3 |
3 |
Über das d.3 DMS (**D**okumenten **M**angement **S**ystem) Plugin ist es möglich Dokumente aus {{formcycle/}} an das d.3 DMS zu übermitteln. Das Plugin nutzt dafür die vom d.3 System bereitgestellte [[SOAP>>https://de.wikipedia.org/wiki/SOAP||rel="noopener noreferrer" target="_blank" title="Simple Object Access Protocol"]]-Webservice Schnittstelle. |
| ... |
... |
@@ -59,6
+59,14 @@ |
| 59 |
59 |
Mit der Definition von Dokument-Typen im d.3 DMS ist meist die Definition von zusätzlichen Eigenschaften an diesen Objekten (sogenannten Metadaten) verbunden. Diese Metadaten werden im d.3 System benötigt um verschiedene Prozesse zu steuern (z.B.: interne Verarbeitung, Suche, Verschlagwortung von Objekten etc.). Ein Teil dieser Metadaten muss bereits beim Neuanlegen von Objekten bekannt sein, weshalb sich an dieser Stelle die Notwendigkeit zur Definition der Metadaten in der {{formcycle/}} Oberfläche erklärt. |
| 60 |
60 |
{{/info}} |
| 61 |
61 |
|
|
64 |
+; Dokument-Nummer |
|
65 |
+: An dieser Stelle können Sie eine individuelle Dokumentennummer für die Ablage des Dokuments im d.3 DMS festlegen. |
|
66 |
+: Wenn bereits ein Dokument mit dieser Nummer im d.3 System existiert, wird versucht das übermittelte Dokument als neue Version im System abzulegen. |
|
67 |
+ |
|
68 |
+{{info title="Hinweis:"}} |
|
69 |
+Die Angabe einer Dokument-Nummer ist nur sinnvoll, wenn es sich bei den "zu importierenden Dokumenten" um eine einzelne Datei handelt. |
|
70 |
+{{/info}} |
|
71 |
+ |
| 62 |
62 |
==== Interaktionsmöglichkeiten innerhalb der Konfigurations-Tabelle //Dokument Metadaten// ==== |
| 63 |
63 |
|
| 64 |
64 |
|
| ... |
... |
@@ -67,7
+67,7 @@ |
| 67 |
67 |
|
| 68 |
68 |
{{info title="Hinweis:"}} |
| 69 |
69 |
Die auswählbaren Datenfeld-Nummern ergeben sich aus dem gewählten Datentyp, sowie aus den noch verfügbaren Nummern. Wenn sie Metadaten manuell anlegen, fragen sie gegebenenfalls ihren d.3 Systembetreuer, welche Datentypen und Datenfeldnummern sie verwenden müssen, damit die übermittelten Metadaten ordnungsgemäß im d.3 System verarbeitet werden können. |
| 70 |
|
-{{info/}} |
|
80 |
+{{/info}} |
| 71 |
71 |
|
| 72 |
72 |
Die zu übertragenen Werte, die den einzelnen Metadaten zugeordnet werden, können dabei über die {{formcycle/}}-[[Platzhalter>>doc:Formcycle.UserInterface.Variables||target="_blank"]]-Logik [[image:icon_placeholder.png]] oder als fest vorgegeben Werte hinterlegt werden. Zu beachten ist dabei, dass der übergebene Wert dem vorgegebenen Datentyp entspricht. Die Tabelle //[[Unterstützte Eingabeformate für Datentypen>>doc:||anchor="metadata_types"]]// listet die verfügbaren Datentypen und deren Eingabeformate auf. |
| 73 |
73 |
|
| ... |
... |
@@ -111,6
+111,70 @@ |
| 111 |
111 |
|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//) |
| 112 |
112 |
|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//) |
| 113 |
113 |
|
|
124 |
+=== Allgemeine Rückgabewerte === |
|
125 |
+ |
|
126 |
+{{figure image="plugin_result.png"}} |
|
127 |
+Konfiguration der Rückgabewerte |
|
128 |
+{{/figure}} |
|
129 |
+ |
|
130 |
+In diesem Bereich werden die vom Plugin als Ergebnis des DMS Datei-Upload Prozesses zurückgelieferten Parameter aufgeführt. Für die einzelnen Parameter kann ein Alias vergeben werden. In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. Der Platzhalter wird dabei nach dem folgenden Muster gebildet: |
|
131 |
+ |
|
132 |
+{{code}} |
|
133 |
+ |
|
134 |
+[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] |
|
135 |
+{{/code}} |
|
136 |
+ |
|
137 |
+; ResultCode |
|
138 |
+: Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. |
|
139 |
+; ResultMessage |
|
140 |
+: Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. |
|
141 |
+; ResultDocumentID |
|
142 |
+: Enthält die vom d.3 System zurückgelieferte Dokument-ID, wenn das Dokument erfolgreich im d.3 System abgelegt werden konnte, sonst den Wert -1. |
|
143 |
+ |
|
144 |
+{{info}} |
|
145 |
+Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert |
|
146 |
+und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden. |
|
147 |
+{{/info}} |
|
148 |
+ |
|
149 |
+Wenn mehrere Dateien gleichzeitig an das DMS übertragen werden, so wird für jede Datei ein entsprechender //ResultCode//, //ResultMessage// und //ResultDocumentID// zurückgeliefert. Um auf die //ResultDocumentID// (einer Plugin-Aktion mit Namen "D3DMSUpload") der dritten übertragenen Datei zuzugreifen muss dann beispielsweise folgender Platzhalter benutzt werden: |
|
150 |
+ |
|
151 |
+{{code}} |
|
152 |
+ |
|
153 |
+[%$D3DMSUpload.RESULT[2].ResultDocumentID%] |
|
154 |
+{{/code}} |
|
155 |
+ |
|
156 |
+Bei gleichzeitiger Übertragung mehrerer Dateien ist es manchmal sinnvoll den Gesamtstatus zu erfragen, um beispielsweise zu wissen, ob ein Fehler beim Import einer Datei aufgetreten ist. |
|
157 |
+Dies kann über den Platzhalter |
|
158 |
+ |
|
159 |
+{{code}} |
|
160 |
+ |
|
161 |
+[%$<Name der Plugin-Aktion>.SUCCESS%] |
|
162 |
+{{/code}} |
|
163 |
+ |
|
164 |
+erfolgen. Dieser liefert "true" zurück, wenn alle Dateien erfolgreich an das DMS übermittelt werden konnten, sonst "false". |
|
165 |
+Der Platzhalter |
|
166 |
+ |
|
167 |
+{{code}} |
|
168 |
+ |
|
169 |
+[%$<Name der Plugin-Aktion>.COUNT%] |
|
170 |
+{{/code}} |
|
171 |
+ |
|
172 |
+wiederum kann genutzt werden, wenn man die Gesamtanzahl der zurückgelieferten Ergebnisse wissen möchte. |
|
173 |
+ |
|
174 |
+Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes: |
|
175 |
+ |
|
176 |
+|=Status / Fehlercode|=Bedeutung |
|
177 |
+|0|Das Plugin wurde fehlerfrei ausgeführt. |
|
178 |
+|10|Die Authentifizierung am d.3 DMS ist fehlgeschlagen, überprüfen Sie bitte die Eigenschaften des anzusprechenden d.3 Servers. |
|
179 |
+|20|Der d.3 DMS-Webservice konnte aufgrund fehlender Pflicht-Parameter (//…Name der fehlenden Pflichtparameter…//) nicht aufgerufen werden. |
|
180 |
+|21|Fehler beim Einlesen des zu importierenden Dokuments |
|
181 |
+|22|Es konnte keine Dokument für einen Import ermittelt werden. |
|
182 |
+|23|Folgende Dokument-Metadaten beinhalten fehlerhafte Werte: …//Auflistung der fehlerhaften Werte// |
|
183 |
+|24|Fehler beim Erzeugen einer neuen Dokument Version. |
|
184 |
+|30|Es konnte keine Verbindung zum d.3 DMS Webservice aufgebaut werden. |
|
185 |
+|31|Aufruf einer Webservice-Methode lieferte Fehler: ...//Detaillierte Fehlermeldung aus d.3 System// |
|
186 |
+|40|In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten. |
|
187 |
+ |
| 114 |
114 |
== Globale Plugin-Einstellungen == |
| 115 |
115 |
|
| 116 |
116 |
{{info}} |
| ... |
... |
@@ -215,6
+215,4 @@ |
| 215 |
215 |
: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
| 216 |
216 |
|
| 217 |
217 |
|
| 218 |
|
- |
| 219 |
|
- |
| 220 |
220 |
|