Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Eingabesystem "OtrisDocumentsSoap"

Das Eingabesystem "OtrisDocumentsSoap" dient dem Einlesen von Mappen aus der Anwendung otris Documents über die SOAP-Proxy-Schnittstelle.

Eigenschaft

Beschreibung

InputSystem.Url*

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

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

InputSystem.User*

InputSystem.Password*(§)

InputSystem.Principal*

InputSystem.Locale

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

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

InputSystem.ProxyServer

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

Syntax: siehe Proxy-Server-Verbindung

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

InputSystem.RequestTimeout

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

Standardwert: 100

InputSystem.FileType[]*

Namen der Mappentypen, die eingelesen werden

Bei Abfrage gegen ein EDA-Archiv ist die Syntax {Mappentyp}@{Archivserver} zu verwenden.

InputSystem.StatusField*

Name des Feldes in der Mappentyp-Definition, das einen Statuswert beinhaltet, der signalisiert, dass die Mappen eingelesen werden sollen (Status "Waiting")

Das Feld wird anschließend über eine Mappen-Aktualisierung auch zur Statusfortschreibung durch xSuite Interface genutzt. Folgende Statusarten sind verfügbar:

  • Working

  • Finished

  • Error

  • Suspended

InputSystem.StatusValue[]

Teilparameter zur Definition der konkreten Werteausprägungen für die verschiedenen Status in der obigen Eigenschaft .StatusField:

  1. Type*: Statusart Waiting, Working, Finished, Canceled, Error oder Suspended

  2. Value: in den Mappen zu verwendende Werteausprägung für den betreffenden Status

Standardmäßig sind die Werteausprägungen identisch mit den Statusarten, die unter Type aufgeführt sind. Somit wird nach Mappen gesucht, die im .StatusField den Wert "Waiting" haben. Nach dem Einlesen wird dieser Wert auf "Working" gesetzt.

Wenn eigene .StatusValue-Einträge definiert werden, muss dieses vollständig für alle gewünschten Status erfolgen. Der Parameter Value kann dabei leer gelassen werden, wenn z. B. neue Mappen im Status "Waiting" durch einen leeren Statuswert gekennzeichnet werden. Einzelne Statusarten können außerdem ausgelassen werden, wenn für diese kein Wert gesetzt werden soll.

Hinweis

Für die Status Waiting und Working sollte immer ein Eintrag definiert sein, damit bereits eingelesene Mappen erkennbar sind und nicht wiederholt eingelesen werden.

InputSystem.ErrorField

optionaler Name eines Feldes in der Mappentyp-Definition

In dieses Feld wird im Fehlerfall (Status Error oder Suspended) die Fehlermeldung aus der xSuite-Interface-Verarbeitung geschrieben.

InputSystem.SearchFilter

optionaler Filterausdruck in otris-Documents-Syntax (siehe SOAP-Proxy-Dokumentation)

Dieser Filterausdruck schränkt die Auswahl der einzulesenden Mappen um ein benutzerdefiniertes Merkmal weiter ein. Der Ausdruck wird über eine Und-Verknüpfung mit der impliziten Suche in der Eigenschaft .StatusField kombiniert.

InputSystem.FileFilter

Namensfilter zur optionalen Einschränkung der Dateianlagen, die aus einer Mappe übernommen werden

Nur die Dateianlagen, die dem angegebenen Namensmuster entsprechen, werden übernommen.

Standardwert: * (Übernahme aller Anlagen)

Die Indexdaten, die aus einer otris-Documents-Mappe extrahiert wurden, werden dem xSuite-Interface-Dokument als künstlich generierte Dateianlage index.json hinzugefügt. Die Indexdaten können dadurch im "Process"-Schritt über einen Indexdatenleser vom Typ "Json" ausgelesen werden. Die Eigenschaften, die in dem JSON-Objekt enthalten sind, entsprechen dabei namentlich den Feldern der Mappentyp-Definition. Tabellarische Daten, die in einer Mappe XML-strukturiert als "GenTable" abgelegt sind, werden automatisch in ein äquivalentes JSON-Konstrukt konvertiert.

Ein GenTable-Feld enthält beispielsweise die folgende XML-Zeichenfolge:

<table>
   <tr>
      <td title="Column1">Hello</td>
      <td title="Column2">World</td>
   </tr>
</table>

Bei der Konvertierung in JSON wird unter dem Namen des GenTable-Feldes (im Beispiel "GenTableField" genannt) ein Array mit einem Objekt pro Tabellenzeile angelegt, das die Spaltennamen als Eigenschaften enthält:

{
   "GenTableField": [
      {
         "Column1": "Hello",
         "Column2": "World",
      }
   ]
}

Im JSON-Indexdatenleser können die .InputName-Eigenschaften für die beiden Tabellenfelder als JSONPath-Ausdrücke GenTableField[*].Column1 und GenTableField[*].Column2 definiert werden. Der Stern (*) in der JSONPath-Syntax steht für die Auswahl aller Array-Elemente, d.h. aller Tabellenzeilen. Wenn über die Eigenschaft ProcessReadIndex[].ItemProperty[] eine explizite Zuordnung zwischen JSON-Array und Zieltabellenfeld im Feldkatalog vorgenommen wird, verkürzen sich die Ausdrücke auf die relativen Pfade Column1 und Column2.

Feldwerte werden von otris Documents immer als String übergeben. Wenn die Zielfelder einen anderen Typ haben, muss daher explizit ein .InputFormat zum korrekten Parsen im Indexdatenleser definiert werden.

Unabhängig von den Backup-Einstellungen und abweichend vom Standard werden otris-Documents-Mappen nach vollständiger Verarbeitung in xSuite Interface grundsätzlich nicht gelöscht.

In diesem Abschnitt: