Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getrootnodes_ad

im_GetRootNodes_Ad

Ermittelt alle „Wurzel“-Elemente aus der Tabelle „TreeView“, das sind Elemente, die keinen Vorgänger besitzen.

Im Artikelbaum, der durch diese Tabelle abgebildet wird, gibt es nur ein Wurzel-Element (welches die ID „0“ besitzt).
Darüber hinaus gibt es aber noch sogenannte „PageTreeNodes“. Diese besitzen alle eine „TreeNodeID“ kleiner „0“. Gemeint sind Elemente, die nicht zur Artikelstruktur gehören, aber trotzdem in den Statistiken zur Basis-Kennzahl „1“ („Views“) auftauchen sollen. Da die Anwendungsfälle hierfür im Regelfall Web-SEITEN (außerhalb der Produkt-Navigation) sind, deren Aufruf man zählen möchte, wurde der Name „Page“-TreeNodes gewählt. Diese „TreeNodes“ sollten nur verwendet werden, wenn man am sogenannten „Click-Stream“ eines Besuchers interessiert ist (siehe st_GetClickStream_Ad), denn ansonsten gibt es die Tabelle „Pages“, „PagesInCategories“, „PageCategories“ und „PageVisits“, die dem Zählen von Seiten-Aufrufen dienen (siehe u.a. st_GetPages_Ad, st_GetPageVisits_Ad etc.).

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieitem management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
OnlyActive1 „0“ : Aktive und inaktive Elemente des Artikelbaums werden ausgegeben
„1“ : Nur die aktiven Elemente des Artikelbaums werden ausgegeben
bit5.0.4
OnlyNotDeleted1 „0“ : Alle Elemente des Artikelbaums werden prinzipiell berücksichtigt
„1“ : Gelöscht Elemente des Artikelbaums werden nicht mitberücksichtigt (solche, für die in „TreeView“ „Deleted = 1“ ist)
bit5.0.4

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
NodeIDID des zur „TreeNodeID“ zugehörigen Elementes aus der Tabelle „dStore“
integer3.5.0
TreeNodeIDID eines „Wurzel“-Elementes. Für den Artikelbaum gibt es nur ein Wurzel-Element, das die ID „0“ hat. Alle anderen (sogenannten „PageTreeNodes“) haben eine ID kleiner „0“.
integer3.5.0
InheritsFromID eines Elementes, von dem Eigenschaften geerbt werden - diese Rückgabespalte hat eigentlich für Wurzel-Elemente keine Bedeutung, da im Regelfall immer vom Vorgänger (die genau diese Elemente ja nicht haben) geerbt wird…
integer3.5.0
NodeDescriptionBezeichnung der „NodeID“
varchar(100)3.5.0
ActiveIst „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)
bit3.5.0
CountSuccessorsWieviele direkte Nachfolger-Elemente besitzt „TreeNodeID“ ? ACHTUNG : Bei der Ermittlung dieser Zahl wird ebenfalls „OnlyActive“ und „OnlyNotDeleted“ entsprechend gefiltert !
integer3.5.0
SymbolIDID eines Symbols, das der „NodeID“ zugeordnet ist
smallint3.5.0
LevelNoNummer der Hierarchie der „NodeID“ (sollte immer „1“ sein)
tinyint3.5.0
SortNoBestimmt die Reihenfolge innerhalb aller Wurzel-Elemente
smallint3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (absteigend)
  • NodeDescription (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameternur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7 2015-01-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
5.0.4 2005-09-261. Neue Parameter „OnlyActive“ und „OnlyNotDeleted“
2. Fehler : In „CountSuccessors“ wurden bisher immer alle Nachfolge-Elemente gezählt, egal ob gelöscht bzw. aktiv oder nicht
3. Fehler : „LockedTreeNodeIDs“ wurde nicht berücksichtigt !
4.0.11 2004-03-311. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3. Änderung der Sortierung
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetRootNodes_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetRootNodes_Ad' | xmllint --format -
dStore_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_GetRootNodes_Ad',
		array(
			// 'OnlyActive' => 1,
			// 'OnlyNotDeleted' => 1
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="im_GetRootNodes_Ad">
			<Parameters>
				<!-- <Parameter Name="OnlyActive">1</Parameter> -->
				<!-- <Parameter Name="OnlyNotDeleted">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_getrootnodes_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)