Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Ausgabesystem "OtrisDocumentsSoap"

Das Ausgabesystem "OtrisDocumentsSoap" dient der Erzeugung neuer oder Aktualisierung vorhandener Mappen in der Anwendung otris Documents über die SOAP-Proxy-Schnittstelle.

Eigenschaft

Beschreibung

OutputSystem[].http*

HTTP(S)-Basisadresse des SOAP-Proxy-Webservices von otris Documents

Die Basisadresse muss inklusive Portnummer, aber ohne Unterpfade angegeben werden.

OutputSystem[].User*

OutputSystem[].Password*(§)

OutputSystem[].Principal*

OutputSystem[].Locale

Benutzername, Passwort, Mandantenkennung und Sprache (Standardwert: de) für die Anmeldung in otris Documents

OutputSystem[].AsUser(%)

zweiter Benutzername, wenn die Anmeldung per "trusted login" im Kontext eines anderen Benutzers erfolgen soll

Dafür muss dem obigen .User-Konto in otris Documents die Eigenschaft trustedLoginAccount=1 zugewiesen werden.

OutputSystem[].ProxyServer

Proxy-Server, der optional für die Kommunikation zum Webservice genutzt wird

Syntax: siehe Proxy-Server-Verbindung

OutputSystem[].MaxConnectionsPerUser

maximale Anzahl gleichzeitiger Logins (Sitzungen) für denselben Benutzer am SOAP-Proxy

Diese Anzahl wird von otris Documents begrenzt. Bei einer parallelen Nutzung mehrerer Schnittstellen zum SOAP-Proxy wird empfohlen, unterschiedliche Benutzerkonten zu verwenden. Ansonsten muss xSuite Interface die Anfragen künstlich serialisieren und somit den Durchsatz drosseln.

Standardwert: 3

OutputSystem[].RequestTimeout

Timeout-Wert in Sekunden, wie lange auf eine Antwort der Webservices gewartet wird, bevor ein Fehler geworfen wird

Standardwert: 100

OutputSystem[].FileType(*%)

Name des Mappentyps, für den neue Mappen erstellt oder bestehende Mappen aktualisiert werden

Diese Angabe ist nur verpflichtend, wenn ausschließlich ein Skript (Eigenschaft .ScriptName) ausgeführt wird.

OutputSystem[].GenTableField[]

Teilparameter zur Definition der Zuordnung von tabellarischen Ausgabefeldern zu einem Zielfeld in der otris-Documents-Mappe, das einen "GenTable"-Inhalt im XML-Format entgegennimmt:

  1. Name*: Name des GenTable-Feldes

  2. FieldName: optionaler Tabellenname der Quellfelder im Feldkatalog

Wenn kein einschränkender FieldName angegeben wird, gilt das GenTable-Zielfeld für alle Quelltabellen.

OutputSystem[].DocRegister[]

Teilparameter zur optionalen Definition der Namen von Registern im Documents-Mappentyp, in denen übergebene Dateianlagen abhängig von ihrem Typ platziert werden:

  1. FileName: Dateinamensmuster (Standardwert: *)

  2. Register*: Name des Registers

Pro Dateianlage werden die Einträge in der Reihenfolge ihrer Definition auf Übereinstimmung mit dem Namensmuster geprüft. Der Registername des ersten übereinstimmenden Eintrags wird genutzt.

OutputSystem[].DirectEas

Wahrheitswert, ob die Neuanlage oder Aktualisierung von Mappen direkt in einem EAS-Archiv anstatt in otris Documents erfolgt

Wenn die Neuanlage/Aktualisierung im EAS-Archiv erfolgt, muss die obige Eigenschaft .FileType um den technischen Namen des Archivservers erweitert werden. Die Syntax hierfür ist {Mappentyp}@{Archivserver}.

Standardwert: FALSE

OutputSystem[].UpdateMode

Modus für die Neuanlage oder Aktualisierung von Mappen:

  • None: keine Aktualisierung, sondern Neuanlage

  • First: Aktualisierung nur der ersten gefundenen Mappe

  • All: Aktualisierung aller gefundenen Mappen

Der Modus All ist nur in der folgenden Konstellation anwendbar: Über einen Schlüsselbegriff (Eigenschaften .UpdateKeyField und .UpdateKeyValueMacro) wird nach bestehenden Mappen gesucht und die Eigenschaft .UpdateExistCheckMode steht nicht auf None.

OutputSystem[].UpdateDocsMode

