Wiki-Quellcode von d.3 DMS Plugin
Verstecke letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
![]() |
2.6 | 1 | {{content/}} |
2 | |||
![]() |
2.8 | 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 | |
![]() |
2.8 | 12 | == Globale Plugin-Einstellungen == |
![]() |
1.1 | 13 | |
14 | {{info}} | ||
15 | Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten. | ||
![]() |
2.2 | 16 | {{/info}} |
![]() |
1.1 | 17 | |
![]() |
2.3 | 18 | Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden. |
![]() |
2.2 | 19 | Die Menüpunkte für die jeweiligen Kontexte sind: |
20 | |||
21 | * **System-Kontext:** System > Systemplugins | ||
22 | * **Mandant-Kontext:** Mandant > Plugins | ||
![]() |
2.3 | 23 | |
24 | === Konfiguration der Plugin-Bundle Properties === | ||
25 | |||
![]() |
3.2 | 26 | {{figure image="plugin_bundle_config.png"}} |
27 | Globale Einstellungen am Plugin-Bundle | ||
28 | {{/figure}} | ||
29 | |||
![]() |
2.8 | 30 | Ü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. |
31 | |||
![]() |
2.3 | 32 | |=Property-Key|=Pflichtfeld|=Bedeutung |
33 | |(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice// | ||
![]() |
3.2 | 34 | |dms.webservice.url|ja|((( |
35 | Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form | ||
36 | **http:~/~/<host>:<port>/ws/servicesD3WService.wsdl** | ||
37 | erfolgen. | ||
38 | ))) | ||
![]() |
2.3 | 39 | |dms.webservice.connection.timeout|nein|((( |
40 | Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. | ||
![]() |
2.5 | 41 | (Standardwert: //10000,// dies entspricht 10 Sekunden) |
![]() |
2.3 | 42 | ))) |
43 | |dms.webservice.read.timeout|nein|((( | ||
44 | Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. | ||
![]() |
2.5 | 45 | (Standardwert: //30000, //dies entspricht 30 Sekunden) |
![]() |
2.3 | 46 | ))) |
47 | |(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server// | ||
48 | |d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems. | ||
49 | |d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist. | ||
50 | |d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann. | ||
51 | |d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//). | ||
52 | |d3.server.login|ja|((( | ||
![]() |
2.4 | 53 | Nutzer-Login, um Zugriff zum d.3 System zu erhalten. |
54 | |||
55 | {{info}} | ||
56 | Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login. | ||
57 | {{/info}} | ||
![]() |
2.3 | 58 | ))) |
![]() |
2.4 | 59 | |d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System. |
60 | |d3.user.group|nein|((( | ||
61 | d.3-Nutzergruppe, welchem der Nutzer-Login angehört. | ||
![]() |
2.3 | 62 | |
![]() |
2.4 | 63 | {{info}} |
64 | Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll. | ||
65 | Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe. | ||
66 | {{/info}} | ||
67 | ))) | ||
68 | |(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"// | ||
69 | |d3.import.doc.types|nein|((( | ||
![]() |
2.5 | 70 | Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden. |
71 | Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel. | ||
72 | \\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen: | ||
73 | \\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...** | ||
74 | |||
![]() |
2.4 | 75 | Einzelne Listenwerte sind durch Komma zu trennen. |
76 | ))) | ||
77 | |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. | ||
78 | |d3.initial.docfield.config.mapping|nein|((( | ||
![]() |
2.5 | 79 | Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden. |
80 | 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 | 81 | |
82 | Folgende Eigenschaften sind zuzuordnen: | ||
83 | |||
84 | * Dokumentart | ||
85 | * Kuerzel | ||
86 | * Datenfeld-Bezeichnung | ||
87 | * Datenfeld-Nummer | ||
88 | * Datenfeld-Typ | ||
89 | |||
90 | Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen: | ||
91 | |||
![]() |
2.5 | 92 | **<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...** |
![]() |
2.4 | 93 | |
94 | (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) | ||
95 | ))) |