Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:do_getprocedurenames_ad

do_GetProcedureNames_Ad

Gibt eine Liste der dokumentierten Prozeduren zurück. Optional kann über die Prozedur-Kategorie, den Prozedur-Typ oder die aktuelle dStore-Version eingeschränkt werden.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriedocumentation
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
ProcedureCategoryIDNULL Wird nur beachtet wenn „GetProcsWithMissingDocu = 0“ UND „ProcedureName is NULL“ gilt ! ID einer Kategorie, nach der eingeschränkt werden soll (siehe do_GetProcedureCategories_Ad).
tinyint3.5.0
ProcedureTypeIDNULL Wird nur beachtet wenn „GetProcsWithMissingDocu = 0“ UND „ProcedureName is NULL“ gilt ! ID eines Prozedur-Typs, nach dem eingeschränkt werden soll (siehe do_GetProcedureTypes_Ad).
tinyint3.5.0
ActualVersionNULL Wird nur beachtet wenn „GetProcsWithMissingDocu = 0“ UND „ProcedureName is NULL“ gilt ! Nur Prozeduren berücksichtigen, die in der angegebenen Version zuletzt geändert wurden.
varchar(20)3.5.0
ProcedureNameNULL Wird nur beachtet wenn „GetProcsWithMissingDocu = 0“ gilt ! Name einer Prozedur - man erhält dann genau einen Datensatz (sofern die Prozedur auch existiert), egal ob eine Doku vorhanden ist oder nicht.
varchar(50)7.0.0
GetProcsWithMissingDocu0 „1“ angeben, um alle Prozeduren zu erhalten, zu denen eine Doku fehlt (in Frage kommen nur solche, die NICHT mit einem „_“ beginnen)
bit7.0.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
SortNo5)Wird nicht ausgegeben - war nur bis Version 6.5.4 relevant (wurde zur Sortierung verwendet)
smallint4.0.0
ProcedureNameName einer „dStore“-Prozedur, zu der es eine Beschreibung gibt (siehe do_GetProcedureDocu_Ad)
varchar(50)3.5.0
ProcedureCategoryIDID einer Kategorie von Prozeduren (siehe do_GetProcedureCategories_Ad), der die Prozedur „ProcedureName“ zugeordnet ist
tinyint3.5.0
ProcedureCategoryBezeichnung der Kategorie „ProcedureCategoryID“
varchar(100)3.5.0
ProcedureTypeIDID eines Prozedur-Typs (siehe do_GetProcedureTypes_Ad), von dem die Prozedur „ProcedureName“ ist
tinyint3.5.0
ProcedureTypeBezeichnung des Prozedur-Typs „ProcedureTypeID“
varchar(20)3.5.0
FirstdStoreVersionIn welcher „dStore“-Version wurde die Prozedur „ProcedureName“ eingeführt
varchar(20)3.5.0
ActualdStoreVersionIn welcher „dStore“-Version wurde die Prozedur „ProcedureName“ zuletzt geändert
varchar(20)3.5.0
ProcedureFunctionEine kurze Charakterisierung der Prozedur, also welchem Zweck sie dient
varchar(255)3.5.0
AuthorAutor der Prozedur. Im Fall „DocuExists = 0“ wird diese Info aus dem Quellcode herausgeparst und kann daher u.U. fehlen.
varchar(250)7.0.0
FirstCreatedAt_charWann die Prozedur zum ersten Mal erstellt wurde. Hinweise :
1. Nur eine Tagesangabe als „string“ im Formt mm/dd/yyyy
2. Im Fall „DocuExists = 0“wird diese Info aus dem Quellcode herausgeparst und kann daher u.U. fehlen
varchar(50)7.0.0
LastCreatedAt_charWann die Prozedur zuletzt übersetzt wurde. Hinweise :
1. Ein „string“ im Formt mm/dd/yyyy hh:mi:ss:ms
2. Im Fall „DocuExists = 0“ kommt diese Info aus einer entsprechenden Systemtabelle (Erstellungsdatum des Objekts)
varchar(50)7.0.0
LastEditedAt_charDatum wann die Prozedur vom Autor als „zuletzt editiert“ gekennzeichnet wurde Hinweise : 1. Nur eine Tagesangabe als „string“ im Formt mm/dd/yyyy 2. Im Fall „DocuExists = 0“wird diese Info aus dem Quellcode herausgeparst und kann daher u.U. fehlen
varchar(50)7.0.0
DocuExistsGibt an, ob eine (Haupt-)Doku existiert („1“) oder nicht („0“). Hier steht immer „1“ beim Aufruf mit Standardwerten und immer „0“ wenn „GetProcsWithMissingDocu = 1“ ist. Bei gegebenem „ProcedureName“ hängt der Wert davon ab, ob eine Doku vorhanden ist.
bit7.0.0
RegisteredForDocuGibt an, ob ein Datensatz in „dstore.dbo.ProcedureDevelopement“ (hier sind alle grundsätzlich dokumentierbaren Prozeduren registriert) existiert („1“) oder nicht („0“). Insbesondere ist also immer „DocuExists = 0“ falls hier „0“ zurückgegeben wird.
bit7.0.0
AliasProcedureNameOptionaler Alias-Name für „ProcedureName“, der in aller erster Linie den Sinn hat, den „vollständigen“ Namen angeben zu können, weil „ProcedureName“ häufig Abkürzungen enthält (Beispiel : s. Wert für pm_GetPChAccRestrForGroups_Ad)
varchar(100)7.0.4
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • ProcedureName (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-577Der Source-Code der SQL-Funktion ist nicht verfügbarnur indirekt
-574Der Source-Code des Triggers ist nicht verfügbarnur indirekt
-573Der Source-Code der Prozedur ist nicht verfügbarnur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.4 2014-03-19Neue Rückgabespalte „AliasProcedureName“
7.0.0 2013-06-041. Neu : „ProcedureName“, „GetProcsWithMissingDocu“
2. Neu (Spalten) : „Author“, „FirstCreatedAt_char“, „LastCreatedAt_char“, „LastEditedAt_char“, „DocuExists“, „RegisteredForDocu“
3. „ProcedureName“ jetzt 1. Spalte
4. Änderung d. Sortierung
6.5.3 2013-03-18„StartProcedure“-Call wg. UTF-8-Unterstützung angepasst
4.0.10 2004-03-151. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“
2. „set transaction isolation level 1“, „set rowcount 0“ zu Beginn d. Prozedur
3. Fehlende „optimizer“- und Index-Angabe in einem Fall
4.0.0 2003-04-03Neue Sortierung nach der „SortNo“ der „ActualdStoreVersion“ und nicht nach „ActualdStoreVersion“ selbst
3.5.16 2002-04-25
3.5.0 2000-11-23Erstmalig 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 GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureNames_Ad'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureNames_Ad' | 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'),
	'do_GetProcedureNames_Ad',
		array(
			// 'ProcedureCategoryID' => NULL,
			// 'ProcedureTypeID' => NULL,
			// 'ActualVersion' => NULL,
			// 'ProcedureName' => NULL,
			// 'GetProcsWithMissingDocu' => 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="do_GetProcedureNames_Ad">
			<Parameters>
				<!-- <Parameter Name="ProcedureCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="ProcedureTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="ActualVersion">NULL</Parameter> -->
				<!-- <Parameter Name="ProcedureName">NULL</Parameter> -->
				<!-- <Parameter Name="GetProcsWithMissingDocu">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/do_getprocedurenames_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)