Aktionen, Kommandos und deren Ergebnisse - Web Services - Foundation 23.2 - Foundation 23.2 - Ready - Content Composer - external - Content-Composer/Web-Services/Foundation-23.2/de-DE/Content-Composer-Web-Services/WS-Process/Aktionen-Kommandos-und-deren-Ergebnisse - 2024-07-12

Content Composer Web Services

Platform
Content Composer
Product
Web Services
Release
Foundation 23.2
License

Ein Vorgang der Web Services wird im Wesentlichen durch seine Aktionen definiert. Eine Aktion kann Vorgänger haben und kann eine Konfiguration erfordern. Eine Aktion hat außerdem einen Status, der Informationen über den Arbeitsfortschritt der Aktion erteilt.

Innerhalb eines MWS-Prozesses repräsentieren die vorhandenen MwsActivityStatus-Prozesskomponenten die Aktionen.

Aktionen der Web Services bei Verwendung des MWS_Standard-Prozesses

Action Beschreibung
OBJECTSELECTION Objektauswahl
DATASELECTION Datenbeschaffung
COMPLETESTRUCTURE Bündelstruktur ergänzen z.B. dynamisches Bündel
CREATEDOCUMENTS Dokumentenerstellung
FORWARD Vorgang weiterleiten
PRINTDOCUMENTS Bündeldokumente drucken
PRINTANDARCHIVE Übergabe der Bündeldokumente an Odin

Diese Reihenfolge gibt auch die Abhängigkeit der Aktionen untereinander vor:

  • Es kann erst gedruckt werden, wenn die Dokumente erstellt worden sind.
  • Die Dokumente können erst erstellt werden, wenn bekannt ist, welche Dokumente erstellt werden sollen.
  • Erst wenn die Daten beschafft worden sind, ist bekannt welche Dokumente erstellt werden sollen.

Zusätzlich zu dieser festen Abhängigkeit zwischen den Aktionen gibt es auch noch dynamische Abhängigkeiten, die nicht immer vorhanden sind und oftmals nur durch eine Benutzereingabe gelöst werden können.

Dies bedeutet, dass eine Aktion in bestimmten Fällen erst dann ausgeführt werden kann, wenn eine Konfiguration dieser Aktion durchgeführt worden ist.

Dynamische Abhängigkeiten

  • Daten können erst dann beschafft werden, wenn die Parameter für die Selektion bekannt sind.

    Die Notwendigkeit zur Eingabe dieser Parameter ist aber erst dann gegeben, wenn solche Parameter überhaupt vorhanden sind.

  • Dokumente können erst dann erstellt werden, wenn die manuellen Variablen gesetzt worden sind.

    Die Notwendigkeit zur Eingabe von manuellen Variablen ist aber erst dann gegeben, wenn manuelle Variablen vorhanden sind. Dies kann sich bekanntlich, je nachdem welche Textbausteine ausgewählt worden sind, sehr schnell ändern.

  • Ein Bündel kann nur dann sofort gedruckt werden, wenn der Sofortdrucker angegeben wurde.

    Die Notwendigkeit zur Angabe eines Sofortdruckers ist erst dann gegeben, wenn Sofortdruck gewünscht ist.

  • Ein Bündel kann nur dann weitergeleitet werden, wenn entweder ein Benutzer und/oder eine Benutzergruppe angegeben ist, an die der Vorgang weitergeleitet werden soll.

    Ist eine oder mehrere dieser dynamischen Abhängigkeiten gegeben, so kann die jeweilige Aktion erst dann erfolgreich gestartet werden, wenn die Konfiguration abgeschlossen wurde.

    Eine Aktion gilt erst dann als konfiguriert, wenn die Eigenschaft (siehe Action-Eigenschaft configured) entsprechend gesetzt wurde.

    Eigenschaften von Aktionen können in den Optionen (siehe Optionen des Vorgangs) beim Aufruf der Funktionen Process_Start oder Process_Create übermittelt werden.

Vorgangssteuerung

Die Vorgangssteuerung der Web Services sieht vor, dass jede Aktion prinzipiell immer gestartet werden kann. Wurden die Vorgänger der zu startenden Aktion noch nicht ausgeführt, dann versucht die Vorgangssteuerung diese auszuführen. Die Überprüfung der Vorgängeraktionen startet immer bei der ersten Aktion des Prozesses.

Wenn also beispielsweise direkt nach der Erstellung des Vorgangs PRINTDOCUMENTS gestartet wird, dann versucht die Vorgangssteuerung alle noch ausstehenden Aktionen, beginnend bei der ersten Aktion des Prozesses, auszuführen.

Sollte eine dieser Aktionen nicht konfiguriert sein, wird eine entsprechende Configuration-Warning zurückgegeben. Ansonsten wird die Aktion ausgeführt und die nächste Aktion wird geprüft.

Der Vorgang läuft somit bis zur ersten Configuration-Warning oder endet mit der Ausführung der gestarteten Ziel-Aktion PRINTDOCUMENTS.

Fehlerbehandlung

Sind manuelle Eingaben erforderlich, führt der Start eines Kommandos zur Rückgabe des Fehlercodes 6000.

Damit nach der Eingabe der fehlenden Informationen das ursprünglich gestartete Kommando fortgesetzt werden kann, merken sich die MWS dieses. Beim nächsten Kommandostart kann das gespeicherte Kommando durch das fiktive Kommando CONTINUE_LAST_ACTION erneut aktiviert werden.

Beispiel Pseudocode

