engine:procedures:im_insertnodebinary_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:im_insertnodebinary_ad [11.01.2016 ] |
engine:procedures:im_insertnodebinary_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_InsertNodeBinary_Ad ===== | ||
| + | |||
| + | Legt ein neues Binärobjekt an und weist dieses (mit einem gewünschten Gültigkeitszeitraum) einer Liste von Artikel-Elementen zu. Die Gültigkeit der Zuordnung kann auf einen längeren Zeitraum und/oder bestimmte Tageszeiten beschränkt werden.\\ | ||
| + | |||
| + | Das Binärobjekt muß dabei über die Tabelle "tempdb.dbo.ImageData" zur "SortNo = 1" übergeben werden. Falls zu dem Binärobjekt auch ein "Thumbnail" angelegt werden soll, fügt man dieses vor dem Aufruf dieser Prozedur ebenfalls in "tempdb.dbo.ImageData" ein, und zwar zur "SortNo = 2".\\ | ||
| + | |||
| + | Falls man das neue "Binary" mehr Elementen zuweisen möchte, als über den Parameter "NodeIDs" angegeben werden kann, gibt es zwei Möglichkeiten :\\ 1.) Man setzt "NodeIDs = NULL" und übergibt alle gewünschten Elemente in "tempdb.dbo.OneID"\\ 2.) Man läßt sich durch Angabe von "ReturnBinaryCodeID = 1" eine Rückgabemenge ausgeben, die die ID des neu angelegten "Binaries" enthält und ruft anschließend [[dstoreproc>im_AddBinaryToNodes_Ad]] (evtl. mehrfach) auf. Nachteil dieser Methode ist allerdings, daß man keine Transaktions-Sicherheit über ALLE Operationen hat.\\ | ||
| + | |||
| + | Jedes Binärobjekt besitzt bestimmte Eigenschaften. Die des neu anzulegenden "Binaries" werden über "tempdb.dbo.CharacteristicValues" angegeben. Dabei MÜSSEN zwei Eigenschaften existieren :\\ 1. "MIME type", "BinaryCharacteristicID = 1"\\ 2. "Bildtyp", "BinaryCharacteristicID = 7"\\ | ||
| + | |||
| + | Anmerkung:\\ Da es sich bei den Tabellen "tempdb.dbo.ImageData" und "tempdb.dbo.CharacteristicValues" nur um Tabellen für die reine Parameterübergabe handelt, und nicht unnötig Speicher in der "tempdb" belegt werden soll, werden diese Tabellen am Ende der Prozedur automatisch geleert (selbstverständlich nur die Daten zur "spid"...) !\\ | ||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[im Insert Node Binary Ad]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Änderung | | ||
| + | |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 ^ | ||
| + | |__NodeIDs__| |Eine Liste von IDs (durch 'das '¶'-Zeichen getrennt) von Artikel-Elementen, denen das neue Binärobjekt zugewiesen werden soll. Bei Übergabe von "NULL", werden die IDs in "tempdb.dbo.OneID" erwartet.\\ |varchar(255)|3.5.0| | ||
| + | |BinaryDescription|NULL |Die Bezeichnung des neuen Binärobjekts\\ |varchar(100)|3.5.0| | ||
| + | |FromDate|NULL |Anfangs-Datum des Zeitraums, in dem das neue Binärobjekt dem (den) Elemt(en) zugewiesen sein soll\\ |datetime|3.5.0| | ||
| + | |ToDate|NULL |End-Datum des Zeitraums, in dem das neue Binärobjekt dem (den) Elemt(en) zugewiesen sein soll\\ |datetime|3.5.0| | ||
| + | |FromTime|NULL |Anfangs-Uhrzeit des Zeitraums, in dem das neue Binärobjekt dem (den) Elemt(en) zugewiesen sein soll\\ |datetime|3.5.0| | ||
| + | |ToTime|NULL |End-Uhrzeit des Zeitraums, in dem das neue Binärobjekt dem (den) Elemt(en) zugewiesen sein soll\\ |datetime|3.5.0| | ||
| + | |AutoContinue|0 |Automatische Weiterführung der Gültigkeitsangaben. DER WERT WIRD ZWAR IN DER TABELLE "DateIntervalls" GESETZT ABER DERZEIT NICHT VERWENDET !\\ |tinyint|3.5.0| | ||
| + | |ReturnBinaryCodeID|0 |Falls "1" angegeben ist, gibt es eine Rückgabemenge, die die ID des neu angelegten Binärobjektes enthält\\ |bit|3.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === wenn ReturnBinaryCodeID = 1 === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |BinaryCodeID|ID des neu angelegten Binärobjektes\\ |integer|3.5.0 | | ||
| + | ==== 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")) ^ | ||
| + | |-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| | ||
| + | |-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| | ||
| + | ==== 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]\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |6.0.4 |2011-10-21|Pflege der NodeMetaInformation\\ | | ||
| + | |5.1.7 |2006-10-31|1. Fehler : Es konnten Werte zu Merkmalen mit vordefinierten Werten automatisch erstellt werden !\\ 2. Detailliertere Informationen (via "print") bei "-500"\\ 3. Änderung in der Doku bzgl. Merkmal mit der ID "1"\\ 4. Interne Änderungen\\ | | ||
| + | |4.0.11 |2004-03-31|1. "_mi_StartProcedure", "_mi_FinishProcedure" u. "_mi_ChooseParamValueSeperator"\\ 2. "set transaction isolation level 1", "set rowcount 0" zu Beginn\\ 3. Konsequente Fehlerbehandlung\\ 4. Interner kl. Fehler\\ 5. Fehlende Index-Angaben\\ | | ||
| + | |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_InsertNodeBinary_Ad|im_InsertNodeBinary_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_InsertNodeBinary_Ad?NodeIDs=<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_InsertNodeBinary_Ad?NodeIDs=<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_InsertNodeBinary_Ad', | ||
| + | array( | ||
| + | 'NodeIDs' => '<value>', | ||
| + | // 'BinaryDescription' => NULL, | ||
| + | // 'FromDate' => NULL, | ||
| + | // 'ToDate' => NULL, | ||
| + | // 'FromTime' => NULL, | ||
| + | // 'ToTime' => NULL, | ||
| + | // 'AutoContinue' => 0, | ||
| + | // 'ReturnBinaryCodeID' => 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_InsertNodeBinary_Ad"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="NodeIDs"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="BinaryDescription">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="FromDate">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ToDate">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="FromTime">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ToTime">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="AutoContinue">0</Parameter> --> | ||
| + | <!-- <Parameter Name="ReturnBinaryCodeID">0</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_insertnodebinary_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)