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