d.3 DMS Plugin
Über das d.3 DMS (Dokumenten Mangement System) Plugin ist es möglich Dokumente aus Xima® Formcycle an das d.3 DMS zu übermitteln. Das Plugin nutzt dafür die vom d.3 System bereitgestellte SOAP-Webservice Schnittstelle.
Aktions-Plugin: d.3 DMS: Dokument importieren
Für die Übermittlung von Dokumenten an das d.3 System steht das Aktions-Plugin d.3 DMS: Dokument importieren zur Verfügung.
Dieses ermöglicht es, Dateien, welche über eine (Datei-)bereitstellende Aktion in der Statusverarbeitung verfügbar sind, in ein d.3 DMS zu überführen.
Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt, die nachfolgend kurz beschrieben werden.
Globale d.3 Server-Konfiguration übersteuern
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.
Wenn für eine Eigenschaft kein Wert festgelegt ist, werden die global am Plugin-Bundle hinterlegten Einstellungen verwendet.
Es können Platzhalter (Auswahlmöglichkeit über Button ) für einzelne Einstellungen verwendet werden.
- IP-Adresse
- IP-Adresse, unter welcher der d.3 Server erreichbar ist
- Port
- Port, unter dem der d.3 Servers angesprochen werden kann
- Archiv
- Kürzel für das genutzte Archiv auf dem d.3 Server
- Sprache
- Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: de bzw. en).
- Nutzer
- Nutzer-Account für den Zugriff auf den d.3 Server
- Passwort
- Das zum Nutzer-Account zugehörige Passwort
- Nutzergruppe
- Nutzerguppe der der Nutzer angehört. Diese Angabe wird zwingend benötigt, wenn von einem Dokument eine neue Version erzeugt werden soll.
- Endpoint URL
- Endpoint-URL zum angebundenen d.3 Server.
Einstellungen für den DMS Dokumentimport
- Zu importierende(s) Dokument(e) (Pflichtfeld)
- 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.
- Dokument-Typ (Pflichtfeld)
- In diesem Auswahlfeld werden alle durch den d.3 Systembetreuer definierten und für einen Import aus Xima® Formcycle bestimmten d.3 Objekt-Typen aufgeführt.
- Dokument Metadaten
- 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 bezogen 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.
Interaktionsmöglichkeiten für Konfigurations-Tabelle Dokument Metadaten
Über die Schaltfläche kann ein neues Dokument Metadatum in die Konfigurations-Tabelle eingefügt werden.
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.
Die zu übertragenen Werte, die den einzelnen Metadaten zugeordnet werden, können dabei über die Xima® Formcycle-Platzhalter-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.
Zusätzlich zu den in Xima® 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.
- [%%FILE_NAME%%]: Liefert den Dateinamen der aktuell in Bearbeitung befindlichen Datei
- [%%FILE_SIZE%%]: Liefert die Dateigröße (in Byte) der aktuell in Bearbeitung befindlichen Datei
Über die Schaltfläche können, anhand des ausgewählten Dokument-Typs, Metadaten aus dem d.3 System ermittelt und in die Konfigurations-Tabelle eingefügt werden, wenn noch keine Entsprechung für das jeweilige Feld in der Tabelle existiert.
Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position besitzt.
Diese existenten Metadaten sind dann in als Pflichtfelder ausgewiesen und können damit nicht mehr gelöscht werden.
Unterstützte Eingabeformate für Datentypen
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.
Datentyp | Erläuterung zum Eingabeformat |
---|---|
Alphanumerisch | Unterstützt werden alle Eingabezeichen (Buchstaben, Ziffern, Sonderzeichen) |
Datum | Unterstützt werden Datumseingaben der Form dd.MM.yyyy (z.B.: 01.01.1970)
|
Tabelle | Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ Alphanumerisch unterstützt. |
Geld | Unterstützt werden zweistellige Fließkommazahlen. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B.: 123,50) |
Numerisch | Unterstützt werden positive und negative Fließkommazahlenwerte. Als Dezimaltrennzeichen muss ein Komma angegeben werden. (z.B. -123,45) |
Globale Plugin-Einstellungen
Das d.3 DMS Plugin-Bundle kann sowohl im System- als auch im Mandant-Kontext installiert werden.
Die Menüpunkte für die jeweiligen Kontexte sind:
- System-Kontext: System > Systemplugins
- Mandant-Kontext: Mandant > Plugins
Konfiguration der Plugin-Bundle Properties
Ü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.
Einstellungen für die Anbindung des d.3 Webservice
- dms.webservice.url (Pflichtfeld)
- Endpoint-URL zum d.3 SOAP-Webservice. Die Angabe muss in der Form
- http://<host>:<port>/ws/servicesD3WService.wsdl
- erfolgen.
- dms.webservice.connection.timeout
- Wert für Connection-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
- (Standardwert: 10000, dies entspricht 10 Sekunden)
- dms.webservice.read.timeout
- Wert für Read-Timeout in Millisekunden, bei der Kommunikation mit dem d.3 Webservice.
- (Standardwert: 30000, dies entspricht 30 Sekunden)
Einstellungen für den verwendeten d.3 Server
- d3.server.ip (Pflichtfeld)
- IP-Adresse des anzubinden d.3 Systems.
- d3.server.port (Pflichtfeld)
- Port, über den das anzubindende d.3 System erreichbar ist.
- d3.server.archive (Pflichtfeld)
- Kürzel mit dem das Repository bzw. Archive des anzubindenden d.3 Systems angesprochen werden kann.
- d3.server.language (Pflichtfeld)
- Kürzel für die zu verwendende Sprache. Format muss zweistellig sein (z.B.: de bzw. en).
- d3.server.login (Pflichtfeld)
- Nutzer-Login, um Zugriff zum d.3 System zu erhalten.
- d3.server.pwd (Pflichtfeld)
- Nutzer-Passwort für den Zugriff zum d.3 System.
- d3.user.group
- d.3-Nutzergruppe, welchem der Nutzer-Login angehört.
Einstellungen für das Statusverarbeitungs-Plugin "Dokument importieren"
- d3.import.doc.types
- Definiert eine Auflistung von d.3 Objekt-Typen, welche als Auswahl innerhalb des Aktions-Plugins dargestellt werden.
- Ein Objekttyp definiert sich über sein, im d.3 DMS festgelegtes, Dokument-Kürzel.
- Ein Listenwert besteht immer aus Dokument-Kürzel und Anzeige-Name und ist nach folgender Bildungsvorschrift zu hinterlegen:
- <Dokument-Kürzel aus d.3>:<Anzeigename in Auswahlliste>,...
- Einzelne Listenwerte sind durch Komma zu trennen.
- d3.initial.docfield.config.doc.type
- Definiert ein d.3 Dokument-Typ-Kürzel, welches Definitionen für eine automatisierte Erstellung von Dokument Metadaten Feldern enthält.
- d3.initial.docfield.config.mapping
- Definiert die Auflistung der Zuordnungen, welche für die Definition eines Metadatums in der Plugin-Oberfläche herangezogen werden.
- Es ist immer eine Eigenschaft zu einer d.3 Datenfeld-Nummer zuzuordnen, welche die Eigenschaft auf dem angebundenen d.3 System enthält.
- Folgende Eigenschaften sind zuzuordnen:
- Dokumentart
- Kuerzel
- Datenfeld-Bezeichnung
- Datenfeld-Nummer
- Datenfeld-Typ
- Die Konfiguration ist nach folgender Bildungsvorschrift zu hinterlegen:
- <Eigenschaft>:<d.3 DocField-Nummer, in der die Eigenschaft definiert ist>,...
- (Standardwert: Dokumentart:1,Kuerzel:2, DatenfeldBezeichnung:3,DatenfeldNummer:4,DatenfeldTyp:5)