Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Funktion

Der EASY Documents Exportservice übergibt Dokumente und Metadaten nach EASY Documents oder aktualisiert sie.

Grundeinstellungen

Die Grundeinstellungen bestehen aus der Server Url von EASY Documents, einem Mappentyp (File type) und den Logindaten unter dem Reiter "Login".

Mappen aktualisieren

Für das Updaten von Mappen wird die Konfiguration des Key fileds benötigt. Der Wert in diesem Feld dient dann als eindeutiger Schlüssel. Bitte beachten Sie, dass hierfür seitens des Herstellers ggf. zusätzliche Lizenzen benötigt werden.

Eine weitere Möglichkeit besteht in der Übergabe der FILEID über ein Steuerfeld.

Positionsdaten

Die Übergabe von Positionsdaten erfolgt über das Gentable field. In diesem Feld wird im Falle der Übergabe von Positionsdaten eine entsprechende HTML Table aufgebaut.

Erweiterte Einstellungen

Create only legt immer eine neue Mappe an.

Fields existence check prüft das Vorhandensein der übergebenen Felder um ggf. einem Fehler vorzubeugen.

Overwrite fields greit beim Update von Mappen und regelt ob bestehende Feldinhalte überschrieben werden sollen.

Weiteres

Sofern die Anlagen auf einem anderen Reiter als der Standardreiter auftauchen sollen, muss dieser über Doc. register konfiguriert werden.

Interne Felder

Auf dem Register "Info" erhalten Sie zusätzliche Infos zu internen Feldern über die weitere Aktionen möglich sind.

Konfigurationsoptionen

OptionBeschreibung

Basics

Server url

Url des EASY Documents SOAP Webservices.

Im Standard läuft der Service auf Port 11001. Eine Beispiel-Url wäre http://localhost:11001/.

Über den Button neben dem Feld kann ein Verbindungstest durchgeführt werden.

File type

Definiert den zu verwendenden Mappentyp bzw. das EDA Archiv.

Der Mappentyp kann auch über die Exportdestination in der Anwendung festgelegt werden.

Der File type für ein EDA Archiv hat folgenden Aufbau:

<ARCHIV>@<STORAGE><ARCHIVE>@<STORAGE>

Beispiel:

INVOICE@store1
Info
titleHinweis

Bei Übergabe der FILEID muss der Mappentyp nicht definiert werden.

Key fieldDefinition des Schlüsselfeldes. Das Schlüsselfeld ist für das Aktualisieren von Mappen erforderlich. Das Schlüsselfeld könnte beispielsweise das Feld "Belegnummer" sein.
Doc. registerOptionale Definition eines Dokumenten-Registers. Alle Dateianlagen werden im Documents entsprechend auf dem angegegeben angegeben Register dargestellt.
Gentable fieldDocuments Feldname für die Übergabe von Positionsdaten.

Advanced

Create onlyMit dieser Option wird explizit kein Update auf bestehende Mappen durchgeführt, sondern immer eine neue Mappe angelegt.
Fields existence checkFührt eine Existenzprüfung der übergebenen Felder im Documents durch um Fehler bei der Übergabe zu verhindern. In anderen Fällen kann es gewünscht sein, dass der Export auf einen Fehler läuft, sobald die Felddefinitionen beider Systeme nicht übereinstimmen.
Overwrite fieldsBei einem Update können bestehende Felder aktualisiert werden.
Only meta dataMit der Option "Only meta data" kann festgelegt werden, ob bei einem Mappen-Update nur die Metadaten oder auch die zugehörigen Blobs mit aktualisiert werden sollen.
Use enhanced document update features

Ermöglicht die Verwendung der FileId und die damit verbundenen Funktionen wie Update.

Info
titleHinweis

Diese Option benötigt eine EASY Documents API Voll-Lizenz.

Login

ClientZu verwendender Mandant.
UserBenutzer.
PasswordBenutzerpasswort.
LocaleAnmeldesprache.

Steuerfelder

Steuerfelder sind definierte Feldnamen über die bestimmte Konfigurationsparameter dynamisch festgelegt werden können. Diese Parameter überschreiben die Angaben, welche im Exportservice fest konfiguriert wurden. Sie werden durch den Exportservice selbst interpretiert.

SteuerfeldBeschreibung
FILETYPEFestlegung des MappentypesMappentyps.
FILEIDAngabe der Mappen-ID für die Auswahl eines in DOCUMENTS existierenden Dokuments für ein Update.
KEYFIELDAlternative Methode zur Angabe der FILEID zum Update eines Dokuments basierend auf einem Feldinhalt.
DOCREGISTERFestlegung des Registers, dem die Blobs zugeordnet werden.
SERVERURLÜberschreibt die angegebene Server-Url.
CLIENTÜberschreibt den angegebenen DOCUMENTS-Mandant.
USERBenutzer mit sich der Exportservice sich gegenüber DOCUMENTS autorisiert.
PASSWORDPasswort mit sich der Exportservice sich gegenüber DOCUMENTS autorisiert.
LOCALESprache mit der die Anmeldung erfolgen soll.

