... |
... |
@@ -118,6
+118,59 @@ |
118 |
118 |
|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//) |
119 |
119 |
|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//) |
120 |
120 |
|
|
121 |
+=== Allgemeine Rückgabewerte === |
|
122 |
+ |
|
123 |
+{{figure image="plugin_result.png"}} |
|
124 |
+Konfiguration der Rückgabewerte |
|
125 |
+{{/figure}} |
|
126 |
+ |
|
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 |
+ |
|
129 |
+{{code}} |
|
130 |
+ |
|
131 |
+[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] |
|
132 |
+{{/code}} |
|
133 |
+ |
|
134 |
+; ResultCode |
|
135 |
+: Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt. |
|
136 |
+; ResultMessage |
|
137 |
+: Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert. |
|
138 |
+; ResultDocumentID |
|
139 |
+: 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. |
|
140 |
+ |
|
141 |
+{{info}} |
|
142 |
+Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert |
|
143 |
+und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden. |
|
144 |
+{{/info}} |
|
145 |
+ |
|
146 |
+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: |
|
147 |
+ |
|
148 |
+{{code}} |
|
149 |
+ |
|
150 |
+[%$D3DMSUpload.RESULT[2].ResultDocumentID%] |
|
151 |
+{{/code}} |
|
152 |
+ |
|
153 |
+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. |
|
154 |
+Dies kann über den Platzhalter |
|
155 |
+ |
|
156 |
+{{code}} |
|
157 |
+ |
|
158 |
+[%$<Name der Plugin-Aktion>.SUCCESS%] |
|
159 |
+{{/code}} |
|
160 |
+ |
|
161 |
+erfolgen. Dieser liefert "true" zurück, wenn alle Dateien erfolgreich an das DMS übermittelt werden konnten, sonst "false". |
|
162 |
+Der Platzhalter |
|
163 |
+ |
|
164 |
+{{code}} |
|
165 |
+ |
|
166 |
+[%$<Name der Plugin-Aktion>.COUNT%] |
|
167 |
+{{/code}} |
|
168 |
+ |
|
169 |
+wiederum kann genutzt werden, wenn man die Gesamtanzahl der zurückgelieferten Ergebnisse wissen möchte. |
|
170 |
+ |
|
171 |
+Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes: |
|
172 |
+ |
|
173 |
+ |
121 |
121 |
== Globale Plugin-Einstellungen == |
122 |
122 |
|
123 |
123 |
{{info}} |