Wiki-Quellcode von d.3 DMS Plugin

Zeige letzte Bearbeiter
1 {{content/}}
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.
4
5 == Aktions-Plugin: //d.3 DMS: Dokument importieren// ==
6
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 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
10 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
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 ; 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}}
69 ==== Interaktionsmöglichkeiten innerhalb der Konfigurations-Tabelle //Dokument Metadaten// ====
70
71
72 Über die Schaltfläche [[image:icon_add.png]] kann ein neues Dokument Metadatum in die Konfigurations-Tabelle eingefügt 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.
74
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}}
78
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
81 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.
82
83 * **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
84 * **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
85
86 {{id name="metadata_update"/}}
87 Ü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.
88 Sollte ein Metadatum bereits in der Tabelle existieren, so wird dieses als Pflichtfeld ausgewiesen und kann nicht mehr gelöscht werden.
89 Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position, wie ein einzufügendes Feld besitzt.
90
91
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
94 Über den Button [[image:icon_del.png]] wird das selektierte Metadatum aus der Konfigurations-Tabelle entfernt.
95 Metadaten, welche aus dem d.3 System als Pflichtfelder ermittelt wurden, können nicht gelöscht werden.
96
97 {{id name="metadata_types"/}}
98
99 ==== Unterstützte Eingabeformate für Datentypen ====
100
101
102 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
104 (% summary="Unterstützte Eingabeformate für Datentypen" %)
105 |=Datentyp|=Erläuterung zum Eingabeformat
106 |Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
107 |Datum|(((
108 Unterstützt werden Datumseingaben der Form **dd.MM.yyyy** (z.B.: //01.01.1970//)
109
110 * **dd:** Tag, zweistellig
111 * **MM:** Monatsangabe, zweistellig
112 * **yyyy:** Jahresangabe, vierstellig
113 )))
114 |Tabelle|(((
115 Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ **Alphanumerisch **unterstützt.
116 Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements||target="_blank"]] wird im d.3 System ein Wert hinterlegt.
117 )))
118 |Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
119 |Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
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 der dritten übertragenen Datei zuzugreifen muss dann beispielsweise folgender Platzhalter benutzt werden: [%$D3DMSUpload.RESULT[2].ResultDocumentID%]
147 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.
148 Dies kann über den Platzhalter [%$<Name der Plugin-Aktion>.SUCCESS%] erfolgen. Dieser liefert „true“ zurück, wenn alle Dateien erfolgreich an das DMS übermittelt werden konnten, sonst „false“.
149 Der Platzhalter [%$<Name der Plugin-Aktion>.COUNT%] wiederrum kann genutzt werden, wenn man die Gesamtanzahl der zurückgelieferten Ergebnisse wissen möchte.
150 Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes:
151
152
153 == Globale Plugin-Einstellungen ==
154
155 {{info}}
156 Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
157 {{/info}}
158
159 Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden.
160 Die Menüpunkte für die jeweiligen Kontexte sind:
161
162 * **System-Kontext:** System > Systemplugins
163 * **Mandant-Kontext:** Mandant > Plugins
164
165 {{id name="plugin_bundle_props"/}}
166
167 === Konfiguration der Plugin-Bundle Properties ===
168
169 {{figure image="plugin_bundle_config.png"}}
170 Globale Einstellungen am Plugin-Bundle
171 {{/figure}}
172
173 Ü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.
174
175 ==== Einstellungen für die Anbindung des d.3 Webservice ====
176
177
178 ; dms.webservice.url (Pflichtfeld)
179 : Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
180
181 : **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//**
182
183 : erfolgen.
184 ; dms.webservice.connection.timeout
185 : Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
186 : (Standardwert: //10000,// dies entspricht 10 Sekunden)
187 ; dms.webservice.read.timeout
188 : Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
189 : (Standardwert: //30000, //dies entspricht 30 Sekunden)
190
191 ==== Einstellungen für den verwendeten d.3 Server ====
192
193
194 ; d3.server.ip (Pflichtfeld)
195 : IP-Adresse des anzubinden d.3 Systems.
196 ; d3.server.port (Pflichtfeld)
197 : Port, über den das anzubindende d.3 System erreichbar ist.
198 ; d3.server.archive (Pflichtfeld)
199 : Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
200 ; d3.server.language (Pflichtfeld)
201 : Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
202 ; d3.server.login (Pflichtfeld)
203 : Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
204
205 {{info}}
206 Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
207 {{/info}}
208
209 ; d3.server.pwd (Pflichtfeld)
210 : Nutzer-Passwort für den Zugriff zum d.3 System.
211 ; d3.user.group
212 : d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
213
214 {{info}}
215 Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
216 Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
217 {{/info}}
218
219 ==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
220
221
222 ; d3.import.doc.types
223 : Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
224 : Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
225 : Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
226
227 : **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
228
229 : Einzelne Listenwerte sind durch Komma zu trennen.
230 {{id name="init_docfield_config"/}}
231 ; d3.initial.docfield.config.doc.type
232 : 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.
233
234 {{info title="Hinweis für {{formcycle/~}~} Systembetreuer:"}}
235 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.
236 {{/info}}
237
238 ; d3.initial.docfield.config.mapping
239 : Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
240 : Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
241
242 : Folgende Eigenschaften sind zuzuordnen:
243
244 * Dokumentart
245 * Kuerzel
246 * Datenfeld-Bezeichnung
247 * Datenfeld-Nummer
248 * Datenfeld-Typ
249
250 : Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
251
252 : **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
253
254 : (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
255
256
257
258

Navigation

Copyright 2000-2025