Logo.CortexAG

Anmelden +

Portal Listen-Funktionen

Die Listen- oder Pivot-Ausgabe einer Portal-Konfiguration liefert die selektierten Datensätze mit den Feldern zurück, die in der Liste konfiguriert wurden. Generell kann die allgemeine Konfiguration übernommen werden, so dass die Ergebnisse in der konfigurierten Liste oder Pivot-Tabelle zurückgegeben werden. Optional kann auch der Name einer beliebigen Pivot-Konfiguration und das Rückgabe-Format angegeben werden.

Das Anfrage- und Rückgabeobjekt aller Portal Liste-Funktionen ähnelt sich erheblich, so dass die folgenden drei Funktionen insgesamt erläutert werden:

 

Hinweis: Alle in der Liste konfigurierten JavaScripte (siehe JavaScript in Listen / Funktionen) werden auch bei der Nutzung über die API zuvor ausgeführt. Jegliche Berechnung für die Liste können Sie daher sehr einfach innerhalb der Datenbank ablegen und die Ergebnisse verarbeiten.

 

getPortalRowData

Ermittelt zu einer Portalzeile die Fundstellen und gibt die Listendaten oder Pivotdaten aus. Die Funktion gibt dabei automatisch entweder die Listendaten oder Pivotdaten zurück, entsprechend der Definition der Portalzeile.

 

getPortalRowDataList

Ermittelt zu einer Portalzeile die Fundstellen und gibt die Listendaten aus. Die Funktion gibt immer die Listendaten zurück, unabhängig davon, ob in der Portalzeile eine Pivottabelle definiert ist.

 

getPortalRowDataPivot

Ermittelt zu einer Portalzeile die Fundstellen, Listendaten und Pivottabelle. Die Funktion gibt dabei immer eine Pivottabelle zurück, unabhängig davon, ob in der Portalzeile eine Pivottabelle definiert ist.

 

Anfrageobjekt

{
  "method": string MethodName,
  "requestid": int RequestId,
  "param": {
    "UpdJsrHdl": string Login-Handle,
 
    //Angabe Portal über ID
    "portaliid": string PortalId,
//ODER über name "portal": string PortalName   //Portalzeile Variante 1 //Abruf der Zeile über die Nummer "rownr": string RowNr,   //Portalzeile Variante 2 //Abruf der Zeile über Gruppenname und Zeilenname "group": string GroupName, "row": string RowName,   //if getPortalRowDataPivot -> Name of pivot "pivot": string PivotName,     // --> optional parameter   //Optionales Rückgabeformat der Pivot "pivotformat": "d3",   } }
  • UpdJsrHdl - Gültiges UpdJsrHdl
  • portaliid - Die interene Cortex-ID der betreffenden Portdefinition
  • portal - Name der Portdefinition
  • Variante 1 Portalzeile
    • rownr - Zeilennummern (als String)
  • Variante 2 Portalzeile
    • group - Name der Gruppe
    • row - Name der Zeile
  • pivot - optional, wenn getPortalRowDataPivot → Name der Pivottabelle
  • pivotformat - optional, Angabe des Rückgabeformats der Pivottabelle, sofern in der Portalzeilendefinition eine Pivottabelle hinterlegt ist (d3, pivot oder list)

Rückgabeobjekt

{
    "rc": int RetCode,
    "error": string ShortErrorDesc,
    "data": {
      "t": "list",
      "c": {
      //******
      //Objekt mit Konfigurationsangaben
      //******
      },
      "d": [
 
      //******
      //Array mit den Datensätzen
      //******
 
      ],
      "i": {
        "countget": 606, //Anzahl abgerufener Datensätze
        "counttotal": 606, //Anzahl Datensätze gesamt
        "nextpos": 606,
        "startpos": 0,
        "timefilter": 0, //Benötigte Zeit um Sublistenfilter zu initialisieren
        "timeget": 0.61, //Benötigte Gesamtzeit zum Abruf der Listendaten
        "list": "Projekt", //verwendete Liste
        "list_iid": "2066b15bf520202020212022", //ID der verwendeten Liste
 
        //falls Portalzeile zunächst über eine Expansionsliste aufgelöst wird, folgen Infos zur Expansion
        "expand_countget": 497,
        "expand_counttotal": 497,
        "expand_timeget": 0.9, //Benötigte Gesamtzeit zur Ausführung der Expansion
        "expand_timefilter": 0,
        "expand_list": "Firma -> Projekte",
        "expand_list_iid": "20696c417b20202020212027",
 
        //falls eine Pivottabelle zurückgegeben wird
        "pivot": "Komplettmatrix", //Name der Pivottabelle
        "pivot_format": "d3", //Ausgabeformat der Pivottabelle
        "timepivot": 0.0695 //Gesamtzeit zur Berechnung der Pivot aus den Listendaten
      },
      "v": {
        "dSummeProjektwerte": 3299922.59,
        "lCountLowBudgetProjects": 164,
        "zgb_sGlobalRelDate": "20131001"
      },
      "rvi": "20131001"
    }
}

 

data:
  • t - Typ der Daten. 'list' = Liste, 'pivot' = Pivottabelle
  • c - Ein Objekt, welches Konfigurationsangaben zu den Listendaten oder Pivotdaten enthät.
  • d - Ein Array, welches die einzelnen Datensätze enthät.
  • i - Infoobjekt mit informellen Angaben. Ein Großteil der Angaben sind optional, d.h. nicht zwangsläufig vorhanden.
  • v - Optionales Objekt, in dem die durch das Spalten-Script global gesetzten Variablen zurückgegeben werden.
  • rvi - Optional Wenn die Liste mind. eine Spalte hat, die Verlaufsinformationen relativ zu einem globalen Bezugsdatum abruft, dann wird das Bezugsdatum im rvi zurückgegeben. I.d.R. das Datum von heute oder das in der Portalzeilendefinition gesetzte Bezugsdatum.

 

Hinweis:

Die Funktionen arbeiten standardmäßig mit einem Caching-Mechanismus. Dieser Cache ist innerhalb einer eingeloggten Sitzung gültig und wird beim Logout/ Login automatisch gelöscht. Dieser Cache bewirkt, dass Fundstellen zu einer Portalzeile und/ oder Listendaten zu einer Portalzeile nicht erneut aus der Datenbank abgefragt werden müssen sondern aus dem Puffer geladen werden. Sollen zu einer Portalzeile verschiedene Pivottabellen ermittelt werden, so ist es daher nicht notwendig die Daten erneut aus der Datenbank abzufragen. Es wird lediglich die Pivottabelle berechnet. Diese Vorgehensweise kann z.B. in Dashboards o.ä. enorme Performanceverbesserungen bewirken.

Es ist zu beachten, dass Änderungen an Konfigurationen und/ oder Datensätzen im Puffer keine Berücksichtigung finden. Der Cache kann daher über die entsprechende clearCache-Funktion geleert werden.

 

 Hinweise zur Online-Hilfe
 

© 2017 Cortex AG
(letzte Aktualisierung: 12.04.2017)

 Haftungsausschluss 

Impressum    AGB