Von Version < 17.3 >
bearbeitet von rth
am 19.03.2020, 11:11
Auf Version < 2.8 >
bearbeitet von rth
am 18.03.2020, 13:30
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,6 +1,6 @@
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.
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.
4 4  
5 5  == Aktions-Plugin: //d.3 DMS: Dokument importieren// ==
6 6  
... ... @@ -7,106 +7,8 @@
7 7  Für die Übermittlung von Dokumenten an das d.3 System steht das Aktions-Plugin **d.3 DMS: Dokument importieren** zur Verfügung. 
8 8  Dieses ermöglicht es, Dateien, welche über eine [[(Datei-)bereitstellende Aktion>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome||target="_blank"]] in der Statusverarbeitung verfügbar sind, in ein d.3 DMS zu überführen.
9 9  
10 -Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
10 +Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
11 11  
12 -=== Globale d.3 Server-Konfiguration übersteuern ===
13 -
14 -{{figure image="plugin_config.png"}}
15 -Einstellungen zum Übersteuern der global definierten Verbindungsparameter
16 -{{/figure}}
17 -
18 -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.
19 -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.
20 -Es können Platzhalter (Auswahlmöglichkeit über Button [[image:icon_placeholder.png]]) für einzelne Einstellungen verwendet werden.
21 -
22 -; IP-Adresse
23 -: IP-Adresse, unter welcher der d.3 Server erreichbar ist
24 -; Port
25 -: Port, unter dem der d.3 Servers angesprochen werden kann
26 -; Archiv
27 -: Kürzel für das genutzte Archiv auf dem d.3 Server
28 -; Sprache
29 -: Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
30 -; Nutzer
31 -: Nutzer-Account für den Zugriff auf den d.3 Server
32 -; Passwort
33 -: Das zum Nutzer-Account zugehörige Passwort
34 -; Nutzergruppe
35 -: Nutzerguppe der der Nutzer angehört. Diese Angabe wird **zwingend** benötigt, wenn von einem Dokument eine neue Version erzeugt werden soll.
36 -; Endpoint URL
37 -: Endpoint-URL zum angebundenen d.3 Server.
38 -
39 -{{info}}
40 -Über den [[image:btn_check.png]]-Button kann die Erreichbarkeit des d.3 Systems geprüft werden.
41 -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.
42 -{{/info}}
43 -
44 -=== Einstellungen für den DMS Dokumentimport ===
45 -
46 -{{figure image="plugin_config_import.png"}}
47 -Einstellungen für den Dokumentimport ins d.3 DMS
48 -{{/figure}}
49 -
50 -; Zu importierende(s) Dokument(e) (Pflichtfeld)
51 -: 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.
52 -{{id name="doc_type"/}}
53 -; Dokument-Typ (Pflichtfeld)
54 -: 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.
55 -; Dokument Metadaten
56 -: 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.
57 -
58 -{{info title="**Was sind Dokument Metadaten im Zusammenhang mit d.3?**"}}
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 -{{/info}}
61 -
62 -==== Interaktionsmöglichkeiten für Konfigurations-Tabelle //Dokument Metadaten// ====
63 -
64 -
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.
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.
69 -
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 -
72 -* **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
73 -* **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
74 -
75 -{{id name="metadata_update"/}}
76 -Ü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.
77 -Sollte ein Metadatum bereits in der Tabelle existieren, so wird dieses als Pflichtfeld ausgewiesen und kann nicht mehr gelöscht werden.
78 -Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position, wie ein einzufügendes Feld besitzt.
79 -
80 -
81 -Ü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.
82 -
83 -Über den Button [[image:icon_del.png]] wird das selektierte Metadatum aus der Konfigurations-Tabelle entfernt.
84 -Metadaten, welche aus dem d.3 System als Pflichtfelder ermittelt wurden, können nicht gelöscht werden.
85 -
86 -{{id name="metadata_types"/}}
87 -
88 -==== Unterstützte Eingabeformate für Datentypen ====
89 -
90 -
91 -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.
92 -
93 -(% summary="Unterstützte Eingabeformate für Datentypen" %)
94 -|=Datentyp|=Erläuterung zum Eingabeformat
95 -|Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
96 -|Datum|(((
97 -Unterstützt werden Datumseingaben der Form **dd.MM.yyyy** (z.B.: //01.01.1970//)
98 -
99 -* **dd:** Tag, zweistellig
100 -* **MM:** Monatsangabe, zweistellig
101 -* **yyyy:** Jahresangabe, vierstellig
102 -)))
103 -|Tabelle|(((
104 -Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ **Alphanumerisch **unterstützt.
105 -Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements||target="_blank"]] wird im d.3 System ein Wert hinterlegt.
106 -)))
107 -|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
108 -|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
109 -
110 110  == Globale Plugin-Einstellungen ==
111 111  
112 112  {{info}}
... ... @@ -119,85 +119,58 @@
119 119  * **System-Kontext:** System > Systemplugins
120 120  * **Mandant-Kontext:** Mandant > Plugins
121 121  
122 -{{id name="plugin_bundle_props"/}}
123 -
124 124  === Konfiguration der Plugin-Bundle Properties ===
125 125  
126 -{{figure image="plugin_bundle_config.png"}}
127 -Globale Einstellungen am Plugin-Bundle
128 -{{/figure}}
129 -
130 130  Über die nachfolgend beschriebenen Einstellungen wird das Plugin ein d.3 System angeschlossen. Die Verbindung erfolgt dabei über einen SOAP-Webservice, welcher vom d.3 System zu Verfügung gestellt wird.
131 131  
132 -==== Einstellungen für die Anbindung des d.3 Webservice ====
28 +|=Property-Key|=Pflichtfeld|=Bedeutung
29 +|(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice//
30 +|dms.webservice.url|ja|Endpoint-URL zum d.3 SOAP-Webservice
31 +|dms.webservice.connection.timeout|nein|(((
32 +Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
33 +(Standardwert: //10000,// dies entspricht 10 Sekunden)
34 +)))
35 +|dms.webservice.read.timeout|nein|(((
36 +Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
37 +(Standardwert: //30000, //dies entspricht 30 Sekunden)
38 +)))
39 +|(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server//
40 +|d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems.
41 +|d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist.
42 +|d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
43 +|d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
44 +|d3.server.login|ja|(((
45 +Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
133 133  
134 -
135 -; dms.webservice.url (Pflichtfeld)
136 -: Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
137 -
138 -: **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//**
139 -
140 -: erfolgen.
141 -; dms.webservice.connection.timeout
142 -: Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
143 -: (Standardwert: //10000,// dies entspricht 10 Sekunden)
144 -; dms.webservice.read.timeout
145 -: Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
146 -: (Standardwert: //30000, //dies entspricht 30 Sekunden)
147 -
148 -==== Einstellungen für den verwendeten d.3 Server ====
149 -
150 -
151 -; d3.server.ip (Pflichtfeld)
152 -: IP-Adresse des anzubinden d.3 Systems.
153 -; d3.server.port (Pflichtfeld)
154 -: Port, über den das anzubindende d.3 System erreichbar ist.
155 -; d3.server.archive (Pflichtfeld)
156 -: Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
157 -; d3.server.language (Pflichtfeld)
158 -: Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
159 -; d3.server.login (Pflichtfeld)
160 -: Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
161 -
162 162  {{info}}
163 163  Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
164 164  {{/info}}
50 +)))
51 +|d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System.
52 +|d3.user.group|nein|(((
53 +d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
165 165  
166 -; d3.server.pwd (Pflichtfeld)
167 -: Nutzer-Passwort für den Zugriff zum d.3 System.
168 -; d3.user.group
169 -: d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
170 -
171 171  {{info}}
172 172  Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
173 173  Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
174 174  {{/info}}
59 +)))
60 +|(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"//
61 +|d3.import.doc.types|nein|(((
62 +Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
63 +Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
64 +\\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
65 +\\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...**
175 175  
176 -==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
67 +Einzelne Listenwerte sind durch Komma zu trennen.
68 +)))
69 +|d3.initial.docfield.config.doc.type|nein|Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
70 +|d3.initial.docfield.config.mapping|nein|(((
71 +Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
72 +Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
177 177  
74 +Folgende Eigenschaften sind zuzuordnen:
178 178  
179 -; d3.import.doc.types
180 -: Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
181 -: Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
182 -: Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
183 -
184 -: **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
185 -
186 -: Einzelne Listenwerte sind durch Komma zu trennen.
187 -{{id name="init_docfield_config"/}}
188 -; d3.initial.docfield.config.doc.type
189 -: 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.
190 -
191 -{{info title="Hinweis für {{formcycle/~}~} Systembetreuer:"}}
192 -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.
193 -{{/info}}
194 -
195 -; d3.initial.docfield.config.mapping
196 -: Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
197 -: Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
198 -
199 -: Folgende Eigenschaften sind zuzuordnen:
200 -
201 201  * Dokumentart
202 202  * Kuerzel
203 203  * Datenfeld-Bezeichnung
... ... @@ -204,13 +204,9 @@
204 204  * Datenfeld-Nummer
205 205  * Datenfeld-Typ
206 206  
207 -: Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
208 -
209 -: **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
210 -
211 -: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
82 +Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
212 212  
84 +**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...**
213 213  
214 -
215 -
216 -
86 +(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
87 +)))
btn_check.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -607 bytes
Inhalt
icon_add.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -239 bytes
Inhalt
icon_collapse.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -507 bytes
Inhalt
icon_copy.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -414 bytes
Inhalt
icon_del.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -330 bytes
Inhalt
icon_expand.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -598 bytes
Inhalt
icon_placeholder.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -448 bytes
Inhalt
icon_update.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -462 bytes
Inhalt
plugin_bundle_config.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -49.4 KB
Inhalt
plugin_config.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -14.9 KB
Inhalt
plugin_config_import.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -54.8 KB
Inhalt
Copyright 2000-2024