Plugin-Dokumentation - d3 DMS Plugin

Page / - last modified by rth on 18.03.2020, 09:05

d3 DMS Plugin

last modified by rth

on 18.03.2020, 09:05

Table of Contents

Aktions-Plugin: d.3 DMS: Dokument importieren

Globale d.3 Server-Konfiguration übersteuern

Einstellungen für den DMS Dokumentimport

Allgemeine Rückgabewerte

Globale Plugin-Einstellungen

Konfiguration der Plugin-Bundle Properties

Plugin-Download (erfordert Anmeldung)

Content [ Hide ]

Aktions-Plugin: d.3 DMS: Dokument importieren

Globale d.3 Server-Konfiguration übersteuern

Einstellungen für den DMS Dokumentimport

Allgemeine Rückgabewerte

Globale Plugin-Einstellungen

Konfiguration der Plugin-Bundle Properties

Über das kostenpflichtige 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

Einstellungen zum Übersteuern der global definierten Verbindungsparameter

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.

Über den -Button kann die Erreichbarkeit des d.3 Systems geprüft werden.
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.

Einstellungen für den DMS Dokumentimport

Einstellungen für den Dokumentimport ins d.3 DMS

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.

Was sind Dokument Metadaten im Zusammenhang mit d.3?

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 Xima® Formcycle Oberfläche erklärt.

Dokument-Nummer

An dieser Stelle können Sie eine individuelle Dokumentennummer für die Ablage des Dokuments im d.3 DMS festlegen.

Wenn bereits ein Dokument mit dieser Nummer im d.3 System existiert, wird versucht das übermittelte Dokument als neue Version im System abzulegen.

Hinweis:

Die Angabe einer Dokument-Nummer ist nur sinnvoll, wenn es sich bei den "zu importierenden Dokumenten" um eine einzelne Datei handelt.

Interaktionsmöglichkeiten innerhalb der 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, Datenfeldnummer und der mit dem Metadatum zu übertragene Wert und gegebenenfalls eine Bezeichnung (dient als Erläuterung) definiert werden.

Hinweis:

Die auswählbaren Datenfeld-Nummern ergeben sich aus dem gewählten Datentyp, sowie aus den noch verfügbaren Nummern. Wenn sie Metadaten manuell anlegen, fragen sie gegebenenfalls ihren d.3 Systembetreuer, welche Datentypen und Datenfeldnummern sie verwenden müssen, damit die übermittelten Metadaten ordnungsgemäß im d.3 System verarbeitet werden können.

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 (oder einer initialen Vorgabe), Metadaten aus dem d.3 System ermittelt und in die Konfigurations-Tabelle eingefügt werden.
Sollte ein Metadatum bereits in der Tabelle existieren, so wird dieses als Pflichtfeld ausgewiesen und kann nicht mehr gelöscht werden.
Ein Metadatum gilt dabei als bereits existent, wenn es die gleiche Datenfeldnummer bzw. Datenbank-Position, wie ein einzufügendes Feld besitzt.

Über die Schaltfläche kann man sich Metadaten-Details wie Datenfeld-Bezeichnung und Datenfeldnummer einblenden lassen. Mittels Button lassen sich die Details anschließend wieder ausblenden.

Über den Button wird das selektierte Metadatum aus der Konfigurations-Tabelle entfernt.
Metadaten, welche aus dem d.3 System als Pflichtfelder ermittelt wurden, können nicht 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) dd: Tag, zweistellig MM: Monatsangabe, zweistellig yyyy: Jahresangabe, vierstellig
Tabelle	Beim Datentyp Tabellenfeld werden dynamische Formulareingaben, vom Typ Alphanumerisch unterstützt. Für jeden Wert aus einem dynamischen Eingabefeld wird im d.3 System ein Wert hinterlegt.
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)

Allgemeine Rückgabewerte

Konfiguration der Rückgabewerte

In diesem Bereich werden die vom Plugin als Ergebnis des DMS Datei-Upload Prozesses zurückgelieferten Parameter aufgeführt. Für die einzelnen Parameter kann ein Alias vergeben werden. In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. Der Platzhalter wird dabei nach dem folgenden Muster gebildet:

