PAScorecard – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer

    • Die PAScorecard Mit der API können Sie Daten zu Indikatoren und ihren zugehörigen Datensätzen abrufen, z. B. Aufgliederungen.

    Diese API erfordert Performance Analytics(Com.snc.PA.Analytics_Center) und wird in ausgeführt SNC Namespace.

    PAScorecard – addParam(String parameter, String value)

    Fügt einen Abfrageparameter hinzu, um die zurückgegebenen Punktzahlen zu filtern.

    Rufen Sie diese Methode mehrere Male auf demselben PAScorecard-Objekt auf, um mehrere Parameter zu übergeben, z. B. den Indikator sys_id und eine Aufgliederung sys_id. Rufen Sie nach Angabe aller Parameter query() auf, um die Abfrage auszuführen.

    Wenn Sie ein PAScorecard-Objekt ohne Parameter abfragen, gibt die API eine Liste aller Indikatoren zurück, die im Analytics Hub angezeigt werden, zusammen mit ihren Punktzahlen.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    breakdown Zeichenfolge SYS_ID einer Aufgliederung, um Diagramminformationen zurückzugeben, die wie von der Aufgliederung definiert organisiert sind. Zum Beispiel die sys_ID einer Prioritätsaufgliederung, um separate Aufgabendiagramminformationen für jeden Prioritätswert zurückzugeben, z. B. Anzahl der offenen Incidents/Priorität/2 – hoch.
    breakdown_relation Zeichenfolge Geben Sie die sys_id einer Aufgliederungsbeziehung an, um die zurückgegebenen Daten unter Verwendung dieser Beziehung aufzuschlüsseln. Sie können verfügbare Aufgliederungsbeziehungen anzeigen, indem Sie den Parameter include_available_breakdowns auf true setzen.
    enthält Zeichenfolge Kommagetrennte Liste von Namen oder Beschreibungen, um nur Ergebnisse von Indikatoren mit einem übereinstimmenden Wert zurückzugeben. Alle durch Kommas getrennten Listenelemente müssen übereinstimmen, oder es werden keine Ergebnisse zurückgegeben: Die Liste folgt UND Logik, nicht ODER Logik.
    Anzeigen Zeichenfolge Kennzeichnung, die den Typ der zurückzugebenden Indikatoren angibt.
    Gültige Werte:
    • Wahr: Gibt nur Indikatoren zurück, die im angezeigt werden Analytics Hub .
    • Alle: Gibt alle Indikatoren zurück.

    Standardwert: wahr
    display_value Zeichenfolge Datenabrufoperation für Referenz- und Auswahlfelder
    Basierend auf diesem Wert wird der Anzeigewert und/oder der tatsächliche Wert in der Datenbank abgerufen.
    • True gibt die Anzeigewerte für alle Felder zurück.
    • false gibt die tatsächlichen Werte aus der Datenbank zurück.
    • all gibt sowohl die tatsächlichen als auch die Anzeigewerte zurück.

    Standardwert: false
    elements_filter Zeichenfolge Geben Sie die sys_id eines Elementfilters an, um diesen Filter auf die zurückgegebenen Daten anzuwenden.

    Datentyp: Zeichenfolge
    exclude_reference_link Boolean Kennzeichnung, die angibt, ob zusätzliche Informationen für Referenzfelder ausgeblendet werden sollen, z. B. der URI zur Referenzressource.
    Gültige Werte:
    • Wahr: Blenden Sie zusätzliche Informationen für Referenzfelder aus.
    • Falsch: Blenden Sie zusätzliche Informationen für Referenzfelder nicht aus.

    Standardwert: false
    favorites Boolean Kennzeichnung, die angibt, ob nur Indikatoren zurückgegeben werden sollen, die Favoriten des abfragenden Anwenders sind.
    Gültige Werte:
    • Wahr: Gibt nur Indikatoren zurück, die Favoriten des abfragenden Anwenders sind.
    • Falsch: Gibt alle Indikatoren zurück.

    Standardwert: false
    von Zeichenfolge Frühestes Datum, ab dem Punktzahlen zurückgegeben werden sollen. Nur Ergebnisse von diesem Datum oder später werden zurückgegeben.

    Für diesen Parameter muss include_scores auf true festgelegt werden.

    Format: ISO-8601-Standard
    include_available_aggregates Zeichenfolge Kennzeichnung, die angibt, ob alle verfügbaren Aggregate für einen Indikator zurückgegeben werden sollen, wenn kein Aggregat angewendet wurde.
    Gültige Werte:
    • Wahr: Gibt alle verfügbaren Aggregate für einen Indikator zurück, wenn kein Aggregat angewendet wurde.
    • Falsch: Keine Aggregate zurückgeben.

    Standardwert: false
    include_available_breakdowns Boolean Kennzeichnung, die angibt, ob alle verfügbaren Aufgliederungen für einen Indikator zurückgegeben werden sollen.
    Gültige Werte:
    • Wahr: Gibt alle verfügbaren Aufgliederungen für einen Indikator zurück.
    • Falsch: Keine Aufgliederungen zurückgeben.

    Standardwert: false
    include_forecast_scores Boolean Kennzeichnung, die angibt, ob das Element „Forecast_Scores“ zurückgegeben werden soll, das ein Array von Datums-Wert-Paaren enthält, die die Prognosedaten für definieren Analytics Hub .

    Für diesen Parameter muss include_scores auf true festgelegt werden.

    Gültige Werte:
    • Wahr: Element „forecast_Scores“ zurückgeben.
    • Falsch: Geben Sie das Element „forecast_Scores“ nicht zurück.

    Standardwert: false
    include_realtime Boolean Kennzeichnung, die angibt, ob das Element „Realtime_enabled“ zurückgegeben werden soll, das angibt, ob Echtzeitpunktzahlen für den Indikator aktiviert sind, und das Element „Realtime_value“, das den Echtzeitpunktzahlwert enthält. Dieser Parameter wird für Formelindikatoren nicht unterstützt.
    Gültige Werte:
    • Wahr: Gibt das Element „Realtime_enabled“ zurück.
    • Falsch: Geben Sie das Element „Realtime_enabled“ nicht zurück.

    Standardwert: false
    include_scores Boolean Kennzeichnung, die angibt, ob Indikatorpunktzahlen für den gesamten in ausgewählten Zeitbereich zurückgegeben werden sollen Analytics Hub . Wenn kein Wert angegeben wird, wird dieser Parameter standardmäßig auf „false“ gesetzt und gibt nur den letzten Punktzahlen-Wert zurück.

    Um den Datumsbereich der zurückgegebenen Punktzahlen einzuschränken, kombinieren Sie diesen Parameter mit from und to.

    Gültige Werte:
    • Wahr: Gibt Indikatorpunktzahlen für den gesamten ausgewählten Zeitbereich zurück.
    • Falsch: Geben Sie keine Indikatorpunktzahlen für den gesamten ausgewählten Zeitbereich zurück.

    Standardwert: false
    include_target_color_scheme Boolean Kennzeichnung, die angibt, ob das Element target_color_scheme zurückgegeben werden soll, das die Mindest- und Höchstwerte sowie die Farbe jedes Abschnitts des Zielfarbschemas für enthält Analytics Hub .
    Gültige Werte:
    • Wahr: Gibt das Element target_color_scheme zurück.
    • Falsch: Geben Sie das Element target_color_scheme nicht zurück.

    Standardwert: false
    include_trendline_scores Zeichenfolge Kennzeichnung, die angibt, ob das Element „trendline_Scores“ zurückgegeben werden soll, das ein Array von Datum-Wert-Paaren enthält, die definieren Analytics Hub trendline.

    Für diesen Parameter muss include_scores auf true festgelegt werden.
    key Boolean Kennzeichnung, die angibt, ob Ergebnisse nur für Schlüsselindikatoren zurückgegeben werden sollen.
    Gültige Werte:
    • Wahr: Gibt das Element „trendline_Scores“ zurück.
    • Falsch: Geben Sie das Element „trendline_Scores“ nicht zurück.

    Standardwert: false
    limit Anzahl Maximale Anzahl der zurückzugebenden Punktzahlen.
    Seite Zeichenfolge Geben Sie die Seitenzahl an. Beispiel: Wenn 20 Indikatoren in abgefragt werden Analytics Hub Geben Sie mit dem Standardwert per_page (10) einen Seitenwert von 2 an, um abzurufen Analytics Hub Für 11–20.
    per_page Anzahl Maximale Anzahl von Indikatoren, die jede Abfrage auf einer Seite zurückgeben kann.

    Standard: 10

    Maximum: 100
    sortby Zeichenfolge Wert, der beim Sortieren von Ergebnissen verwendet werden soll.
    Gültige Werte:
    • Aufzählungszeichen
    • Change
    • Change-Perc
    • Datum
    • Standard
    • direction
    • Duedate
    • Häufigkeit
    • Lücke
    • Gapperc
    • Gruppe
    • indicator_group
    • name
    • Bestellen
    • Ziel
    • Trend
    • Wert

    Standard: Wert
    sortdir Zeichenfolge Sortierrichtung.
    Gültige Werte:
    • asc: Bezeichnet aufsteigend
    • Des: Gibt absteigend an

    Standard: Absteigend
    step Anzahl Numerischer Wert zum Überspringen von Punktzahlen basierend auf der Indikatorhäufigkeit. Geben Sie beispielsweise den Wert 3 an, um nur die Bewertungen von jedem dritten Tag für einen täglichen Indikator oder von jeder dritten Woche für einen wöchentlichen Indikator zurückzugeben.
    tags Zeichenfolge Geben Sie die sys_id einer Indikatorgruppe ein, um die Indikatoren in dieser Gruppe zurückzugeben. Verwenden mit diesem Parameter Sie nicht uuid.
    Ziel Boolean Kennzeichnung, die angibt, ob Ergebnisse nur für Indikatoren zurückgegeben werden sollen, für die ein Ziel auf festgelegt ist Analytics Hub .
    Gültige Werte:
    • Wahr: Gibt nur Ergebnisse für Indikatoren zurück, für die ein Ziel festgelegt ist.
    • Falsch: Gibt Ergebnisse für alle anwendbaren Indikatoren zurück.

    Standardwert: false
    bis Zeichenfolge Spätestes Datum, ab dem Punktzahlen zurückgegeben werden sollen. Nur Ergebnisse von diesem Datum oder früher werden zurückgegeben.

    Für diesen Parameter muss include_scores auf true festgelegt werden.
    uuid Zeichenfolge Geben Sie eine durch Doppelpunkte getrennte Liste von sys_id-Werten ein, um anzugeben, welche Indikatoren, Aufgliederungen, Zusammenfassungen und Domänen abgefragt werden sollen. Der Parameter folgt diesem Format:

    <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id oder element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id oder element_sys_ids>:<aggregate_sys_id>;<domain_sys_id>

    Der Parameter muss mit der sys_id eines Indikatordatensatzes beginnen. Optional können Sie die sys_id-Werte einer Aufgliederung und eines Aufgliederungselements anhängen, um die auf der Aufgliederung basierende Antwort zu gruppieren, und die sys_id einer Zusammenfassung, um diese Zusammenfassung anzuwenden. Sie können eine Aufgliederung mit einer Zusammenfassung verwenden oder nur je eines davon.

    Informationen zum Abrufen der sys_id-Werte von Datensätzen finden Sie unter Eindeutiger Datensatz-Identifier (sys_id).

    Hinweis:
    Wenn ein Indikator so konfiguriert ist, dass er eine Standardzeitreihe verwendet, verwenden alle Analytics Hub-Werte für diesen Indikator die ausgewählte Zeitreihenaggregation.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    In diesem Beispiel gibt der Parameter „uuid“ den Indikator „Number of open incidents“ an, und der Parameter „breakdown“ gibt die Aufgliederung nach Priorität an. Beide Parameter haben die sys_id der jeweiligen Datensätze als Wert. Die query()-Funktion gibt die Ergebnisse als Objekt zurück.

    var sc = new SNC.PAScorecard(); //in a scoped app, do not use the SNC namespace
sc.addParam('uuid', 'fb007202d7130100b96d45a3ce6103b4');       // Number of open incidents
sc.addParam('breakdown', '0df47e02d7130100b96d45a3ce610399');  // by Priority
var result = sc.query();  // Query results, which are returned as an object
for (var i = 0; i < result.length; i++)
gs.info(result[i].name + ': ' + result[i].value + ' ' + result[i].unit.display_value);

    PAScorecard – query()

    Führt eine Abfrage basierend auf den angegebenen Parametern durch und gibt die Ergebnisse als Objekt zurück.

    Bevor Sie diese Methode aufrufen, konfigurieren Sie die Parameter für das PAScorecard-Objekt, indem Sie addParamaddParam(String parameter, String value) aufrufen.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt Das PAScorecard-Objekt.

    PAScorecard – result()

    Ruft das letzte Abfrageergebnis als Objekt ab.

    Diese Methode führt keine Abfrage durch. Um eine Abfrage durchzuführen, bevor das Ergebnis zurückgegeben wird, verwenden Sie quer().

    Diese Funktion kann nicht in einem anderen Bereich als global ausgeführt werden.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt Die Ergebnisse der letzten Abfrage, als JS-Objekt zurückgegeben.