Von Version < 17.5 >
bearbeitet von rth
am 19.03.2020, 11:34
Auf Version < 18.12 >
bearbeitet von rth
am 19.03.2020, 13:42
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -59,6 +59,13 @@
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  
62 +; Dokument-Nummer
63 +: An dieser Stelle können Sie eine individuelle Dokumentennummer für die Ablage des Dokuments im d.3 DMS festlegen.
64 +: Wenn bereits ein Dokument mit dieser Nummer im d.3 System existiert, wird versucht das übermittelte Dokument als neue Version im System abzulegen.
65 +
66 +{{info title="Hinweis:"}}
67 +Die Angabe einer Dokument-Nummer ist nur sinnvoll, wenn es sich bei den "zu importierenden Dokumenten" um eine einzelne Datei handelt.
68 +{{/info}}
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/}}
77 +{{/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,59 @@
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  
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 +
114 114  == Globale Plugin-Einstellungen ==
115 115  
116 116  {{info}}
... ... @@ -216,5 +216,4 @@
216 216  
217 217  
218 218  
219 -
220 220  
plugin_result.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +6.4 KB
Inhalt
Copyright 2000-2024