Modus für die Behandlung von gleichnamigen Dateianlagen bei der Aktualisierung von Mappen:

  • Append: Dateianlagen werden immer hinzugefügt (Standardwert)

  • Replace: gleichnamige Dateianlagen werden ersetzt

  • ReplaceVer: gleichnamige Dateianlagen werden ersetzt und versioniert

Die Modi bewirken nur das Setzen entsprechender Schalter in der otris-Documents-API. Die tatsächliche Funktionsfähigkeit hängt von weiteren Einstellungen in otris Documents ab.

OutputSystem[].UpdateExistCheckMode

Modus für die Existenzprüfung von zu aktualisierenden Mappen:

  • None: keine explizite Prüfung (Standardwert)

  • Error: Fehler werfen, wenn nicht gefunden

  • Create: Neuerstellung, wenn nicht gefunden

Im Modus None greift das Standardverhalten von otris Documents, d.h. bei Nichtexistenz einer zu aktualisierenden Mappe wird versionsabhängig entweder implizit eine neue Mappe angelegt oder ein Fehler geworfen. Außerdem wird bei der Suche über einen Schlüsselbegriff (Eigenschaften .UpdateKeyField und .UpdateKeyValueMacro) grundsätzlich nur die erste gefundene Mappe aktualisiert, unabhängig von dem obigen .UpdateMode.

In den anderen Modi führt xSuite Interface vorab explizit eine eigene Suche nach bestehenden Mappen durch. Im Modus Error wird bei Nichtexistenz ein Fehler geworfen und im Modus Create wird eine neue Mappe angelegt. Das gilt nur für die Suche über einen Schlüsselbegriff, denn bei Vorgabe einer konkreten Mappen-ID (Eigenschaft .UpdateFileId) wird die Existenz der betreffenden Mappe immer vorausgesetzt und ansonsten ein Fehler geworfen.

OutputSystem[].UpdateFileId(%)

OutputSystem[].UpdateKeyField(%)

OutputSystem[].UpdateKeyValueMacro

Definition des Identifikationsmerkmals einer zu aktualisierenden Mappe

Die Identifikation kann entweder direkt über die eindeutige Mappen-ID erfolgen (.UpdateFileId) oder über eine auszuführende Suche anhand eines Suchfeldnamens (.UpdateKeyField) und eines Suchwertes (.UpdateKeyValueMacro).

Der Wert ist hier in Form eines Feldmakroausdrucks anzugeben. Der Feldmakroausdruck muss eine Zeichenfolge zurückliefern, die bei typisierten Suchfeldern, z. B. Datumsfeldern, syntaktisch den Anforderungen von otris Documents entspricht.

OutputSystem[].SendFileUser(%)

OutputSystem[].SendFileTaskDescr(%)

Angabe eines empfangenden Benutzers und einer Aufgabenbeschreibung, wenn eine Mappe nach der Erstellung oder Aktualisierung direkt versendet wird

OutputSystem[].WorkflowName(%)

Name eines Workflows, der nach der Erstellung oder Aktualisierung einer Mappe gestartet wird

OutputSystem[].ScriptName(%)

OutputSystem[].ScriptParam[]

Name eines Portalskriptes, das nach der Erstellung oder Aktualisierung einer Mappe ausgeführt wird

Als Sonderfall ist auch die reine Ausführung eines Skriptes ohne Mappenbezug möglich, wenn kein .FileType angegeben wird.

Über die aus Teilwerten bestehende Eigenschaft .ScriptParam[] können Aufrufparameter für das Skript definiert werden:

  1. Name*: Name des Skript-Parameters

  2. Value*: Wert des Skript-Parameters

Analog zu normalen Indexfeldern werden auch Parameterwerte immer als Zeichenfolgen übergeben, sodass bei typisierten Werten, z. B. einem Datum, auf eine geeignete Syntax zu achten ist.

OutputSystem[].FileIdField

optionaler Name eines Feldes aus dem Feldkatalog

In dieses Feld wird die generierte Mappen-ID oder nach einer Aktualisierung geänderte Mappen-ID zurückgeschrieben.

Im .OutputName sind die Zielfelder entsprechend ihrer Benennung im betreffenden otris-Documents-Mappentyp anzugeben. Bei tabellarischen, an ein GenTable-Element zu übergebenden Feldern müssen die Ausgabenamen dem "title"-Attribut der GenTable-Felddefinitionen entsprechen.

Die Übergabe von Feldwerten erfolgt grundsätzlich als Zeichenfolge (String), sodass bei typisierten Werten eine geeignete Syntax im .OutputFormat zu definieren ist, die den Anforderungen des Zielsystems entspricht. Bei einer Anmeldung in deutscher Sprache werden z. B. Datumswerte typischerweise im Format dd.MM.yyyy erwartet.