Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_createdstoreuser_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:mi_createdstoreuser_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== mi_CreatedStoreUser_Ad =====
 +
 +Legt einen neuen "​dStore"​-Benutzer (s. [[dstoreproc>​mi_GetUserInfo_Ad]]) inkl. zugehöriem ASE-Login, (ASE-)Datenbank-Benutzer und gleichnamiger Person des Typs "​dStoreUser"​ an.\\ 
 +
 +ACHTUNG : Zur erfolgreichen Ausführung dieser Prozedur muß der Aufrufer die ASE-Rolle "​sso"​ haben !\\ 
 +
 +
 +
 +Dazu werden folgende Schritte erledigt :\\ Anmerkung : Die Aktionen können aufgrund von Beschränkungen im ASE leider nicht in einer Transaktion ausgeführt werden. Daher kann es theoretisch bei einem Fehler dazu kommen, daß nur ein Teil der Schritte ausgeführt wurde. Man kann aber die Prozedur einfach (nachdem die Ursache erkannt und behoben wurde natürlich) erneut aufrufen ! Wir versuchen aber, alle möglichen Fehler VORHER festzustellen (die "​-500"​-/"​-504"​-Fehler z.B.), so daß diese Situation hoffentlich eher selten vorkommt.\\ ​
 +
 +
 +
 +1. Die ganze Sache setzt einen Login im ASE-Server voraus. Dieser kann über "​DBLogin"​ angegeben werden (falls mit "​NULL"​ belegt, wählen wir den gleichen "​string"​ wie in "​UserName"​ angegeben).\\ ACHTUNG : Bis Version 6.0.8 konnte "​DBLogin"​ von "​UserName"​ abweichen, ab 6.5.0 ist das aber NICHT mehr erlaubt (=> am besten also immer mit "​NULL"​ belegen)\\ Außerdem muß natürlich ein entsprechendes Passwort zum Login (-> "​Password"​) übergeben werden. Zu jedem Login im ASE kann eine Art "​Kurzbezeichnung"​ (z.B. der "volle Name") hinterlegt werden - diese übergibt man in "​DBLoginDescription"​.\\ ACHTUNG : Optional war "​DBLoginDescription"​ nur bis Version 6.0.8, ab Version 6.5.0 MUSS "​DBLoginDescription"​ angegeben sein und mindestens 5 Zeichen (ohne Leertasten am Anfang und Ende) enthalten und darf (ab Version 7.0.2) keine Grossbuchstaben enthalten! Dies wird aber nur geprüft, wenn "​UserName"​ noch nicht als Login existiert (man kann diese Prozedur hier ja nochmals mit demselben "​UserName"​ aufrufen, weil z.B. etwas "​schief gelaufen"​ ist, s. obige Anmerkung). Außerdem prüfen wir ab Version 6.5.0, ob "​DBPassword"​ mindestens 6 Zeichen (ohne Leertasten) enthält !\\ 
 +
 +Hinweis : Existiert der Login schon, gibt es einen Fehler (neues Verhalten seit Version 6.5.0). Möchte man in so einem Fall aber, daß es weitergeht (etwa weil es bei einer vorherigen Ausführung einen Fehler gab, s. obige Anmerkung), setzt man "​AbortIfLoginAlreadyExists"​ auf "​0"​ - "​DBPassword"​ und "​DBLoginDescription"​ werden dann aber ignoriert (der Login wird also NICHT aktualisiert) !\\ Hintergrund für dieses neue Standard-Verhalten (Abbruch wenn der Login schon existiert) ist zu verhindern, daß aus Versehen bei UNTERSCHIEDLICHEN Engines auf demselben ASE-Server versucht wird, denselben Benutzer anzulegen, wobei aber einer sich dann nicht einloggen kann (weil die Passwörter natürlich in der Regel verschieden sind, aber nur einer "den Zuschlag erhalten"​ kann - der, der den Benutzer ZUERST anlegt nämlich) !\\ 
 +
 +ACHTUNG : In der derzeitigen Version des ASE können von "​DBLogin",​ "​DBPassword"​ und "​DBLoginDescription"​ nur die ersten 30 Zeichen berücksichtigt werden !\\ 
 +
 +
 +
 +2. Existiert der Login "​DBLogin"​ bzw. konnte er erfolgreich angelegt werden, wird in der Datenbank, in der diese Prozedur hier aufgerufen wird, ein Benutzer mit dem Namen "​UserName"​ zu besagtem Login angelegt - dabei entscheidet "​DBGroupAdmin"​ darüber, ob der neue Benutzer in die (Datenbank-)Gruppe "​admin"​ kommt ("​1"​) oder der "​public"​-Gruppe zugeordnet wird ("​0"​).\\ ​
 +
 +Hinweis : Existiert der Benutzer schon, gibt es KEINEN Fehler !\\ 
 +
 +
 +
 +3. Anschließend wird in den sogenannten "​dstore"​-Datenbanken ebenfalls dafür gesorgt, daß ein Benutzer "​UserName"​ (immer in der "​public"​-Gruppe) existiert. Besagte Datenbanken sind derzeit :
 +  * "​dstore"​
 +  * "​dstorechecks"​
 +  * "​dstoreifin"​
 +  * "​dstoreifout"​
 +  * "​dstoretempdb"​
 +
 +
 +
 +
 +4. Nun wird "​UserName"​ in der Tabelle "​UserInfo"​ registriert.\\ ​
 +
 +
 +
 +5. Innerhalb der Engine gibt es ebenfalls (wie in einer ASE-Datenbank auch) "​Gruppen"​. Diese dienen zur Administration der Rechtevergabe für Prozeduren und der Einschränkung von Prozedur-Aufrufen (s. [[dstoreproc>​mi_GetUserGroups_Ad]]). Im Gegensatz zu ASE-Datenbank-Gruppen kann ein Benutzer in der Engine aber in MEHRERE Gruppen eingeordnet werden (s. [[dstoreproc>​mi_ModifyUsersInGroups_Ad]]). Beim Anlegen eines Benutzers durch diese Prozedur hier hat man nun die Möglichkeit,​ den Benutzer direkt in eine Gruppe einzuordnen. Dazu übergibt man "​UserGroupID"​ entsprechend - der Default-Wert steht für die "​default"​-Gruppe,​ um die grundlegendsten "​Ad"​-Prozeduren ausführen zu können.\\ Beschränkungen :\\ 1.) Sofern der Benutzer, der diese Prozedur hier aufruft, NICHT der "Super Admin" (Name entspricht dem Namen der Datenbank) und auch NICHT in der Gruppe "super admin" (ID "​0"​) ist, muß "​UserGroupID"​ die ID einer Gruppe sein, der er selbst angehört !\\ 2.) Hier muß im Fall "​DBGroupAdmin = 0" IMMER "​NULL"​ angegeben werden, weil der neue Benutzer dann der (Datenbank-)Gruppe "​public"​ angehört und eine Gruppen-Zuordnung keinen Sinn macht, da dieser Benutzer sowieso nur "​public"​-Prozeduren ausführen kann !\\ 
 +
 +
 +
 +6. Es wird eine Person des Typs "​dStoreUser"​ angelegt, wobei die Eigenschaft zum Merkmal "​UserName"​ natürlich mit "​UserName"​ belegt wird, und als "​Password"​ der in "​CreatePersonWithPassword"​ angegebene Wert gewählt wird - bei Angabe von "​NULL"​ ermitteln wir den SHA1-Wert (i.d.R. mit einem geheimen "​salt",​ s. "​PersonTypeSettings"​-Eintrag zum Schlüssel "​DefaultEncryptionAlgorithm"​) für "​DBPassword"​.\\ Hinweis : Wenn "​CreatePersonWithPassword"​ angegeben ist, sollte dies natürlich "​DBPassword"​ entsprechen - nur eben verschlüsselt ! Genauer muß es die Form...\\ {<​Verschl.-Algorithmus (max. 10 Zeichen)>​}<​verschlüsseltes DBPassword, mind. 5 Zeichen, nur Zahlen/​Buchst.>​\\ ... haben (s.a. [[dstoreproc>​pm_GetEncryptionAlgorithm_Pu]]).\\ Falls es nicht diese Form hat oder andere Zeichen außer Buchstaben, Zahlen, "​-"​ und geschweifte Klammern enthält, gibt es einen Fehler !\\ 
 +
 +
 +
 +7. Falls "​UserMayCreateNewUsers"​ mit "​1"​ übergeben wird, vergeben wir dem neuen Login noch die ASE-Rolle "​sso"​ (wird benötigt, um Logins/​Benutzer im ASE anlegen zu können) und gewähren dem Benutzer "​UserName"​ Ausführungsrechte auf diese Prozedur hier - damit der neue Benutzer seinerseits neue Benutzer anlegen kann.\\ ​
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[mi Created Store User Ad]}}|
 +|Engine-Kategorie|configurations |
 +|Engine-Typ|Daten-Änderung |
 +|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 ^
 +|__UserName__| |Name des anzulegenden Benutzers (darf nicht mit "​_"​ beginnen, Hintergrund : s. Parameter "​InvalidateUserIfDeletionFails"​ von [[dstoreproc>​mi_DeletedStoreUser_Ad]],​ und darf keine Grossbuchstaben enthalten)\\ |varchar(50)|5.1.1|
 +|DBLogin|NULL |Name des zugehörigen ASE-Logins (s. Beschreibung). Falls "​NULL"​ angegeben wird, nimmt die Prozedur automtisch an, daß der Login dem Wert in "​UserName"​ entsprechen soll.\\ |varchar(50)|5.1.1|
 +|__DBPassword__| |Paßwort des zugehörigen ASE-Logins "​DBLogin"​ (s. Beschreibung). Es müssen mindestens 6 Zeichen (ohne Leertasten) angegeben werden !\\ |varchar(30)|5.1.1|
 +|__DBLoginDescription__| |Kurzbeschreibung des zugehörigen ASE-Logins "​DBLogin"​. Es müssen mindestens 5 Zeichen (ohne Leertasten) angegeben werden !\\ |varchar(50)|5.1.1|
 +|DBGroupAdmin|1 |"​0"​ : Der neue Benutzer wird der (Datenbank-)Gruppe "​public"​ zugeordnet\\ "​1"​ : Der neue Benutzer wird der (Datenbank-)Gruppe "​admin"​ zugeordnet\\ (s.a. Beschreibung)\\ |bit|5.1.1|
 +|UserGroupID|1 |ID einer "​dStore"​-Benutzer-Gruppe (s. [[dstoreproc>​mi_GetUserGroups_Ad]]),​ der der neue Benutzer automatisch zugeordnet werden soll (s. Beschreibung)\\ |smallint|5.1.1|
 +|CreatePersonWithPassword|NULL |Es wird eine Person des Typs angelegt, der in "​Settings"​ zum Schlüssel "​PersonTypeID_dStoreUser"​ konfiguriert ist - mit diesem Wert (bei "​NULL"​ wählen wir den SHA1-Wert von "​DBPassword"​) zum Merkmal "​Password"​ und mit "​UserName"​ zum Merkmal "​UserName"​\\ |varchar(100)|5.1.5|
 +|UserMayCreateNewUsers|0 |"​1"​ angeben, wenn der neue Benutzer seinerseits neue Benutzer anlegen können soll (dafür sind nämlich bestimmte Rechte erforderlich)\\ |bit|6.5.0|
 +|AbortIfLoginAlreadyExists|1 |Existiert der Login "​DBLogin"​ schon, gibt es einen Fehler. Möchte man diesen vermeiden (um die weiteren Schritte ausführen zu lassen, s. Beschreibung),​ übergibt man hier den Wert "​0"​.\\ |bit|6.5.0|
 +==== Rückgabe ====
 +
 +Die Prozedur hat keine Rückgaben.
 +==== 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"​)) ^
 +|-697|Aktion kann nicht durchgeführt werden, da für ein Merkmal eine Zugriffsbeschränkung besteht|nur direkt|
 +|-650|Es sind nicht alle Pflichtmerkmale vorhanden|nur indirekt|
 +|-642|Inkrementelle Änderung konnte aufgrund paralleler Änderungen nicht durchgeführt werden|nur indirekt|
 +|-641|Die "​Unique"​-Eigenschaft mindestens eines Merkmals ist verletzt - Prozedur wurde abgebrochen|nur indirekt|
 +|-640|Einige Personendaten sind ungültig|nur indirekt|
 +|-630|Personendaten konnten nicht angelegt werden|nur indirekt|
 +|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
 +|-610|Fehlende oder falsche Daten in PersonMetaInformation|nur indirekt|
 +|-602|Zur defaultUniqueID ("​VisitorID = -2") können keinerlei Daten gespeichert oder verändert werden|nur indirekt|
 +|-572|Die Prozedur darf nur innerhalb einer Transaktion ausgeführt werden|nur indirekt|
 +|-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|
 +|-550|Fehlender oder falscher Eintrag in Settings|direkt und indirekt|
 +|-540|Falsches Format|nur indirekt|
 +|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
 +|-530|Der Wert ist nicht konvertierbar|nur indirekt|
 +|-518|Es ist eine bestimte ASE-Rolle erforderlich,​ die der Benutzer aber nicht besitzt|nur direkt|
 +|-517|Nicht-Super-Admins dürfen Benutzer-Gruppen-Zuordnungen nur für Gruppen verwalten denen sie angehören|nur direkt|
 +|-514|Anlegen des Benutzers fehlgeschlagen,​ da der Aufruf einer ASE-Prozedur fehlschlug (s. standard out)|nur direkt|
 +|-513|Ein Benutzer kann maximal 256 Gruppen zugeordnet werden|nur direkt|
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-504|Es ist ein Problem aufgetreten,​ das nicht gelöst werden kann, Prozedur wird daher abgebrochen|direkt und 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|1. Fehler behoben : Sofern das logging für diese Prozedur eingeschaltet war, wurde "​DBPassword"​ im Klartext\\ protokolliert !\\ 2. Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|7.0.2 |2013-08-29|"​UserName"​ MUSS ab sofort "​lower-case"​ sein\\ ​ |
 +|6.5.4 |2013-04-29|1. Fehler bzgl. Prüfung von "​EncryptedPassword"​ behoben (im "​Verschlüsselungs-Algorithmus"​ muß auch "​+"​ erlaubt sein)\\ 2. Implementierung des neuen Merkmal-Zugriffsbeschränkungen-Features\\ ​ |
 +|6.5.2 |2013-02-26|Fehler "​attempt to insert null value into column SortNo"​ bei "​UsersInGroups"​ behoben\\ ​ |
 +|6.5.1 |2012-11-02|1. Evtl. nötige SHA1-Wert-Ermittlung für "​DBPassword"​ nun auch evtl. mit "​salt"​\\ 2. Anpassungen bzgl. UTF8-Unterstützung\\ 3. Anpssungen, um Fehler zu erkennen BEVOR irgendeine Anlage/​Änderung durchgeführt wird [weil keine Transaktion möglich ist]\\ ​ |
 +|6.5.0 |2012-09-17|1. Neue Parameter "​UserMayCreateNewUsers",​ "​AbortIfLoginAlreadyExists"​\\ 2. Diverse neue Parameter-Prüfungen/​-Beschränkungen\\ 3. Bei "​CreatePersonWithPassword = NULL" wird nun trotzdem eine Person des Typs "​dStoreUser"​ angelegt\\ ​ |
 +|5.5.0 |2008-01-07|1. Fehler : Im Fall "​CreatePersonWithPassword"​ wurde nach den Merkmal-Bezeichnungen "​UserName"​ und "​Password"​ case-sensitive gesucht\\ 2. Es gab bislang einen Fehler, falls "​CreatePersonWithPassword"​ das Zeichen "​¶"​ enthielt\\ ​ |
 +|5.1.10 |2007-03-12|1. Da die Merkmal-IDs für "​UserName"​ bzw. "​Password"​ bei einigen Installationen schon vergeben waren, sind diese IDs ab jetzt nicht mehr "hart codiert"​\\ 2. "​print"​-Ausgabe im Fehler-Fall "​-550",​ die nähere Informationen über die Ursache enthält\\ ​ |
 +|5.1.5 |2006-08-29|Neuer Parameter "​CreatePersonWithPassword"​\\ ​ |
 +|5.1.1 |2006-04-05|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_CreatedStoreUser_Ad|mi_CreatedStoreUser_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_CreatedStoreUser_Ad?​UserName=<​value>&​DBPassword=<​value>&​DBLoginDescription=<​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 POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_CreatedStoreUser_Ad?​UserName=<​value>&​DBPassword=<​value>&​DBLoginDescription=<​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_CreatedStoreUser_Ad',​
 + array(
 + '​UserName'​ => '<​value>',​
 + '​DBPassword'​ => '<​value>',​
 + '​DBLoginDescription'​ => '<​value>',​
 + // '​DBLogin'​ => NULL,
 + // '​DBGroupAdmin'​ => 1,
 + // '​UserGroupID'​ => 1,
 + // '​CreatePersonWithPassword'​ => NULL,
 + // '​UserMayCreateNewUsers'​ => 0,
 + // '​AbortIfLoginAlreadyExists'​ => 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_CreatedStoreUser_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​UserName"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​DBPassword"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​DBLoginDescription"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​DBLogin">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​DBGroupAdmin">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​UserGroupID">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​CreatePersonWithPassword">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​UserMayCreateNewUsers">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​AbortIfLoginAlreadyExists">​1</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/mi_createdstoreuser_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)