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