- Erstellt von Redakteur7 am Feb. 16, 2021
Für dieses Element ist ein How-To Artikel verfügbar.
Semantik
Mit dem <eoms-input-submit>-Element können Daten (Dateien / Verzeichnisse) an die EOMS-Input-Schnittstelle von docxworld geschickt (eingeliefert) werden. Optional können Sie ein Array (in JavaScript erstellte HashMap) mit Informationen übergeben, dass mit versendet werden soll. Besonders wichtig ist das Attribut id, denn über diese id können Sie sich später z.B. in einem <eoms-input-query-data> oder <eoms-input-query-status> auf diesen Sendevorgang beziehen.
Die Verbindungsinformationen, wohin sich <eoms-input-submit> verbinden soll, sind in der eoms.invoker.client.properties festgelegt.
Attribute
Attributname | Datentyp | Beschreibung | Mögliche Werte | Standardwert | Obligatorisch? |
---|---|---|---|---|---|
id | STRING | Die ID des Elements, über die es im Code angesprochen werden kann. | beliebiger, regelkonformer Name. | — | |
file | FILEOBJECT | Das FILEOBJECT (Datei / Verzeichnis), das übertragen werden soll. | Ein existierendes FILEOBJECT. | — | |
variables | MAP | Eine Map (Eigenschaft - Wert), die bei der Übertragung berücksichtigt und mitgesendet wird. Diese Map kann z.B. Informationen wie docxworld-Client oder docxworld-Vertrag enthalten und muss per Skript erstellt werden (siehe Beispiel). | HashMap (JavaScript). | — | |
timeout | STRING (long) | Die Zeit in ms, die auf eine erfolgreiche Übertragung gewartet werden soll, bis der Vorgang mit einer Ausnahme abgebrochen wird. | Numerische Zeitangabe in ms. | 1000 (ms) |
Subelemente / Inhalt
Das <eoms-input-submit>-Element besitzt keine Subelemente.
Variablenbindungen
Das <eoms-input-submit>-Element ist vom Typ REQUEST-OBJECT. Dieser Typ besitzt folgende Variablenbindungen:
Bindung | Beschreibung | Rückgabetyp |
---|---|---|
getId() | Gibt die Id des <eoms-input-submit>-Elements zurück. | STRING |
getCreated() | Gibt den Zeitpunkt, zu dem die Übertragung initialisiert wurde, zurück. | DATE |
getExpires() | Gibt den Zeitpunkt, bis zu dem der Vorgang gültig ist, zurück. Ab diesem Zeitpunkt wird der Vorgang verworfen, falls er noch nicht geendet hat. | DATE |
getMessages() | Gibt die internen Messages zurück. | LIST OF STRINGS |
getProperties() | Gibt die HashMap, die für den Übertragungsvorgang als variables übergeben wurde, zurück. | MAP |
getStatus() | Gibt den Status des <eoms-input-submit> zurück. Kann entweder ACTIVE (aktiv) oder TERMINATED (fertig) sein. | REQUESTSTATUS |
getBody() | Sollte nicht verwendet werden. | SUBMITJOBREQUEST |
Beispiel
In folgendem Beispiel wird die vom Aufrags-System (Spooler) durch <fetchresource> empfangene Ressource direkt an den EOMS-Input-Server gesendet. Mit übergeben wird eine HashMap, die per JavaScript erstellt wurde und per variables übergeben wird. Das Beispiel verzichtet auf eine Nachbehandlung des <eoms-input-submit>-Vorgangs. Beispiele dazu finden Sie bei <eoms-input-query-status> und <eoms-input-query-data>.
<rcml> <process id="ExampleProcess" name="example process"> <script language="JavaScript"><![CDATA[ var submitVariables = new java.util.HashMap(); submitVariables.put('EOMS_CLIENT', process['eoms.client']); submitVariables.put('EOMS_PROCEDURE', process['eoms.procedure']); submitVariables.put('EOMS_REFERENCE', process['eoms.reference']); ]]> </script> <workdir id="workdir" home="./WORK"/> <fetchresource id="inputFile" resource="${process['eoms.process.input']}" /> <eoms-input-submit id="submitJob" file="inputFile" variables="${submitVariables}"/> <!-- Hier kann mit <eoms-input-query-status> und <eoms-input-query-data> Status und Daten abgefragt werden... --> </process> </rcml>
Zweck:
Datenübertragung
Typ:
Standalone
Elternelement:
Top-Level-Elemente
Subelemente:
Nein
Variablenbindungen:
Ja
Falls die Übertragung durch <eoms-input-submit> fehlschlägt, wird das Element eine Ausnahme (Exception) und die Verarbeitung wird nicht fortgesetzt. Folgender Code wird nicht ausgeführt.
- Keine Stichwörter