Inhaltsverzeichnis
mi_ModifyApplicationParts_Ad
Prozedur zur Verwaltung von sogenannten „Teilen“ registrierter „dStore-Anwendungen“.
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. Hintergrund hierfür ist die Möglichkeit für die Anwendung, zu diesen Teilen bestimmte Einstellungen hinterlegen zu können - siehe dazu mi_ModifyAppPartSettings_Ad.
Anmerkung zum Parameter „UserID“ :
Anwendungs-Teile können „global“ (zur „UserID = -1“) als auch für speziell für einen Benutzer definiert sein. Beim Anlegen eines neuen Anwendungs-Teils wird er automatisch zu dem Benutzer, der die Prozedur aufruft, gespeichert - sofern man „UserID = NULL“ angibt. Möchte man das neue Anwendungs-Teil zu einem anderen Benutzer hinterlegen, ist „UserID“ entsprechend zu belegen.
Hinweis : die „UserID“ eines bestehenden Anwendungs-Teils kann nicht mehr geänder werden !
| HTTP-Method | POST |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | basics |
| Engine-Typ | Daten-Änderung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| ApplicationID | ID einer registrierten „dStore“-Anwendung, zu der „ApplicationPart“ gehört - hat nur Bedeutung falls „ApplicationPart“ neu registriert werden soll, also „ApplicationPartID = NULL“ ist | smallint | 4.0.8 | |
| UserID | NULL | Hat nur Bedeutung, wenn ein neuer Anwendungs-Teil angelegt wird ! ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad) und zu dem der Anwendungs-Teil gehört (s.a. Beschreibung !). | smallint | 4.0.8 |
| ApplicationPart | Name des Teils der Anwendung, der neu registriert werden soll („ApplicationPartID = NULL“) bzw. der neue Name, den „ApplicationPartID“ bekommen soll („Delete = 0“) | varchar(250) | 4.0.8 | |
| Delete | 0 | Wird nur beachtet, falls „ApplicationPartID“ nicht „NULL“ ist ! „0“ : Der Name des Anwendung-Teils „ApplicatinPartID“ soll geändert werden „1“ : Der bestehende Anwendungs-Teil „ApplicationPartID“ soll gelöscht werden | bit | 4.0.8 |
Rückgabe
Die Prozedur hat keine Rückgaben.
Output-Parameter
| ApplicationPartID | ID eines Teils einer „dStore“-Anwendung, der je nach „Delete“ geändert oder gelöscht wird. Bei Angabe von „NULL“ wird der Teil „ApplicationPart“ zur Anwendung „ApplicationID“ registriert und die neue ID kann über diesen Parameter ausgelesen werden. |
Mögliche Return-Codes
| Code | Beschreibung | Quelle 1) |
|---|---|---|
| -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] |
| 6.5.3 | 2013-03-18 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
| 4.0.14 | 2004-06-03 | Fehler : Beim Löschen eines Anwendungs-Teils wurden zwar Elemente aus „ApplicatinPartsTree“, die auf den zu löschenden Anwendungsteil referenzieren, gelöscht, aber evtl. vorhandene UNTERgeordnete Elemente blieben bestehen ! |
| 4.0.10 | 2004-03-15 | „Fehler“ : Trat beim Anlegen ein Fehler auf, wurde der Ausgabe-Parameter „ApplicationPartID“ nicht auf „NULL“ gesetzt |
| 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_ModifyApplicationParts_Ad?ApplicationID=<value>&ApplicationPart=<value>'
Mit xmllint 2) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyApplicationParts_Ad?ApplicationID=<value>&ApplicationPart=<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_ModifyApplicationParts_Ad', array( 'ApplicationID' => <value>, 'ApplicationPart' => '<value>', // 'UserID' => NULL, // 'Delete' => 0 ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray(); $OutputParams = $xml_result->getOutputParametersAsArray();
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_ModifyApplicationParts_Ad"> <Parameters> <Parameter Name="ApplicationID"><!-- smallint value --></Parameter> <Parameter Name="ApplicationPart"><!-- varchar value --></Parameter> <!-- <Parameter Name="UserID">NULL</Parameter> --> <!-- <Parameter Name="Delete">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>