PAScorecard – Umfang

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 6 Minuten Lesedauer

    • Die PAScorecard Mit der API können Sie Daten zu Indikatoren und den 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(Zeichenfolgenparameter, Zeichenfolgenwert)

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

    Rufen Sie diese Methode mehrmals im selben PAScorecard-Objekt auf, um mehrere Parameter zu übergeben, z. B. die sys_ID des Indikators und eine sys_ID der Aufgliederung Nachdem Sie alle Parameter angegeben haben, rufen Sie auf Abfrage() Zum Ausführen der Abfrage.

    Wenn Sie ein PAScorecard-Objekt ohne Parameter abfragen, gibt die API eine Liste aller Indikatoren zurück, die auf angezeigt werden Analytics Hub, 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. Beispiel: Die sys_ID einer Prioritätsaufgliederung, um separate Aufgabendiagramminformationen für jeden Prioritätswert zurückzugeben, z. B. die Anzahl der offenen Incidents/Priorität/2 – hoch.
    Aufgliederung_Beziehung Zeichenfolge Geben Sie die sys_ID einer Aufgliederungsbeziehung an, um die zurückgegebenen Daten anhand dieser Beziehung aufzugliedern. Sie können verfügbare Aufgliederungsbeziehungen anzeigen, indem Sie festlegen include_available_breakdownsParameter bis Wahr .
    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 auf angezeigt werden Analytics Hub .
    • Alle: Gibt alle Indikatoren zurück.

    Standard: Wahr
    Display_value Zeichenfolge Datenabrufvorgang für Referenz- und Auswahlfelder.
    Basierend auf diesem Wert werden der Anzeigewert und/oder der ist-Wert in der Datenbank abgerufen.
    • Wahr Gibt Anzeigewerte für alle Felder zurück.
    • Falsch Gibt ist-Werte aus der Datenbank zurück.
    • Alle Gibt sowohl ist-Werte als auch Anzeigewerte zurück.

    Standard: Falsch
    Elements_Filter Zeichenfolge Geben Sie die sys_ID eines Elementfilters an, um diesen Filter auf die zurückgegebenen Daten anzuwenden.

    Datentyp: Zeichenfolge
    Ausschließen_Referenz_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.

    Standard: Falsch
    Favoriten 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.

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

    Dieser Parameter erfordert das include_scoresIst auf festgelegt Wahr .

    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.

    Standard: Falsch
    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.

    Standard: Falsch
    Include_Forecast_Punktzahlen Boolean Kennzeichnung, die angibt, ob das Element „Prognose_Punktzahlen“ zurückgegeben werden soll, das ein Array von Datum-Wert-Paaren enthält, die die Prognosedaten für definieren Analytics Hub .

    Dieser Parameter erfordert das include_scoresIst auf festgelegt Wahr .

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

    Standard: Falsch
    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.

    Standard: Falsch
    Include_Punktzahlen Boolean Kennzeichnung, die angibt, ob Indikatorpunktzahlen für den gesamten in ausgewählten Zeitbereich zurückgegeben werden sollen Analytics Hub . Wenn kein Wert angegeben ist, wird dieser Parameter standardmäßig auf „falsch“ gesetzt und gibt nur den neuesten Punktzahlwert zurück.

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

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

    Standard: Falsch
    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.

    Standard: Falsch
    Include_trendline_Punktzahlen 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.

    Dieser Parameter erfordert das include_scoresIst auf festgelegt Wahr .
    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.

    Standard: Falsch
    limit Nummer Maximale Anzahl zurückzugebender Punktzahlen.
    Seite Zeichenfolge Geben Sie die Seitenzahl an. Beispiel: Wenn 20 Indikatoren in abgefragt werden Analytics HubGeben Sie mit dem Standardwert pro_page (10) einen Seitenwert von 2 an, um abzurufen Analytics HubFür 11–20.
    Per_page Nummer Maximale Anzahl von Indikatoren, die jede Abfrage auf einer Seite zurückgeben kann.

    Standard: 10

    Maximum: 100
    Sortieren nach 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
    • Indikator_Gruppe
    • name
    • Reihenfolge
    • Ziel
    • Trend
    • Wert

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

    Standard: Absteigend
    step Nummer Numerischer Wert zum Überspringen von Punktzahlen basierend auf der Indikatorhäufigkeit. Geben Sie beispielsweise einen Wert von 3 an, um nur Punktzahlen ab jedem dritten Tag für einen täglichen Indikator oder ab jeder dritten Woche für einen wöchentlichen Indikator zurückzugeben.
    tags Zeichenfolge Geben Sie eine sys_ID der Indikatorgruppe ein, um die Indikatoren in dieser Gruppe zurückzugeben. Nicht verwenden uuidMit diesem Parameter.
    Ziel Boolean Kennzeichnung, die angibt, ob Ergebnisse nur für Indikatoren zurückgegeben werden sollen, für die ein Ziel 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.

    Standard: Falsch
    bis Zeichenfolge Spätestes Datum, ab dem Punktzahlen zurückgegeben werden sollen. Nur Punktzahlen ab diesem Datum oder früher werden zurückgegeben.

    Dieser Parameter erfordert das include_scoresIst auf festgelegt Wahr .
    uuid Zeichenfolge Geben Sie eine durch Doppelpunkte getrennte Liste von sys_ID-Werten ein, um anzugeben, welche Indikatoren, Aufgliederungen, Aggregate 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 or 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 eines Aufgliederungs- und Aufgliederungselements anhängen, um die Antwort basierend auf der Aufgliederung zu gruppieren, und die sys_ID eines Aggregats, um dieses Aggregat anzuwenden. Sie können eine Aufgliederung mit einer Zusammenfassung oder nur eine verwenden.

    Informationen zum Abrufen der sys_ID-Werte von Datensätzen finden Sie unter Eindeutiger Datensatzbezeichner (sys_ID) .

    Hinweis:
    Wenn ein Indikator für die Verwendung eines konfiguriert ist Standardzeitreihen , Alle Analytics HubWerte für diesen Indikator verwenden diese Zeitreihenzusammenfassung.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    In diesem Beispiel gibt der UUID-Parameter den Indikator „Anzahl der offenen Incidents“ an, und der Aufgliederungsparameter gibt die Prioritätsaufgliederung an. Beide Parameter haben die sys_ID der jeweiligen Datensätze als Werte. Die Funktion query() 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ühren Sie eine Abfrage basierend auf den angegebenen Parametern durch, und geben Sie die Ergebnisse als Objekt zurück.

    Bevor Sie diese Methode aufrufen, konfigurieren Sie Parameter für das PAScorecard-Objekt, indem Sie aufrufen AddParam(Zeichenfolgenparameter, Zeichenfolgenwert) .

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Objekt Das PAScorecard-Objekt.

    PAScorecard – result()

    Ruft das letzte Abfrageergebnis als Objekt ab.

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

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

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