mi_GetApplicPartSettings_Pu [dstore]

Inhaltsverzeichnis

mi_GetApplicPartSettings_Pu

mi_GetApplicPartSettings_Pu

Gibt Einstellungen zu „Teilen“ einer registrierten „dStore“-Anwendung aus, die zu dem Benutzer, der diese Prozedur aufruft, gespeichert sind.

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.
Hierdurch gibt es aber für die Anwendung die Möglichkeit, zu bestimmten Teilen Einstellungen hinterlegen zu können (s. mi_ModifyAppPartSettings_Ad).

Anmerkung zum Parameter „GetValuesForGlobalUser“ :
Einstellungen zu Anwendungen können sowohl „global“ (zur „UserID = -1“) als auch speziell für einen Benutzer definiert sein.
Ist „GetValuesForGlobalUser = 1“, werden sowohl die Einstellungen zur „UserID = -1“ als auch zu dem Benutzer, der diese Prozedur aufruft, berücksichtigt. Setzt man diesen Parameter auf „2“, bekommt man NUR Einstellungen, die global definiert sind.

Anmerkung zum Parameter „SearchForKeyVariableWithLike“ :
Ist „1“ angegeben, d.h. soll mit dem „LIKE“-Operator gesucht werden, kann „KeyVariable“ die in T-SQL erlaubten „wildcards“ („%“ für eine beliebige Zeichenkette, „_“ für ein beliebiges Zeichen) enthalten. „KeyVariable“ darf aber NICHT mit einem „wildcard“ (also mit „%“ oder „_“) BEGINNEN !

HTTP-Method	GET
HTTP-Auth	Optional
Alias	mi_GetApplicationPartSettings_Pu
Tags	[mi, Get, Application, Part, Settings, Pu]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ApplicationPartID		ID eines Teils einer „dStore“-Anwendung, zu dem Einstellungen ermittelt werden sollen. Bei Angabe von „NULL“ erwartet die Prozedur „ApplicationPartID“s in „tempdb.dbo.OneID“.	integer	4.0.12
KeyVariable	NULL	Name eines Schlüssels, zu dem der für den Benutzer der diese Prozedur aufruft (bzw. für den „globalen“ Benutzer) hinterlegte Wert zurückgegeben werden soll. „NULL“ angeben, um die Werte zu ALLEN hinterlegten Schlüsseln zu bekommen.	varchar(100)	4.0.12
SearchForKeyVariableWithLike	0	„0“ : Den Datensatz ausgeben, für den „KeyVariable = KeyVariable“ gilt „1“ : Die Datensätze ausgeben, für die „KeyVariable LIKE KeyVariable“ gilt (s. a. Beschreibung !)	bit	4.0.12
GetValuesForGlobalUser	1	„0“ : Nur Einstellungen des Benutzers, der diese Prozedur aufruft, beachten „1“ : Auch „global“ definierte Einstellungen berücksichtigen „2“ : NUR „global“ definierte Einstellungen beachten (s. a. Beschreibung !)	tinyint	4.0.12

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ApplicationPartID	ID eines Teils einer „dStore“-Anwendung, zu dem die Einstellung „Value“ hinterlegt ist (entspricht entweder „ApplicationID“ oder einer ID, die via „tempdb.dbo.OneID“ übergeben wurde)	integer	4.0.12
KeyVariable	Ein Schlüssel, zu dem der Wert „Value“ für den Benutzer, der diese Prozedur aufruft (bzw. für den „globalen“ Benutzer) hinterlegt ist	varchar(100)	4.0.12
Value	Der Wert, der zum Schlüssel „KeyVariable“ für den Benutzer , der diese Prozedur aufruft (bzw. für den „globalen“ Benutzer) hinterlegt ist	varchar(3500)	4.0.12
ValueDerivedFromGlobalUser	„1“, falls „Value“ zur „UserID = -1“ gespeichert ist	bit	4.0.12

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ApplicationPartID (aufsteigend)
KeyVariable (aufsteigend)

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.5	2014-05-26	Doku angepasst. Rückgabespalte „Value“ hat nun als Datentyp „varchar[3500]„
6.5.3	2013-03-18	Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
4.0.12	2004-04-30	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_GetApplicPartSettings_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplicPartSettings_Pu?ApplicationPartID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplicPartSettings_Pu?ApplicationPartID=<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_GetApplicPartSettings_Pu',
		array(
			'ApplicationPartID' => <value>,
			// 'KeyVariable' => NULL,
			// 'SearchForKeyVariableWithLike' => 0,
			// 'GetValuesForGlobalUser' => 1
		)
);
 
$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_GetApplicPartSettings_Pu">
			<Parameters>
				<Parameter Name="ApplicationPartID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="KeyVariable">NULL</Parameter> -->
				<!-- <Parameter Name="SearchForKeyVariableWithLike">0</Parameter> -->
				<!-- <Parameter Name="GetValuesForGlobalUser">1</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