Interne Parameter

Die internen Parameter werden in Form von Feldern vom Exportservice direkt an die SOAP-Schnittstelle des DOCUMENTS-Systems weitergegeben. Sie werden erst vom SOAP-Service des DOCUMENTS-Servers interpretiert.

ParameterBeschreibung
.FileTypeMappentyp festlegen.
.FileID

DOCUMENTS-Mappen-Id (eindeutig) zum Updaten einer bestehenden Mappe.

.FileKey

Name des Feldes, welches als Feldwert einen eindeutigen Schlüssel für die Mappe darstellt (bspw. RechnungsNr).

Dieser Schlüssel wird für ein Update einer bestehenden Mappe herangezogen.

Existiert eine Mappe mit dem angegebenen Schlüssel nicht, dann wird eine neue angelegt.

.FileOwner

der angegebene Benutzer (login-Name) wird als Eigentümer der Mappe eingetragen.

.TargetFolder

die Mappe wird in den angegebenen öffentlichen Ordner eingefügt.

.Register

die im Import-Datensatz angegebenen Dokumente werden der angegeben Registerseite zugeordnet.

.CommentKommentar für alle enthaltenen Dokumente.
.TitleTitel setzen (überschreibt den Titel aus FT:).
.Resubmission

Setzen des Wiedervorlagedatums für den Eigentümer der Mappe.

.ArchiveID

Frühe Archivierung:

Über dieses Schlüsselwort wird beim Anlegen der Mappe eine Referenz auf eine Mappe im Archiv gesetzt. Als Wert muss der Key der Archivmappe übergeben werden. Das Format des Keys bei Verwendung des XML-Servers (EE.i) ist

$(Lagerort)\Archiv,MappenId,Version (Bsp. $(BELEGE)\DEMO,00000004,001) bzw. als Beispiel für die EE.x der Archivkey  Bsp. Unit=Default/Instance=Default/Pool=DEMO

Desweiteren muss der Mappentyp ein Register mit dem Registertypen "Archivierte Dokumente" besitzen. Unter diesem Register werden dann die Dokumente aus der referenzierten Archivmappe angezeigt.

.OwnerInbox

Wird hier der Wert "0" übergeben, wird die Mappe  nicht in den Eingangskorb der Eigentümers gelegt.

.DeleteOldDOCUMENTS

Wird hier der Wert "1" übergeben, werden beim Update! einer Mappe alle Dokumente vor dem Upload der neuen Dokumente aus der Mappe gelöscht!

.Workflow

Der angegebene Workflow (Versendeliste) wird an der Mappe angelegt.

Verwendung der Parameter

Für die Verwendung der Parameter gibt es grundsätzlich zwei Wege. Grundsätzlich werden sie aus Feldinhalten heraus verwendet, damit ergeben sich grundsätzlich zwei Wege sie dem Exportservice mitzugeben. Zum einen können sie direkt im Feldschema als Definition für das external Field angegeben werden, zum anderen ist natürlich die Übersetzung der Mapping-Scheme möglich. In beiden Fällen erfolgt allerdings keine Weitergabe als tatsächlicher Dokumenteninhalt in Form eines Feldes im späteren Dokument in DOCUMENTS. 

Verwendung als External Field 

Im einfachsten Fall können die oben angegebenen Parameter einfach als Feld in einem Feldschema konfiguriert werden. Das entsprechende Feld ist so anzulegen, dass in der Option "External field" der vorgesehene Paramter in der oben angegebenen Schreibweise angegeben ist. Bei Parametern für den SOAP-Service ist bei der Angabe der vorangestellte Punkt wichtig.

Verwendung im Mapping-Scheme 

Alternativ zum Eintrag im Feldschema kann die Zuordnung auch über ein Mapping Scheme erfolgen, etwa wenn mehrere Exporte, sprich Exportservices in einem Exportvorgang nacheinander ausgeführt werden sollen und nicht alle Felder 1:1 verwendet werden können. Die Exportservices werden dazu über ein Exportscheme kombinert. Innerhalb eines Exportschemes kann dann je Exportschritt ein Mapping Scheme zugwiesen werden.

Zunächst ist das Mapping Scheme mit den Feldern des Feldschemas zu definieren. Hierbei wird den Feldern mit denen man während des Exports Inhalte in das Zielsystem transportieren will, bzw. im Exportservice Eigenschaften bzw. Funktionen beeinflussen will, der externe Name (Target) direkt zugewiesen. Soll das Feld in einem weiteren Exportschritt dann ausgelassen werden, ist diesem Export ein anderes Mapping Scheme zuzuweisen, in dem der Wert für Target leer gelassen wird.

Technische Bezeichnung

cceasydocumentsexport.dll

Table of Contents

Children Display
alltrue
depth1