Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
engine:procedures:im_modifylevels_ad [11.01.2016 ] |
engine:procedures:im_modifylevels_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== im_ModifyLevels_Ad ===== | ||
+ | |||
+ | Löscht, erstellt oder ändert eine Hierarchie.\\ | ||
+ | |||
+ | Hintergrund : Jedem Artikel-Element ist genau eine Hierarchie zugeordnet, die angibt, um was für ein Element es sich handelt, z.B. eine "Pruduktgruppe", eine "Variante", ein "Bereich", ein "Produkt" etc.\\ | ||
+ | |||
+ | Anmerkungen :\\ 1.) "LevelNo" muß mindestens "2" sein ("1" ist für die "Wurzel"-Ebene vordefiniert) und darf nicht größer als "MAX(LevelNo) + 1" sein. Selbstverständlich kümmert sich die Prozedur darum, daß die bisherigen Hierarchien mit "LevelNo >= LevelNo" um "1" herabgestuft (d.h. die "LevelNo" wird erhöht) werden.\\ | ||
+ | |||
+ | 2.) Wenn eine Hierarchie gelöscht wird, schließt die Prozedur die Lücke der "LevelNo"s.\\ | ||
+ | |||
+ | 3.) Die Nummer einer bereits existierenden Hierarchie ("LevelNo") kann direkt natürlich NICHT geändert werden !\\ | ||
+ | |||
+ | |||
+ | |||
+ | Anmerkung zum Parameter "DefaultSymbolID" :\\ | ||
+ | |||
+ | Hier gibt man die ID des Symbols an, welches zur Anzeige von Elementen der entsprechenden Hierarchie verwendet werden soll. Theoretisch (aufgrund der Definition der Tabelle "Levels") kann hier auch "NULL" angegeben werden. Dies kann allerdings beim Anlegen eines neuen Artikel-Elementes (z.B. durch [[dstoreproc>im_InsertNewNode_Ad]]) zu einem FEHLER führen, daher sollte hier immer eine existierende "SymbolID" angegeben werden !\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[im Modify Levels 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 ^ | ||
+ | |LevelID|NULL |ID der Hierarchiestufe, die gelöscht oder geändert werden soll ("NULL" angeben, um eine neue Hierarchie anzulegen)\\ |tinyint|3.5.0| | ||
+ | |__LevelNo__| |Nummer der Hierarchie. Eine höhere Nummer bedeutet eine niedrigere Hierarchie. Das "Root"-Element hat die Nummer "1". Im Artikelbaum muß die Hierarchie-Nummer eines Nachfolger-Elementes immer höher als die des Vorgängers sein.\\ |tinyint|3.5.0| | ||
+ | |__LevelDescription__| |Bezeichnung der Hierarchie, z.B. "Pruduktgruppe", "Variante", "Bereich", "Produkt", ...\\ |varchar(100)|3.5.0| | ||
+ | |DefaultSymbolID|1 |ID des Symbols, das zur Anzeige von Elementen dieser Hierarchie verwendet werden soll. D.h. bei Neu-Anlage eines Artikel-Elementes der Hierarchie "LevelID" (bzw. der neuen Hierarchie mit "LevelNo") wird dem Element automatisch dieses Symbol zugewiesen.\\ |smallint|3.5.0| | ||
+ | |__DefaultTemplateID__| |ID des Templates, welches standardmäßig zur Darstellung von Elementen dieser Hierarchie im "Default"-Kontext verwendet werden soll. (Siehe auch [[dstoreproc>im_GetTemplates_Ad]] bzw. [[dstoreproc>im_GetTemplates_Pu]])\\ |smallint|3.5.0| | ||
+ | |DeleteLevel|0 |"0" : Ändern der bestehenden "LevelID" oder (falls "LevelID = NULL") Neuanlegen einer Hierarchie (mit der Nummer "LevelNo")\\ "1" : Löschen der vorhandenen "LevelID"\\ |bit|3.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")) ^ | ||
+ | |-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 aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |5.1.4 |2006-08-14|Fehler : Beim Löschen-Fall wurde bisher erwartet, daß auch der Parameter "LevelNo" angegeben wird\\ | | ||
+ | |4.0.13 |2004-05-18|1. Aufruf der Prozeduren "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator" \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
+ | |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=im_ModifyLevels_Ad|im_ModifyLevels_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_ModifyLevels_Ad?LevelNo=<value>&LevelDescription=<value>&DefaultTemplateID=<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/im_ModifyLevels_Ad?LevelNo=<value>&LevelDescription=<value>&DefaultTemplateID=<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'), | ||
+ | 'im_ModifyLevels_Ad', | ||
+ | array( | ||
+ | 'LevelNo' => <value>, | ||
+ | 'LevelDescription' => '<value>', | ||
+ | 'DefaultTemplateID' => <value>, | ||
+ | // 'LevelID' => NULL, | ||
+ | // 'DefaultSymbolID' => 1, | ||
+ | // 'DeleteLevel' => 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="im_ModifyLevels_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="LevelNo"><!-- tinyint value --></Parameter> | ||
+ | <Parameter Name="LevelDescription"><!-- varchar value --></Parameter> | ||
+ | <Parameter Name="DefaultTemplateID"><!-- smallint value --></Parameter> | ||
+ | <!-- <Parameter Name="LevelID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="DefaultSymbolID">1</Parameter> --> | ||
+ | <!-- <Parameter Name="DeleteLevel">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||