Verwaltet die Kriterien zur Sortierung von Hauptbeiträgen eines Forums.
Hintergrund :
fo_GetMainPostings_Pu liefert Hauptbeiträge eines Forums zurück. Dabei kann man angeben, nach welcher Sortierung die Ergebnismenge gebildet werden soll.
ACHTUNG : Wenn ein Sortier-Kriterium aktiviert wird (→ „ActivateCriteria“), werden die Beiträge gemäß der (neuen) Kriterien sortiert. Dies geschieht aber aus Performance-Gründen NICHT in einer Transaktion, da dieser Vorgang in einem Forum mit sehr vielen Beiträgen sehr lange dauert und dann in der Zeit KEIN Beitrag geändert/angelegt werden könnte !
Daher wird intern das „IsActive“-Flag auf den Wert „2“ gesetzt (s. gleichnamige Rückgabespalte von fo_GetMainPostSortCriteria_Ad), um zu signalisieren, daß das Kriterium „initialisiert“ wird. Kommt es nun zu einem Fehler (z.B. „deadlock“), BLEIBT natürlich das „IsActive“-Flag im Status „2“. In einem solchen Fall muß unbedingt diese Prozedur hier erneut aufgerufen werden, und zwar mit den gleichen Werten, jedoch mit „ActivateCriteria = 0“ (um das Kriterium zu deaktivieren), da sonst kein neuer Beitrag im Forum mehr angelegt werden kann !
Grundsätzliches zu Sortier-Kriterien :
1. Ist für ein Forum mindestens ein Sortier-Kriterium definiert und aktiv, wird bei jeglicher Änderung im Forum, die Hauptbeiträge betreffen (u.U. auch Antworten, je nach Konfigurierung der Optionen des Kriteriums), die Sortierung aktualisiert.
2. Ein Sortier-Kriterium kann aus maximal 3 Einzel-Kriterien bestehen. Zwei Hauptbeiträge werden anhand des ersten Kriteriums verglichen, und nur falls der Vergleich „unentschieden“ ausfällt, wird das evtl. vorhandene zweite Kriterium herangezogen. Nur wenn auch der zweite Vergleich nicht eindeutig ist, wird (sofern konfiguriert) das dritte Kriterium beachtet.
3. Wenn der Vergleich zweier Hauptbeiträge nicht eindeutig (trotz Anwendung aller Einzel-Kriterien) ist, wird willkürlich einer der beiden Beiträge „höher priorisiert“ - es gibt keine eindeutige Regel hierfür, die Entscheidung ist mehr oder weniger „zufällig“.
4. Zur Zeit gibt es zwei Arten von Einzel-Kriterien : Entweder die Eigenschaft zu einem Merkmal (d.h. eine „PostingCharacteristicID“ - zu der übrigens „MaxNumberOfProperties = 1“ konfiguriert sein muß !) oder das Anlagedatum („PostDate“). Einzelheiten zum Vergleich (z.B. auf- oder absteigende Sortierung) müssen bei der Konfiguration durch die jeweiligen Options-Parameter („SortingOptions_…“) angegeben werden. Es handelt sich jeweils um die „Summe“ von folgenden einzelnen Optionen :
(Die Optionen „1“ und „2“ sowie „4“ und „8“ schließen sich natürlich aus, es muß aber ENTWEDER „1“ ODER „2“ bzw. „4“ ODER „8“ als Option gewählt sein !)
(Die folgenden Optionen regeln, ob bei der Ermittlung des für die Sortierung relevanten Wertes nur Beiträge beachtet werden sollen, die in einem bestimmten „Visible“-Status sind. Ist keine dieser Optionen angegeben, bedeutet dies, daß keine Filterung hinsichtlich des „Visible“-Status stattfindet !)
5. Es werden garantiert alle Hauptbeiträge des Forums bei einer Sortierung berücksichtigt. D.h. auch wenn z.B. durch die Optionen „32“ bis „256“ ein Hauptbeitrag quasi durch seinen „Visible“-Status herausfällt, bedeutet dies ja lediglich, daß der Wert zum Kriterium „NULL“ ist, und dies wird durch Option „4“ oder „8“ geregelt !
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | configurations |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ForumID | ID eines Forums, für das ein Sortier-Kriterium konfiguriert/gelöscht werden soll | smallint | 5.0.4 | |
SortingCriteriaNo | (Eindeutige) Nummer eines Sortier-Kriteriums für das Forum „ForumID“, das man konfigurieren möchte. Ist es nicht vorhanden, wird ein neues Kriterium erstellt, ansonsten entscheidet „DeleteCriteria“ darüber, ob es geändert oder gelöscht wird. | tinyint | 5.0.4 | |
SortingCriteria_1st | Entweder - eine „PostingCharacteristicID“, oder - der Wert „-1“ (steht für das „PostDate“) Die „allgemeine“ Eigenschaft (zur „PersonID = 0“) zum Merkmal bzw. das „PostDate“ wird zum Vergleich zweier Hauptbeiträge herangezogen. | smallint | 5.0.4 | |
SortingOptions_1st | Einstellungen/Optionen zum Sortier-Kriterium „SortingCriteria_1st“, u.a. ob die Sortierung auf- oder absteigend ist. Details : s. Beschreibung „Grundsätzliches zu Sortier-Kriterien“, Punkt 4 ! | smallint | 5.0.4 | |
SortingCriteria_2nd | NULL | Entweder - eine „PostingCharacteristicID“, oder - der Wert „-1“ (steht für das „PostDate“) Die „allgemeine“ Eigenschaft (zur „PersonID = 0“) zum Merkmal bzw. das „PostDate“ wird zum Vergleich zweier Hauptbeiträge herangezogen. (Darf auch „NULL“ sein) | smallint | 5.0.4 |
SortingOptions_2nd | NULL | Einstellungen/Optionen zum Sortier-Kriterium „SortingCriteria_2nd“, u.a. ob die Sortierung auf- oder absteigend ist. Details : s. Beschreibung „Grundsätzliches zu Sortier-Kriterien“, Punkt 4 ! | smallint | 5.0.4 |
SortingCriteria_3rd | NULL | Entweder - eine „PostingCharacteristicID“, oder - der Wert „-1“ (steht für das „PostDate“) Die „allgemeine“ Eigenschaft (zur „PersonID = 0“) zum Merkmal bzw. das „PostDate“ wird zum Vergleich zweier Hauptbeiträge herangezogen. (Darf auch „NULL“ sein) | smallint | 5.0.4 |
SortingOptions_3rd | NULL | Einstellungen/Optionen zum Sortier-Kriterium „SortingCriteria_3rd“, u.a. ob die Sortierung auf- oder absteigend ist. Details : s. Beschreibung „Grundsätzliches zu Sortier-Kriterien“, Punkt 4 ! | smallint | 5.0.4 |
ActivateCriteria | 0 | Wird nur beachtet, wenn „SortingCriteriaNo“ noch nicht vorhanden ist oder „DeleteCriteria = 0“ ist. Gibt an, ob das (neue) Kriterium aktiviert („1“) werden soll oder nicht („0“). | bit | 5.0.4 |
DeleteCriteria | 0 | Falls „SortingCriteriaNo“ ein bereits vorhandenes Kriterium ist, entscheidet dieser Wert darüber ob das Kritierum gelöscht („1“) wird oder nicht („0“) | bit | 5.0.4 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-856 | Fehlerhafte Daten in „MainPostingSorting“ | nur indirekt |
-855 | Fehlerhafte Konfiguration des Sortier-Kriteriums | direkt und indirekt |
-853 | Aktualisierung/Initialisierung des Sortier-Kriteriums nicht möglich (wg. eines parallelen Prozesses) | nur direkt |
-850 | Sortier-Kriterium nicht definiert oder inaktiv oder nicht verwendbar | nur indirekt |
-572 | Die Prozedur darf nur innerhalb einer Transaktion ausgeführt werden | 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 |
-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 |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
5.0.4 | 2005-09-26 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyMainPostSortCrit_Ad?ForumID=<value>&SortingCriteriaNo=<value>&SortingCriteria_1st=<value>&SortingOptions_1st=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyMainPostSortCrit_Ad?ForumID=<value>&SortingCriteriaNo=<value>&SortingCriteria_1st=<value>&SortingOptions_1st=<value>' | xmllint --format -
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_ModifyMainPostSortCrit_Ad', array( 'ForumID' => <value>, 'SortingCriteriaNo' => <value>, 'SortingCriteria_1st' => <value>, 'SortingOptions_1st' => <value>, // 'SortingCriteria_2nd' => NULL, // 'SortingOptions_2nd' => NULL, // 'SortingCriteria_3rd' => NULL, // 'SortingOptions_3rd' => NULL, // 'ActivateCriteria' => 0, // 'DeleteCriteria' => 0 ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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_ModifyMainPostSortCrit_Ad"> <Parameters> <Parameter Name="ForumID"><!-- smallint value --></Parameter> <Parameter Name="SortingCriteriaNo"><!-- tinyint value --></Parameter> <Parameter Name="SortingCriteria_1st"><!-- smallint value --></Parameter> <Parameter Name="SortingOptions_1st"><!-- smallint value --></Parameter> <!-- <Parameter Name="SortingCriteria_2nd">NULL</Parameter> --> <!-- <Parameter Name="SortingOptions_2nd">NULL</Parameter> --> <!-- <Parameter Name="SortingCriteria_3rd">NULL</Parameter> --> <!-- <Parameter Name="SortingOptions_3rd">NULL</Parameter> --> <!-- <Parameter Name="ActivateCriteria">0</Parameter> --> <!-- <Parameter Name="DeleteCriteria">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>