Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getpostingproperties_pu

fo_GetPostingProperties_Pu

Mit dieser Prozedur können Eigenschaften von Forum-Beiträgen („Postings“) ausgelesen werden.

Selbstverständlich ist hierzu mindestens lesendes Recht für das zugehörige Forum erforderlich. Schlägt die Identifizierung fehl oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, werden die Rechte der anonymen Person („PersonID = 0“) herangezogen.

Grundsätzliches zu Posting-Eigenschaften :
1. Eigenschaften eines Beitrags sind immer an eine „PersonID“ gebunden. Dies bedeutet, daß eine Eigenschaft entweder „allgemein“ gültigt ist - nämlich wenn „PersonID = 0“ ist - oder die Eigenschaft hat nur Gültigkeit für die durch „PersonID“ angegebene Person. Pro Merkmal ist durch das sogenannte „CommonCharacteristic“-Flag (s. Rückgabemenge) konfiguriert, ob

  • nur
  • auch
  • keine

allgemeine(n) Eigenschaften hinterlegt werden können.
2. Genau wie im „Item-“ und „Person-Management“ gehören Eigenschaften immer zu einem Merkmal - Merkmale charakterisieren sozusagen die Eigenschaften.
Wenn für das zugehörige Forum eines Beitrags mindestens ein Merkmal zugeordnet ist (→ fo_ModifyCharacsForForums_Ad), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die dem Forum zugeordnet sind.
3. Sind dem Forum eines Beitrags direkt KEINE Merkmale zugeordnet (→ fo_ModifyCharacsForForums_Ad), können diesem Beitrag ausschließlich Eigenschaften zu Merkmalen hinzugefügt werden, die wenigestens einer Kategorie, in die das Forum DIREKT eingeordnet ist, zugeordnet sind (→ fo_ModifyCharacForForumCats_Ad).

Anmerkungen zum Parameter „PersonID“ :
1. Standardmäßig ist der Parameter „PersonID“ mit „NULL“ belegt, was dazu führt, daß die Prozedur Eigenschaften zur identifizierten Person ermittelt.
2. Man kann hier aber auch „0“ angeben, dann bekommt man die sogenannten allgemeinen Eigenschaften (zur „PersonID = 0“).
3. Natürlich kann man auch die „PersonID“ der identifizierten Person angeben, wenn diese schon bekannt ist (es gibt also keinen Fehler, ist aber auch nicht hilfreicher).

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PersonIdentificationValues Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.
varchar(255)4.0.16
PersonTypeID ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.
tinyint4.0.16
UniqueID Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zur „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ „NULL“ sein.
varchar(50)4.0.16
PostingID ID eines Postings, zu dem man Eigenschaften auslesen möchte. Bei „NULL“ werden „PostingID“s in „tempdb.dbo.OneID“ erwartet. „PostingID“s, die nicht zum gleichen Forum wie das der kleinsten „PostingID“ gehören, werden ignoriert, es gibt also keinen Fehler.
integer4.0.16
PersonIDNULL Eigenschaften sind immer an eine „PersonID“ gebunden, hierdurch wird angegeben, zu welcher „PersonID“ die Eigenschaften herangezogen werden sollen. Weitere Erläuterungen : s. Beschreibung
integer4.0.16
CharacteristicIDListNULL Liste von (durch „¶“ getrennte) „PostingCharacteristicID“s. Falls „NULL“, werden alle Eigenschaften ermittelt, sonst nur die zu den Merkmalen, deren ID in dieser List vorkommt - es gibt keinen Fehler, wenn „falsche“ IDs angegeben werden.
varchar(250)4.0.16
DateFormat'german' Bestimmt das Format der Ausgabe von Datums-Eigenschaften. Falls „german“ oder „germany“ (Groß- und Kleinschreibung wird nicht beachtet) übergeben wird, sind Datums-Eigenschaften im Format „Tag-Monat-Jahr“, sonst „Monat-Tag-Jahr“.
varchar(10)4.0.16
GetAdditionalInfosForCharac0 „1“ angeben, um in der Ergebnismenge zusätzliche Informationen/Einstellungen zum jeweiligen Merkmal der Eigenschaften zu erhalten (s. Rückgabemenge)
bit4.0.16
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichen die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

wenn GetAdditionalInfosForCharac = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PostingIDID eines Postings, das die Eigenschaft „Value“ besitzt. Hierbei handelt es sich entweder um „PostingID“ oder um eine ID, die via „tempdb.dbo.OneID“ übergeben wurde
integer4.0.16
CharacteristicIDID des Posting-Merkmals, auf das sich die Eigenschaft „Value“ bezieht
smallint4.0.16
ValueDie Eigenschaft des Beitrags „PostingID“ zum Merkmal „CharacteristicID“
varchar(250)4.0.16
ValueIDID der Eigenschaft „Value“
integer4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PostingID (aufsteigend)
  • CharacteristicID (aufsteigend)
  • Value (aufsteigend)

