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