Diese Funktionalität ist nur in bestimmten Ausbaustufen verfügbar.

Sie befinden sich hier: Referenz > Jobdefinitionen > webserviceTrigger

webserviceTrigger

Das Tag <webserviceTrigger> umhüllt die Definitionen für einen Trigger, mit dem über eine Webservice-Schnittstelle ein Job gestartet wird. Dieses Tag besitzt keine Attribute.

Erlaubte Unterelemente Anzahl
outputFolder 1
failedFolder 1

Beispielaufruf eines Jobs (ohne Callback)

Der Job kann über den Aufruf einer URL im Browser (HTTP GET) oder über einen HTTP-Webservice-Aufruf (HTTP POST) ausgelöst werden. Dabei können beliebige Schlüssel-Wert-Paare über URL-Parameter (HTTP GET) bzw. im Request-Body (HTTP POST) mitgesendet werden. Auf diese wird in der Job-Definition über trigger.params zugegriffen. Das obige Beispiel zeigt den Zugriff auf die gesamte Parameter-Map und den dedizierten Wert des Schlüssels 'mykey', hier: '1234'.

Als Antwort wird die Fortschrittsseite für den erzeugen Job angezeigt.

Hinweis:

Bei einem POST-Aufruf werden alle angegebenen URL-Parameter ignoriert.

Als Antwort erhält man das Job-Objekt mit Statusinformationen zum Zeitpunkt des Anlegens. Weitere Fortschrittsinformationen müssen wiederholt abgefragt werden (Polling). Alternativ kann unter Angabe einer Callback-URL ein Aufruf eines externen Webservice durch den Job Server bei Fertigstellung des Jobs erfolgen. Siehe dazu Abschnitt "Beispielaufruf des Callbacks durch Job Server".

Beispielabfrage des Job-Status

Ein angelegter, noch nicht abgeschlossener Job kann folgende Zustände haben:

 

Ein abgeschlossener Job kann folgende Zustände einnehmen:

 

Beispielaufruf des Callbacks durch den Job Server

Wird beim Anlegen des Jobs eine Callback-URL angegeben, ruft der Job Server bei Fertigstellung des Jobs die URL mit einem POST auf. Die Antwort wird ignoriert.

Download der erzeugten Dateien

Über den, im Job-Status enthaltenen, Link downloads kann die Liste der erzeugten Dateien des Jobs abgefragt werden. Die einzelne Datei wird dann über den enthaltenen file-Link heruntergeladen. Die Dateien müssen während der Job-Ausführung mittels MarkFileForDownloadCommand dem Job Server bekanntgegeben werden.