wenn GetAdditionalInfosForCharac = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
PostingIDID eines Postings, das die Eigenschaft „Value“ besitzt. Hierbei handelt es sich entweder um „PostingID“ oder um eine ID, die via „tempdb.dbo.OneID“ übergeben wurde
integer4.0.16
CharacteristicIDID des Posting-Merkmals, auf das sich die Eigenschaft „Value“ bezieht
smallint4.0.16
ValueDie Eigenschaft des Beitrags „PostingID“ zum Merkmal „CharacteristicID“
varchar(250)4.0.16
ValueIDID der Eigenschaft „Value“
integer4.0.16
CharacteristicDescriptionBezeichnung des Merkmals „CharacteristicID“
varchar(100)4.0.16
PropertyModificationAllowedGibt an, ob Eigenschaften zum Merkmal nachträglich geändert werden können. Es ist eine Summe folgender Werte :
„0“ : Hinzufügen, Ändern oder Löschen ist NICHT möglich
„1“ : Hinzufügen ist möglich
„2“ : Ändern ist möglich
„4“ : Löschen ist möglich
tinyint4.0.16
CommonCharacteristicGibt an, zu welchen „PersonID“s Eigenschaften zum Merkmal hinterlegt werden können :
„0“ : Nur „PersonID“s ungleich „0“
„1“ : „PersonID“ kann beliebig sein
„2“ : Nur „PersonID = 0“
tinyint4.0.16
PredefinedValuesSind mögliche Eigenschaften für Postings zum Merkmal „CharacteristicID“ vordefiniert („1“) oder nicht („0“)
bit4.0.16
CheckPostingVisibility„1“ bedeutet, daß das LESEN von Eigenschaften zum Merkmal (über diese Prozedur) nur erlaubt ist, wenn die identifizierte Person auch den Beitrag lesen darf - was ja vom „Visible“-Status des jeweiligen Beitrags abhängt
bit4.0.16
MaxNumberOfPropertiesGibt an, wieviele Eigenschaften zum Merkmal ein Beitrag (bei gleicher „PersonID“) maximal haben darf :
- „NULL“ : Keine Einschränkung
- „0“ : Dieser Wert ist nicht erlaubt
- „1“ : Maximal 1 Eigenschaft
- „2“ : Maximal 2 Eigenschaften
usw.
tinyint4.0.16
FieldTypeIDID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „PostingCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)
tinyint4.0.16
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PostingID (aufsteigend)
  • CharacteristicID (aufsteigend)
  • Value (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-875Keine Berechtigung zum Ändern/Lesen von Posting-Eigenschaften einer anderen Personnur direkt
-801Kein lesender Zugriff auf das Forumnur direkt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur 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
-550Fehlender oder falscher Eintrag in Settingsnur 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 Parameterdirekt 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„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.0 2012-09-17Holger Wies : Wird in „UniqueID“ die „DefaultUniqueID“ angegeben, wird nun [ohne Aufruf von
pm_CheckPersonIdentity_Pu] der Aufrufer als „anonyme Person“ [„PersonID = 0“] identifiziert
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Ausgabe via „print“ im Fehler-Fall „-500“ (mit Informationen über die Ursache)
3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
4. Fehlende Fehlerbehandlung in einem Fall
5.1.0 2006-02-08Ab jetzt wird explizit auf „lesendes Recht“ [„AccessLevelID = 1“] geprüft
5.0.3 2005-06-07Fehler falls für ein Merkmal „CheckPostingVisibility = 1“ konfiguriert war und die Eigenschaft zu einem bestimmten Beitrag (→ „PostingID“ gesetzt) ermittelt werden sollte
4.0.16 2004-08-31Erstmalig 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/fo_GetPostingProperties_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingProperties_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<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'),
	'fo_GetPostingProperties_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'PostingID' => <value>,
			// 'PersonID' => NULL,
			// 'CharacteristicIDList' => NULL,
			// 'DateFormat' => 'german',
			// 'GetAdditionalInfosForCharac' => 0,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$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="fo_GetPostingProperties_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PostingID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="CharacteristicIDList">NULL</Parameter> -->
				<!-- <Parameter Name="DateFormat">'german'</Parameter> -->
				<!-- <Parameter Name="GetAdditionalInfosForCharac">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
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/fo_getpostingproperties_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)