PAScorecard : Bereichsbezogen

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

Diese API erfordert die Anwendung Performance Analytics (com.snc.pa.analytics_center) und wird im SNC -Namespace ausgeführt.

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 zur Ausgabe von Diagramminformationen, die gemäß der Definition in der Aufgliederung organisiert sind. 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 Ergebnisse nur für 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 der UND-Logik, nicht der ODER-Logik.
Anzeigen	Zeichenfolge	Kennzeichnung, die den Typ der zurückzugebenden Indikatoren angibt. Gültige Werte: „wahr“: Gibt nur Indikatoren zurück, die im Analytics Hub angezeigt werden. all: 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 für die Referenzressource. Gültige Werte: „wahr“: Zusätzliche Informationen für Referenzfelder ausblenden. „falsch“: Zusätzliche Informationen für Referenzfelder nicht ausblenden. 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“: Gibt keine Aggregate zurück. 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“: Gibt keine Aufgliederungen zurück. Standardwert: false
include_forecast_scores	Boolean	Kennzeichnung, die angibt, ob das Element „prognose_scores“ zurückgegeben werden soll, das ein Array von Datums-Wert-Paaren enthält, die die Prognosedaten für Analytics Hub definieren. Für diesen Parameter muss include_scores auf true festgelegt werden. Gültige Werte: „wahr“: Gibt das Element „prognose_scores“ zurück. „falsch“: Element „prognose_scores“ nicht zurückgeben. Standardwert: false
include_realtime	Boolean	Kennzeichnung, die angibt, ob das Element „realtime_enabled“ zurückgegeben werden soll, das angibt, ob Echtzeit-Punktzahlen für den Indikator aktiviert sind, oder das Element „realtime_value“, das den Echtzeit-Punktzahlwert enthält. Dieser Parameter wird für Formelindikatoren nicht unterstützt. Gültige Werte: „wahr“: Gibt das Element „realtime_enabled“ zurück. „falsch“: Das Element „realtime_enabled“ wird nicht zurückgegeben. Standardwert: false
include_scores	Boolean	Kennzeichnung, die angibt, ob Indikatorpunktzahlen für den gesamten unter Analytics Hub ausgewählten Zeitraum zurückgegeben werden sollen. 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 Zeitraum zurück. „falsch“: Indikatorpunktzahlen für den gesamten ausgewählten Zeitraum nicht zurückgeben. Standardwert: false
include_target_color_scheme	Boolean	Kennzeichnung, die angibt, ob das Element „target_color_scheme“ zurückgegeben werden soll, das den Mindest- und Höchstwert und die Farbe jedes Abschnitts des Zielfarbschemas für Analytics Hub enthält. Gültige Werte: „wahr“: Gibt das Element „target_color_scheme“ zurück. „falsch“: Element „target_color_scheme“ nicht zurückgeben. Standardwert: false
include_trendline_scores	Zeichenfolge	Kennzeichnung, die angibt, ob das Element „trendline_scores“ zurückgegeben werden soll, das ein Array von Datums-Wert-Paaren enthält, die die Trendlinie Analytics Hub definieren. 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“: Element „trendline_scores“ nicht zurückgeben. Standardwert: false
limit	Nummer	Maximale Anzahl der zurückzugebenden Punktzahlen.
Seite	Zeichenfolge	Geben Sie die Seitenzahl an. Wenn Sie beispielsweise 20 Indikatoren in Analytics Hub mit dem Standardwert für „per_page“ (10) abfragen, geben Sie einen Seitenwert von 2 an, um Analytics Hub für 11 bis 20 abzurufen.
per_page	Nummer	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ählung Change changeperc Datum Standard direction Fälligkeitsdatum Häufigkeit Lücke Gapperc Gruppe indicator_group name Bestellen Ziel Trend Wert Standard: Wert
sortdir	Zeichenfolge	Sortierrichtung. Gültige Werte: asc: Steht aufsteigend des: Bezeichnet absteigend Standard: Absteigend
step	Nummer	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 Analytics Hub festgelegt ist. Gültige Werte: true: Es werden nur Ergebnisse für Indikatoren zurückgegeben, für die ein Ziel festgelegt ist. „falsch“: Gibt Ergebnisse für alle zutreffenden 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.