engine:procedures:mi_getbatchjobs_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:mi_getbatchjobs_ad [11.01.2016 ] |
engine:procedures:mi_getbatchjobs_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== mi_GetBatchJobs_Ad ===== | ||
| + | |||
| + | Liefert den Inhalt der Tabelle "BatchJobs" zurück.\\ | ||
| + | |||
| + | In dieser Tabelle sind verschiedene Prozeduren registriert, die gewisse "Batch-Job"-typische Aufgaben erledigen, wie z.B. Schnittstellen-Läufe.\\ Für diese Prozeduren ist festgehalten, wann sie zuletzt von welchem Benutzer aufgerufen wurden. Außerdem gibt es einen "Status", an dem man erkennen kann, ob die Prozedur zuletzt erfolgreich ("0") ausgeführt wurde, ob sie momentan noch läuft ("100") oder ob es einen Fehler gab.\\ | ||
| + | |||
| + | HINWEIS :\\ Es gibt Fehler (wie z.B. ein "deadlock"), die die Abarbeitung einer Prozedur einfach unterbrechen, ohne daß man die Möglichkeit hat, den Fehler abzufangen. In diesem Fall bleibt der Status der Prozedur auf "100", obwohl es keinen Prozeß mehr gibt, der die Prozedur ausführt. Dies ist höchstwahrscheinlich dann der Fall, wenn "LastRun" sehr viele Stunden oder gar Tage her ist. In diesem Fall (und wenn ein Fehler auftrat) wird jeder Versuch, die Prozedur erneut aufzurufen, scheitern - der Return-Code "-560" wird zurückgegeben.\\ Wenn man "sicher" ist, daß der Fehler behoben ist bzw. kein Prozeß mehr läuft, der diese Prozedur ausführt, kann man mit [[dstoreproc>mi_ResetBatchJob_Ad]] den Status wieder auf "0" setzen.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[mi Get Batch Jobs Ad]}}| | ||
| + | |Engine-Kategorie|miscellaneous | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
| + | |||
| + | ==== Parameter ==== | ||
| + | |||
| + | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ProcedureName|NULL |Optionale Einschränkung der Ausgabe auf eine bestimmte Prozedur\\ |varchar(50)|3.5.0| | ||
| + | |OrderByColumn|1 |Nach welcher Rückgabe-Spalte soll das Ergebnis sortiert werden ? Sonderfall : "LastRun" ist ein "varchar"-Feld, enthält aber eine Datumsangabe. In diesem Fall wird natürlich nicht alphanumerisch sortiert, sondern nach dem Datum.\\ |tinyint|4.0.8| | ||
| + | |OrderDesc|0 |Soll die Rückgabemenge absteigend ("1") oder aufsteigend ("0") nach der "OrderByColumn"ten Spalte sortiert werden ?\\ |bit|4.0.8| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ProcedureID|ID einer Prozedur\\ |smallint|3.5.0 | | ||
| + | |ProcedureName|Name der Prozedur "ProcedureID"\\ |varchar(50)|3.5.0 | | ||
| + | |LastRun|Zeitpunkt des letzten Aufrufs (Format : "15.04.2000 12:33:28")\\ |varchar(30)|3.5.0 | | ||
| + | |Status|Status der letzen Ausführung, mögliche Werte:\\ "0" : "Success" (Prozedur wurde erfolgreich ausgeführt, es gab keine Fehler)\\ "100" : "Running" (Die Prozedur wird momentan ausgeführt - siehe auch "HINWEIS" in der Beschreibung !)\\ Sonst : Ein Error-Code\\ |integer|3.5.0 | | ||
| + | |LastCallFromUser|Name eines dStore-Benutzers (aus "UserInfo", siehe [[dstoreproc>mi_GetUserInfo_Ad]]), der die Prozedur "ProcedureID" zuletzt aufgerufen hat\\ |varchar(50)|3.5.0 | | ||
| + | |||
| + | == Sortierungen der Rückgabe == | ||
| + | |||
| + | wenn OrderDesc = 0 und OrderByColumn = 1 | ||
| + | * ProcedureID (aufsteigend) | ||
| + | wenn OrderDesc = 1 und OrderByColumn = 1 | ||
| + | * ProcedureID (absteigend) | ||
| + | wenn OrderDesc = 0 und OrderByColumn = 2 | ||
| + | * ProcedureName (aufsteigend) | ||
| + | wenn OrderDesc = 1 und OrderByColumn = 2 | ||
| + | * ProcedureName (absteigend) | ||
| + | wenn OrderDesc = 0 und OrderByColumn = 3 | ||
| + | * LastRun (aufsteigend) | ||
| + | wenn OrderDesc = 1 und OrderByColumn = 3 | ||
| + | * LastRun (absteigend) | ||
| + | wenn OrderDesc = 0 und OrderByColumn = 4 | ||
| + | * Status (aufsteigend) | ||
| + | wenn OrderDesc = 1 und OrderByColumn = 4 | ||
| + | * Status (absteigend) | ||
| + | wenn OrderDesc = 0 und OrderByColumn = 5 | ||
| + | * LastCallFromUser (aufsteigend) | ||
| + | wenn OrderDesc = 1 und OrderByColumn = 5 | ||
| + | * LastCallFromUser (absteigend) | ||
| + | |||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt| | ||
| + | |-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt| | ||
| + | |-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt| | ||
| + | |-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt| | ||
| + | |-530|Der Wert ist nicht konvertierbar|nur indirekt| | ||
| + | |-510|Der Benutzer ist nicht registriert|nur indirekt| | ||
| + | |-504|Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt| | ||
| + | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
| + | |-500|Falsche Parameter|direkt und indirekt| | ||
| + | ==== XML-Schema ==== | ||
| + | |||
| + | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
| + | ==== Historie ==== | ||
| + | |||
| + | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |4.0.14 |2004-06-03|1. Aufruf der Prozeduren "_mi_StartProcedure" und "_mi_FinishProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
| + | |4.0.8 |2004-02-20|Neue Parameter "OrderByColumn" und "OrderDesc"\\ | | ||
| + | |4.0.7 |2004-01-16|Interne Änderung : "ProcedureName" steht jetzt in der neuen Tabelle "RegisteredProcedures", in "BatchJobs" steht nur noch die "ProcedureID", die auf die "ProcedureID" besagter neuer Tabelle referenziert\\ | | ||
| + | |3.5.0 |2000-11-23|Erstmalig in dieser Version erstellt\\ | | ||
| + | |||
| + | ==== Code-Snippets ==== | ||
| + | |||
| + | == Engine Playground == | ||
| + | Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist: | ||
| + | * [[http://playground.dstore.de/index.php?proc=mi_GetBatchJobs_Ad|mi_GetBatchJobs_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetBatchJobs_Ad'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetBatchJobs_Ad' | xmllint --format -</code>== dStore_php == | ||
| + | <code php> | ||
| + | use dStore_php\WebService; | ||
| + | |||
| + | $service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80); | ||
| + | |||
| + | $request = new WebService\Requests\Engine\Procedure\Request( | ||
| + | new WebService\Requests\AccessData('default'), | ||
| + | 'mi_GetBatchJobs_Ad', | ||
| + | array( | ||
| + | // 'ProcedureName' => NULL, | ||
| + | // 'OrderByColumn' => 1, | ||
| + | // 'OrderDesc' => 0 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | </code> | ||
| + | == engine/execute == | ||
| + | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
| + | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <ListOfBatches> | ||
| + | <Batch No="0"> | ||
| + | <Procedure Name="mi_GetBatchJobs_Ad"> | ||
| + | <Parameters> | ||
| + | <!-- <Parameter Name="ProcedureName">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="OrderByColumn">1</Parameter> --> | ||
| + | <!-- <Parameter Name="OrderDesc">0</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/mi_getbatchjobs_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)