Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 8 hinzugefügt, 0 gelöscht)
  • btn_check.png
  • icon_add.png
  • icon_copy.png
  • icon_del.png
  • icon_placeholder.png
  • icon_update.png
  • plugin_bundle_config.png
  • plugin_config.png

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,16 +1,49 @@
1	1	{{content/}}
2	2
3		-Über das d.3 DMS 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	+Ü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	5	== Aktions-Plugin: //d.3 DMS: Dokument importieren// ==
6	6
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.
8		-Dieses ermöglich 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.
	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.
9	9
	10	+Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
10	10
11		-== Konfiguration des Plugins ==
	12	+=== Globale d.3 Server-Konfiguration übersteuern ===
12	12
	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	+
13	13	{{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}}
14	14	Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
15	15	{{/info}}
16	16
...	...	@@ -20,56 +20,75 @@
20	20	* **System-Kontext:** System > Systemplugins
21	21	* **Mandant-Kontext:** Mandant > Plugins
22	22
	56	+{{id name="plugin_bundle_props"/}}
23	23	=== Konfiguration der Plugin-Bundle Properties ===
24	24
25		-|=Property-Key|=Pflichtfeld|=Bedeutung
26		-|(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice//
27		-|dms.webservice.url|ja|Endpoint-URL zum d.3 Webservice
28		-|dms.webservice.connection.timeout|nein|(((
29		-Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
30		-(Standardwert: //10000,// dies entspricht 10 Sekunden)
31		-)))
32		-|dms.webservice.read.timeout|nein|(((
33		-Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
34		-(Standardwert: //30000, //dies entspricht 30 Sekunden)
35		-)))
36		-|(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server//
37		-|d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems.
38		-|d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist.
39		-|d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
40		-|d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
41		-|d3.server.login|ja|(((
42		-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}}
43	43
	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	+
44	44	{{info}}
45	45	Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
46	46	{{/info}}
47		-)))
48		-|d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System.
49		-|d3.user.group|nein|(((
50		-d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
51	51
	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	+
52	52	{{info}}
53	53	Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
54	54	Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
55	55	{{/info}}
56		-)))
57		-|(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"//
58		-|d3.import.doc.types|nein|(((
59		-Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
60		-Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
61		-\\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
62		-\\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...**
63	63
64		-Einzelne Listenwerte sind durch Komma zu trennen.
65		-)))
66		-|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.
67		-|d3.initial.docfield.config.mapping|nein|(((
68		-Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
69		-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" ====
70	70
71		-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:
72	72
	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	+
73	73	* Dokumentart
74	74	* Kuerzel
75	75	* Datenfeld-Bezeichnung
...	...	@@ -76,9 +76,8 @@
76	76	* Datenfeld-Nummer
77	77	* Datenfeld-Typ
78	78
79		-Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
80		-
81		-**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...**
82		-
83		-(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
84		-)))
	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//)

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