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"]] 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 :
56
57 == Globale Plugin-Einstellungen ==
58
59 {{info}}
60 Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
61 {{/info}}
62
63 Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden.
64 Die Menüpunkte für die jeweiligen Kontexte sind:
65
66 * **System-Kontext:** System > Systemplugins
67 * **Mandant-Kontext:** Mandant > Plugins
68
69 {{id name="plugin_bundle_props"/}}
70
71 === Konfiguration der Plugin-Bundle Properties ===
72
73 {{figure image="plugin_bundle_config.png"}}
74 Globale Einstellungen am Plugin-Bundle
75 {{/figure}}
76
77 Ü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.
78
79 ==== Einstellungen für die Anbindung des d.3 Webservice ====
80
81 ; dms.webservice.url (Pflichtfeld)
82 : Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
83
84 : **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//**
85
86 : erfolgen.
87 ; dms.webservice.connection.timeout
88 : Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
89 : (Standardwert: //10000,// dies entspricht 10 Sekunden)
90 ; dms.webservice.read.timeout
91 : Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
92 : (Standardwert: //30000, //dies entspricht 30 Sekunden)
93
94 ==== Einstellungen für den verwendeten d.3 Server ====
95
96 ; d3.server.ip (Pflichtfeld)
97 : IP-Adresse des anzubinden d.3 Systems.
98 ; d3.server.port (Pflichtfeld)
99 : Port, über den das anzubindende d.3 System erreichbar ist.
100 ; d3.server.archive (Pflichtfeld)
101 : Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
102 ; d3.server.language (Pflichtfeld)
103 : Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
104 ; d3.server.login (Pflichtfeld)
105 : Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
106
107 {{info}}
108 Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
109 {{/info}}
110
111 ; d3.server.pwd (Pflichtfeld)
112 : Nutzer-Passwort für den Zugriff zum d.3 System.
113 ; d3.user.group
114 : d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
115
116 {{info}}
117 Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
118 Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
119 {{/info}}
120
121 ==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
122
123 ; d3.import.doc.types
124 : Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
125 : Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
126 : Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
127
128 : **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
129
130 : Einzelne Listenwerte sind durch Komma zu trennen.
131 ; d3.initial.docfield.config.doc.type
132 : Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
133 ; d3.initial.docfield.config.mapping
134 : Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
135 : Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
136
137 : Folgende Eigenschaften sind zuzuordnen:
138
139 * Dokumentart
140 * Kuerzel
141 * Datenfeld-Bezeichnung
142 * Datenfeld-Nummer
143 * Datenfeld-Typ
144
145 : Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
146
147 : **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
148
149 : (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)

Navigation

Copyright 2000-2025