engine:procedures:im_sorttreenodes_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:im_sorttreenodes_pu [11.01.2016 ] |
engine:procedures:im_sorttreenodes_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_SortTreeNodes_Pu ===== | ||
| + | |||
| + | Sortiert eine Menge von TreeNodeIDs anhand ihrer Eigenschaften. Die "TreeNodeIDs" sind über die Interface-Prozedur "if_im_SortTreeNodes" vor dem Aufruf dieser Prozedur in die Schnittstelle einzufügen.\\ | ||
| + | |||
| + | Die Merkmal-IDs der Eigenschaften, die zur Sortierung herangezogen werden (maximal 3 !) sind (durch "¶" getrennt) in "SortByCharacteristicIDList" zu übergeben. Sortiert wird zuerst nach den Eigenschaften zum ersten Merkmal, dann (falls angegeben) zum zweiten Merkmal und schließlich (falls angegeben) zum dritten Merkmal.\\ | ||
| + | |||
| + | WIE zu sortieren ist, muß man im Parameter "SortOptionList" angeben. Dabei handelt es sich um eine Summe von Optionen, bzw. um eine Liste von "Options-Summen" (durch "¶" getrennt), die sich auf das Merkmal in "SortByCharacteristicIDList" beziehen, das an der entsprechenden Stelle kommt.\\ | ||
| + | |||
| + | Folgende Optionen sind derzeit möglich : | ||
| + | * "1" : ABsteigende Sortierung nach der zur Eigenschaft zugehörigen "SortNo" aus "NodeCharacteristicValues" | ||
| + | * "2" : AUFsteigende Sortierung nach der zur Eigenschaft zugehörigen "SortNo" aus "NodeCharacteristicValues" | ||
| + | * "4" : ABsteigende Sortierung nach den Werten selbst. Dabei wird bei "Text"-Eigenschaften die Groß- und Kleinschreibung | ||
| + | grundsätzlich NICHT beachtet. | ||
| + | * "8" : AUFsteigende Sortierung nach den Werten selbst. Dabei wird bei "Text"-Eigenschaften die Groß- und Kleinschreibung | ||
| + | grundsätzlich NICHT beachtet. | ||
| + | * "16" : "NULL"-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach UNTEN sortiert | ||
| + | * "32" : "NULL"-Werte (d.h. es ist KEINE Eigenschaft vorhanden) werden nach OBEN sortiert | ||
| + | |||
| + | |||
| + | Logischerweise kann nur EINE von den Optionen "1", "2", "4" und "8" gewählt werden, und es kann natürlich nur entweder Option\\ "16" oder "32" gewählt werden !\\ | ||
| + | |||
| + | Bei der Ermittlung der Eigenschaften gibt es durch die Parameter "InheritDepthOptionList" und "RecursiveEvaluationOptionList" die Möglichkeit, bzgl. Vererbung und rekursiver Auswertung Einschränkungen vorzunehmen. Es handelt sich wieder jeweils um eine Liste von Werten (durch "¶"), die sich auf das Merkmal in "SortByCharacteristicIDList" beziehen, das an der entsprechenden Stelle kommt :\\ | ||
| + | |||
| + | 1.) Mit dem jeweiligen "InheritDepth"-Wert hat der Aufrufer die Möglichkeit, bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal hinsichtlich der Vererbung Einschränkungen vorzunehmen : | ||
| + | * -1 : alle direkten und geerbten Eigenschaften berücksichtigen | ||
| + | * 0 : keine geerbten Eigenschaften beachten | ||
| + | * 1 : zusätzlich einfach geerbte Eigenschaften berücksichtigen | ||
| + | * 2 : zusätzlich einfach und zweifach geerbte Eigenschaften berücksichtigen | ||
| + | usw.\\ | ||
| + | |||
| + | 2.) Es gibt sogenannte "REKURSIVE" Merkmale, die als Ausprägung wiederum Merkmale haben, d.h. alle (vordefinierten)\\ Eigenschaften sind IDs.\\ | ||
| + | |||
| + | Beispiel : Es sind mehrere "Preis"-Merkmale definiert, "Preis in EUR", "Sonderpreis in EUR", etc. Das Merkmal\\ "Verkaufspreis (EUR)" sei die Angabe, welches von den Preisen denn der für den Verkauf relevante ist. Möchte\\ ich nun nach dem Verkaufspreis sortieren, ist es in der Regel gewünscht, daß nach dem tatsächlichen Preis\\ sortiert werden soll - und nicht nach den Merkmal-IDs, die direkt zum Merkmal Verkaufspreis gespeichert sind !\\ In diesem Fall übergebe ich an der entsprechenden Stelle im Parameter "RecursiveEvaluationOptionList" den Wert\\ "1". Ist das nicht gewünscht oder ist das Merkmal überhaupt kein rekursives Merkmal, ist "0" anzugeben.\\ Wie schon bei "SortOptionList" kann man auch für diese beiden Parameter "NULL" angeben. Es wird dann automatisch KEINE\\ Vererbung berücksichtigt und auch KEINE rekursive Auswertung durchgeführt !\\ | ||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[im Sort Tree Nodes Pu]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.1 (2013-08-07)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |__SortByCharacteristicIDList__| |Liste von (durch "¶" getrennt) bis zu drei Merkmal-IDs, zu denen die Eigenschaften der zu sortierenden Elemente bestimmt werden und nach denen dann ("SortOptionList" entsprechend) sortiert wird\\ |varchar(50)|6.0.1| | ||
| + | |SortOptionList|NULL |Liste von (durch "¶" getrennt) Optionen, WIE nach der Eigenschaft zum entsprechenden Merkmal in "SortByCharacteristicIDList" (heißt : an der gleichen Position in der Liste) sortiert werden soll. Genaueres : s. Beschreibung !\\ |varchar(50)|6.0.1| | ||
| + | |InheritDepthOptionList|NULL |Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in "SortByCharacteristicIDList" (heißt : an der gleichen Position in der Liste) die Vererbung beachtet werden soll oder nicht. Genaueres : s. Beschreibung !\\ |varchar(50)|6.0.1| | ||
| + | |RecursiveEvaluationOptionList|NULL |Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in "SortByCharacteristicIDList" (heißt : an der gleichen Position in der Liste) evtl. eine rekursive Auswertung durchgeführt werden soll oder nicht. Genaueres : s. Beschreibung !\\ |varchar(50)|6.0.1| | ||
| + | |BinaryCharacteristicValueID|NULL |ID einer Eigenschaft die "Binaries" haben können (eine Dateigröße z.B.). Ermöglicht zu jedem gefundenen Element die Ausgabe einer (kleinsten) "BinaryCodeID" (siehe Rückgabemenge), das diese Eigenschaft besitzt.\\ |integer|6.0.1| | ||
| + | |GetValuesForSortByCharacs|1 |Gibt an, ob die zur Sortierung ermittelten Eigenschaften zu den in "SortByCharacteristicIDList" angegeben Merkmalen auch in der Rückgabemenge (s. Spalten "Value_1", "Value_2" und "Value_3") enthalten sein sollen ("1") oder nicht ("0").\\ |bit|6.0.2| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |//ValueSortNo_1((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls "SortByCharacteristicIDList" angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft "Value_1" von "NodeID" innerhalb aller "Value_1"-Werte.\\ |integer|6.0.1 | | ||
| + | |//ValueSortNo_2((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls "SortByCharacteristicIDList" angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft "Value_2" von "NodeID" innerhalb aller "Value_2"-Werte.\\ |integer|6.0.1 | | ||
| + | |//ValueSortNo_3((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls "SortByCharacteristicIDList" angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft "Value_3" von "NodeID" innerhalb aller "Value_3"-Werte.\\ |integer|6.0.1 | | ||
| + | |PrePredecessorsTreeNodeID|ID des Vor-Vorgänger-Elementes im Artikelbaum des sortierten Elementes\\ |integer|6.0.1 | | ||
| + | |PrePredecessorsDescription|Bezeichnung des Vor-Vorgängers\\ |varchar(100)|6.0.1 | | ||
| + | |PredecessorsTreeNodeID|ID des Vorgänger-Elementes im Artikelbaum des sortierten Elementes\\ |integer|6.0.1 | | ||
| + | |PredecessorsDescription|Bezeichnung des Vorgängers\\ |varchar(100)|6.0.1 | | ||
| + | |TreeNodeID|ID des sortierten Elementes im Artikelbaum\\ |integer|6.0.1 | | ||
| + | |NodeID|ID des sortierten Artikel-Elementes (der Hierarchie "LevelID")\\ |integer|6.0.1 | | ||
| + | |NodeDescription|Bezeichnung der "NodeID"\\ |varchar(100)|6.0.1 | | ||
| + | |BinaryCodeID|ID eines "Binaries", das der "NodeID" zugeordnet ist, und das "BinaryCharacteristicValueID" als Eigenschaft besitzt. Da es prinzipiell mehrere "Binaries" mit dieser Eigenschaft geben könnte, wird immer das Binärobjekt mit der KLEINSTEN ID zurückgegeben\\ |integer|6.0.1 | | ||
| + | |Value_1|Eigenschaft der "NodeID" zum ersten in "SortByCharacteristicIDList" angegeben Merkmal. Immer "NULL", wenn "GetValuesForSortByCharacs = 0" !\\ |varchar(1000)|6.0.1 | | ||
| + | |Value_2|Eigenschaft der "NodeID" zum zweiten in "SortByCharacteristicIDList" angegeben Merkmal. Immer "NULL", wenn "GetValuesForSortByCharacs = 0" !\\ |varchar(1000)|6.0.1 | | ||
| + | |Value_3|Eigenschaft der "NodeID" zum dritten in "SortByCharacteristicIDList" angegeben Merkmal. Immer "NULL", wenn "GetValuesForSortByCharacs = 0" !\\ |varchar(1000)|6.0.1 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * ValueSortNo_1 (aufsteigend) | ||
| + | * ValueSortNo_2 (aufsteigend) | ||
| + | * ValueSortNo_3 (aufsteigend) | ||
| + | * TreeNodeID (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")) ^ | ||
| + | |-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| | ||
| + | |-286|Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern|nur indirekt| | ||
| + | |-284|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren|nur indirekt| | ||
| + | |-283|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln|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.1 |2013-08-07|Datentyp der Rückgabespalten "Value_..." hat sich erweitert => Anpassung der Doku\\ | | ||
| + | |6.5.4 |2013-04-29|Default-Wert "NULL" für den Parameter "SortByCharacteristicIDList" entfernt, weil dies ein Pflichtparameter ist\\ und "NULL" sowieso zu einem Fehler führt\\ | | ||
| + | |6.0.2 |2011-06-08|"grant execute"-Statement ergänzt\\ | | ||
| + | |6.0.1 |2010-07-20|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_SortTreeNodes_Pu|im_SortTreeNodes_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_SortTreeNodes_Pu?SortByCharacteristicIDList=<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_SortTreeNodes_Pu?SortByCharacteristicIDList=<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_SortTreeNodes_Pu', | ||
| + | array( | ||
| + | 'SortByCharacteristicIDList' => '<value>', | ||
| + | // 'SortOptionList' => NULL, | ||
| + | // 'InheritDepthOptionList' => NULL, | ||
| + | // 'RecursiveEvaluationOptionList' => NULL, | ||
| + | // 'BinaryCharacteristicValueID' => NULL, | ||
| + | // 'GetValuesForSortByCharacs' => 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="im_SortTreeNodes_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="SortByCharacteristicIDList"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="SortOptionList">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="InheritDepthOptionList">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="RecursiveEvaluationOptionList">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="BinaryCharacteristicValueID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="GetValuesForSortByCharacs">1</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_sorttreenodes_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)