Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
  • plugin_result.png

Details

Seiteneigenschaften

Inhalt

...	...	@@ -59,20 +59,30 @@
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		-==== Interaktionsmöglichkeiten für Konfigurations-Tabelle //Dokument Metadaten// ====
	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.
63	63
	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}}
	69	+==== Interaktionsmöglichkeiten innerhalb der Konfigurations-Tabelle //Dokument Metadaten// ====
64	64
	71	+
65	65	Über die Schaltfläche [[image:icon_add.png]] kann ein neues Dokument Metadatum in die Konfigurations-Tabelle eingefügt werden.
66		-Anschließend muss für dieses Metadatum der Datentyp, der mit dem Metadatum zu übertragene Wert und gegebenenfalls eine Bedeutung (dient als Erläuterung) definiert werden.
	73	+Anschließend muss für dieses Metadatum der Datentyp, Datenfeldnummer und der mit dem Metadatum zu übertragene Wert und gegebenenfalls eine Bezeichnung (dient als Erläuterung) definiert werden.
67	67
68		-Die zu übertragenen Werte, die den einzelnen Metadaten zugeordnet werden, können dabei über die {{formcycle/}}-[[Platzhalter>>doc:Formcycle.UserInterface.Variables||target="_blank"]]-Logik 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.
	75	+{{info title="Hinweis:"}}
	76	+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.
	77	+{{/info}}
69	69
	79	+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.
	80	+
70	70	Zusätzlich zu den in {{formcycle/}} standardmäßig vorhandenen Platzhaltern gibt es die nachfolgend aufgeführten Platzhalter, die nur in diesem Plugin verwendet werden können. Diese Platzhalter sind dafür gedacht, auf spezielle Dateieigenschaften einzelner Dateien zuzugreifen, wenn durch das Feld //Zu importierende(s) Dokument(e)// **mehrere** Dateien gleichzeitig ins DMS überführt werden.
71	71
72	72	* **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
73	73	* **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
74	74
75		-
76	76	{{id name="metadata_update"/}}
77	77	Über die Schaltfläche [[image:icon_update.png]] können, anhand des ausgewählten Dokument-Typs (oder einer [[initialen Vorgabe>>doc:||anchor="init_docfield_config"]]), Metadaten aus dem d.3 System ermittelt und in die Konfigurations-Tabelle eingefügt werden.
78	78	Sollte ein Metadatum bereits in der Tabelle existieren, so wird dieses als Pflichtfeld ausgewiesen und kann nicht mehr gelöscht werden.
...	...	@@ -79,14 +79,18 @@
79	79	Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position, wie ein einzufügendes Feld besitzt.
80	80
81	81
	92	+Über die Schaltfläche [[image:icon_collapse.png]] kann man sich Metadaten-Details wie Datenfeld-Bezeichnung und Datenfeldnummer einblenden lassen. Mittels [[image:icon_expand.png]] Button lassen sich die Details anschließend wieder ausblenden.
	93	+
82	82	Über den Button [[image:icon_del.png]] wird das selektierte Metadatum aus der Konfigurations-Tabelle entfernt.
83	83	Metadaten, welche aus dem d.3 System als Pflichtfelder ermittelt wurden, können nicht gelöscht werden.
84	84
85	85	{{id name="metadata_types"/}}
	98	+
86	86	==== Unterstützte Eingabeformate für Datentypen ====
87	87
88	88
89	89	Die nachfolgende Tabelle listet alle Datentypen, welche für die Ablage von Metadaten im d.3 System zur Auswahl stehen und deren gefordertes Eingabeformat, auf.
	103	+
90	90	(% summary="Unterstützte Eingabeformate für Datentypen" %)
91	91	|=Datentyp|=Erläuterung zum Eingabeformat
92	92	|Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
...	...	@@ -104,6 +104,59 @@
104	104	|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
105	105	|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
106	106
	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	+
107	107	== Globale Plugin-Einstellungen ==
108	108
109	109	{{info}}
...	...	@@ -185,7 +185,7 @@
185	185	; d3.initial.docfield.config.doc.type
186	186	: Definiert ein //d.3 Dokument-Typ//-Kürzel, welches Definitionen für eine automatisierte Erstellung von //[[Dokument Metadaten>>doc:||anchor="metadata_update"]]// Feldern enthält.
187	187
188		-{{info title="Hinweis für {{formcycle/}} Systembetreuer:"}}
	255	+{{info title="Hinweis für {{formcycle/~}~} Systembetreuer:"}}
189	189	Wurde für diese Plugin-Einstellung **kein** Wert hinterlegt, greift bei der automatisierten Metadaten Ermittlung im [[Aktions-Plugin>>doc:||anchor="metadata_update"]] eine Rückfall-Logik welche untersucht, ob am gewählten [[Dokument-Typ>>doc:||anchor="doc_type"]], innerhalb des d.3 Systems, Pflichtfelder (sogenannte "DocFields") definiert sind. Ist dies der Fall, werden diese als Metadaten in die Konfigurations-Tabelle übernommen.
190	190	{{/info}}
191	191
...	...	@@ -209,6 +209,4 @@
209	209
210	210
211	211
212		-
213		-
214	214

plugin_result.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.rth

Größe

...	...	@@ -1,0 +1,1 @@
	1	+6.4 KB

Inhalt