Inhaltsverzeichnis
pm_GetPersonPredefinedVals_Ad
Gibt zu einem Personen-Merkmal (oder zu allen Merkmalen) alle vordefinierten Werte zurück.
Anmerkung zum Parameter „PersonCharacteristicID“ :
Falls ein Merkmal angegeben ist („PersonCharacteristicID <> -1“), das für den Benutzer, der diese Prozedur aufruft, KOMPLETT lesend gesperrt ist (s. Rückgabespalten „AccessRestriction“ und „ReadAccessRestrictionPattern“ von pm_GetPChAccRestrForUsers_Ad), gibt es einen Fehler !
Anmerkung zum Parameter „Value“ :
Möchte man nur eine bestimmte Eigenschaft haben, gibt man „Value“ entsprechend an - der Parameter wird natürlich nur berücksichtigt, wenn „PersonCharacteristicID“ NICHT „-1“ ist !
Für diese Funktionalität darf der Benutzer, der diese Prozedur aufruft, keinerlei lesende Beschränkung (weder komplett noch „teilweise“, s. Rückgabespalten „AccessRestriction“ und „ReadAccessRestrictionPattern“ von pm_GetPChAccRestrForUsers_Ad) auf das Merkmal „PersonCharacteristicID“ haben, sonst gibt es einen Fehler !
Anmerkungen zum Parameter „GetReferencesForTableID“ :
Wir ermitteln zu jedem vordefinierten Wert, ob und welche sogenannte „Referenz“ auf (genau) einen Datensatz einer Tabelle (s. Rückgabespalten „TableID“ und „TableKeyID“) es gibt. Es kann prinzipiell mehrere solcher Referenzen geben, aber pro Tabelle immer nur maximal eine.
Für welche Tabelle nun pro Wert ein solche mögliche Referenz ermittelt werden soll, gibt man in diesem Parameter an.
Mögliche Werte ermittelt man durch folgenden Aufruf : exec mi_GetTabsRefInOtherTabs_Ad UsedInPersonCharacValueRefs = 1„.
Wird „NULL“ in diesem Parameter angegeben, wählen wir selbst die kleinste mögliche „TableID“.
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Alias | pm_GetPersonPredefinedValues_Ad |
| Tags | |
| Engine-Kategorie | person management |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| PersonCharacteristicID | -1 | ID eines Personen-Merkmals. Wird “-1„ angegeben, ermittelt die Prozedur alle vordefinierten Merkmale zu ALLEN Merkmalen (zu denen „PredefinedValue = 1“ hinterlegt ist - siehe auch pm_GetPersonCharacteristics_Ad). „Value“ wird in diesem Fall ignoriert. | smallint | 3.5.0 |
| LanguageID | 0 | ID einer Sprache, in der Übersetzungen zu den Eigenschaften ausgegeben werden sollen (siehe Rückgabespalte „TranslatedValue“) | tinyint | 3.5.0 |
| Value | NULL | Eine Eigenschaft zum Merkmal „PersonCharacteristicID“; wird nur beachtet, falls „PersonCharacteristicID“ nicht “-1„ ist. Wenn angegeben, wird nur der Datensatz zu dieser Eigenschaft ausgegeben (oder die Rückgabemenge ist leer…). | varchar(100) | 3.5.12 |
| GetReferencesForTableID | NULL | ID einer Tabelle, in der ein Element definiert ist, auf das sich ein vordefinierter Wert bezieht - eine sogenannte „Referenz“. Bei Angabe von „NULL“, wählen wir selbst die kleinste mögliche „TableID“. s. Beschreibung ! | tinyint | 5.5.2 |
Rückgabe
(parameterunabhängig)
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| ID5) | Wird nicht mehr zurückgegeben, da seit Version 3.5.12 in „PersonCharacteristicID“ umbenannt | smallint | 3.5.0 |
| PersonCharacteristicID | ID eines Personen-Merkmals mit vordefinierten Werten („PredefinedValues = 1“). Identisch mit „PersonCharacteristicID“, falls hierfür ein Wert ungleich “-1„ angegeben wurde. Merkmale m. komplett lesend. Zugriffsbeschr. für den Aufrufer fehlen im Ergebnis. | smallint | 3.5.12 |
| CharacteristicSortNo | Bestimmt die Reihenfolge des Merkmals „PersonCharacteristicID“ innerhalb aller Merkmale | smallint | 3.5.12 |
| ValueID | ID der Eigenschaft „Value“ | integer | 3.5.0 |
| Value | Eine (vordefinierte) Eigenschaft zum Merkmal „PersonCharacteristicID“. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „ValueRestrictedByPattern“ gekennzeichnet ist. | varchar(100) | 3.5.0 |
| ValueRestrictedByPattern | Was enthält „Value“ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ? - NULL : den vollständigen Wert - “#left(<n>)#„ : nur die ERSTEN n Zeichen - “#right(<n>)#„ : nur die LETZTEN n Zeichen Anmerkung : „n = 0“ möglich, „Value“ ist dann „NULL“ | varchar(100) | 6.5.2 |
| ValueSortNo | Bestimmt die Reihenfolge der Eigenschaft „ValueID“ innerhalb aller Eigenschaften zum Merkmal „PersonCharacteristicID“ | integer | 3.5.12 |
| TranslatedValue | Übersetzung der Eigenschaft „Value“ in der durch „LanguageID“ angegebenen Sprache | varchar(100) | 3.5.12 |
| IsCurrentlyValid | Gibt an, ob die Eigenschaft aktuell verwendet werden darf („1“) oder nicht („0“). Hinweis : Es können seit Version 4.0.0 Gültigkeitszeiträume für Eigenschaften festgelegt werden (siehe pm_ModifyPeriodsForPredVals_Ad). | bit | 4.0.0 |
| TableID | ID einer Tabelle, in der ein Element (→ „TableKeyID“) definiert ist, auf das der Wert „ValueID“ referenziert. Hier steht entweder „GetReferencesForTableID“ oder (falls „NULL“) die kleinste möglich „TableID“. | tinyint | 5.1.7 |
| TableKeyID | ID eines Objektes der durch „TableID“ angegebenen Tabelle, auf das der Wert „ValueID“ referenziert. Mögliche Werte : Werte für die „PrimaryKeyColumnName“-Spalte für die Tabelle (siehe „exec mi_GetTabsRefInOtherTabs_Ad TableID = <TableID>“). | integer | 5.1.7 |
Sortierung der Rückgabe
(parameterunabängige Sortierung)
- CharacteristicSortNo (absteigend)
- ValueSortNo (absteigend)
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 6) |
|---|---|---|
| -697 | Aktion kann nicht durchgeführt werden, da für ein Merkmal eine Zugriffsbeschränkung besteht | nur direkt |
| -621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
| -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 |
| -550 | Fehlender oder falscher Eintrag in Settings | 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 | direkt und indirekt |
| -502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
| -501 | Der Parameter „TableID“ und/oder der Parameter „TableKeyID“ ist ungültig | 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.2 | 2013-02-26 | 1. Beachtung der neuen Zugriffs-Beschränkungen für Merkmale [⇒ Doku-Anpassung] 2. Interne Anpassungen wg. UTF8-Unterstützung 3. Neue Rückgabespalte „ValueRestrictedByPattern“ [wg. des neuen features „Zugriffsbeschränkung“] |
| 5.5.2 | 2008-10-21 | 1. Neuer Parameter „GetReferencesForTableID“, um das [falsche] Verhalten seit Einführung von „TableID“ und „TableKeyID“ zu ändern : Es konnte vorher nämlich MEHRERE Datensätze zu einer „ValueID“ geben ! 2. Quellcode-Anpassung an den aktuellen Standard |
| 5.1.7 | 2006-10-31 | Neue Rückgabespalten „TableID“, „TableKeyID“ |
| 5.1.2 | 2006-06-26 | 1. Umkodierung aufgrund eines Bugs in ASE 15 bzgl. Kombination von „isnull“ und „NOT“ 2. Ab jetzt gibt es “-500„ wenn eine „PersonCharacteristicID“ angegeben wurde, das keinem Merkmal mit vordefinierten Werten entspricht |
| 4.0.15 | 2004-07-30 | 1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur 3. Konsequente Fehlerbehandlung |
| 4.0.0 | 2003-04-03 | 1. Neue Rückgabespalte „IsCurrentlyValid“ 2. Fehler in der Doku behoben |
| 3.5.21 | 2002-08-06 | |
| 3.5.17 | 2002-05-02 | |
| 3.5.12 | 2001-10-17 | |
| 3.5.0 | 2000-11-23 | 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 GET 'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonPredefinedVals_Ad'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonPredefinedVals_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'), 'pm_GetPersonPredefinedVals_Ad', array( // 'PersonCharacteristicID' => -1, // 'LanguageID' => 0, // 'Value' => NULL, // 'GetReferencesForTableID' => NULL ) ); $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="pm_GetPersonPredefinedVals_Ad"> <Parameters> <!-- <Parameter Name="PersonCharacteristicID">-1</Parameter> --> <!-- <Parameter Name="LanguageID">0</Parameter> --> <!-- <Parameter Name="Value">NULL</Parameter> --> <!-- <Parameter Name="GetReferencesForTableID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>