Inhaltsverzeichnis
mi_ModifyAppPartSettings_Ad
Verwaltet benutzerspezifische Einstellungen zu sogenannten „dStore“-Anwendungs-Teilen.
Was sich letztlich hinter einem Anwendungs-Teil verbirgt, ist für den „dStore“ vollkommen bedeutungslos. Es kann sich hierbei um ein „Objekt“ handeln, oder um ein „Frame“, oder um eine Kombination von Fenstern, etc.
Anmerkung zum Parameter „DataInTempdb“ :
Es können mehrere Einstellungen gleichzeitig verarbeitet werden, indem man „DataInTempdb“ auf „1“ setzt. In „tempdb.dbo.CharacteristicConditions“ erwartet die Prozedur dann „ApplicationID-KeyVariable-Value“-Werte, die so übergeben werden :
- „EstimatedRowsAffected“ enthält „ApplicationPartID“s
- „Condition1“ enthält „KeyVariable“s (Ein „KeyVariable“-Wert darf NICHT mehr als 100 Bytes enthalten !)
- „Condition2“ enthält „Value“s (Ein „Value“-Wert darf NICHT mehr als 255 Bytes enthalten !)
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“).
Des Weiteren kann man die Daten auch über die Input-Schnittstelle von mi_ModifyAppPartSettings_Ad übergeben, was den Vorteil hat, dass „Value“ größere Datenmengen enthalten kann (bis zu 3500 Bytes). Um die Schnittstelle zu füllen, wird „if_mi_ModifyAppPartSettings_Ad“ verwendet und anschliessend diese Prozedur mit „ApplicationPartID = NULL“ und „DataInTempdb = 0“ aufgerufen (siehe Dokumentation von „if_mi_ModifyAppPartSettings_Ad“ ).
| HTTP-Method | POST |
| HTTP-Auth | Optional |
| Alias | mi_ModifyApplicationPartSettings_Ad |
| Tags | |
| Engine-Kategorie | basics |
| Engine-Typ | Daten-Änderung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| ApplicationPartID | ID eines Teils einer „dStore“-Anwendung. Wird nur beachtet, wenn „DataInTempdb = 0“ ist ! Wird „NULL“ angegeben und ist „DataInTempdb = 0“, müssen die Daten zuvor via „if_mi_ModifyAppPartSettings_Ad“ in die Schnittstelle eingefügt worden sein. | integer | 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 den Anwendungs-Teil „ApplicationPartID“ hinterlegt werden soll | varchar(3500) | 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 |
| DataInTempdb | 0 | Übergibt man hier „1“, werden die Parameter „ApplicationPartID“, „KeyVariable“ und „Value“ ignoriert. Es müssen in „tempdb.dbo.CharacteristicConditions“ dann „ApplicationPartID-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 4) |
|---|---|---|
| -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.5 | 2014-05-26 | Neue Möglichkeit der Datenübergabe via „dstoreifin.dbo.mi_ModifyAppPartSettings_Ad“ und Parameter „Value“ auf „varchar[3500]“ erweitert |
| 7.0.2 | 2013-08-29 | Ab jetzt werden „KeyVariable“- und „Value“-Werte - wenn die Übergabe über „tempdb.dbo.CharacteristicConditions“ erfolgt - hinsichtlich der maximalen Länge geprüft und es gibt ggf. einen Fehler [vorher wurden die Werte einfach abgeschnitten] |
| 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:
cURL
Unformatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyAppPartSettings_Ad?ApplicationPartID=<value>&KeyVariable=<value>&Value=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyAppPartSettings_Ad?ApplicationPartID=<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_ModifyAppPartSettings_Ad', array( 'ApplicationPartID' => <value>, 'KeyVariable' => '<value>', 'Value' => '<value>', // 'UserID' => NULL, // 'Delete' => 0, // 'DataInTempdb' => 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_ModifyAppPartSettings_Ad"> <Parameters> <Parameter Name="ApplicationPartID"><!-- integer value --></Parameter> <Parameter Name="KeyVariable"><!-- varchar value --></Parameter> <Parameter Name="Value"><!-- varchar value --></Parameter> <!-- <Parameter Name="UserID">NULL</Parameter> --> <!-- <Parameter Name="Delete">0</Parameter> --> <!-- <Parameter Name="DataInTempdb">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>