... |
... |
@@ -1,6
+1,8 @@ |
|
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 |
|
-Ü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. |
|
5 |
+Über das kostenpflichtige 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. |
4 |
4 |
|
5 |
5 |
== Aktions-Plugin: //d.3 DMS: Dokument importieren// == |
6 |
6 |
|
... |
... |
@@ -66,6
+66,7 @@ |
66 |
66 |
{{info title="Hinweis:"}} |
67 |
67 |
Die Angabe einer Dokument-Nummer ist nur sinnvoll, wenn es sich bei den "zu importierenden Dokumenten" um eine einzelne Datei handelt. |
68 |
68 |
{{/info}} |
|
71 |
+ |
69 |
69 |
==== Interaktionsmöglichkeiten innerhalb der Konfigurations-Tabelle //Dokument Metadaten// ==== |
70 |
70 |
|
71 |
71 |
|
... |
... |
@@ -127,9
+127,61 @@ |
127 |
127 |
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: |
128 |
128 |
|
129 |
129 |
{{code}} |
130 |
|
-\[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] |
|
133 |
+ |
|
134 |
+[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] |
131 |
131 |
{{/code}} |
132 |
132 |
|
|
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 |
+ |
133 |
133 |
== Globale Plugin-Einstellungen == |
134 |
134 |
|
135 |
135 |
{{info}} |
... |
... |
@@ -234,5
+234,4 @@ |
234 |
234 |
: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
235 |
235 |
|
236 |
236 |
|
237 |
|
- |
238 |
238 |
|