...
res := Process.Process_Start(FSID, FPID, 'PRINT_AND_ARCHIVE', options, resxml);
if res = 6000 then
begin
   ok := LetUserConfigActions(options, resxml);
   if ok then
      res := Process.Process_Start(FSID, FPID, 'CONTINUE_LAST_ACTION', options, resxml);
end;
...

Kommandos und deren Ergebnisse

Wie man am letzten Beispiel sehen kann, entspricht der Inhalt des Parameters command nicht dem Namen der Aktionen des Vorgangs.

Abgesehen von den zwei statischen Kommandos SET_PARAMETERS und CONTINUE_LAST_ACTION leiten sich die Kommandos aus den Namen der im MWS-Prozess enthaltenen Skriptausführungs-ProzessBausteine ab.

Dabei wird durch Angabe des Kommandos der erste Skriptausführungs-ProzessBaustein, dessen Objektnamen mit dem übergebenen Kommando übereinstimmt, als Zielaktivität festgelegt.

Wird kein entsprechender Skriptausführungs-ProzessBaustein gefunden, wird ein entsprechender Fehler ausgelöst.

Die folgende Auflistung bezieht sich auf den MWS_Standard Prozess.

  • SET_PARAMETERS

    Bei diesem Kommando werden nur die Parameter in den Optionen ausgewertet und gesetzt. Eine Aktion wird nicht gestartet. Bei Erfolg wird ein leerer String zurückgegeben.

  • SELECT_OBJECT

    Die Aktion OBJECTSELECTION wird gestartet. Bei Erfolg gleicht das Ergebnis XML dem des Kommandos SELECT_DATA.

    Ist kein Bündel geladen und entsprechende Parameter zum Laden des Objektes (Bündel) benötigt werden, kehrt das Kommando mit dem Fehlercode 6000 zurück.

    Die Beschreibung zum Aufbau des XMLs finden Sie im Kapitel XML Beispiele einer Configuration Warning für die Aktion FORWARD.

  • SELECT_DATA

    Die Aktion DATASELECTION (Datenbeschaffung) wird gestartet. Bei Erfolg wird ein XML zurückgegeben, welches die Struktur des Bündels widerspiegelt.

    Dieses XML entspricht dem Ergebnis der Prozedur Obj_GetStructure wenn man im Parameter RootRef einen Leerstring und im Parameter MaxLevel eine 1 übergeben würde.

    Das Kommando kehrt mit dem Fehlercode 6000 zurück, wenn Parameter für den Start der Selektion benötigt werden.

    In diesem Fall enthält das Ergebnis-XML die benötigten Parameter.

    Die Beschreibung zum Aufbau des XMLs finden Sie im Kapitel XML Beispiele zu SELPARAMS.

  • COMPLETE_STRUCTURE

    Das Ereignis NachDatenbeschaffung wird ausgelöst und das entsprechende Skript (sofern zugewiesen) wird ausgeführt.

    Das Ergebnis-XML entspricht dem des Kommandos SELECT_DATA.

  • CREATE_DOCUMENTS

    Die Dokumenterstellung wird gestartet. Auch bei diesem Kommando wird, wie beim Kommando SELECT_DATA, bei Erfolg die Struktur des Bündels zurückgegeben.

    Das Kommando kehrt mit dem Fehlercode 6000 zurück, wenn noch manuelle Variablen benötigt werden.

    In diesem Fall enthält das Ergebnis-XML die benötigten manuellen Variablen.

    Die Beschreibung zum Aufbau des XMLs finden Sie im Kapitel XML Beispiele zu MANVARS.

  • FORWARD_DOCUMENTS

    Die Aktion FORWARD wird gestartet. Bei Erfolg gleicht das Ergebnis XML dem des Kommandos SELECT_DATA.

    Das Kommando kehrt mit dem Fehlercode 6000 zurück, wenn das Bündel geblockt ist (im Skript NachDokumenteErzeugen wurde das Flag BlockBundle auf true gesetzt und der aktuelle User entspricht dem User, der den Vorgang angelegt hat).

    In diesem Fall enthält das Ergebnis-XML die benötigten Parameter zur Vorgangsweiterleitung.

    Die Beschreibung zum Aufbau des XMLs finden Sie im Kapitel XML Beispiele zu SELPARAMS.

  • PRINT_DOCUMENTS

    Führt die Aktion PRINTDOCUMENTS aus. Die Übergabe in das Outputmanagement wird vorbereitet.

    Bei Erfolg gleicht das Ergebnis XML dem des Kommandos SELECT_DATA.

    Das Kommando kehrt mit dem Fehlercode 6000 zurück, wenn nicht für alle Dokumente gültige Druckdefinitionen vorhanden sind.

    In diesem Fall enthält das Ergebnis-XML die Dokumente deren Druckdefinition noch mittels der Methode Obj_SetStructure zu vervollständigen sind.

    Genauere Informationen zum Aufbau des XMLs finden Sie im Kapitel OUTPUTPARAMS.

  • PRINT_AND_ARCHIVE

    Die Übergabe in das Outputmanagement wird mittels der OdinProcessImport-Komponente durchgeführt.

    Bei Erfolg gleicht das Ergebnis XML dem des Kommandos SELECT_DATA.

    Anderenfalls wird ein entsprechendes Fehler-XML zurückgegeben.

  • CONTINUE_LAST_ACTION

    Wenn ein Kommando durch den Fehler 6000 abgebrochen wurde, dann kann es mit Hilfe dieses fiktiven Kommandos wieder gestartet werden.

    Liegt kein gespeichertes Kommando vor, wird ein entsprechendes Error XML zurückgegeben.