PAScorecard - Dans le champ d’application

L’API PAScorecard vous permet d’extraire des données sur les indicateurs et leurs enregistrements associés, tels que les répartitions.

Cette API nécessite l’application Analyse des performances (com.snc.pa.analytics_center) et s’exécute dans l’espace de noms SNC .

PAScorecard : addParam(paramètre de chaîne, valeur de chaîne)

Ajoute un paramètre de requête pour filtrer les scores renvoyés.

Appelez cette méthode plusieurs fois sur le même objet PAScorecard pour transmettre plusieurs paramètres, tels que l’indicateur sys_id et une sys_id de répartition. Après avoir spécifié tous les paramètres, appelez query() pour exécuter la requête.

Si vous interrogez un objet PAScorecard sans paramètres, l’API renvoie une liste de tous les indicateurs affichés sur le Centre d'analyse, avec leurs scores.

Tableau 1. Paramètres

Nom	Type	Description
répartition	Chaîne	Sys_id d’une répartition pour renvoyer des informations de graphique organisées selon la définition de la répartition. Par exemple, le sys_id d’une répartition des priorités pour renvoyer des informations de graphique de tâches distinctes pour chaque valeur de priorité, telles que le nombre d’incidents ouverts / Priorité / 2 - Élevée.
breakdown_relation	Chaîne	Spécifiez le sys_id d’une relation de répartition pour répartir les données renvoyées à l’aide de cette relation. Vous pouvez afficher les relations de répartition disponibles en définissant le include_available_breakdowns paramètre sur vrai.
contient	Chaîne	Liste de noms ou de descriptions séparés par des virgules pour renvoyer les résultats uniquement à partir d’indicateurs ayant une valeur correspondante. Tous les éléments de liste séparés par des virgules doivent correspondre, sinon aucun résultat n’est renvoyé : la liste suit la logique ET, et non la logique OR.
affichage	Chaîne	Marqueur indiquant le type d’indicateurs à renvoyer. Valeurs valides : true : renvoie uniquement les indicateurs qui s’affichent sur le Centre d'analyse fichier . all : renvoie tous les indicateurs. Valeur par défaut : true
display_value	Chaîne	Opération de récupération de données pour les champs de référence et de choix. Sur la base de cette valeur, la valeur d’affichage et/ou la valeur réelle dans la base de données sont récupérées. true renvoie les valeurs d’affichage de tous les champs. false renvoie les valeurs réelles de la base de données. Tout renvoie à la fois la valeur réelle et la valeur d’affichage. Valeur par défaut : false
elements_filter	Chaîne	Spécifiez le sys_id d’un filtre d’éléments pour appliquer ce filtre aux données renvoyées. Type de données : chaîne
exclude_reference_link	Booléen	Marqueur indiquant s’il faut masquer les informations supplémentaires fournies pour les champs de référence, telles que l’URI à la ressource de référence. Valeurs valides : true : masquer les informations supplémentaires fournies pour les champs de référence. Faux : ne masquez pas les informations supplémentaires fournies pour les champs de référence. Valeur par défaut : false
Favoris	Booléen	Marqueur indiquant s’il faut renvoyer uniquement les indicateurs qui sont les favoris de l’utilisateur qui effectue la requête. Valeurs valides : true : renvoie uniquement les indicateurs qui sont les favoris de l’utilisateur qui effectue la requête. false : renvoie tous les indicateurs. Valeur par défaut : false
de	Chaîne	Date la plus ancienne à partir de laquelle renvoyer les scores. Seuls les scores à partir de cette date ou d’une date ultérieure sont renvoyés. Ce paramètre nécessite que include_scores soit défini sur vrai. Format : Norme ISO-8601
include_available_aggregates	Chaîne	Marqueur qui indique s’il faut renvoyer tous les agrégats disponibles pour un indicateur lorsqu’aucun agrégat n’a été appliqué. Valeurs valides : true : renvoie tous les agrégats disponibles pour un indicateur lorsqu’aucun agrégat n’a été appliqué. false : ne renvoie aucun agrégat. Valeur par défaut : false
include_available_breakdowns	Booléen	Marqueur indiquant s’il faut renvoyer toutes les répartitions disponibles pour un indicateur. Valeurs valides : vrai : renvoie toutes les répartitions disponibles pour un indicateur. faux : ne renvoyer aucune répartition. Valeur par défaut : false
include_forecast_scores	Booléen	Marqueur indiquant s’il faut renvoyer l’élément forecast_scores qui contient un tableau de paires date-valeur qui définissent les données de prévision pour le Centre d'analyse . Ce paramètre nécessite que include_scores soit défini sur vrai. Valeurs valides : true : renvoie l’élément forecast_scores. false : ne renvoyez pas l’élément forecast_scores. Valeur par défaut : false
include_realtime	Booléen	Marqueur indiquant s’il faut renvoyer l’élément realtime_enabled, qui indique si les scores en temps réel sont activés pour l’indicateur, et l’élément realtime_value, qui contient la valeur du score en temps réel. Ce paramètre n’est pas pris en charge pour les indicateurs de formule. Valeurs valides : true : renvoie l’élément realtime_enabled. false : ne renvoyez pas l’élément realtime_enabled. Valeur par défaut : false
include_scores	Booléen	Marqueur indiquant s’il faut renvoyer les scores des indicateurs pour l’ensemble de la plage temporelle sélectionnée sur le Centre d'analyse . Si aucune valeur n’est spécifiée, ce paramètre est défini par défaut sur faux et ne renvoie que la valeur de score la plus récente. Pour contraindre la plage de dates des scores retournés, combinez ce paramètre avec from et .to Valeurs valides : vrai : renvoie les scores de l’indicateur pour l’ensemble de la plage horaire sélectionnée. faux : ne renvoie pas les scores de l’indicateur pour l’ensemble de la plage horaire sélectionnée. Valeur par défaut : false
include_target_color_scheme	Booléen	Marqueur indiquant s’il faut renvoyer l’élément target_color_scheme qui contient les valeurs minimale et maximale, ainsi que la couleur de chaque section de la combinaison de couleurs cible pour le Centre d'analyse . Valeurs valides : true : renvoie l’élément target_color_scheme. false : ne renvoyez pas l’élément target_color_scheme. Valeur par défaut : false
include_trendline_scores	Chaîne	Marqueur indiquant s’il faut renvoyer l’élément trendline_scores qui contient un tableau de paires date-valeur qui définissent la Centre d'analyse courbe de tendance. Ce paramètre nécessite que include_scores soit défini sur vrai.
key	Booléen	Marqueur indiquant s’il faut renvoyer des résultats uniquement pour les indicateurs clés. Valeurs valides : true : renvoie l’élément trendline_scores. false : ne renvoyez pas l’élément trendline_scores. Valeur par défaut : false
limite	Numéro	Nombre maximum de scores à renvoyer.
Page	Chaîne	Spécifiez le numéro de page. Par exemple, lors de l’interrogation de 20 indicateurs dans le Centre d'analyse avec la valeur de per_page par défaut (10), spécifiez une valeur de page de 2 pour récupérer les Centre d'analyse valeurs de 11 à 20.
per_page	Numéro	Nombre maximal d’indicateurs que chaque requête peut renvoyer sur une page. Par défaut : 10 Maximum : 100
Trier par	Chaîne	Valeur à utiliser lors du tri des résultats. Valeurs valides : balle changement changeperc date Par défaut direction Date d’échéance fréquence écart gapperc groupe indicator_group nom order target tendance valide Par défaut : valeur
rép_tri	Chaîne	Sens de tri. Valeurs valides : asc : Indique l’ascendant des : Indique descendant Par défaut : Décroissant
étape	Numéro	Valeur numérique permettant d’ignorer les scores, en fonction de la fréquence de l’indicateur. Par exemple, spécifiez une valeur de 3 pour renvoyer uniquement les scores de tous les trois jours pour un indicateur quotidien ou de toutes les trois semaines pour un indicateur hebdomadaire.
balises	Chaîne	Entrez un groupe d’indicateurs sys_id pour renvoyer les indicateurs de ce groupe. Ne pas utiliser uuid avec ce paramètre.
target	Booléen	Marqueur qui indique s’il faut renvoyer des résultats uniquement pour les indicateurs dont la cible est définie sur le Centre d'analyse . Valeurs valides : true : renvoie uniquement les résultats des indicateurs pour lesquels une cible est définie. faux : renvoie les résultats de tous les indicateurs applicables. Valeur par défaut : false
à	Chaîne	Dernière date à partir de laquelle renvoyer les scores. Seuls les scores à partir de cette date ou d’une date antérieure sont renvoyés. Ce paramètre nécessite que include_scores soit défini sur vrai.
uuid	Chaîne	Entrez une liste de valeurs de sys_id séparées par deux-points pour spécifier les indicateurs, répartitions, agrégats et domaines à interroger. Le paramètre suit le format suivant : <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or element_sys_ids>:<aggregate_sys_id>;<domain_sys_id> Le paramètre doit commencer par le sys_id d’un enregistrement d’indicateur. Vous pouvez éventuellement ajouter les valeurs de sys_id d’une répartition et d’un élément de répartition pour regrouper la réponse en fonction de la répartition, ainsi que la sys_id d’un agrégat pour appliquer cet agrégat. Vous pouvez utiliser une répartition avec un agrégat ou n’en utiliser qu’un. Pour plus d’informations sur l’obtention des valeurs de sys_id des enregistrements, voir Identificateur unique d’enregistrement (sys_id). Remarque : Si un indicateur est configuré pour utiliser une série chronologique par défaut, toutes les Centre d'analyse valeurs de cet indicateur utilisent cette agrégation de série chronologique.

Tableau 2. Renvoie

Type	Description
Aucun

Dans cet exemple, le paramètre uuid spécifie l’indicateur Nombre d’incidents ouverts et le paramètre répartition spécifie la répartition Priorité. Les deux paramètres ont comme valeurs les sys_id des enregistrements respectifs. La fonction query() renvoie les résultats sous forme d’objet.

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()

Effectuez une requête basée sur les paramètres spécifiés et renvoyez les résultats en tant qu’objet.

Avant d’appeler cette méthode, configurez les paramètres de l’objet PAScorecard en appelant addParam(String parameter, String value).

Tableau 3. Paramètres

Nom	Type	Description
Aucun

Tableau 4. Renvoie

Type	Description
Objet	L’objet PAScorecard.

PAScorecard : result()

Obtenir le dernier résultat de la requête en tant qu’objet.

Cette méthode n’effectue pas de requête. Pour effectuer une requête avant de renvoyer le résultat, utilisez query().

Cette fonction ne peut pas s’exécuter dans un périmètre autre que global.

Tableau 5. Paramètres

Nom	Type	Description
Aucun

Tableau 6. Renvoie

Type	Description
Objet	Les résultats de la dernière requête, retournés en tant qu’objet JS.