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 ; Dokument-Typ (Pflichtfeld)
53 : 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.
54 ; Dokument Metadaten
55 : In dieser Liste werden die Dokument Metadaten zum jeweiligen d.3 //Dokument-Typ// verwaltet. Die Dokument Metadaten können dabei manuell durch den Nutzer angelegt oder aus dem d.3 System ermittelt werden. Dafür muss im Vorfeld durch einen d.3 Systembetreuer eine entsprechende Möglichkeit dazu getroffen werden.
56 : Die 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// listet die verfügbaren Datentypen und deren Eingabeformate auf.
57
58 {{info title="**Weiterführende Erläuterungen:**"}}
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 * **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
63 * **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
64
65 : 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.
66
67 ==== Unterstützte Eingabeformate für Datentypen ====
68
69 (% summary="Unterstützte Eingabeformate für Datentypen" %)
70 |=Datentyp|=Erläuterung zum Eingabeformat
71 |Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
72 |Datum|(((
73 Unterstützt werden Datumseingaben der Form **dd.MM.yyyy** (z.B.: //01.01.1970//)
74
75 * **dd:** Tag, zweistellig
76 * **MM:** Monatsangabe, zweistellig
77 * **yyyy:** Jahresangabe, vierstellig
78 )))
79 |Tabelle|(((
80 Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ **Alphanumerisch **unterstützt.
81 Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements||target="_blank"]] wird im d.3 System ein Wert hinterlegt.
82 )))
83 |Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
84 |Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
85
86 == Globale Plugin-Einstellungen ==
87
88 {{info}}
89 Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
90 {{/info}}
91
92 Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden.
93 Die Menüpunkte für die jeweiligen Kontexte sind:
94
95 * **System-Kontext:** System > Systemplugins
96 * **Mandant-Kontext:** Mandant > Plugins
97
98 {{id name="plugin_bundle_props"/}}
99
100 === Konfiguration der Plugin-Bundle Properties ===
101
102 {{figure image="plugin_bundle_config.png"}}
103 Globale Einstellungen am Plugin-Bundle
104 {{/figure}}
105
106 Ü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.
107
108 ==== Einstellungen für die Anbindung des d.3 Webservice ====
109
110 ; dms.webservice.url (Pflichtfeld)
111 : Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
112
113 : **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//**
114
115 : erfolgen.
116 ; dms.webservice.connection.timeout
117 : Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
118 : (Standardwert: //10000,// dies entspricht 10 Sekunden)
119 ; dms.webservice.read.timeout
120 : Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
121 : (Standardwert: //30000, //dies entspricht 30 Sekunden)
122
123 ==== Einstellungen für den verwendeten d.3 Server ====
124
125 ; d3.server.ip (Pflichtfeld)
126 : IP-Adresse des anzubinden d.3 Systems.
127 ; d3.server.port (Pflichtfeld)
128 : Port, über den das anzubindende d.3 System erreichbar ist.
129 ; d3.server.archive (Pflichtfeld)
130 : Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
131 ; d3.server.language (Pflichtfeld)
132 : Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
133 ; d3.server.login (Pflichtfeld)
134 : Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
135
136 {{info}}
137 Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
138 {{/info}}
139
140 ; d3.server.pwd (Pflichtfeld)
141 : Nutzer-Passwort für den Zugriff zum d.3 System.
142 ; d3.user.group
143 : d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
144
145 {{info}}
146 Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
147 Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
148 {{/info}}
149
150 ==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
151
152 ; d3.import.doc.types
153 : Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
154 : Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
155 : Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
156
157 : **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
158
159 : Einzelne Listenwerte sind durch Komma zu trennen.
160 ; d3.initial.docfield.config.doc.type
161 : Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
162 ; d3.initial.docfield.config.mapping
163 : Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
164 : Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
165
166 : Folgende Eigenschaften sind zuzuordnen:
167
168 * Dokumentart
169 * Kuerzel
170 * Datenfeld-Bezeichnung
171 * Datenfeld-Nummer
172 * Datenfeld-Typ
173
174 : Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
175
176 : **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
177
178 : (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
179
180
181
182
183
184

Navigation

Copyright 2000-2025