engine:procedures:mi_getsessionmanagement_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:mi_getsessionmanagement_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== mi_GetSessionManagement_Pu ===== | ||
| + | |||
| + | Gibt ein oder alle zu einer Benutzer-Sitzung hinterlegte(s) Key-Value-Paar(e) zurück\\ | ||
| + | |||
| + | |||
| + | |||
| + | Anmerkung zum Parameter "UpdateDateAndTime" :\\ | ||
| + | |||
| + | Bei jedem Aufruf dieser Prozedur werden als erstes alle Einträge aus "SessionManagement" gelöscht, die älter als 30 Minuten bzw. älter als die in "Settings" zum Schlüssel "InvalidateSessionDataAfterXMinutes" konfigurierte Anzahl Minuten sind ! Daher kann man mit "UpdateDateAndTime" bewirken, daß der/die ermittelte(n) Datensatz/Datensätze aktualisiert wird/werden, um so quasi die "Lebensdauer zu verlängern".\\ | ||
| + | |||
| + | Hinweis :\\ Tatsächlich aktualisiert wird ein Eintrag aber nur, wenn der Zeitpunkt der letzten Aktualisierung länger als 1/3 der Ablaufzeit (von Einträgen) vom aktuellen Zeitpunkt zurückliegt. Die Ablaufzeit beträgt wie oben bereits geschildert 30 Minuten bzw. die in "Settings" zum Schlüssel "InvalidateSessionDataAfterXMinutes" konfigurierte Anzahl Minuten.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[mi Get Session Management Pu]}}| | ||
| + | |Engine-Kategorie|miscellaneous | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.8 (2015-08-21)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |__SessionID__| |ID einer Sitzung - im Regelfall z.B. die "UniqueID" eines Besuchers (Tabelle "Visitors")\\ |varchar(50)|3.5.0| | ||
| + | |__KeyVariable__| |Name eines Schlüssels, zu dem der für die Sitzung "SessionID" hinterlegte Wert zurückgegeben werden soll. "NULL" angeben, um die Werte zu ALLEN hinterlegten Schlüsseln zu bekommen.\\ |varchar(50)|3.5.0| | ||
| + | |UpdateDateAndTime|1 |Gibt an, ob der Eintrag zum Schlüssel "KeyVariable" bzw. alle Einträge der Session "SessionID" aktualisiert werden sollen ("1") oder nicht ("0").\\ Hintergrund : s. Beschreibung !\\ |bit|3.5.0| | ||
| + | |SelectResult|1 |Dieser Parameter wird nur beachtet, falls "KeyVariable" angegeben ist !\\ "0" : Ergebnis nur über den Rückgabeparameter "Value" ausgeben\\ "1" : ZUSÄTZLICH eine Rückgabemenge liefern\\ |bit|3.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === wenn SelectResult = 1 und KeyVariable is NOT NULL === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |Value|Zur Session "SessionID" hinterlegter Wert zum Schlüssel "KeyVariable"\\ |varchar(255)|3.5.0 | | ||
| + | === wenn KeyVariable is NULL === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |KeyVariable|Ein Schlüssel, zu dem für die Session "SessionID" der Wert "Value" hinterlegt ist\\ |varchar(50)|3.5.19 | | ||
| + | |Value|Der zum Schlüssel "KeyVariable" hinterlegte Wert (für die Session "SessionID")\\ |varchar(255)|3.5.19 | | ||
| + | |DateAndTime|Zeitpunkt, wann der Eintrag "Value" zum Schlüssel "KeyVariable" zuletzt aktualisiert wurde\\ |datetime|3.5.19 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | |Value|Ausgabeparameter für den zum Schlüssel "KeyVariable" hinterlegten Wert - wird natürlich nur belegt, falls "KeyVariable" angegeben ist !| | ||
| + | ==== 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|nur 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.8 |2015-08-21|1. Implementierung des neuen "Settings"-Eintrags "InvalidateSessionDataAfterXMinutes"\\ 2. Allgemeine Quellcode-Anpassungen an den aktuellen Standard\\ 3. "Start-/Finish-Procedure"-Logik eingebaut\\ | | ||
| + | |4.0.0 |2003-04-03|Kleine Veränderung am Quellcode - nur "kosmetischer" Natur\\ | | ||
| + | |3.5.19 |2002-06-17|\\ | | ||
| + | |3.5.10 |2001-07-14|\\ | | ||
| + | |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_GetSessionManagement_Pu|mi_GetSessionManagement_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetSessionManagement_Pu?SessionID=<value>&KeyVariable=<value>'</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_GetSessionManagement_Pu?SessionID=<value>&KeyVariable=<value>' | 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_GetSessionManagement_Pu', | ||
| + | array( | ||
| + | 'SessionID' => '<value>', | ||
| + | 'KeyVariable' => '<value>', | ||
| + | // 'UpdateDateAndTime' => 1, | ||
| + | // 'SelectResult' => 1 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | $OutputParams = $xml_result->getOutputParametersAsArray();</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_GetSessionManagement_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="SessionID"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="KeyVariable"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="UpdateDateAndTime">1</Parameter> --> | ||
| + | <!-- <Parameter Name="SelectResult">1</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/mi_getsessionmanagement_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)