Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 9 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
  • plugin_config_import.png

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,6 +1,6 @@
1	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	+Ü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,8 +7,58 @@
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	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	+Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
11	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	+
	39	+{{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	+{{figure image="plugin_config_import.png"}}
	47	+Einstellungen für den Dokumentimport ins d.3 DMS
	48	+{{/figure}}
	49	+
	50	+; Zu importierende(s) Dokument(e) (Pflichtfeld)
	51	+: In diesem Auswahlfeld werden alle (datei)-bereitstellenden Aktionen, welche dem Import-Plugin vorangestellt sind, aufgeführt. Die hier getroffene Auswahl bestimmt die Medien (Dokument(e) oder Bild(er)) welches ins d.3 DMS übermittelt werden sollen.
	52	+; Dokument-Typ (Pflichtfeld)
	53	+: In diesem Auswahlfeld werden alle durch den d.3 Systembetreuer definierten und für einen Import aus {{formcycle/}} bestimmten d.3 Objekt-Typen aufgeführt.
	54	+; Dokument Metadaten
	55	+: In dieser Liste werden die Dokument Metadaten zum jeweiligen d.3 //Dokument-Typ// verwaltet. Die Dokument Metadaten können dabei manuell durch den Nutzer angelegt oder aus dem d.3 System ermittelt werden. Dafür muss im Vorfeld durch einen d.3 Systembetreuer eine entsprechende Möglichkeit dazu getroffen werden.
	56	+: Die Werte, die den einzelnen Metadaten zugeordnet werden, können dabei über die {{formcycle/}}-[[Platzhalter>>doc:Formcycle.UserInterface.Variables]]-Logik oder als fest vorgegeben Werte hinterlegt werden. Zu beachten ist dabei, dass der übergebene Wert dem vorgegebenen Datentyp entspricht. Die Tabelle //Unterstützte Eingabeformate für Datentypen// listet die verfügbaren Datentypen und deren Eingabeformate auf.
	57	+
	58	+{{info title="Weiterführende Erläuterungen"}}
	59	+Mit der Definition von Dokument-Typen im d.3 DMS ist meist die Definition von zusätzlichen Eigenschaften an diesen Objekten (sogenannten Metadaten) verbunden. Diese Metadaten werden im d.3 System benötigt um verschiedene Prozesse zu steuern (z.B.: interne Verarbeitung, Suche, Verschlagwortung von Objekten etc.). Ein Teil dieser Metadaten muss bereits beim Neuanlegen von Objekten bekannt sein. Dies macht es notwendig, in der FORMCYCLE Oberfläche eine Möglichkeit zur Definition solcher Metadaten zu integrieren.
	60	+{{/info}}
	61	+
12	12	== Globale Plugin-Einstellungen ==
13	13
14	14	{{info}}
...	...	@@ -21,58 +21,76 @@
21	21	* **System-Kontext:** System > Systemplugins
22	22	* **Mandant-Kontext:** Mandant > Plugins
23	23
	74	+{{id name="plugin_bundle_props"/}}
	75	+
24	24	=== Konfiguration der Plugin-Bundle Properties ===
25	25
	78	+{{figure image="plugin_bundle_config.png"}}
	79	+Globale Einstellungen am Plugin-Bundle
	80	+{{/figure}}
	81	+
26	26	Ü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.
27	27
28		-|=Property-Key|=Pflichtfeld|=Bedeutung
29		-|(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice//
30		-|dms.webservice.url|ja|Endpoint-URL zum d.3 SOAP-Webservice
31		-|dms.webservice.connection.timeout|nein|(((
32		-Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
33		-(Standardwert: //10000,// dies entspricht 10 Sekunden)
34		-)))
35		-|dms.webservice.read.timeout|nein|(((
36		-Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
37		-(Standardwert: //30000, //dies entspricht 30 Sekunden)
38		-)))
39		-|(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server//
40		-|d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems.
41		-|d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist.
42		-|d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
43		-|d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
44		-|d3.server.login|ja|(((
45		-Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
	84	+==== Einstellungen für die Anbindung des d.3 Webservice ====
46	46
	86	+; dms.webservice.url (Pflichtfeld)
	87	+: Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
	88	+
	89	+: **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//**
	90	+
	91	+: erfolgen.
	92	+; dms.webservice.connection.timeout
	93	+: Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
	94	+: (Standardwert: //10000,// dies entspricht 10 Sekunden)
	95	+; dms.webservice.read.timeout
	96	+: Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
	97	+: (Standardwert: //30000, //dies entspricht 30 Sekunden)
	98	+
	99	+==== Einstellungen für den verwendeten d.3 Server ====
	100	+
	101	+; d3.server.ip (Pflichtfeld)
	102	+: IP-Adresse des anzubinden d.3 Systems.
	103	+; d3.server.port (Pflichtfeld)
	104	+: Port, über den das anzubindende d.3 System erreichbar ist.
	105	+; d3.server.archive (Pflichtfeld)
	106	+: Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
	107	+; d3.server.language (Pflichtfeld)
	108	+: Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
	109	+; d3.server.login (Pflichtfeld)
	110	+: Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
	111	+
47	47	{{info}}
48	48	Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
49	49	{{/info}}
50		-)))
51		-|d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System.
52		-|d3.user.group|nein|(((
53		-d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
54	54
	116	+; d3.server.pwd (Pflichtfeld)
	117	+: Nutzer-Passwort für den Zugriff zum d.3 System.
	118	+; d3.user.group
	119	+: d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
	120	+
55	55	{{info}}
56	56	Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
57	57	Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
58	58	{{/info}}
59		-)))
60		-|(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"//
61		-|d3.import.doc.types|nein|(((
62		-Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
63		-Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
64		-\\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
65		-\\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...**
66	66
67		-Einzelne Listenwerte sind durch Komma zu trennen.
68		-)))
69		-|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.
70		-|d3.initial.docfield.config.mapping|nein|(((
71		-Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
72		-Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
	126	+==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
73	73
74		-Folgende Eigenschaften sind zuzuordnen:
	128	+; d3.import.doc.types
	129	+: Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
	130	+: Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
	131	+: Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
75	75
	133	+: **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...**
	134	+
	135	+: Einzelne Listenwerte sind durch Komma zu trennen.
	136	+; d3.initial.docfield.config.doc.type
	137	+: Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
	138	+; d3.initial.docfield.config.mapping
	139	+: Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
	140	+: Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
	141	+
	142	+: Folgende Eigenschaften sind zuzuordnen:
	143	+
76	76	* Dokumentart
77	77	* Kuerzel
78	78	* Datenfeld-Bezeichnung
...	...	@@ -79,9 +79,9 @@
79	79	* Datenfeld-Nummer
80	80	* Datenfeld-Typ
81	81
82		-Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
83		-
84		-**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...**
85		-
86		-(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
87		-)))
	150	+: Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
	151	+
	152	+: **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...**
	153	+
	154	+: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
	155	+~{~{/info}}

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

plugin_config_import.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.rth

Größe

...	...	@@ -1,0 +1,1 @@
	1	+54.8 KB

Inhalt