[%$<Name der Plugin-Aktion>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]

ResultCode

Enthält einen Zahlenwert, welchen den Abarbeitungs- bzw. Fehlerstatus des Plugins wiedergibt.

ResultMessage

Enthält eine Klartextmeldung, welche den zurückgelieferten ResultCode näher erläutert.

ResultDocumentID

Enthält die vom d.3 System zurückgelieferte Dokument-ID, wenn das Dokument erfolgreich im d.3 System abgelegt werden konnte, sonst den Wert -1.

Über den Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.

Wenn mehrere Dateien gleichzeitig an das DMS übertragen werden, so wird für jede Datei ein entsprechender ResultCode, ResultMessage und ResultDocumentID zurückgeliefert. Um auf die ResultDocumentID (einer Plugin-Aktion mit Namen "D3DMSUpload") der dritten übertragenen Datei zuzugreifen muss dann beispielsweise folgender Platzhalter benutzt werden:

[%$D3DMSUpload.RESULT[2].ResultDocumentID%]

Bei gleichzeitiger Übertragung mehrerer Dateien ist es manchmal sinnvoll den Gesamtstatus zu erfragen, um beispielsweise zu wissen, ob ein Fehler beim Import einer Datei aufgetreten ist.
Dies kann über den Platzhalter

[%$<Name der Plugin-Aktion>.SUCCESS%]

erfolgen. Dieser liefert "true" zurück, wenn alle Dateien erfolgreich an das DMS übermittelt werden konnten, sonst "false".
Der Platzhalter

[%$<Name der Plugin-Aktion>.COUNT%]

wiederum kann genutzt werden, wenn man die Gesamtanzahl der zurückgelieferten Ergebnisse wissen möchte.

Die nachfolgende Tabelle liefert eine Übersicht über alle vom Plugin zurückgelieferten Status- bzw. Fehlercodes:

Status / Fehlercode	Bedeutung
0	Das Plugin wurde fehlerfrei ausgeführt.
10	Die Authentifizierung am d.3 DMS ist fehlgeschlagen, überprüfen Sie bitte die Eigenschaften des anzusprechenden d.3 Servers.
20	Der d.3 DMS-Webservice konnte aufgrund fehlender Pflicht-Parameter (…Name der fehlenden Pflichtparameter…) nicht aufgerufen werden.
21	Fehler beim Einlesen des zu importierenden Dokuments
22	Es konnte keine Dokument für einen Import ermittelt werden.
23	Folgende Dokument-Metadaten beinhalten fehlerhafte Werte: …Auflistung der fehlerhaften Werte
24	Fehler beim Erzeugen einer neuen Dokument Version.
30	Es konnte keine Verbindung zum d.3 DMS Webservice aufgebaut werden.
31	Aufruf einer Webservice-Methode lieferte Fehler: ...Detaillierte Fehlermeldung aus d.3 System
40	In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten.

Globale Plugin-Einstellungen

Dieser Abschnitt ist nur für Xima® Formcycle-Administratoren relevant, die das Plugin-Bundle initial im System einrichten.

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

Globale Einstellungen am Plugin-Bundle

Ü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.

Alle nutzerabhängigen Webservice-Funktionen, verwenden ebenfalls diesen Login.

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.

Diese Angabe ist notwendig, wenn für ein bestehendes Dokument eine neue Version im d.3 System erzeugt werden soll.
Das Dokument muss dann gegebenenfalls in den „Bearbeiten“-Status überführt werden und dies geht nur durch Angabe einer Nutzergruppe.

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.

Hinweis für Xima® Formcycle Systembetreuer:

Wurde für diese Plugin-Einstellung kein Wert hinterlegt, greift bei der automatisierten Metadaten Ermittlung im Aktions-Plugin eine Rückfall-Logik welche untersucht, ob am gewählten Dokument-Typ, innerhalb des d.3 Systems, Pflichtfelder (sogenannte "DocFields") definiert sind. Ist dies der Fall, werden diese als Metadaten in die Konfigurations-Tabelle übernommen.

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)