mi_ModifyAppSettings_Ad [dstore]

Inhaltsverzeichnis

mi_ModifyAppSettings_Ad

mi_ModifyAppSettings_Ad

Speichert oder ändert oder löscht benutzerspezifische Einstellungen zu registrierten „dStore“-Anwendungen.

Darunter sind jegliche Arten von Anwendungen zu verstehen, die auf dem „dStore“ basieren. Für den dStore selbst hat die Registrierung von solchen Anwendungen keine Bedeutung; hierdurch wird aber jeder Anwendung die Möglichkeit gegeben, benutzerabhängige Einstellungen zu speichern (mit dieser Prozedur, s. a. mi_ModifyAppPartSettings_Ad).

Anmerkung zum Parameter „KeyValuePairsInTempdb“ :
Es können mehrere Einstellungen gleichzeitig verarbeitet werden, indem man „KeyValuePairsInTempdb“ auf „1“ setzt. In „tempdb.dbo.CharacteristicConditions“ erwartet die Prozedur dann „KeyVariable-Value“-Werte, die so übergeben werden :

„Condition1“ enthält „KeyVariable“s
„Condition2“ enthält „Value“s

Alle anderen Spalten können beliebige Werte enthalten, diese werden nicht weiter beachtet (Achtung : „CharacteristicID“ muß eindeutig sein, d.h. hier verwendet man am besten eine Art „Zeilennummer“).
Hinweise :
1. Ein „KeyVariable“-Wert (in „Condition1“ übergeben) darf NICHT mehr als 100 Bytes enthalten
2. Für den „Value“-Wert (in „Condition2“ übergeben) können in diesem Fall leider „nur 1000 Bytes“ übergeben werden. Wenn man mehr speichern möchte, ist man gezwungen, den Weg über den Parameter „Value“ zu wählen !

HTTP-Method	POST
HTTP-Auth	Optional
Alias	mi_ModifyApplicationSettings_Ad
Tags	[mi, Modify, Application, Settings, Ad]
Engine-Kategorie	basics
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ApplicationID		ID einer registrierten „dStore“-Anwendung	smallint	4.0.8
UserID	NULL	ID eines in „UserInfo“ registrierten „dStore“-Benutzers (bei „NULL“ : der Benutzer, der die Prozedur aufruft), für den die Einstellung gilt. „-1“ bedeutet, daß die Einstellung für alle Benutzer (die keinen eigenen Eintrag zu „KeyVariable“ haben) gilt.	smallint	4.0.8
KeyVariable		Ein Schlüssel, auf den sich „Value“ bezieht, bzw. zu dem ein evtl. bereits vorhandener Wert gelöscht werden soll (falls „Delete = 1“)	varchar(100)	4.0.8
Value		Der Wert zum Schlüssel „KeyVariable“, der zum Benutzer „UserID“ für die Anwendung „ApplicationID“ hinterlegt werden soll	text	4.0.8
Delete	0	„0“ : „Value“ soll zum Schlüssel „KeyVariable“ für den Benutzer „UserID“ hinterlegt werden „1“ : Eine evtl. vorhandene Einstellung zum Schlüssel „KeyVariable“ für den Benutzer „UserID“ soll gelöscht werden	bit	4.0.8
KeyValuePairsInTempdb	0	Übergibt man hier „1“, werden die Parameter „KeyVariable“ und „Value“ ignoriert. Es müssen in „tempdb.dbo.CharacteristicConditions“ dann „KeyVariable-Value“-Werte übergeben werden, die zu setzen bzw. löschen sind.	bit	4.0.8

Rückgabe

Die Prozedur hat keine Rückgaben.

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
-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.2	2013-08-29	1. Ab jetzt werden „KeyVariable“-Werte bei Übergabe über „tempdb.dbo.CharacteristicConditions“ hinsichtlich der maximalen Länge geprüft 2. Parameter „Value“ wurde auf Datentyp „text“ erweitert
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.9	2004-03-03	1. Verwendung von „_mi_ChooseParamValueSeperator“ als Vorbereitung von „_mi_StartProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.8	2004-02-20	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_ModifyAppSettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyAppSettings_Ad?ApplicationID=<value>&KeyVariable=<value>&Value=<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_ModifyAppSettings_Ad',
		array(
			'ApplicationID' => <value>,
			'KeyVariable' => '<value>',
			'Value' => <value>,
			// 'UserID' => NULL,
			// 'Delete' => 0,
			// 'KeyValuePairsInTempdb' => 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_ModifyAppSettings_Ad">
			<Parameters>
				<Parameter Name="ApplicationID"><!-- smallint value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<Parameter Name="Value"><!-- text value --></Parameter>
				<!-- <Parameter Name="UserID">NULL</Parameter> -->
				<!-- <Parameter Name="Delete">0</Parameter> -->
				<!-- <Parameter Name="KeyValuePairsInTempdb">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