Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:mi_getdstoreuser_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== mi_GetdStoreUser_Ad ===== | ||
+ | |||
+ | Ermittelt alle "dStore"-Benutzer aus "UserInfo". Im Gegensatz zu [[dstoreproc>mi_GetUserInfo_Ad]] bekommt man aber garantiert ALLE Datensätze (also auch evtl. Benutzer wie "sa" oder "dstore") zurück bzw. man kann angeben, daß man nur Administratoren ausgegeben bekommt (s. Anmerkung).\\ | ||
+ | |||
+ | Anmerkung:\\ | ||
+ | |||
+ | Die Benutzer im "dStore" unterteilen sich in...\\ | ||
+ | |||
+ | * Vom "dStore" (bzw. "ASE") vorgegebene Benutzer, die entweder Ausführungsrechte auf ALLE, KEINE oder nur auf bestimmte Prozeduren besitzen | ||
+ | * "sa" : Der vom "ASE" vorgegebene Benutzer "sa" ist im Regelfall NICHT in "UserInfo" eingetragen, da dieser eigentlich nur für den Datenbank-Server betreffende administrative Aufgaben gedacht ist. | ||
+ | * "dstore" : Wie "sa" ist er im Regelfall auch nicht in "UserInfo" eingetragen. "dstore" "besitzt" die Datenbank (d.h. ist "owner" in der Sybase-Terminologie), auf der die Software "dStore" installiert wurde und sollte nur für administrative Aufgaben, die die Datenbank betreffen, verwendet werden. | ||
+ | (Man kann die beiden Benutzer "sa" und "dstore" natürlich "zu Fuß" in "UserInfo", via "INSERT INTO ...", eintragen - zu Testzwecken etwa, denn viele Prozeduren können nicht ausgeführt werden, wenn der Benutzer nicht in "UserInfo" registriert ist.) | ||
+ | * "Global" : Hierbei handelt es sich NUR um einen "dummy"-Benutzer, der kein Login für den ASE-Server besitzt, und es gibt auch keinen gleichnamigen Benutzer in der Datenbank. Er wird nur an einigen Stellen für allgemeine / "globale" Einstellungen benötigt, wie z.B. für die Tabelle "Settings" (siehe [[dstoreproc>mi_GetSettings_Ad]] bzw. [[dstoreproc>mi_ModifySettings_Ad]]). | ||
+ | * "cronjob" : Dieser ist für "Batch-Jobs" gedacht, die in einem bestimmten Rhythmus (stündlich, täglich etc.) ausgeführt werden, d.h. er sollte nur für sehr wenige Prozeduren Ausführungsrechte benötigen. Im Regelfall implementiert man in der "dstore"-Datenbank die "sp_Cronjob..."-Prozeduren und vergibt nur auf diese Ausführungsrechte für den "cronjob". | ||
+ | * "actionuser" : Für die Abarbeitung von "Actions" (siehe [[dstoreproc>ac_GetActions_Ad]]) gedacht. | ||
+ | * "interfaceuser" : Gehört in der Regel der (in der Datenbank eingerichteten) Gruppe "interface" an und sollte für jegliche Art von Schnittstellen verwendet werden (Artikelimport z.B.). | ||
+ | * sweeper : Dies ist der einzige Benutzer, der "_co_SweepCurrentlyUsersOnline" ausführen kann, und er ist im Regelfall NICHT in "UserInfo" eingetragen, da er keinen anderen Zweck erfüllen muß. | ||
+ | |||
+ | |||
+ | * Administratoren | ||
+ | Sie gehören der (in der Datenbank eingerichteten !) Gruppe "admin" an und können standardmäßig alle Prozeduren ausführen AUSSER die "internen" (das sind Prozeduren, deren Name mit einem "_" beginnt). Durch [[dstoreproc>mi_SetExecuteRights_Ad]] kann man jedoch gezielt Ausführungsrechte verteilen.\\ Es gibt einen besonderen Administrator, der vom "dStore" vorgegeben ist, und auch nicht aus "UserInfo" gelöscht werden kann (zumindest nicht über [[dstoreproc>mi_ModifyUserInfo_Ad]]) : der "Super"-Admin. Er zeichnet sich dadurch aus, daß sein Name mit dem Datenbanknamen übereinstimmt (in der die Software "dStore" installiert ist) und es "..._Ad"-Prozeduren gibt, die NUR er ausführen darf - oder Prozeduren, die mit bestimmten Parametern nur vom "Super"-Admin aufgerufen werden dürfen.\\ Um alle Administator-Benutzer zu sehen, führt man [[dstoreproc>mi_GetdStoreUser_Ad OnlyAdmins = 1]] aus.\\ | ||
+ | |||
+ | und schließlich :\\ | ||
+ | |||
+ | * "publicuser" | ||
+ | Dieser Benutzer ist der (in der Datenbank eingerichteten) Gruppe "public" zugeordnet und besitzt somit nur Ausführungsrechte auf "..._Pu"-Prozeduren. Der "publicuser" ist also für "den Rest der Welt" gedacht, d.h. für alle Nutzer, die eine Anwendung, die auf dem "dStore" basiert ("Web-Shop", "Community" etc.), verwenden. Man sollte dem "publicuser" also AUF KEINEN FALL Ausführungsrechte auf "..._Ad"-Prozeduren oder gar interne Prozeduren geben !\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[mi Getd Store User Ad]}}| | ||
+ | |Engine-Kategorie|basics | | ||
+ | |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 ^ | ||
+ | |OnlyAdmins|1 |"0" : ALLE Benutzer aus "UserInfo" werden ausgegeben\\ "1" : Nur die "Admin"-Benutzer werden ausgegeben, d.h. alle außer vom "dStore" bzw. vom ASE vordefinierten User (z.Zt. "sa", "dstore", "cronjob", "actionuser", "Global", "publicuser", "interfaceuser")\\ |bit|3.5.0| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |UserID|ID eines "dStore" / "ASE"-Benutzers, der in "UserInfo" registriert ist\\ |smallint|3.5.0 | | ||
+ | |UserName|Name des Benutzers "UserID"\\ |varchar(50)|3.5.0 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * UserName (aufsteigend) | ||
+ | |||
+ | ==== 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| | ||
+ | |-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.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
+ | |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.0 |2003-04-03|Der "interfaceuser" ist auch kein "Admin"-Benutzer !\\ | | ||
+ | |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_GetdStoreUser_Ad|mi_GetdStoreUser_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetdStoreUser_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_GetdStoreUser_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_GetdStoreUser_Ad', | ||
+ | array( | ||
+ | // 'OnlyAdmins' => 1 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_GetdStoreUser_Ad"> | ||
+ | <Parameters> | ||
+ | <!-- <Parameter Name="OnlyAdmins">1</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||