Wiki-Quellcode von d.3 DMS Plugin
Verstecke letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
![]() |
2.6 | 1 | {{content/}} |
2 | |||
![]() |
3.3 | 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. |
![]() |
2.6 | 4 | |
![]() |
2.7 | 5 | == Aktions-Plugin: //d.3 DMS: Dokument importieren// == |
![]() |
1.1 | 6 | |
![]() |
2.7 | 7 | Für die Übermittlung von Dokumenten an das d.3 System steht das Aktions-Plugin **d.3 DMS: Dokument importieren** zur Verfügung. |
![]() |
2.8 | 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. |
![]() |
1.1 | 9 | |
![]() |
3.2 | 10 | Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden. |
![]() |
1.1 | 11 | |
![]() |
10.3 | 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 | |||
![]() |
10.4 | 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. |
![]() |
10.5 | 19 | Wenn für eine Eigenschaft kein Wert festgelegt ist, werden die [[global am Plugin-Bundle hinterlegten Einstellungen>>doc:||anchor="plugin_bundle_props"]] verwendet. |
![]() |
10.4 | 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 | |||
![]() |
10.5 | 39 | {{info}} |
![]() |
10.4 | 40 | Über den [[image:btn_check.png]]-Button kann die Erreichbarkeit des d.3 Systems geprüft werden. |
![]() |
10.5 | 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}} | ||
![]() |
10.4 | 43 | |
![]() |
2.8 | 44 | == Globale Plugin-Einstellungen == |
![]() |
1.1 | 45 | |
46 | {{info}} | ||
47 | Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten. | ||
![]() |
2.2 | 48 | {{/info}} |
![]() |
1.1 | 49 | |
![]() |
2.3 | 50 | Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden. |
![]() |
2.2 | 51 | Die Menüpunkte für die jeweiligen Kontexte sind: |
52 | |||
53 | * **System-Kontext:** System > Systemplugins | ||
54 | * **Mandant-Kontext:** Mandant > Plugins | ||
![]() |
2.3 | 55 | |
![]() |
10.5 | 56 | {{id name="plugin_bundle_props"}} |
![]() |
2.3 | 57 | === Konfiguration der Plugin-Bundle Properties === |
58 | |||
![]() |
3.2 | 59 | {{figure image="plugin_bundle_config.png"}} |
60 | Globale Einstellungen am Plugin-Bundle | ||
61 | {{/figure}} | ||
62 | |||
![]() |
2.8 | 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 | |||
![]() |
3.3 | 65 | ==== Einstellungen für die Anbindung des d.3 Webservice ==== |
![]() |
2.4 | 66 | |
![]() |
3.3 | 67 | ; dms.webservice.url (Pflichtfeld) |
68 | : Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form | ||
69 | |||
![]() |
10.3 | 70 | : **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//** |
![]() |
3.3 | 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 | |||
![]() |
2.4 | 93 | {{info}} |
94 | Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login. | ||
95 | {{/info}} | ||
![]() |
2.3 | 96 | |
![]() |
3.3 | 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 | |||
![]() |
2.4 | 102 | {{info}} |
103 | Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll. | ||
104 | Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe. | ||
105 | {{/info}} | ||
![]() |
2.5 | 106 | |
![]() |
3.3 | 107 | ==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ==== |
![]() |
2.4 | 108 | |
![]() |
3.3 | 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: | ||
![]() |
3.5 | 113 | |
![]() |
10.3 | 114 | : **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...** |
![]() |
3.5 | 115 | |
![]() |
3.3 | 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. | ||
![]() |
2.4 | 122 | |
![]() |
3.3 | 123 | : Folgende Eigenschaften sind zuzuordnen: |
124 | |||
![]() |
2.4 | 125 | * Dokumentart |
126 | * Kuerzel | ||
127 | * Datenfeld-Bezeichnung | ||
128 | * Datenfeld-Nummer | ||
129 | * Datenfeld-Typ | ||
130 | |||
![]() |
3.3 | 131 | : Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen: |
![]() |
10.2 | 132 | |
133 | : **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...** | ||
134 | |||
![]() |
3.3 | 135 | : (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
![]() |
10.5 | 136 | {{/id}} |