Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
engine:procedures:im_insertnewnode_ad [11.01.2016 ] |
engine:procedures:im_insertnewnode_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== im_InsertNewNode_Ad ===== | ||
+ | |||
+ | Fügt ein neues Element in den Artikelbaum ein oder kopiert bzw. "clone"d ein Element (evtl. mit Nachfolger-Elementen) an eine Stelle des Artikelbaums.\\ | ||
+ | |||
+ | Die Bezeichnung des zugehörigen neuen Artikel-Elementes ("NodeID") kann durch "NodeDescription" (immer in der Standardsprache) angegeben werden. Falls ein Element kopiert bzw. ge"clone"d wird, hat dieser Parameter keine Bedeutung.\\ | ||
+ | |||
+ | Soll eine Kopie oder ein Clone eines anderen Elementes des Artikelbaums angelegt werden, sind entsprechend die Parameter "ModelNode" und "Clone" zu setzen, wobei "IncludeSubNodes" angibt, ob dabei auch die Nachfolger von "ModelNode" kopiert bzw. ge"clone"d werden sollen.\\ | ||
+ | |||
+ | ACHTUNG : Das Erstellen von "Clone"s ist derzeit NOCH NICHT IMPLEMENTIERT !!!\\ | ||
+ | |||
+ | Eine Hierarchie ("LevelID") braucht nur angegeben zu werden, falls das neu anzulegende Element NICHT auf einer um\\ eins niedrigeren Hierarchie-Stufe als sein Vorgänger sein soll.\\ | ||
+ | |||
+ | Die ID des neuen Elementes im Artikelbaum ("TreeNodeID") und die des neuen Artikel-Elementes ("NodeID") werden über zwei entsprechende Ausgabeparameter zurückgegeben.\\ | ||
+ | |||
+ | Falls ein neues Element auf der Produkt-Hierarchie (siehe "Settings"-Eintrag zum Schlüssel "ProductLevelID") angelegt wird, bekommt es automatisch die gleichen Templates zugewiesen, wie ein "Nachbar"-Element (das ist ein Produkt-Element mit dem gleichen Vorgänger) oder aber (falls es kein benachbartes Element gibt) das "Default"-Template der Produkt-Hierachie.\\ | ||
+ | |||
+ | Wird ein NEUES Element angelegt, das sich auf der Produkt-Hierarchie ("ProductLevelID" in "Settings") oder der Varianten-Hierarchie (per Definition die größte "LevelNo" in "Levels") befindet, wird automatisch eine Produktbezeichnung in der Standardsprache eingefügt.\\ | ||
+ | |||
+ | |||
+ | |||
+ | Anmerkungen:\\ | ||
+ | |||
+ | 1. Das Merkmal für die Produktbezeichnung in einer Sprache ist DERZEIT das Merkmal, dessen Bezeichnung mit "Produktbez" beginnt und die entsprechende "ValueLanguageID" besitzt. Dies wird irgendwann einmal geändert werden (über eine separate Tabelle wahrscheinlich), da es wenig Sinn macht, z.B. das Merkmal für die französische Produktbezeichnung mit "Produktbez..." zu bezeichnen...\\ | ||
+ | |||
+ | 2. Die Produktbezeichnungen werden derzeit nach folgendem Muster generiert :\\ | ||
+ | |||
+ | Für Produkte...\\ <Bezeichnung ("NodeDescription") des Vorgängers> + ' "' + <Bezeichnung ("NodeDescription") des Produkt-Elementes> + '"'\\ | ||
+ | |||
+ | Für Varianten...\\ <Produktbezeichnung des Produkt-Vorgängers> + ' ' + <Bezeichnung ("NodeDescription") des Varianten-Elementes>\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[im Insert New Node Ad]}}| | ||
+ | |Engine-Kategorie|item management | | ||
+ | |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 ^ | ||
+ | |__Predecessor__| |ID eines Elementes im Artikelbaum, unter dem ein neues Element angelegt werden soll\\ |integer|3.5.0| | ||
+ | |__NodeDescription__| |Bezeichnung des neuen Artikel-Elementes\\ |varchar(100)|3.5.0| | ||
+ | |LevelID|NULL |Angabe einer ID einer Hierarchiestufe, auf der das neue Element liegen soll. Wenn "NULL" angegeben ist, wählt die Prozedur automatisch die nächst niedrigere Hierarchie nach der Hierarchie des zu "Predecessor" korrespondierenden Artikel-Elementes.\\ |tinyint|3.5.0| | ||
+ | |ModelNode|NULL |Falls das neue Element von einem anderen Element ge"clone"d oder kopiert werden soll (-> "Clone"), gibt man hier die entsprechende "TreeNodeID" an. ACHTUNG: Das "Cloning" ist derzeit noch nicht implementiert !\\ |integer|3.5.0| | ||
+ | |Clone|0 |Wird nur beachtet, falls in "ModelNode" ein Element des Artikelbaums angegeben ist !\\ "0" : "ModelNode" wird kopiert\\ "1" : "ModelNode" wird ge"clone"d (ACHTUNG ! Derzeit noch nicht implementiert !!!)\\ |bit|3.5.0| | ||
+ | |IncludeSubNodes|1 |Wird nur beachtet, falls in "ModelNode" ein Element des Artikelbaums angegeben ist !\\ "0" : Es wird nur das Element "ModelNode" selbst ge"clone"d bzw. kopiert\\ "1" : Auch die Elemente unterhalb von "ModelNode" werden mitkopiert bzw. mitge"clone"d\\ |bit|3.5.0| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | Die Prozedur hat keine Rückgaben. | ||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | |NewNodeID|Ausgabeparameter für die ID des neuen Artikel-Elementes| | ||
+ | |NewTreeNodeID|Ausgabeparameter für die ID des neuen Elementes im Artikelbaum| | ||
+ | ==== Mögliche Return-Codes ==== | ||
+ | |||
+ | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt| | ||
+ | |-599|Lizenz ist ungültig oder abgelaufen|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|nur indirekt| | ||
+ | |-540|Falsches Format|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| | ||
+ | |-503|Fehlerhafte Daten in einer Tabelle - genauere Fehlermeldung auf der Standardausgabe|nur indirekt| | ||
+ | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
+ | |-500|Falsche Parameter|nur indirekt| | ||
+ | |-285|Der Benutzer hat keine Berechtigung, vergangene Eigenschaften zu diesem(n) Merkmal(en) zu ändern|nur indirekt| | ||
+ | |-284|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren|nur indirekt| | ||
+ | |-245|Einige Artikel-Eigenschaften sind ungültig|nur indirekt| | ||
+ | |-242|Relative Änderung nicht möglich, da es eine Eigenschaft gibt, deren Gültigkeit in d. Zukunft beginnt|nur indirekt| | ||
+ | |-241|Änderung(en) der Eigenschaft(en) konnte(n) aufgrund paralleler Änderungen nicht durchgeführt werden|nur indirekt| | ||
+ | |-220|Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werden|nur indirekt| | ||
+ | |-190|Ein Element auf der niedrigsten Hierarchiestufe kann keine Nachfolger haben|nur indirekt| | ||
+ | |-180|Falsche Hierarchie : Ein Element muß immer eine niedrigere Hierarchiestufe als sein Vorgänger haben|nur indirekt| | ||
+ | |-120|Der Benutzer hat keine Berechtigung für das (die) Element(e)|nur indirekt| | ||
+ | |-110|Das (die) Element(e) ist (sind) nicht vorhanden|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]\\ | | ||
+ | |6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard\\ | | ||
+ | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |5.1.0 |2006-02-08|Verlagerung des Codes in die neuen Prozeduren "_im_InsertNewNode" und "_im_CopyNode"\\ | | ||
+ | |4.0.15 |2004-07-30|1. Beim Anlegen eines neuen Elementes unterhalb von "root" wurde bisher auch die "SortNo" von "root" immer erhöht\\ 2. Bei der Überarbeitung in Version 4.0.11 entstand ein Fehler bzgl. einer temporären Tabelle\\ | | ||
+ | |4.0.11 |2004-03-31|1. "_mi_StartProcedure", "_mi_FinishProcedure" u. "_mi_ChooseParamValueSeperator" sowie [[dstoreproc>mi_GetSettingEntry]]\\ 2. "set transaction isolation level 1", "set rowcount 0" zu Beginn\\ 3. Konsequente Fehlerbehandlung\\ 4. Fehlende Index-Angaben\\ | | ||
+ | |4.0.1 |2003-05-16|Ab jetzt wird berücksichtigt, daß in "NodeProperties" auch Gültigkeitszeiträume in der Zukunft vorhanden sein können !\\ | | ||
+ | |3.5.20 |2002-07-22|\\ | | ||
+ | |3.5.19 |2002-06-17|\\ | | ||
+ | |3.5.14 |2002-01-23|\\ | | ||
+ | |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_InsertNewNode_Ad|im_InsertNewNode_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_InsertNewNode_Ad?Predecessor=<value>&NodeDescription=<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_InsertNewNode_Ad?Predecessor=<value>&NodeDescription=<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_InsertNewNode_Ad', | ||
+ | array( | ||
+ | 'Predecessor' => <value>, | ||
+ | 'NodeDescription' => '<value>', | ||
+ | // 'LevelID' => NULL, | ||
+ | // 'ModelNode' => NULL, | ||
+ | // 'Clone' => 0, | ||
+ | // 'IncludeSubNodes' => 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="im_InsertNewNode_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="Predecessor"><!-- integer value --></Parameter> | ||
+ | <Parameter Name="NodeDescription"><!-- varchar value --></Parameter> | ||
+ | <!-- <Parameter Name="LevelID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="ModelNode">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="Clone">0</Parameter> --> | ||
+ | <!-- <Parameter Name="IncludeSubNodes">1</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||