Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_searchproducttreenodes_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_searchproducttreenodes_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_SearchProductTreeNodes_Pu =====
 +
 +Prozedur zur Produktsuche (Artikel-Elemente auf der in "​Settings"​ durch "​ProductLevelID"​ angegebenen Hierarchie) innerhalb eines Bereiches ("​DomainTreeNodeID"​) des Artikelbaums über Eigenschaften. Dabei kann angegeben werden, ob nur direkt zugewiesene oder auch vererbte Eigenschaften beachtet werden sollen.\\ ​
 +
 +Gesucht wird folgendermaßen:​\\ Der übergebene Wert ("​Value"​) muß eine Eigenschaft zu den in "​NodeCharacteristicIDs"​ angegebenen Merkmalen, bzw. "so ähnlich"​ (falls "​IsLike = 1") sein - das bedeutet, der Begriff muß in der Eigenschaft VORKOMMEN.\\ ​
 +
 +Möchte man, daß bei der Suche auch Detailinformation zu Eigenschaften ("​ValueDetails"​) berücksichtigt werden, ist dies explizit über einen Parameter ("​IncludeValueDetails"​) anzugeben, weil eine solche Suche mehr Performance kostet !\\ 
 +
 +Optional kann eine Eigenschaft angegeben werden ("​FilterByCharacteristicID"​ und "​FilterByCharacValue"​),​ die die Produkte zusätzlich haben müssen (es wird keine Vererbung berücksichtigt !) bzw. NICHT haben müssen (falls "​NegateFilterByParams = 1"), d.h. alle Elemente, die diese Eigenschaft NICHT haben, sind NICHT in der Ergebnismenge,​ bzw. (falls "​NegateFilterByParams = 1") es sind nur die Knoten in der Ergebnismenge,​ die diese Eigenschaft nicht besitzen.\\ ​
 +
 +
 +
 +Es wird auch eine erweiterte Suche unterstützt (besser ist aber die seit Version 5.5.0 verfügbare Prozedur [[dstoreproc>​im_SearchTreeNodes_Pu]]). Dazu übergibt man für den Suchbegriff (Parameter "​Value"​) den Wert "​NULL"​ und gibt stattdessen die Suchbedingungen über die Tabelle "​tempdb.dbo.CharacteristicConditions"​ an (siehe Prozedur [[dstoreproc>​mi_InsertTemp_CharacConditions]]) :\\ 
 +
 +  * CharacteristicID smallint
 +-> ID eines Merkmals. In den Eigenschaften zu diesen Merkmalen soll gesucht werden
 +  * BasicFieldTypeID tinyint
 +-> Für diese Prozedur irrelevant (z.B. "​0"​ angeben)
 +  * Operator1 varchar(2)
 +-> Einer der Operatoren "​=",​ "<>",​ ">",​ "<",​ ">​="​ oder "<​="​. Die Operatoren "​="​ und "<>"​ machen hier nur dann Sinn, wenn unter "​Operator2"​ und "​Condition2"​ jeweils "​NULL"​ angegeben ist !
 +  * Condition1 varchar(255)
 +-> Wert, nach dem unter Berücksichtigung des unter Operator1 angegebenen Suchoperators gesucht werden soll
 +  * Operator2 varchar(2)
 +-> Einer der Operatoren "<",​ ">",​ ">​="​ oder "<​="​
 +  * Condition2 varchar(255)
 +-> Wert nach dem unter Berücksichtigung des unter Operator2 angegebenen Suchoperators gesucht werden soll
 +  * EstimatedRowsAffected integer
 +-> Diesen Wert belegt die intern zur Suche verwendete Prozedur, er braucht nicht angegeben zu werden (z.B. "​0"​ angeben).\\ ​
 +
 +Ein Beispiel:​\\ ​
 +
 +Angenommen, die Merkmal-ID "​53"​ steht für den "Preis (EUR)" und die ID "​57"​ stellt das Merkmal für "​Farben"​ dar und es sollen nun alle Produkte gesucht werden, die zwischen 10 und 20 Euro kosten und "​rot"​ sind. In "​tempdb.dbo.CharacteristicConditions"​ müssen dann folgende Zeilen eingetragen werden:\\ spid, 53, 0, '>​=',​ '​10',​ '<​=',​ '​20',​ 0\\ spid, 57, 0, '​=',​ '​rot',​ null, null, 0\\ 
 +
 +
 +
 +
 +
 +ANMERKUNGEN zu Parametern :\\ 
 +
 +1.) Zum Parameter "​IncludeValueDetails"​ (genauer, falls hierfür der Wert "​1"​ übergeben wird) :\\ Leider kann die ASE-Funktion "​lower"​ (um case-insensitiv zu suchen) nicht auf den Datentyp "​text"​ angewendet werden. Daher wird in "​ValueDetails"​ gesucht nach...
 +  * dem exakten Vorkommen von "​Value"​
 +  * "​Value"​ komplett in Groß- bzw. in Kleinbuchstaben
 +  * "​Value"​ komplett in Kleinbuchstaben,​ mit Ausnahme des ersten Zeichens (auf dieses wird die "​upper"​-Funktion angewendet)
 +
 +
 +2.) Zum Parameter "​MaintainSearchItemLacks"​ :\\ Wenn die Suche erfolglos war, dann wird (falls dieser Parameter auf "​1"​ gesetzt wird) der Suchbegriff in die Tabelle "​SearchItemLacks"​ eingetragen. Falls der Begriff schon vorhanden ist, wird der zugehörige "​Counter"​ erhöht. So kann man evtl. herausfinden,​ welche Begriffe häufig (aber vergebens) von Benutzern eingegeben werden. Aufgrund dieser Erkenntnis kann ein Sachbearbeiter herausfinden,​ welche Art von Artikeln wohl auf diesen Suchbegriff passen und einen entsprechenden Eintrag in "​SearchItems"​ machen (Prozedur hierfür in einer der kommenden Versionen), so daß eine erneute Suche dann erfolgreich ist.\\ ​
 +
 +3.) Zum Parameter "​OutputIntoOneID"​ :\\ Hiermit kann man steuern, ob eine Ergebnismenge zurückgeben werden soll, oder ob stattdessen die gefundenen "​TreeNodeID"​s in die Tabelle "​tempdb.dbo.OneID"​ eingefügt werden sollen - um dann anschließend z.B. [[dstoreproc>​im_GetNodeProperties]] aufrufen zu können. Folgende Werte sind möglich :
 +  * "​0"​ : Es wird NUR eine Ergebnismenge bereitgestellt
 +  * "​1"​ : Es wird KEINE Ergebnismenge ausgegeben, stattdessen werden ALLE gefundenen "​TreeNodeID"​s in "​tempdb.dbo.OneID"​ eingefügt (d.h. "​StartAtRowNo"​ und "​RowCount"​ werden ignoriert)
 +  * "​2"​ : Es wird KEINE Ergebnismenge ausgegeben, stattdessen werden die gefundenen "​TreeNodeID"​s AB dem durch "​StartAtRowNo"​ gekennzeichneten Datensatz in "​tempdb.dbo.OneID"​ eingefügt, jedoch nur soviele, wie durch "​RowCount"​ angegeben
 +  * "​3"​ : Es wird eine Ergebnismenge bereitgestellt UND ALLE gefundenen "​TreeNodeID"​s werden in "​tempdb.dbo.OneID"​ gespeichert
 +  * "​4"​ : Es wird eine Ergebnismenge bereitgestellt UND die in dieser Ergebnismenge enthaltenen "​TreeNodeID"​s werden in "​tempdb.dbo.OneID"​ gespeichert
 +
 +
 +
 +
 +Anmerkung zur Sortierung der Rückgabemenge nach Eigenschaften :\\ 
 +
 +Man hat die Möglichkeit,​ das Ergebnis nach Eigenschaften der Elemente zu bestimten Merkmalen zu sortieren. Die Merkmal-IDs (maximal 3 !) sind (durch "​¶"​ getrennt) in "​SortByCharacteristicIDList"​ zu übergeben.\\ ​
 +
 +Sortiert wird in einem solchen Fall 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 !\\ 
 +
 +Haben zwei Elemente zu allen Merkmalen gleichwertige Eigenschaften,​ wird aufsteigend nach der "​TreeNodeID"​ sortiert !\\ 
 +
 +Es ist möglich, für "​SortOptionList"​ nichts (also "​NULL"​) anzugeben - dann wird automatisch immer der Wert "​17"​ (also Optionen "​1"​ und "​16"​) gewählt.\\ ​
 +
 +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|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Search Product Tree Nodes Pu]}}|
 +|Engine-Kategorie|item management |
 +|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 ^
 +|DomainTreeNodeID|0 |ID eines Elementes im Artikelbaum. Die Suche bezieht sich nur auf Nachfolger dieses Elementes.\\ |integer|3.5.0|
 +|NodeCharacteristicIDs|NULL |Eine Liste von IDs (durch das '​¶'​-Zeichen getrennt) von den Merkmalen, in deren Eigenschaften nach dem Suchbegriff "​Value"​ gesucht werden soll. Darf nur "​NULL"​ sein, wenn auch "​Value"​ "​NULL"​ ist !\\ |varchar(255)|3.5.0|
 +|__Value__| |Der Suchbegriff. Falls "​NULL"​ angegeben, erwartet die Prozedur die Such-Parameter in "​tempdb.dbo.CharacteristicConditions"​ (siehe Beschreibung).\\ |varchar(1000)|3.5.0|
 +|IsLike|0 |Dieser Parameter steuert, wie genau die Eigenschaft mit dem Suchbegriff übereinstimmen muß (Groß- und Kleinschreibung wird NUR für die Suche in "​ValueDetails"​ beachtet):​\\ "​0"​ : Genaue Übereinstimmung\\ "​1"​ : Der Suchbegriff muß in der Eigenschaft vorkommen\\ |bit|3.5.0|
 +|IncludeInherited|1 |"​0"​ : Nur direkt zugewiesene Eigenschaften werden beachtet\\ "​1"​ : Auch geerbte Eigenschaften werden berücksichtigt\\ |bit|3.5.0|
 +|StartAtRowNo|1 |Erste Zeile der Ausgabe innerhalb des gesamten Suchergebnisses. Zusammen mit "​RowCount"​ kann man sich so durch das gesamte Ergebnis "​blättern"​.\\ |integer|3.5.0|
 +|RowCount|100 |Anzahl der auszugebenden Datensätze des Suchergebnisses. Zusammen mit "​StartAtRowNo"​ kann man sich so durch das gesamte Ergebnis "​blättern"​.\\ |integer|3.5.0|
 +|IncludeValueDetails|0 |"​0"​ : Nach dem Suchbegriff wird nur in den Eigenschaften gesucht\\ "​1"​ : Nach dem Suchbegriff wird auch in Detail-Informationen zu Eigenschaften ("​ValueDetails"​) gesucht\\ |bit|3.5.3|
 +|IncludeVariants|1 |Soll auch in den Varianten gesucht werden? (zurückgegeben werden aber trotzdem immer nur Produkt-Elemente !)\\ |bit|3.5.6|
 +|MaintainSearchItemLacks|1 |Wenn nichts gefunden wurde, dann wird der Begriff in die Tabelle "​SearchItemLacks"​ eingetragen,​ falls dieser Parameter mit "​1"​ übergeben wird. (s.a. zweite Anmerkung in der "​Beschreibung"​)\\ |bit|3.5.6|
 +|BinaryCharacteristicValueID|NULL |ID einer Eigenschaft die "​Binaries"​ haben können (eine Dateigröße z.B.). Ermöglicht zu jedem gefundenen Produkt-Element die Ausgabe einer (kleinsten) "​BinaryCodeID"​ (siehe Rückgabemenge),​ das diese Eigenschaft besitzt.\\ |integer|3.5.10|
 +|FilterByCharacteristicID|NULL |Nur Elemente, die "​FilterByCharacValue"​ als Eigenschaft zum Merkmal "​FilterByCharacteristicID"​ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)\\ |smallint|3.5.11|
 +|FilterByCharacValue|NULL |Nur Elemente, die "​FilterByCharacValue"​ als Eigenschaft zum Merkmal "​FilterByCharacteristicID"​ haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)\\ |varchar(1000)|3.5.11|
 +|Country|'​german'​ |Datumsformat,​ welches beim Suchen nach Datumswerten verwendet wird.\\ '​german'​ : Tag-Monat-Jahr\\ '​english'​ : Monat-Tag-Jahr\\ |varchar(10)|3.5.20|
 +|NegateFilterByParams|0 |Wird nur berücksichtigt,​ falls die "​FilterBy..."​-Parameter angegeben sind ! Bei Angabe von "​1"​ für diesen Parameter sind nur Elemente in der Rückgabemenge,​ die die Eigenschaft "​FilterByCharacValue"​ zum Merkmal "​FilterByCharacteristicID"​ NICHT haben.\\ |bit|4.0.2|
 +|SortByCharacteristicIDList|NULL |Liste von (durch "​¶"​ getrennt) bis zu drei Merkmal-IDs,​ zu denen die Eigenschaften der ermittelten Elemente bestimmt werden und nach denen dann ("​SortOptionList"​ entsprechend) sortiert wird\\ |varchar(50)|5.1.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)|5.1.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)|5.1.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)|5.1.1|
 +|GetValuesForSortByCharacs|0 |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|5.1.1|
 +|OutputIntoOneID|0 |s. Beschreibung ! "​TreeNodeID"​s in "​OneID"​ einfügen ?\\ "​0"​ : NUR Ergebnis\\ "​1"​ : KEIN Ergebnis, ALLE IDs einfüg.\\ "​2"​ : KEIN Ergebnis, IDs ab "​StartAtRowNo"​ ("​RowCount"​ viele) einfüg.\\ "​3"​ : Ergebnis, ALLE IDs einfüg.\\ "​4"​ : Ergebnis, diese IDs einfüg.\\ |tinyint|5.5.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|//​SortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|Wird nicht zurückgegeben,​ aber zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge des Elementes "​TreeNodeID"​ innerhalb aller Nachfolger von "​PredecessorsTreeNodeID"​\\ |smallint|3.5.12 |
 +|//​PredecessorSortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|Wird nicht zurückgegeben,​ aber zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge des Elementes "​PredecessorsTreeNodeID"​ innerhalb aller Nachfolger von "​PrePredecessorsTreeNodeID"​\\ |smallint|3.5.12 |
 +|//​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|5.1.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|5.1.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|5.1.1 |
 +|//​Category((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|NICHT MEHR VORHANDEN ! Bezeichnung des Vorgängers des gefundenen Produktes. Seit Version "​3.5.6"​ heißt diese Spalte "​PredecessorsDescription"​ !\\ |varchar(100)|3.5.0 |
 +|//​Domain((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|NICHT MEHR VORHANDEN ! Bezeichnung des Vor-Vorgängers des gefundenen Produktes. Seit Version "​3.5.6"​ heißt diese Spalte "​PrePredecessorsDescription"​ !\\ |varchar(100)|3.5.0 |
 +|PrePredecessorsTreeNodeID|ID des Vor-Vorgänger-Elementes im Artikelbaum des gefundenen Produkt-Elementes\\ |integer|3.5.6 |
 +|PrePredecessorsDescription|Bezeichnung des Vor-Vorgängers\\ |varchar(100)|3.5.6 |
 +|PredecessorsTreeNodeID|ID des Vorgänger-Elementes im Artikelbaum des gefundenen Produkt-Elementes\\ |integer|3.5.6 |
 +|PredecessorsDescription|Bezeichnung des Vorgängers\\ |varchar(100)|3.5.6 |
 +|Product|Bezeichnung des gefundenen Produkt-Elementes\\ |varchar(100)|3.5.0 |
 +|TreeNodeID|ID des gefundenen Produkt-Elementes im Artikelbaum\\ |integer|3.5.0 |
 +|NodeID|ID des gefundenen Produkt-Artikel-Elementes\\ |integer|3.5.0 |
 +|MatchingValue|Eigenschaft der "​NodeID",​ durch die das Produkt-Element gefunden wurde\\ |varchar(1000)|3.5.0 |
 +|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|3.5.10 |
 +|Value_1|Eigenschaft der "​NodeID"​ zum ersten in "​SortByCharacteristicIDList"​ angegeben Merkmal. Immer "​NULL",​ wenn "​GetValuesForSortByCharacs = 0" !\\ |varchar(1000)|5.1.1 |
 +|Value_2|Eigenschaft der "​NodeID"​ zum zweiten in "​SortByCharacteristicIDList"​ angegeben Merkmal. Immer "​NULL",​ wenn "​GetValuesForSortByCharacs = 0" ist oder wenn nur ein Merkmal in "​SortByCharacteristicIDList"​ angegeben wurde !\\ |varchar(1000)|5.1.1 |
 +|Value_3|Eigenschaft der "​NodeID"​ zum dritten in "​SortByCharacteristicIDList"​ angegeben Merkmal. Immer "​NULL",​ wenn "​GetValuesForSortByCharacs = 0" ist oder wenn nur zwei Merkmale in "​SortByCharacteristicIDList"​ angegeben wurden !\\ |varchar(1000)|5.1.1 |
 +
 +== Sortierungen der Rückgabe ==
 +
 +wenn SortByCharacteristicIDList is NULL
 +  * PrePredecessorsTreeNodeID (aufsteigend)
 +  * PredecessorSortNo (absteigend)
 +  * SortNo (absteigend)
 +wenn SortByCharacteristicIDList is NOT NULL
 +  * ValueSortNo_1 (aufsteigend)
 +  * ValueSortNo_2 (aufsteigend)
 +  * ValueSortNo_3 (aufsteigend)
 +  * TreeNodeID (aufsteigend)
 +
 +==== Output-Parameter ====
 +
 +|Count|Ausgabeparameter,​ um zu erfahren, wieviele Produkte insgesamt gefunden wurden|
 +==== 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|
 +|-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|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|
 +|-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|direkt und 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]\\ ​ |
 +|7.0.1 |2013-08-07|1. Datentyp-Erweiterung der Parameter "​Value"​ und "​FilterByCharacValue"​ [von 100 auf 1000]\\ 2. Datentyp der Rückgabespalten "​MatchingValue"​ und "​Value_..."​ hat sich erweitert => Auch Anpassung der Doku\\ ​ |
 +|6.5.3 |2013-03-18|1. Quellcode-Anpassungen wg. UTF8\\ 2. Fehler : Bei der Überprüfung,​ ob eine "​Variable voll ist", muß "​datalength"​ [nicht "​char_lenght"​] verwendet werden\\ 3. Intern Umstellung bzgl. "​Listen-Variablen"​ ("​UPDATE ... SET ..."​-Methode)\\ ​ |
 +|5.5.1 |2008-07-29|1. Fehler "The SELECT list for the INSERT statement contains fewer items than the INSERT list" trat in einem Fall auf\\ 2. Berücksichtigung des neuen "​Settings"​-Eintrags "​AssignmentMethodForListVariables"​\\ ​ |
 +|5.5.0 |2008-01-07|Neuer Parameter "​OutputIntoOneID"​\\ ​ |
 +|5.1.8 |2006-12-12|1. Fehler bzgl. "​rowcount"​ [ASE-Bug]\\ 2. Ausgabe an die Standard-Ausgabe [via "​print"​] im Fehler-Fall "​-500"​ bzw. "​-504",​ die nähere Informationen über die Ursache enthält\\ ​ |
 +|5.1.7 |2006-10-31|Fehler : Aufgrund des Checks bzgl. "​LockedNodeCharacteristics"​ kam es seit dem Update 5.1.5 im Fall "​NodeCharacteristicIDs = NULL" unberechtigterweise zum Fehler "​-500"​ !\\  |
 +|5.1.5 |2006-08-29|1. Explizites "ORDER BY" eingefügt, um die Sortierung der Rückgabemenge zu garantieren\\ 2. Fehler : "​LockedNodeCharacteristics"​ wurde für die im Parameter "​NodeCharacteristicIDs"​ angegebenen Merkmale bisher GAR NICHT beachtet !\\  |
 +|5.1.1 |2006-04-05|1. Zahlreiche neue Parameter\\ 2. Neue Rückgabespalten\\ 3. Diverse interne Überarbeitungen\\ 4. Änderung des Datentyps von "​RowCount"​ und "​StartAtRowNo"​\\ 5. Neue Möglichkeit,​ sich ALLE Datensätze ausgeben zu lassen\\ ​ |
 +|5.0.0 |2004-12-21|Fehler : Falls "​_im_SearchCharacConditions"​ verwendet wurde, um eine Suche anhand mehrerer Bedingungen zu realisieren,​ konnte ein Produkt mehrfach im Ergebnis vorkommen, falls mehrere Eigenschaften die Bedingungen erfüllten.\\ ​ |
 +|4.0.5 |2003-10-04|Fehler : "​Count"​ wurde u.U. nicht korrekt belegt, wenn "​Filter"​-Parameter angegeben wurden\\ ​ |
 +|4.0.4 |2003-08-26|Neuer Parameter "​Count"​\\ ​ |
 +|4.0.2 |2003-06-11|1. Neuer Parameter "​NegateFilterByParams"​\\ 2. Interne Vereinfachung bzgl. "​if-else"​-Verschachtelung\\ 3. Durch die in 3.5.12 eingeführte Sortierung klappte das "​Blättern"​ via "​StartAtRowNo"​ und "​RowCount"​ nicht mehr\\ ​ |
 +|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 !\\  |
 +|4.0.0 |2003-04-03|1. Fehler in der Doku behoben ("​IncludeInactiveNodes"​ gibt es nicht)\\ 2. Fehler bzgl. "​FilterBy..."​-Parameter : es wurde genau nach der Negierung gefiltert !\\ 3. Kleiner Fehler beim Parameter-Check\\ ​ |
 +|3.5.20 |2002-07-22|\\ ​ |
 +|3.5.12 |2001-10-17|\\ ​ |
 +|3.5.11 |2001-09-06|\\ ​ |
 +|3.5.10 |2001-07-14|\\ ​ |
 +|3.5.6 |2001-04-17|\\ ​ |
 +|3.5.3 |2001-02-11|\\ ​ |
 +|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_SearchProductTreeNodes_Pu|im_SearchProductTreeNodes_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_SearchProductTreeNodes_Pu?​Value=<​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 GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_SearchProductTreeNodes_Pu?​Value=<​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_SearchProductTreeNodes_Pu',​
 + array(
 + '​Value'​ => '<​value>',​
 + // '​DomainTreeNodeID'​ => 0,
 + // '​NodeCharacteristicIDs'​ => NULL,
 + // '​IsLike'​ => 0,
 + // '​IncludeInherited'​ => 1,
 + // '​StartAtRowNo'​ => 1,
 + // '​RowCount'​ => 100,
 + // '​IncludeValueDetails'​ => 0,
 + // '​IncludeVariants'​ => 1,
 + // '​MaintainSearchItemLacks'​ => 1,
 + // '​BinaryCharacteristicValueID'​ => NULL,
 + // '​FilterByCharacteristicID'​ => NULL,
 + // '​FilterByCharacValue'​ => NULL,
 + // '​Country'​ => '​german',​
 + // '​NegateFilterByParams'​ => 0,
 + // '​SortByCharacteristicIDList'​ => NULL,
 + // '​SortOptionList'​ => NULL,
 + // '​InheritDepthOptionList'​ => NULL,
 + // '​RecursiveEvaluationOptionList'​ => NULL,
 + // '​GetValuesForSortByCharacs'​ => 0,
 + // '​OutputIntoOneID'​ => 0
 + )
 +);
 +
 +$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_SearchProductTreeNodes_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​Value"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​DomainTreeNodeID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​NodeCharacteristicIDs">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​IsLike">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeInherited">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​StartAtRowNo">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​RowCount">​100</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeValueDetails">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeVariants">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaintainSearchItemLacks">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​BinaryCharacteristicValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​FilterByCharacteristicID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​FilterByCharacValue">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​Country">'​german'</​Parameter>​ -->
 + <!-- <​Parameter Name="​NegateFilterByParams">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​SortByCharacteristicIDList">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​SortOptionList">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​InheritDepthOptionList">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​RecursiveEvaluationOptionList">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetValuesForSortByCharacs">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputIntoOneID">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_searchproducttreenodes_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)