Änderungen von Dokument d.3: DMS-Plugin

Von Version < 10.7 >

bearbeitet von rth
am 18.03.2020, 16:12

Auf Version < 19.1

bearbeitet von gru
am 11.03.2021, 11:08

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (4 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 4 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Titel

@@ -1,1
          +1,1 @@
--d.3 DMS Plugin
++d.3: DMS-Plugin

Übergeordnete Seite

@@ -1,1
          +1,1 @@
--Formcycle.PluginDocumentation.WebHome
++WebHome

Dokument-Autor

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

Inhalt

@@ -1,6
          +1,8 @@
++[[**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)
++
  {{content/}}
--Ü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.
++Ü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.
  == Aktions-Plugin: //d.3 DMS: Dokument importieren// ==
@@ -16,7
          +16,7 @@
  {{/figure}}
  In diesem Bereich besteht die Möglichkeit die global am Plugin-Bundle registrierten Eigenschaften für den anzubindenden d.3 Server und deren Authentifizierungs-Informationen formular-prozess-spezifisch zu übersteuern.
--Wenn für eine Eigenschaft kein Wert festgelegt ist, werden die [[global am Plugin-Bundle hinterlegten Einstellungen>>doc:||anchor="plugin_bundle_props"]] verwendet.
++Wenn für eine Eigenschaft kein Wert festgelegt ist, werden die [[global am Plugin-Bundle hinterlegten Einstellungen>>doc:||anchor="plugin_bundle_props" target="_blank"]] verwendet.
  Es können Platzhalter (Auswahlmöglichkeit über Button [[image:icon_placeholder.png]]) für einzelne Einstellungen verwendet werden.
  ; IP-Adresse
@@ -41,6
          +41,148 @@
  Beachten Sie dabei, dass bei Verwendung von Platzhaltern keine Prüfung der Erreichbarkeit durchgeführt werden kann, da Platzhalter erst zur Ausführungszeit des Plugins mit realen Werten belegt werden.
  {{/info}}
++=== Einstellungen für den DMS Dokumentimport ===
++
++{{figure image="plugin_config_import.png"}}
++Einstellungen für den Dokumentimport ins d.3 DMS
++{{/figure}}
++
++; Zu importierende(s) Dokument(e) (Pflichtfeld)
++: In diesem Auswahlfeld werden alle (datei)-bereitstellenden Aktionen, welche dem Import-Plugin vorangestellt sind, aufgeführt. Die hier getroffene Auswahl bestimmt die Medien (Dokument(e) oder Bild(er)) welches ins d.3 DMS übermittelt werden sollen.
++{{id name="doc_type"/}}
++; Dokument-Typ (Pflichtfeld)
++: In diesem Auswahlfeld werden alle durch den d.3 Systembetreuer definierten und für einen Import aus {{formcycle/}} bestimmten d.3 Objekt-Typen aufgeführt.
++; Dokument Metadaten
++: In dieser Konfigurations-Tabelle werden die Dokument Metadaten zum jeweiligen //d.3 Dokument-Typ// verwaltet. Die Metadaten können dabei manuell durch den Nutzer angelegt oder aus dem d.3 System bezogen werden. Für eine automatische Ermittlung muss im Vorfeld durch einen d.3 Systembetreuer eine entsprechende Definition der Metadaten im d.3 System durchgeführt werden.
++
++{{info title="**Was sind Dokument Metadaten im Zusammenhang mit d.3?**"}}
++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.
++{{/info}}
++
++; Dokument-Nummer
++: An dieser Stelle können Sie eine individuelle Dokumentennummer für die Ablage des Dokuments im d.3 DMS festlegen.
++: Wenn bereits ein Dokument mit dieser Nummer im d.3 System existiert, wird versucht das übermittelte Dokument als neue Version im System abzulegen.
++
++{{info title="Hinweis:"}}
++Die Angabe einer Dokument-Nummer ist nur sinnvoll, wenn es sich bei den "zu importierenden Dokumenten" um eine einzelne Datei handelt.
++{{/info}}
++
++==== Interaktionsmöglichkeiten innerhalb der Konfigurations-Tabelle //Dokument Metadaten// ====
++
++
++Über die Schaltfläche [[image:icon_add.png]] kann ein neues Dokument Metadatum in die Konfigurations-Tabelle eingefügt werden.
++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.
++
++{{info title="Hinweis:"}}
++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.
++{{/info}}
++
++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.
++
++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.
++
++* **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
++* **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
++
++{{id name="metadata_update"/}}
++Ü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.
++Sollte ein Metadatum bereits in der Tabelle existieren, so wird dieses als Pflichtfeld ausgewiesen und kann nicht mehr gelöscht werden.
++Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position, wie ein einzufügendes Feld besitzt.
++
++
++Ü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.
++
++Über den Button [[image:icon_del.png]] wird das selektierte Metadatum aus der Konfigurations-Tabelle entfernt.
++Metadaten, welche aus dem d.3 System als Pflichtfelder ermittelt wurden, können nicht gelöscht werden.
++
++{{id name="metadata_types"/}}
++
++==== Unterstützte Eingabeformate für Datentypen ====
++
++
++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.
++
++(% summary="Unterstützte Eingabeformate für Datentypen" %)
++|=Datentyp|=Erläuterung zum Eingabeformat
++|Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
++|Datum|(((
++Unterstützt werden Datumseingaben der Form **dd.MM.yyyy** (z.B.: //01.01.1970//)
++
++* **dd:** Tag, zweistellig
++* **MM:** Monatsangabe, zweistellig
++* **yyyy:** Jahresangabe, vierstellig
++)))
++|Tabelle|(((
++Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ **Alphanumerisch **unterstützt.
++Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements||target="_blank"]] wird im d.3 System ein Wert hinterlegt.
++)))
++|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
++|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
++
++=== Allgemeine Rückgabewerte ===
++
++{{figure image="plugin_result.png"}}
++Konfiguration der Rückgabewerte
++{{/figure}}
++
++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:
++
++{{code}}
++
++[%$<Name der Plugin-Aktion>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
++{{/code}}
++
++; ResultCode
++: Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt.
++; ResultMessage
++: Enthält eine Klartextmeldung, welche den zurückgelieferten //ResultCode// näher erläutert.
++; ResultDocumentID
++: 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.
++
++{{info}}
++Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
++und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.
++{{/info}}
++
++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:
++
++{{code}}
++
++[%$D3DMSUpload.RESULT[2].ResultDocumentID%]
++{{/code}}
++
++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.
++Dies kann über den Platzhalter
++
++{{code}}
++
++[%$<Name der Plugin-Aktion>.SUCCESS%]
++{{/code}}
++
++erfolgen. Dieser liefert "true" zurück, wenn alle Dateien erfolgreich an das DMS übermittelt werden konnten, sonst "false".
++Der Platzhalter
++
++{{code}}
++
++[%$<Name der Plugin-Aktion>.COUNT%]
++{{/code}}
++
++wiederum kann genutzt werden, wenn man die Gesamtanzahl der zurückgelieferten Ergebnisse wissen möchte.
++
++Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes:
++
++|=Status / Fehlercode|=Bedeutung
++|0|Das Plugin wurde fehlerfrei ausgeführt.
++|10|Die Authentifizierung am d.3 DMS ist fehlgeschlagen, überprüfen Sie bitte die Eigenschaften des anzusprechenden d.3 Servers.
++|20|Der d.3 DMS-Webservice konnte aufgrund fehlender Pflicht-Parameter (//…Name der fehlenden Pflichtparameter…//) nicht aufgerufen werden.
++|21|Fehler beim Einlesen des zu importierenden Dokuments
++|22|Es konnte keine Dokument für einen Import ermittelt werden.
++|23|Folgende Dokument-Metadaten beinhalten fehlerhafte Werte: …//Auflistung der fehlerhaften Werte//
++|24|Fehler beim Erzeugen einer neuen Dokument Version.
++|30|Es konnte keine Verbindung zum d.3 DMS Webservice aufgebaut werden.
++|31|Aufruf einer Webservice-Methode lieferte Fehler: ...//Detaillierte Fehlermeldung aus d.3 System//
++|40|In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten.
++
  == Globale Plugin-Einstellungen ==
  {{info}}
@@ -54,6
          +54,7 @@
  * **Mandant-Kontext:** Mandant > Plugins
  {{id name="plugin_bundle_props"/}}
++
  === Konfiguration der Plugin-Bundle Properties ===
  {{figure image="plugin_bundle_config.png"}}
@@ -64,6
          +64,7 @@
  ==== Einstellungen für die Anbindung des d.3 Webservice ====
++
  ; dms.webservice.url (Pflichtfeld)
  : Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
@@ -79,6
          +79,7 @@
  ==== Einstellungen für den verwendeten d.3 Server ====
++
  ; d3.server.ip (Pflichtfeld)
  : IP-Adresse des anzubinden d.3 Systems.
  ; d3.server.port (Pflichtfeld)
@@ -106,6
          +106,7 @@
  ==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
++
  ; d3.import.doc.types
  : Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
  : Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
@@ -114,8
          +114,14 @@
  : **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
  : Einzelne Listenwerte sind durch Komma zu trennen.
++{{id name="init_docfield_config"/}}
  ; d3.initial.docfield.config.doc.type
--: Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
++: 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.
++
++{{info title="Hinweis für {{formcycle/~}~} Systembetreuer:"}}
++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.
++{{/info}}
++
  ; d3.initial.docfield.config.mapping
  : Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
  : Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
@@ -133,3
          +133,6 @@
  : **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
  : (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
++
++
++

icon_collapse.png

Author

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

Größe

...	...	@@ -1,0 +1,1 @@
	1	+507 bytes

Inhalt

icon_expand.png

Author

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

Größe

...	...	@@ -1,0 +1,1 @@
	1	+598 bytes

Inhalt

plugin_config_import.png

Author

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

Größe

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

Inhalt

plugin_result.png

Author

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

Größe

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

Inhalt

Änderungen von Dokument d.3: DMS-Plugin

Zusammenfassung

Details

Navigation