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