Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Eingabesystem "XSuiteWorkflow"

Das Eingabesystem "XSuiteWorkflow" dient dem Einlesen von Arbeitselementen aus dem Workflow Service der xSuite Helix Cloud.

Eigenschaft

Beschreibung

InputSystem.Url*

HTTPS-Basisadresse des xSuite-Helix-Webservices

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

InputSystem.Keycloak*

Eigenschaften für die Authentifizierung gegenüber den Webservices über einen Keycloak-Dienst

Syntax: siehe Keycloak-Authentifizierung

InputSystem.ProxyServer

Proxy-Server, der optional für die Kommunikation mit den Webservices genutzt wird

Syntax: siehe Proxy-Server-Verbindung

InputSystem.RequestTimeout

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

Standardwert: 100

InputSystem.SearchDefinition(*)

Name einer Suchabfrage, über die Arbeitselemente ermittelt werden, die auf Export warten

Die Suchabfrage muss serverseitig definiert sein.

InputSystem.WorkflowName(*)

InputSystem.ActivityName(*)

veraltete Variante zur Ermittlung der Arbeitselemente, die auf Export warten

Diese Eigenschaften sind eine Alternative zur Suche über die Eigenschaft .SearchDefinition.

Die genutzte Suchabfrage ist fest im Programm hinterlegt und wird um die folgenden Filterwerte ergänzt:

  • WorkflowName: Name des Workflows, dessen auf Export wartende Arbeitselemente eingelesen werden sollen

  • ActivityName: Name der Aktivität im Workflow, in der sich die auf Export wartenden Arbeitselemente befinden

InputSystem.FileFilter

Namensfilter für die einzulesenden Dateianlagen der Arbeitselemente

Standardwert: * (keine namentliche Einschränkung)

InputSystem.FileTypeFilter

Filter für den Dokumenttyp der einzulesenden Dateianlagen der Arbeitselemente

Syntax: siehe Syntax von Namensfiltern

Neben * sind hier insbesondere die folgenden Werte einzeln oder in Kombination nutzbar:

  • Unknown

  • OriginalDocument (Standardwert)

  • WorkingDocument

  • Attachment

InputSystem.FileNameMacro

optionaler Feldmakroausdruck, der einen benutzerdefinierten Dateinamen für eine Dateianlage zurückliefert

Hier können die allgemeinen Dateivariablen genutzt werden, z. B. FileName, FileBaseName und FileExt. Außerdem ist die Variable FileType nutzbar, die sich auf den Dokumenttyp bezieht.

Hinweis

Die xSuite-Helix-Dienste zur Statusaktualisierung arbeiten asynchron. Die Abfrage der Arbeitselemente, die zum Export bereitstehen, sollte daher in einem ausreichend großen Intervall durchgeführt werden (siehe Eigenschaft Worker[].Timer ).

Wenn der Intervall zu klein ist, können unmittelbar zuvor exportierte Elemente bei der nächsten Abfrage fälschlicherweise erneut zum Export angeboten werden. Das führt zu einem Fehler beim wiederholten Exportversuch und einer Warnmeldung im Logging.

Die Indexdaten eines Arbeitselements werden von dem jeweiligen Webservice als JSON-Struktur zurückgeliefert. Die JSON-Struktur entspricht dem Datenschema des Workflows. Zum späteren Auslesen der Daten im "Process"-Schritt werden die Indexdaten dem xSuite-Interface-Dokument als künstlich generierte Dateianlage index.json hinzugefügt. Diese Dateianlage kann mit dem allgemeinen JSON-Indexdatenleser verarbeitet werden.

Die Arbeitselemente werden nach vollständiger Verarbeitung in xSuite Interface auf Workflow-Seite grundsätzlich nicht gelöscht, unabhängig von den Backup-Einstellungen in xSuite Interface. Die Arbeitselemente werden direkt nach dem erfolgreichen Einlesen in den nächsten Workflow-Schritt verschoben. Die Verarbeitung in xSuite Interface erfolgt somit asynchron zur weiteren Workflow-Ausführung. Eine Rückmeldung des Verarbeitungsstatus an den Workflow erfolgt nicht.