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

Navigation

Copyright 2000-2025