Wiki-Quellcode von d.3 DMS Plugin

Verstecke letzte Bearbeiter

version	line-number	content
2.6	1	{{content/}}
	2
3.3	3	Über das d.3 DMS (Dokumenten Mangement System) 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.
11.12	19	Wenn für eine Eigenschaft kein Wert festgelegt ist, werden die [[global am Plugin-Bundle hinterlegten Einstellungen>>doc:\|\|anchor="plugin_bundle_props" target="_blank"]] 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
11.2	44	=== Einstellungen für den DMS Dokumentimport ===
10.9	45
11.2	46	{{figure image="plugin_config_import.png"}}
	47	Einstellungen für den Dokumentimport ins d.3 DMS
	48	{{/figure}}
	49
10.9	50	; Zu importierende(s) Dokument(e) (Pflichtfeld)
11.2	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.
10.9	52	; Dokument-Typ (Pflichtfeld)
11.2	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
11.3	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.
11.14	56	: Die Werte, die den einzelnen Metadaten zugeordnet werden, können dabei über die {{formcycle/}}-[[Platzhalter>>doc:Formcycle.UserInterface.Variables\|\|target="_blank"]]-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>>doc:\|\|anchor="metadata_types"]]// listet die verfügbaren Datentypen und deren Eingabeformate auf.
10.9	57
11.6	58	{{info title="Weiterführende Erläuterungen:"}}
11.5	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, weshalb sich an dieser Stelle die Notwendigkeit zur Definition der Metadaten in der {{formcycle/}} Oberfläche erklärt.
11.3	60	{{/info}}
	61
11.13	62	* [%%FILE_NAME%%]: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
	63	* [%%FILE_SIZE%%]: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
	64
	65	: Zusätzlich zu den in {{formcycle/}} standardmäßig vorhandenen Platzhaltern gibt es die nachfolgend aufgeführten Platzhalter, die nur in diesem Plugin verwendet werden können. Diese Platzhalter sind dafür gedacht, auf spezielle Dateieigenschaften einzelner Dateien zuzugreifen, wenn durch das Feld //Zu importierende(s) Dokument(e)// mehrere Dateien gleichzeitig ins DMS überführt werden.
	66
11.14	67
	68	{{id name="metadata_types"/}}
11.12	69	==== Unterstützte Eingabeformate für Datentypen ====
11.7	70
11.12	71	(% summary="Unterstützte Eingabeformate für Datentypen" %)
	72	\|=Datentyp\|=Erläuterung zum Eingabeformat
	73	\|Alphanumerisch\|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen)
	74	\|Datum\|(((
	75	Unterstützt werden Datumseingaben der Form dd.MM.yyyy (z.B.: //01.01.1970//)
11.6	76
11.12	77	* dd: Tag, zweistellig
	78	* MM: Monatsangabe, zweistellig
	79	* yyyy: Jahresangabe, vierstellig
	80	)))
	81	\|Tabelle\|(((
	82	Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ Alphanumerisch unterstützt.
	83	Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements\|\|target="_blank"]] wird im d.3 System ein Wert hinterlegt.
	84	)))
	85	\|Geld\|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//)
	86	\|Numerisch\|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//)
	87
2.8	88	== Globale Plugin-Einstellungen ==
1.1	89
	90	{{info}}
	91	Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.
2.2	92	{{/info}}
1.1	93
2.3	94	Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden.
2.2	95	Die Menüpunkte für die jeweiligen Kontexte sind:
	96
	97	* System-Kontext: System > Systemplugins
	98	* Mandant-Kontext: Mandant > Plugins
2.3	99
10.7	100	{{id name="plugin_bundle_props"/}}
10.9	101
2.3	102	=== Konfiguration der Plugin-Bundle Properties ===
	103
3.2	104	{{figure image="plugin_bundle_config.png"}}
	105	Globale Einstellungen am Plugin-Bundle
	106	{{/figure}}
	107
2.8	108	Ü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.
	109
3.3	110	==== Einstellungen für die Anbindung des d.3 Webservice ====
2.4	111
3.3	112	; dms.webservice.url (Pflichtfeld)
	113	: Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
	114
10.3	115	: //http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//
3.3	116
	117	: erfolgen.
	118	; dms.webservice.connection.timeout
	119	: Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
	120	: (Standardwert: //10000,// dies entspricht 10 Sekunden)
	121	; dms.webservice.read.timeout
	122	: Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
	123	: (Standardwert: //30000, //dies entspricht 30 Sekunden)
	124
	125	==== Einstellungen für den verwendeten d.3 Server ====
	126
	127	; d3.server.ip (Pflichtfeld)
	128	: IP-Adresse des anzubinden d.3 Systems.
	129	; d3.server.port (Pflichtfeld)
	130	: Port, über den das anzubindende d.3 System erreichbar ist.
	131	; d3.server.archive (Pflichtfeld)
	132	: Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
	133	; d3.server.language (Pflichtfeld)
	134	: Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//).
	135	; d3.server.login (Pflichtfeld)
	136	: Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
	137
2.4	138	{{info}}
	139	Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.
	140	{{/info}}
2.3	141
3.3	142	; d3.server.pwd (Pflichtfeld)
	143	: Nutzer-Passwort für den Zugriff zum d.3 System.
	144	; d3.user.group
	145	: d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
	146
2.4	147	{{info}}
	148	Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
	149	Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.
	150	{{/info}}
2.5	151
3.3	152	==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ====
2.4	153
3.3	154	; d3.import.doc.types
	155	: Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
	156	: Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
	157	: Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
3.5	158
10.3	159	: //<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...
3.5	160
3.3	161	: Einzelne Listenwerte sind durch Komma zu trennen.
	162	; d3.initial.docfield.config.doc.type
	163	: Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält.
	164	; d3.initial.docfield.config.mapping
	165	: Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
	166	: 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	167
3.3	168	: Folgende Eigenschaften sind zuzuordnen:
	169
2.4	170	* Dokumentart
	171	* Kuerzel
	172	* Datenfeld-Bezeichnung
	173	* Datenfeld-Nummer
	174	* Datenfeld-Typ
	175
3.3	176	: Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
10.2	177
	178	: //<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...
	179
3.3	180	: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//)
11.12	181
	182
	183
	184
	185
	186

Wiki-Quellcode von d.3 DMS Plugin

Navigation