Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_modifynodeproperties_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_modifynodeproperties_ad [11.01.2016 ]
engine:procedures:im_modifynodeproperties_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_ModifyNodeProperties_Ad =====
 +
 +Einer Menge von Artikel-Elementen ("​NodeID"​s aus der Tabelle "​dStore"​) kann man mit dieser Prozedur eine Eigenschaft zu einem bestimmten Merkmal zuweisen.\\ ​
 +
 +Es wird überprüft,​ ob der Benutzer, der diese Prozedur aufruft, auch für alle Elemente die Berechtigung besitzt, sie entsprechend zu bearbeiten. Es ist grundsätzlich NICHT möglich, Eigenschaften in der Vergangenheit zu manipulieren !\\ Prinzipiell wird nach drei Arten der "​Modifikation"​ unterschieden :
 +  * Neu-Anlage von Eigenschaften
 +  * Ändern von Eigenschaftn
 +  * Löschen von Eigenschaften
 +Die Definition dieser drei Arten und wie man einzelne Berechtigungen vergeben kann, ist in [[dstoreproc>​im_GetLockedNodeCharacs_Ad]] bzw. [[dstoreproc>​im_ModifyLockedNodeCharacs_Ad]] beschrieben.\\ ​
 +
 +Optional kann ein Gültigkeitszeitraum dieser Eigenschaft über "​ValidFrom"​ und "​ValidTo"​ angegeben werden; ansonsten\\ ist die Eigenschaft ab jetzt ( "​ValidFrom = getdate()"​ ) unbeschränkt ("​ValidTo = NULL") gültig.\\ ​
 +
 +Anmerkungen:​\\ 1. Falls "​Value"​ NULL ist, wird der Wert ""​ eingetragen (also nicht "​NULL"​ oder etwa überhaupt kein Datensatz) !\\ 2. Um die aktuell UND für zukünftige Zeiträume zugewiesene Eigenschaft zum Merkmal "​NodeCharacteristicID"​ zu löschen, muß man "​ValidFrom"​ und "​ValidTo"​ so übergeben, daß gilt : "​ValidFrom >= ValidTo"​.\\ ​
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Modify Node Properties Ad]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Änderung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +|__NodeIDList__| |Eine Liste von IDs von Artikel-Elementen,​ für die eine Eigenschaft zugewiesen werden soll. Falls hier "​NULL"​ oder %%''​%% angegeben wird, erwartet die Prozedur die IDs in "​tempdb.dbo.OneID"​.\\ |varchar(255)|3.5.0|
 +|__NodeCharacteristicID__| |ID des Merkmals, zu dem die Eigenschaft zugewiesen werden soll\\ |smallint|3.5.0|
 +|__Value__| |Eigenschaft,​ die zugewiesen werden soll. Hat das Merkmal vordefinierte Werte ["​PredefinedValues = 1"], kann man hier sowohl einen Wert also auch eine "​ValueID"​ angeben - was man gewählt hat, ist über "​ValueIDForPredefinedCharac"​ anzugeben.\\ |varchar(1000)|3.5.0|
 +|ValidFrom|NULL |Optionale Angabe des Gültigkeitsstartzeitpunktes - die Eigenschaft ist nur zwischen "​ValidFrom"​ und "​ValidTo"​ gültig. Wenn "​NULL"​ angegeben ist, wird automatisch der Zeitpunkt des Aufrufs der Prozedur gewählt.\\ |datetime|3.5.0|
 +|ValidTo|NULL |Optionale Angabe des Gültigkeitsendes - die Eigenschaft ist nur zwischen "​ValidFrom"​ und "​ValidTo"​ gültig. "​NULL"​ bedeutet, daß die Eigenschaft "​unendlich"​ lang gültig ist.\\ |datetime|3.5.0|
 +|DeleteValueID|NULL |Falls angegeben, wird der Datensatz aus "​NodeProperties"​ mit "​NodeID = <​übergebene NodeID>",​ "​ValueID = DeleteValueID",​ "​ValidFrom = ValidFrom"​ gelöscht, sofern "​ValidFrom in der Zukunft liegt\\ |integer|4.0.5|
 +|ValueIDForPredefinedCharac|1 |Hat das Merkmal vordefinierte Werte ["​PredefinedValues = 1"], gibt man hier an, ob "​Value"​ einen Wert ("​0"​) oder eine "​ValueID"​ ("​1"​) enthält. ACHTUNG : Ist "​UseDataFrom_dstoreifin = 1", wird dieser Parameter ignoriert - es werden IMMER Werte erwartet !\\ |bit|5.1.0|
 +|UseDataFrom_dstoreifin|0 |Um z.B. zu VERSCHIEDENEN Merkmalen Eigenschaften zu ändern, muß man hier "​1"​ angeben, und VORHER die Prozedur "​if_im_ModifyNodeProperties_Ad"​ (s. Doku dort) aufgerufen haben. In diesem Fall wird "​NewValueID"​ natürlich nicht belegt (ist also "​NULL"​) !\\ |bit|5.1.1|
 +==== Rückgabe ====
 +
 +=== wenn Result (Pseudo-Parameter) IN (-245,-284) und UseDataFrom_dstoreifin = 1 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeID|ID eines der in der Input-Schnittstelle übergebenen Artikel-Elemente\\ |integer|5.1.1 |
 +|NodeCharacteristicID|ID des Merkmals, zu dem eine Eigenschaft von "​NodeID"​ geändert werden sollte, es aber einen Fehler gab\\ |smallint|5.1.1 |
 +|ErrorCode|Fehler-Ursache :\\ - "​1"​ : Die Eigenschaft entspricht nicht dem Feldtyp\\ - "​2"​ : Die Eigenschaft existiert nicht, es sind aber nur vordefinierte Werte erlaubt\\ - "​3"​ : Der Wert der relativen Änderung ist ungültig\\ - "​4"​ : Fehlende Berechtigung(en)\\ |tinyint|5.1.1 |
 +==== Output-Parameter ====
 +
 +|NewValueID|Rückgabeparameter für die "​ValueID"​ der zugewiesenen Eigenschaft "​Value"​ (bei vordefinierten Werten steht hier natürlich das gleiche wie in "​Value"​ übergeben wurde)|
 +==== 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|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-500|Falsche Parameter|direkt und 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|direkt und 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|
 +|-120|Der Benutzer hat keine Berechtigung für das (die) Element(e)|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.3 |2013-12-13|Bugfix : "​NewValueID"​ konnte manchmal falsch belegt werden, nämlich mit der ID der alten Eigenschaft [also vor der\\ Änderung]\\ ​ |
 +|7.0.1 |2013-08-07|Datentyp-Erweiterung des Parameters "​Value"​ [von 100 auf 1000]\\ ​ |
 +|6.5.3 |2013-03-18|Interne Anpassungen wg. UTF8-Unterstützung\\ ​ |
 +|6.0.4 |2011-10-21|1. Pflege der neuen "​NodeMetaInformation"​-Tabelle\\ 2. Quellcode-Anpassungen an den aktuellen Standard\\ ​ |
 +|6.0.3 |2011-09-07|Fehler bei der Belegung des Ausgabeparameters "​NewValueID"​ im Fall "​ValidFrom is NULL" (er wurde dadurch manchmal mit "​NULL"​ belegt)\\ ​ |
 +|5.1.5 |2006-08-29|1. Die Überprüfung bzgl. "​LockedNodeCharacteristics"​ wird jetzt intern von "​_im_ModifyNodeProperties"​ durchgeführt\\ 2. Neuer "​ErrorCode"​ in der Ergebnismenge,​ falls Fehler auftreten\\ ​ |
 +|5.1.1 |2006-04-05|1. Neuer Parameter "​UseDataFrom_dstoreifin"​\\ 2. Interne Änderung, da der "​LockStatus = 2" für "​LockedNodeCharacteristics"​ ersatzlos weggefallen ist\\ 3. Fehler bei einem Aufruf einer Prozedur (fehlende Fehlerbehandlung)\\ ​ |
 +|5.1.0 |2006-02-08|1. Verlagerung der Codes auf die neue Prozedur "​_im_ModifyNodeProperties"​\\ 2. "​DeleteValueID"​ wird nun beachtet, sobald NICHT "​NULL"​ angegeben ist\\ 3. Neuer Parameter "​ValueIDForPredefinedCharac"​\\ 4. Fehler bei der Überprüfung des "​LockStatus = 2"​\\ ​ |
 +|4.0.13 |2004-05-18|1. Aufruf der Prozeduren "​_mi_StartProcedure",​ "​_mi_FinishProcedure"​ und "​_mi_ChooseParamValueSeperator"​ \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ 3. Konsequente Fehlerbehandlung\\ ​ |
 +|4.0.5 |2003-10-04|1. Implementierung des neuen "​LockStatus"​ "​2",​ mit dem man einem Benutzer verbieten kann, vergangene Eigenschaften zu diesem Merkmal zu ändern\\ 2. Neuer Parameter "​DeleteValueID"​\\ ​ |
 +|4.0.1 |2003-05-16|1. Ab jetzt wird berücksichtigt,​ daß in "​NodeProperties"​ auch Gültigkeitszeiträume in der Zukunft vorhanden sein können !\\ 2. Ausnutzung einiger neuer Parameter von "​_im_CheckLockedTreeNodeIDs"​\\ 3. Performance-Verbesserung\\ ​ |
 +|3.5.20 |2002-07-22|\\ ​ |
 +|3.5.19 |2002-06-17|\\ ​ |
 +|3.5.12 |2001-10-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_ModifyNodeProperties_Ad|im_ModifyNodeProperties_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_ModifyNodeProperties_Ad?​NodeIDList=<​value>&​NodeCharacteristicID=<​value>&​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 POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_ModifyNodeProperties_Ad?​NodeIDList=<​value>&​NodeCharacteristicID=<​value>&​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_ModifyNodeProperties_Ad',​
 + array(
 + '​NodeIDList'​ => '<​value>',​
 + '​NodeCharacteristicID'​ => <​value>,​
 + '​Value'​ => '<​value>',​
 + // '​ValidFrom'​ => NULL,
 + // '​ValidTo'​ => NULL,
 + // '​DeleteValueID'​ => NULL,
 + // '​ValueIDForPredefinedCharac'​ => 1,
 + // '​UseDataFrom_dstoreifin'​ => 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_ModifyNodeProperties_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​NodeIDList"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​NodeCharacteristicID"><​!-- smallint value --></​Parameter>​
 + <​Parameter Name="​Value"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​ValidFrom">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValidTo">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​DeleteValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValueIDForPredefinedCharac">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​UseDataFrom_dstoreifin">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_modifynodeproperties_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)