| ... |
... |
@@ -1,10
+1,49 @@ |
| 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 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 |
+ |
| 7 |
7 |
{{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}} |
| 8 |
8 |
Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten. |
| 9 |
9 |
{{/info}} |
| 10 |
10 |
|
| ... |
... |
@@ -14,56
+14,75 @@ |
| 14 |
14 |
* **System-Kontext:** System > Systemplugins |
| 15 |
15 |
* **Mandant-Kontext:** Mandant > Plugins |
| 16 |
16 |
|
|
56 |
+{{id name="plugin_bundle_props"/}} |
| 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. |
|
59 |
+{{figure image="plugin_bundle_config.png"}} |
|
60 |
+Globale Einstellungen am Plugin-Bundle |
|
61 |
+{{/figure}} |
| 37 |
37 |
|
|
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 |
+ |
| 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 |
|
|
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 |
+ |
| 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. |
|
107 |
+==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ==== |
| 64 |
64 |
|
| 65 |
|
-Folgende Eigenschaften sind zuzuordnen: |
|
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: |
| 66 |
66 |
|
|
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 |
+ |
| 67 |
67 |
* Dokumentart |
| 68 |
68 |
* Kuerzel |
| 69 |
69 |
* Datenfeld-Bezeichnung |
| ... |
... |
@@ -70,9
+70,8 @@ |
| 70 |
70 |
* Datenfeld-Nummer |
| 71 |
71 |
* Datenfeld-Typ |
| 72 |
72 |
|
| 73 |
|
-Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen: |
| 74 |
|
- |
| 75 |
|
-**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...** |
| 76 |
|
- |
| 77 |
|
-(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
| 78 |
|
-))) |
|
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//) |