Änderungen von Dokument d.3: DMS-Plugin

Von Version < 2.5 >
bearbeitet von rth
am 18.03.2020, 12:51
Auf Version < 5.1 >
bearbeitet von rth
am 18.03.2020, 15:25
< >
Änderungskommentar: Neues Bild btn_check.png hochladen

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,9 +1,16 @@
1 -== Plugin-Aktion: d.3 DMS: Dokument importieren ==
1 +{{content/}}
2 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.
3 3  
5 +== Aktions-Plugin: //d.3 DMS: Dokument importieren// ==
4 4  
5 -== Konfiguration des Plugins ==
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.
6 6  
10 +Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
11 +
12 +== Globale Plugin-Einstellungen ==
13 +
7 7  {{info}}
8 8  Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
9 9  {{/info}}
... ... @@ -16,54 +16,76 @@
16 16  
17 17  === Konfiguration der Plugin-Bundle Properties ===
18 18  
19 -|=Property-Key|=Pflichtfeld|=Bedeutung
20 -|(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice//
21 -|dms.webservice.url|ja|Endpoint-URL zum d.3 Webservice
22 -|dms.webservice.connection.timeout|nein|(((
23 -Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
24 -(Standardwert: //10000,// dies entspricht 10 Sekunden)
25 -)))
26 -|dms.webservice.read.timeout|nein|(((
27 -Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
28 -(Standardwert: //30000, //dies entspricht 30 Sekunden)
29 -)))
30 -|(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server//
31 -|d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems.
32 -|d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist.
33 -|d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
34 -|d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
35 -|d3.server.login|ja|(((
36 -Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
26 +{{figure image="plugin_bundle_config.png"}}
27 +Globale Einstellungen am Plugin-Bundle
28 +{{/figure}}
37 37  
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 +
38 38  {{info}}
39 39  Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
40 40  {{/info}}
41 -)))
42 -|d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System.
43 -|d3.user.group|nein|(((
44 -d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
45 45  
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 +
46 46  {{info}}
47 47  Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
48 48  Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
49 49  {{/info}}
50 -)))
51 -|(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"//
52 -|d3.import.doc.types|nein|(((
53 -Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
54 -Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
55 -\\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
56 -\\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...**
57 57  
58 -Einzelne Listenwerte sind durch Komma zu trennen.
59 -)))
60 -|d3.initial.docfield.config.doc.type|nein|Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
61 -|d3.initial.docfield.config.mapping|nein|(((
62 -Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
63 -Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
76 +==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
64 64  
65 -Folgende Eigenschaften sind zuzuordnen:
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:
66 66  
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 +
67 67  * Dokumentart
68 68  * Kuerzel
69 69  * Datenfeld-Bezeichnung
... ... @@ -70,9 +70,10 @@
70 70  * Datenfeld-Nummer
71 71  * Datenfeld-Typ
72 72  
73 -Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
102 +: Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
74 74  
75 -**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...**
104 +{{code}}
105 +<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...
106 +{{/code}}
76 76  
77 -(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
78 -)))
108 +: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
btn_check.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +607 bytes
Inhalt
plugin_bundle_config.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +49.4 KB
Inhalt
plugin_config.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +14.9 KB
Inhalt

Navigation

Copyright 2000-2024