mi_CheckFieldTypeOfValues_Ad [dstore]

Inhaltsverzeichnis

mi_CheckFieldTypeOfValues_Ad

mi_CheckFieldTypeOfValues_Ad

Überprüft, ob Werte hinsichtlich eines bestimmten „Formats“ (auch „Feld-Typ“ genannt → „FieldTypeID“) korrekt sind. Damit kann man z.B. schon VOR Änderungen bestimmter Daten (wie z.B. Artikel- oder Personen-Eigenschaften) herausfinden, ob es einen Fehler geben wird oder nicht.

Anmerkungen zum Parameter „UseOldVersion“:

Da derzeit noch bei vielen Prozeduren (z.B. beim Ändern von Personendaten) intern eine andere (alte) Prozedur zur Überprüfung
verwendet wird, kann man den Check über die „alte Version“ erzwingen, indem man „UseOldVersion“ auf „1“ setzt.
Hier eine Liste der betroffenen „Objekte“, die derzeit noch über die alte Version laufen :

NodeProperties
PersonProperties
PostingProperties
AuctionItemSettingsForMode
ParticipantSettingsForMode

Anmerkungen zum Parameter „Value“ :

Möchte man mehrere Werte überprüfen lassen, setzt man „Value“ auf „NULL“ und übergibt die zu untersuchenden Daten via „tempdb.dbo.CharacteristicValues“ :

CharacteristicID : Dient nur der Eindeutigkeit des Datensatzes, im Prinzip kann hier ein beliebiger Wert übergeben werden (es muß nur für jeden Datensatz ein anderer sein)
Value : Muß die Form <FieldTypeID>,<beliebige Zeichenkette mit mindestens einem Zeichen> haben

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[mi, Check, Field, Type, Of, Values, Ad]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
Value		Der zu untersuchende Wert. Bei Angabe von „NULL“ erwartet die Prozedur Daten in „tempdb.dbo.CharacteristicValues“ (s. Beschreibung) !	varchar(1000)	5.1.2
FieldTypeID		ID eines „Feld-Typs“ (mögliche Werte : s. mi_GetFieldTypes_Ad), der das Format beschreibt, welches „Value“ erfüllen muß	tinyint	5.1.2
Country	'german'	Gibt an, in welchem „Datums-Format“ der Wert „Value“ ist, falls es sich um eine Datums-Angabe handelt (Groß-/Kleinschreibung wird nicht beachtet) : 'german', 'germany' : Tag-Monat-Jahr 'english', 'england' : Monat-Tag-Jahr	varchar(10)	5.1.2
UseOldVersion	0	„1“ angeben, um eine Überprüfung nach „alter Methode“ zu erzwingen (s. Beschreibung !)	bit	5.1.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value	Ein zu untersuchender Wert - entspricht also „Value“ bzw. einem „Value“-Wert aus „tempdb.dbo.CharacteristicValues“	varchar(1000)	5.1.2
FieldTypeID	ID eines „Feld-Typs“ (mögliche Werte : s. mi_GetFieldTypes_Ad), der das Format beschreibt, welches „Value“ je nach „ErrorCode“ erfüllt oder nicht	tinyint	5.1.2
ErrorCode	Das Ergebnis : - „0“ : Alles ok, der Wert kann so übernommen werden - „1“ : Alles ok, aber der Wert mußte umformatiert werden (→ „AlteredValue“), z.B. bei Datumsangaben, wenn 'german' für „Country“ übergeben wurde - „2“ : Falsches Format	tinyint	5.1.2
AlteredValue	Immer „NULL“, außer im Fall „ErrorCode = 1“. In diesem Fall würde intern nicht der (ursprünglich) übergebene Wert „Value“ gespeichert werden, sondern dieser hier !	varchar(1000)	5.1.2

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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
-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

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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.5	2014-05-26	Datentypen von Parameter „Value“ und Variable „Value_tmp“ erweitert, Anpassung bzgl. Datentyp an „#Result“ und Anpassung der Doku
6.5.3	2013-03-18	Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
5.1.2	2006-06-26	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:

mi_CheckFieldTypeOfValues_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_CheckFieldTypeOfValues_Ad?Value=<value>&FieldTypeID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_CheckFieldTypeOfValues_Ad?Value=<value>&FieldTypeID=<value>' | 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'),
	'mi_CheckFieldTypeOfValues_Ad',
		array(
			'Value' => '<value>',
			'FieldTypeID' => <value>,
			// 'Country' => 'german',
			// 'UseOldVersion' => 0
		)
);
 
$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="mi_CheckFieldTypeOfValues_Ad">
			<Parameters>
				<Parameter Name="Value"><!-- varchar value --></Parameter>
				<Parameter Name="FieldTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="Country">'german'</Parameter> -->
				<!-- <Parameter Name="UseOldVersion">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis