| ... |
... |
@@ -1,99
+1,10 @@ |
| 1 |
|
-{{content/}} |
|
1 |
+== Plugin-Aktion: d.3 DMS: Dokument importieren == |
| 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. |
| 4 |
4 |
|
| 5 |
|
-== Aktions-Plugin: //d.3 DMS: Dokument importieren// == |
| 6 |
6 |
|
| 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ö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. |
|
5 |
+== Konfiguration des Plugins == |
| 9 |
9 |
|
| 10 |
|
-Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden. |
| 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" target="_blank"]] 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 |
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 Konfigurations-Tabelle werden die Dokument Metadaten zum jeweiligen //d.3 Dokument-Typ// verwaltet. Die Metadaten können dabei manuell durch den Nutzer angelegt oder aus dem d.3 System ermittelt werden. Für eine automatische Ermittlung muss im Vorfeld durch einen d.3 Systembetreuer eine entsprechende Definition der Metadaten im d.3 System durchgeführt werden. |
| 56 |
|
- |
| 57 |
|
-{{info title="**Was sind Dokument Metadaten im Zusammenhang mit d.3?**"}} |
| 58 |
|
-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. |
| 59 |
|
-{{/info}} |
| 60 |
|
- |
| 61 |
|
-==== Interaktionsmöglichkeiten für Konfigurations-Tabelle //Dokument Metadaten// ==== |
| 62 |
|
- |
| 63 |
|
-Über die Schaltfläche [[image:icon_add.png]] kann ein neues Dokument Metadatum in die Konfigurations-Tabelle eingefügt werden. |
| 64 |
|
-Anschließend muss für dieses Metadatum der Datentyp, der mit dem Metadatum zu übertragene Wert und gegebenenfalls eine Bedeutung (dient als Erläuterung) definiert werden. |
| 65 |
|
- |
| 66 |
|
-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. |
| 67 |
|
- |
| 68 |
|
-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. |
| 69 |
|
- |
| 70 |
|
-* **[%%FILE_NAME%%]**: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei |
| 71 |
|
-* **[%%FILE_SIZE%%]**: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei |
| 72 |
|
- |
| 73 |
|
- |
| 74 |
|
-{{id name="metadata_types"/}} |
| 75 |
|
-==== Unterstützte Eingabeformate für Datentypen ==== |
| 76 |
|
-Die nachfolgende Tabelle listet alle Datentypen, welche für die Ablage von Metadaten im d.3 System zur Auswahl stehen und deren gefordertes Eingabeformat, auf. |
| 77 |
|
-(% summary="Unterstützte Eingabeformate für Datentypen" %) |
| 78 |
|
-|=Datentyp|=Erläuterung zum Eingabeformat |
| 79 |
|
-|Alphanumerisch|Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen) |
| 80 |
|
-|Datum|((( |
| 81 |
|
-Unterstützt werden Datumseingaben der Form **dd.MM.yyyy** (z.B.: //01.01.1970//) |
| 82 |
|
- |
| 83 |
|
-* **dd:** Tag, zweistellig |
| 84 |
|
-* **MM:** Monatsangabe, zweistellig |
| 85 |
|
-* **yyyy:** Jahresangabe, vierstellig |
| 86 |
|
-))) |
| 87 |
|
-|Tabelle|((( |
| 88 |
|
-Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ **Alphanumerisch **unterstützt. |
| 89 |
|
-Für jeden Wert aus einem [[dynamischen Eingabefeld>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.DynamicElements||target="_blank"]] wird im d.3 System ein Wert hinterlegt. |
| 90 |
|
-))) |
| 91 |
|
-|Geld|Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: //123,50//) |
| 92 |
|
-|Numerisch|Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. //-123,45//) |
| 93 |
|
- |
| 94 |
|
-== Globale Plugin-Einstellungen == |
| 95 |
|
- |
| 96 |
|
-{{info}} |
| 97 |
97 |
Dieser Abschnitt ist nur für {{formcycle/}}-Administratoren relevant, die das Plugin-Bundle initial im System einrichten. |
| 98 |
98 |
{{/info}} |
| 99 |
99 |
|
| ... |
... |
@@ -103,76
+103,56 @@ |
| 103 |
103 |
* **System-Kontext:** System > Systemplugins |
| 104 |
104 |
* **Mandant-Kontext:** Mandant > Plugins |
| 105 |
105 |
|
| 106 |
|
-{{id name="plugin_bundle_props"/}} |
| 107 |
|
- |
| 108 |
108 |
=== Konfiguration der Plugin-Bundle Properties === |
| 109 |
109 |
|
| 110 |
|
-{{figure image="plugin_bundle_config.png"}} |
| 111 |
|
-Globale Einstellungen am Plugin-Bundle |
| 112 |
|
-{{/figure}} |
|
19 |
+|=Property-Key|=Pflichtfeld|=Bedeutung |
|
20 |
+|(% colspan="3" %)//Einstellungen für die Anbindung des d.3 Webservice// |
|
21 |
+|dms.webservice.url|ja|Endpoint-URL zum d.3 Webservice |
|
22 |
+|dms.webservice.connection.timeout|nein|((( |
|
23 |
+Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. |
|
24 |
+(Standardwert: //10000,// dies entspricht 10 Sekunden) |
|
25 |
+))) |
|
26 |
+|dms.webservice.read.timeout|nein|((( |
|
27 |
+Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. |
|
28 |
+(Standardwert: //30000, //dies entspricht 30 Sekunden) |
|
29 |
+))) |
|
30 |
+|(% colspan="3" %)//Einstellungen für den verwendeten d.3 Server// |
|
31 |
+|d3.server.ip|ja|IP-Adresse des anzubinden d.3 Systems. |
|
32 |
+|d3.server.port|ja|Port, über den das anzubindende d.3 System erreichbar ist. |
|
33 |
+|d3.server.archive|ja|Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann. |
|
34 |
+|d3.server.language|ja|Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//). |
|
35 |
+|d3.server.login|ja|((( |
|
36 |
+Nutzer-Login, um Zugriff zum d.3 System zu erhalten. |
| 113 |
113 |
|
| 114 |
|
-Ü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. |
| 115 |
|
- |
| 116 |
|
-==== Einstellungen für die Anbindung des d.3 Webservice ==== |
| 117 |
|
- |
| 118 |
|
-; dms.webservice.url (Pflichtfeld) |
| 119 |
|
-: Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form |
| 120 |
|
- |
| 121 |
|
-: **//http:~/~/<host>:<port>/ws/servicesD3WService.wsdl//** |
| 122 |
|
- |
| 123 |
|
-: erfolgen. |
| 124 |
|
-; dms.webservice.connection.timeout |
| 125 |
|
-: Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. |
| 126 |
|
-: (Standardwert: //10000,// dies entspricht 10 Sekunden) |
| 127 |
|
-; dms.webservice.read.timeout |
| 128 |
|
-: Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice. |
| 129 |
|
-: (Standardwert: //30000, //dies entspricht 30 Sekunden) |
| 130 |
|
- |
| 131 |
|
-==== Einstellungen für den verwendeten d.3 Server ==== |
| 132 |
|
- |
| 133 |
|
-; d3.server.ip (Pflichtfeld) |
| 134 |
|
-: IP-Adresse des anzubinden d.3 Systems. |
| 135 |
|
-; d3.server.port (Pflichtfeld) |
| 136 |
|
-: Port, über den das anzubindende d.3 System erreichbar ist. |
| 137 |
|
-; d3.server.archive (Pflichtfeld) |
| 138 |
|
-: Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann. |
| 139 |
|
-; d3.server.language (Pflichtfeld) |
| 140 |
|
-: Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: //de// bzw. //en//). |
| 141 |
|
-; d3.server.login (Pflichtfeld) |
| 142 |
|
-: Nutzer-Login, um Zugriff zum d.3 System zu erhalten. |
| 143 |
|
- |
| 144 |
144 |
{{info}} |
| 145 |
145 |
Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login. |
| 146 |
146 |
{{/info}} |
|
41 |
+))) |
|
42 |
+|d3.server.pwd|ja|Nutzer-Passwort für den Zugriff zum d.3 System. |
|
43 |
+|d3.user.group|nein|((( |
|
44 |
+d.3-Nutzergruppe, welchem der Nutzer-Login angehört. |
| 147 |
147 |
|
| 148 |
|
-; d3.server.pwd (Pflichtfeld) |
| 149 |
|
-: Nutzer-Passwort für den Zugriff zum d.3 System. |
| 150 |
|
-; d3.user.group |
| 151 |
|
-: d.3-Nutzergruppe, welchem der Nutzer-Login angehört. |
| 152 |
|
- |
| 153 |
153 |
{{info}} |
| 154 |
154 |
Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll. |
| 155 |
155 |
Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe. |
| 156 |
156 |
{{/info}} |
|
50 |
+))) |
|
51 |
+|(% colspan="3" %)//Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"// |
|
52 |
+|d3.import.doc.types|nein|((( |
|
53 |
+Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden. |
|
54 |
+Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel. |
|
55 |
+\\Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen: |
|
56 |
+\\**<Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...** |
| 157 |
157 |
|
| 158 |
|
-==== Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren" ==== |
|
58 |
+Einzelne Listenwerte sind durch Komma zu trennen. |
|
59 |
+))) |
|
60 |
+|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. |
|
61 |
+|d3.initial.docfield.config.mapping|nein|((( |
|
62 |
+Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden. |
|
63 |
+Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält. |
| 159 |
159 |
|
| 160 |
|
-; d3.import.doc.types |
| 161 |
|
-: Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden. |
| 162 |
|
-: Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel. |
| 163 |
|
-: Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen: |
|
65 |
+Folgende Eigenschaften sind zuzuordnen: |
| 164 |
164 |
|
| 165 |
|
-: **//<Dokument-Kürzel aus d.3>//~://<Anzeigename in Auswahlliste>//,...** |
| 166 |
|
- |
| 167 |
|
-: Einzelne Listenwerte sind durch Komma zu trennen. |
| 168 |
|
-; d3.initial.docfield.config.doc.type |
| 169 |
|
-: Definiert ein d.3 Dokumenttyp-Kürzel, welches Daten für die initiale Erstellung von Dokument-Metadaten-Feldern enthält. |
| 170 |
|
-; d3.initial.docfield.config.mapping |
| 171 |
|
-: Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden. |
| 172 |
|
-: Es ist immer eine //Eigenschaft// zu einer d.3 //Datenfeld-Nummer// zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält. |
| 173 |
|
- |
| 174 |
|
-: Folgende Eigenschaften sind zuzuordnen: |
| 175 |
|
- |
| 176 |
176 |
* Dokumentart |
| 177 |
177 |
* Kuerzel |
| 178 |
178 |
* Datenfeld-Bezeichnung |
| ... |
... |
@@ -179,14
+179,9 @@ |
| 179 |
179 |
* Datenfeld-Nummer |
| 180 |
180 |
* Datenfeld-Typ |
| 181 |
181 |
|
| 182 |
|
-: Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen: |
| 183 |
|
- |
| 184 |
|
-: **//<Eigenschaft>//~://<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>//,...** |
| 185 |
|
- |
| 186 |
|
-: (Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
|
73 |
+Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen: |
| 187 |
187 |
|
|
75 |
+**<Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...** |
| 188 |
188 |
|
| 189 |
|
- |
| 190 |
|
- |
| 191 |
|
- |
| 192 |
|
- |
|
77 |
+(Standardwert: //Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5//) |
|
78 |
+))) |