Ein Vorgang in den Web Services besteht aus mehreren Aktionen, aus einem Vorgangsmanager, der die Aktionen verwaltet, sowie aus Variablenpools. Jedes dieser Objekte hat Eigenschaften, die sich im Laufe des Vorgangs verändern können.
Eine Anwendung die die MWS integriert, hat die Möglichkeit Informationen zum Vorgang abzurufen, um sie anzuzeigen bzw. um zu entscheiden, welche weiteren Aktionen auszuführen sind. Damit die Datenmenge die über die Leitung gesendet wird, minimal gehalten werden kann, besteht die Möglichkeit, die Informationen auch selektiv anzufordern. Dazu muss der Typ der benötigten Information angegeben werden.
Die Eigenschaften des Vorgangsmanagers werden unabhängig vom Informationstyp immer zurückgegeben.
Das Element mwsprocessmngr befindet sich unter dem Element process.
Beispiel
... <mwsprocessmngr lasterrorcode="0" lasterrormessage="" lastactionname="" onstart=""> ...
Attribut | Beschreibung |
---|---|
lasterrorcode | Nummer des zuletzt aufgetretenen Fehlers |
lasterrormessage | Beschreibung des zuletzt aufgetretenen Fehlers |
onstart | Name der Aktion, die direkt nach dem Erstellen des Vorgangs gestartet werden soll. Anmerkung: Das Setzen dieser Eigenschaft zu einem späteren Zeitpunkt als beim Erstellen des Vorgangs hat keine Auswirkung.
|
lastactionname | Name der zuletzt ausgeführten Aktion |
Eine weitere wichtige Information ist der zuletzt aufgetretene Fehler. Diese Information wird immer dann unabhängig vom Informationstyp zurückgegeben, wenn ein Fehler aufgetreten ist. Diese Information befindet sich unmittelbar unter dem Element mws.
... <error errorcode="6000">error text</error> ...
Aktuell werden folgende Informationstypen unterstützt
PROCESSINFO
Attribut | Beschreibung |
---|---|
Titel | Titel des Vorgangs |
Beschreibung | Beschreibung des Vorgangs |
Unmittelbar unter dem Vorgangsmanager werden mit dem Element mwsaction die Aktionen aufgelistet.
Jede Aktion hat folgende Attribute:
Attribut | Beschreibung |
---|---|
name | Name der Aktion |
lasterrorcode | Nummer des zuletzt aufgetretenen Fehlers |
lasterrormessage | Beschreibung des zuletzt aufgetretenen Fehlers |
state | Siehe Action Eigenschaft state |
configured | Siehe Action Eigenschaft configured |
Erweiterte Attribute der Aktion DATASELECTION. Siehe Spezielle Attribute der Aktion DATASELECTION
Erweiterte Attribute der Aktion PRINTANDARCHIVE. Siehe Spezielle Attribute der Aktion PRINTDOCUMENTS
POOLVARS
Ausgabe von Variablen des Pools SYSTEMPOOL. Siehe Poolvariablen abfragen und setzen.
MANVARS, MANVARS2
Ausgabe von manuellen Variablen des Bündels.
Da die manuellen Variablen zur Aktion CREATEDOCUMENTS gehören, werden sie unter dem entsprechenden Element aufgelistet.
Beispiel
... <mwsaction name="CREATEDOCUMENTS" lasterrorcode="0" lasterrormessage="" state="0" configured="0"> <manvars> <docref name="Partner_Application_ManVar" title="Partner_Application_ManVar" reference="790B817A-B2C3-475E-86E5-08118150EA94"> <manvar name="Agent_Forename" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_E4437CCD-E71A-4181-9C6E-0691B26E0C8F" title="Agent_Forename" mask="" vh_name="" vh_id="" vh_system="" vh_type="2" input_enabled="Y" data_link="MODUSUSER" data_attribute="Forename" input_required="0"/> <manvar name="Agent_Surname" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_EAAC39D9-81BA-476B-A003-039ABF3618AA" title="Agent_Surname" mask="" vh_name="" vh_id="" vh_system="" vh_type="0" input_enabled="Y" data_link="MODUSUSER" data_attribute="Surname" input_required="0"/>Doe </docref> </manvars> <manvars2> <docref name="Partner_Application_ManVar" title="Partner_Application_ManVar" reference="790B817A-B2C3-475E-86E5-08118150EA94"> <manvar2 name="Agent_Forename" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_E4437CCD-E71A-4181-9C6E-0691B26E0C8F" title="Agent_Forename" mask="" vh_name="Forename" vh_id="" vh_system="" vh_type="2" input_enabled="Y" data_link="MODUSUSER" data_attribute="Forename" input_required="0"/><valuehelp><combobox xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" sorted="true"> <items> <item>Martin</item> <item>Hugo</item> <item>Ernest</item> <item>Max</item> <item>John</item> </items> </combobox></valuehelp>Doe</manvar2> <manvar2 name="Agent_Surname" reference="DocumentCollection.790B817A-B2C3-475E-86E5-08118150EA94:308DFBC5-F520-414E-ACBD-0A4495C33301_EAAC39D9-81BA-476B-A003-039ABF3618AA" title="Agent_Surname" mask="" vh_name="" vh_id="" vh_system="" vh_type="0" input_enabled="Y" data_link="MODUSUSER" data_attribute="Surname" input_required="0"/> </docref> </manvars2> </mwsaction> ...
Die Elemente manvars und manvars2 sind Sammelknoten für alle manuellen Variablen. Die manuellen Variablen eines Dokuments werden unter dem Sammelknoten docref aufgelistet.
Die Elemente manvars und manvars2 haben folgende Attribute:
Attribut | Beschreibung |
---|---|
name | Name des Dokuments |
title | Titel des Dokuments. |
reference | Siehe Adresse eines Objekts im Bündel |
Die Elemente manvars und manvars2 beschreiben eine manuelle Variable wie folgt:
Attribut | Beschreibung |
---|---|
name | Name der manuellen Variablen |
reference | Siehe Adresse eines Objekts im Bündel |
title | Titel für den Prompt |
mask | Eingabemaske (siehe Studio Dokumentation) |
vh_name | Name der Wertehilfe (optional) |
vh_id | Objekt-ID der Wertehilfe (optional) |
vh_system | System-ID der Wertehilfe (optional) |
vh_type | Typ der Wertehilfe Mögliche Werte 0: Der Variablen ist keine Wertehilfe zugewiesen 1: Textbox 2: Combobox 3: Kalender 4: Numerisches Eingabefeld (SpinEdit) 7: Mehrzeilige Textbox |
input_enabled | 0, wenn keine manuelle Eingabe möglich sein soll (wenn z.B. nur eine Auswahl möglich sein soll) Dieses Attribut ist nur dann vorhanden, wenn keine manuelle Eingabe möglich sein soll. |
Data | Aktueller Wert der manuellen Variablen |
Falls in den zugehörigen AppSettings angegeben, muss das Element manvar2 vom MWS bei Anfrage von manual variables info zurückgegeben werden. Dies ist der Fall für
- Die zurückgegebene Warnung Configuration for action CREATEDOCUMENTS required!
- Einen Aufruf von Process_GetInfo mit dem infoType MANVARS.
Ist eine Wertehilfe der Variablen zugewiesen, die durch das Element manvar2 beschrieben wird, wird ein zusätzliches Kindelement <valuehelp> hinzugefügt, das die zugehörige serialisierte Wertehilfedefinition enthält.
SELPARAMS
Ausgabe von Parametern für die Datenbeschaffung. Da diese Parameter zur Aktion DATASELECTION gehören, werden sie unter dem entsprechenden Element aufgelistet.
Beispiel
... <mwsaction name="DATASELECTION" lasterrorcode="0" lasterrormessage="" state="0" configured="0"> <selparams> <selections> <selection name="Partner_Letter" title="Partner_Letter" active="True"> <selparam name="Partnernumber" displayname="PartnerNumberTest" mask=""/>0815</selparam> </selection> </selections> </selparams> </mwsaction>
Ein Parameter für die Datenbeschaffung wird mit dem Element selparam beschrieben:
Attribut | Beschreibung |
---|---|
name | Name des Parameters |
displayname | Name, der in der Anzeige verwendet werden soll. Wenn leer, wird der Name verwendet. |
mask | Eingabemaske für diesen Parameter. Wenn leer, wird keine Eingabemaske verwendet. |
data | Parameterwert |
OUTPARAMS
Ausgabe von Parametern für das Outputmanagement. Da diese Parameter zur Aktion PRINTDOCUMENTS gehören, werden sie unter dem entsprechenden Element aufgelistet.
Beispiel
... <mwsaction name="PRINTDOCUMENTS" lasterrorcode="0" lasterrormessage="" state="0" configured="0"> <objects> <object title="ApplicationPack" type="D" name="ApplicationPack" index="07102009-289-tdr-dm1" reference="933110B7-0485-4C62-A50C-0B9D7FC62DB1"/> </objects> </mwsaction> ...
Es sind alle Objekte aufgelistet, deren Druckdefinition noch mit Hilfe der Methode Obj_SetStructure zu vervollständigen sind.