Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

@@ Zeile 1: / Zeile 1: @@
+===== im_SearchCharacteristics_Pu =====
+Sucht alle Artikel-Elemente, die (zu einem bestimmten Zeitpunkt) eine Eigenschaft (zu bestimmten Merkmalen) besitzen, die einem Suchbegriff ("Value") entspricht bzw. diesen enthält.\\
+Es kann angegeben werden, ob nur direkt zugewiesene Eigenschaften in Frage kommen oder auch vererbte.\\
+Weiter kann das Suchergebnis nur auf Elemente beschränkt werden, die zwischen zwei bestimmten Hierarchie-Stufen liegen.\\
+Zusätzlich zur Suche in den Eigenschaften ist es möglich, auch in der Element-Bezeichnung ("NodeDescription") suchen zu lassen.\\
+ANMERKUNG 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.\\
+|HTTP-Method|GET |
+|HTTP-Auth|Optional |
+|Tags|{{tag>[im Search Characteristics 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 ^
+|NodeCharacteristicIDs|NULL |Eine Liste von IDs (durch das '¶'-Zeichen getrennt) von den Merkmalen, in deren Eigenschaften nach dem Suchbegriff "Value" gesucht werden soll\\ |varchar(255)|3.5.0|
+|__Value__| |Der Suchbegriff\\ |varchar(1000)|3.5.0|
+|IsLike|0 |Dieser Parameter steuert, wie genau die Eigenschaft mit dem Suchbegriff übereinstimmen muß (Groß- und Kleinschreibung wird NIE beachtet !) :\\ "0" : Genaue Übereinstimmung\\ "1" : Der Suchbegriff muß in der Eigenschaft vorkommen\\ |bit|3.5.0|
+|Date|NULL |Zeitpunkt der Gültigkeit der Eigenschaft\\ |datetime|3.5.0|
+|IncludeInherited|0 |"0" : Nur direkt zugewiesene Eigenschaften werden beachtet\\ "1" : Auch geerbte Eigenschaften werden berücksichtigt\\ |bit|3.5.0|
+|LanguageID|1 |ID einer Sprache; relevant im Bezug auf die Bezeichnung der Artikelelemente in der Rückgabemenge und in der Suche, falls "IncludeNodeDescription = 1"\\ |tinyint|3.5.0|
+|IncludeNodeDescription|0 |"0" : Nur Eigenschaften durchsuchen\\ "1" : Auch in den Bezeichnungen der Artikel-Elemente ("NodeDescription") suchen\\ |bit|3.5.0|
+|ResultUpToLevelNo|NULL |Im Ergebnis werden nur die gefundenen Elemente angezeigt, die über dieser Hierarchie liegen\\ |tinyint|3.5.0|
+|SearchUpToLevelNo|NULL |Einschränkung der Suchtiefe. Nur Artikel-Elemente mit einer höheren Hierarchie (d.h. "LevelNo <= SearchUpToLevelNo") werden bei der Suche betrachtet\\ |tinyint|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".\\ |smallint|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".\\ |tinyint|3.5.0|
+|MaintainSearchItemLacks|1 |Wenn nichts gefunden wurde, dann wird der Begriff in die Tabelle "SearchItemLacks" eingetragen, falls dieser Parameter mit "1" übergeben wird\\ |bit|3.5.6|
+|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|
+|SortResult|0 |"1" angeben, um eine Sortierung der Rückgabemenge zu erhalten (siehe Doku der Sortierung der Rückgabemenge)\\ |bit|4.0.0|
+|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|
+==== 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 ausgegeben, sondern nur (im Fall "SortResult = 1") zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge von "TreeNodeID" innerhalb aller Nachfolger von "PredecossorsTreeNodeID".\\ |smallint|4.0.0 |
+|//Predecessor_SortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Wird nicht ausgegeben, sondern nur (im Fall "SortResult = 1") zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge von "PredecessorsTreeNodeID" innerhalb aller Nachfolger von "PrePredecossorsTreeNodeID".\\ |smallint|4.0.0 |
+|HTreeNodeID|ID eines zur "NodeID" zugehörigen Elementes aus "HistoryTreeView" (in dieser ist die Historie des gesamten Artikelbaums abgebildet)\\ |integer|3.5.0 |
+|TreeNodeID|ID eines Elementes im Artikelbaum, das "NodeID" als Artikel-Element zugewiesen hat - oder "0" (es gibt zu jeder "NodeID" eine "HTreeNodeID" mit einem offenen Gültigkeitszeitraum und "unbekannter TreeNodeID")\\ |integer|3.5.0 |
+|NodeID|ID eines Artikel-Elementes, das eine Eigenschaft besitzt, die zum Suchbegriff "Value" paßt\\ |integer|3.5.0 |
+|NodeDescription|Bezeichnung der "NodeID"\\ |varchar(1000)|3.5.0 |
+|NodeCharacteristicID|ID des Merkmals, zu dem "NodeID" eine Eigenschaft besitzt, die zum Suchbegriff "Value" paßt. "-2147486548" bedeutet, daß der Suchbegriff über die Element-Bezeichnung ("NodeDescription") gefunden wurde.\\ |smallint|3.5.0 |
+|ValueID|ID der Eigenschaft "Value"\\ |integer|3.5.0 |
+|Value|Eigenschaft, die "NodeID" besitzt, die dem Suchbegriff "Value" entspricht\\ |varchar(1000)|3.5.0 |
+|Inherited|Besitzt "NodeID" die Eigenschaft "Value" direkt oder wurde diese vererbt ?\\ |bit|3.5.0 |
+|LevelNo|Nummer der Hierarchie der "NodeID"\\ |tinyint|3.5.6 |
+|PredecessorsTreeNodeID|ID des Vorgänger-Elementes im Artikelbaum des gefundenen Elementes\\ |integer|3.5.6 |
+|PredecessorsDescription|Bezeichnung des Vorgängers\\ |varchar(1000)|3.5.6 |
+|PrePredecessorsTreeNodeID|ID des Vor-Vorgänger-Elementes im Artikelbaum des gefundenen Elementes\\ |integer|3.5.6 |
+|PrePredecessorsDescription|Bezeichnung des Vor-Vorgängers\\ |varchar(1000)|3.5.6 |
+== Sortierung der Rückgabe ==
+wenn SortResult = 1
+  * PrePredecessorsTreeNodeID (aufsteigend)
+  * Predecessor_SortNo (absteigend)
+  * SortNo (absteigend)
+==== 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")) ^
+|-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|nur 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|nur indirekt|
+|-220|Es konnte keine Merkmal-ID für die Produktbezeichnung ermittelt werden|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 "NodeDescription", "Value", "PredecessorsDescription" und\\ "PrePredecessorsDescription" hat sich erweitert => Anpassung der Doku\\  |
+|6.5.3 |2013-03-18|Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung\\  |
+|5.1.5 |2006-08-29|1. "LockedNodeCharacteristics" wurde bisher GAR NICHT beachtet !\\ 2. "_mi_StartProcedure"/"_mi_FinishProcedure" eingebaut\\  |
+|4.0.2 |2003-06-11|Neuer Parameter "NegateFilterByParams"\\  |
+|4.0.0 |2003-04-03|Neuer Parameter "SortResult"\\  |
+|3.5.20 |2002-07-22|\\  |
+|3.5.11 |2001-09-06|\\  |
+|3.5.6 |2001-04-17|\\  |
+|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_SearchCharacteristics_Pu|im_SearchCharacteristics_Pu im Engine Playground öffnen]]
+== cURL ==
+Unformatierte Ausgabe:
+<code bash>
+curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_SearchCharacteristics_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_SearchCharacteristics_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_SearchCharacteristics_Pu',
+		array(
+			'Value' => '<value>',
+			// 'NodeCharacteristicIDs' => NULL,
+			// 'IsLike' => 0,
+			// 'Date' => NULL,
+			// 'IncludeInherited' => 0,
+			// 'LanguageID' => 1,
+			// 'IncludeNodeDescription' => 0,
+			// 'ResultUpToLevelNo' => NULL,
+			// 'SearchUpToLevelNo' => NULL,
+			// 'StartAtRowNo' => 1,
+			// 'RowCount' => 100,
+			// 'MaintainSearchItemLacks' => 1,
+			// 'FilterByCharacteristicID' => NULL,
+			// 'FilterByCharacValue' => NULL,
+			// 'SortResult' => 0,
+			// 'NegateFilterByParams' => 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_SearchCharacteristics_Pu">
+			<Parameters>
+				<Parameter Name="Value"><!-- varchar value --></Parameter>
+				<!-- <Parameter Name="NodeCharacteristicIDs">NULL</Parameter> -->
+				<!-- <Parameter Name="IsLike">0</Parameter> -->
+				<!-- <Parameter Name="Date">NULL</Parameter> -->
+				<!-- <Parameter Name="IncludeInherited">0</Parameter> -->
+				<!-- <Parameter Name="LanguageID">1</Parameter> -->
+				<!-- <Parameter Name="IncludeNodeDescription">0</Parameter> -->
+				<!-- <Parameter Name="ResultUpToLevelNo">NULL</Parameter> -->
+				<!-- <Parameter Name="SearchUpToLevelNo">NULL</Parameter> -->
+				<!-- <Parameter Name="StartAtRowNo">1</Parameter> -->
+				<!-- <Parameter Name="RowCount">100</Parameter> -->
+				<!-- <Parameter Name="MaintainSearchItemLacks">1</Parameter> -->
+				<!-- <Parameter Name="FilterByCharacteristicID">NULL</Parameter> -->
+				<!-- <Parameter Name="FilterByCharacValue">NULL</Parameter> -->
+				<!-- <Parameter Name="SortResult">0</Parameter> -->
+				<!-- <Parameter Name="NegateFilterByParams">0</Parameter> -->
+			</Parameters>
+		</Procedure>
+	</Batch>
+</ListOfBatches></code>

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge