CSBScratchpadUtil : dans le champ d’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture

    • L’API CSBScratchpadUtil permet aux consommateurs de partager avec leurs fournisseurs des informations « supplémentaires » qui se trouvent en dehors de tout autre Pont de services service.

    Ces informations sont stockées sous forme de paires nom-valeur dans la table bloc-notes [sn_sb_scratchpad]. Les informations partagées doivent être associées à des tâches de deux types : tâches du fournisseur ou tâches à distance.

    Si la tâche associée est active, les informations mises à jour du bloc-notes sont synchronisées avec l’instance du consommateur. Si une tâche est désactivée ou supprimée, les informations contenues dans le bloc-notes sont également supprimées après un nombre de jours spécifié ; par défaut, trois. Cette valeur par défaut est définie dans la propriété sn_sb.scratchpad.autodelete.days.

    Les fournisseurs et les consommateurs peuvent ajouter, mettre à jour et supprimer des informations vers et depuis la table Bloc-notes. Les producteurs mettent à jour ces informations à l’aide de l’API PSBScratchpadUtil : dans le champ d’application .

    Pour accéder à cette API, l’application Pont de services for Consumers doit être installée. Cette API s’exécute dans l’espace de noms sn_sb_con .

    CSBScratchpadUtil : get(GlideRecord taskGR, nom de chaîne)

    Renvoie la valeur d’une propriété spécifiée du bloc-notes.

    Tableau 1. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur associée à la propriété de bloc-notes spécifiée.

    Tables : Tâche distante [sn_sb_con_remote_task] et Tâche fournisseur [sn_sb_con_provider_task].
    nom Chaîne Nom de la propriété bloc-notes dont la valeur doit être récupérée.

    Table : bloc-notes [sn_sb_scratchpad]
    Tableau 2. Renvoie
    Type Description
    Chaîne ou null Valeur de la propriété de bloc-notes demandée. Nul si la propriété est introuvable.

    L’exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
rtGR.setLimit(1); 
rtGR.query();  
rtGR.next() 
if (rtGR.isValidRecord()) { 
  var util = new sn_sb_con.CSBScratchpadUtil();
  util.update(rtGR, "name1", "value1"); 
  gs.info(util.get(rtGR, "name1"));
}

    Sortie :

    "value1"

    CSBScratchpadUtil : getAll(GlideRecord taskGR)

    Renvoie les noms et valeurs de propriété (paires nom-valeur) de toutes les propriétés de bloc-notes associées à la tâche spécifiée.

    Tableau 3. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur dont les propriétés de bloc-notes associées doivent être renvoyées.

    Table : tables Tâche distante [sn_sb_con_remote_task] et Tâche du fournisseur [sn_sb_con_provider_task].
    Tableau 4. Renvoie
    Type Description
    Objet Tous les noms et valeurs de propriété contenus dans la tâche spécifiée.

    Par exemple :

    { name1 : value1, name2 : value2, ... }

    L’exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
rtGR.setLimit(1);
rtGR.query();  
rtGR.next() 
if (rtGR.isValidRecord()) {  
  var util = new sn_sb_con.CSBScratchpadUtil();
  util.update(rtGR, "name1", "value1"); 
  gs.info(JSON.stringify(util.getAll(rtGR))); 
}

    Sortie :

    { "name1": "value1" }

    CSBScratchpadUtil : getNames(GlideRecord taskGR)

    Renvoie la liste des noms de toutes les propriétés de bloc-notes associées à l’enregistrement de tâche spécifié.

    Tableau 5. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur pour laquelle renvoyer la liste des noms de toutes les propriétés de bloc-notes associées.

    Table : Tâche distante [sn_sb_con_remote_task] et Tâche du fournisseur [sn_sb_con_provider_task]
    Tableau 6. Renvoie
    Type Description
    Tableau de chaînes Liste des noms des propriétés du bloc-notes associées à l’enregistrement de tâche spécifié.

    L’exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
rtGR.setLimit(1); 
rtGR.query();  
rtGR.next() 
if (rtGR.isValidRecord()) {
  var util = new sn_sb_con.CSBScratchpadUtil();
  util.update(rtGR, "name1", "value1"); 
  gs.info(JSON.stringify(util.getNames(rtGR))); 
}

    Sortie :

    [ "name1" ]

    CSBScratchpadUtil : populateClientScratchpadBR(GlideRecord taskGR)

    Place les propriétés du bloc-notes associées à la tâche distante spécifiée ou à la tâche du fournisseur dans le g_scratchpad client.

    Vous pouvez appeler cette méthode à partir d’une règle métier d’affichage de l’interface utilisateur.

    Tableau 7. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur dont les entrées de bloc-notes associées doivent être placées dans le g_scratchpad client.

    Tables : Tâche distante [sn_sb_con_remote_task] et Tâche fournisseur [sn_sb_con_provider_task]
    Tableau 8. Renvoie
    Type Description
    Néant

    L’exemple de code suivant montre comment appeler cette méthode.

    new sn_sb_con.CSBScratchpadUtil().populateClientScratchpadBR(current);

    CSBScratchpadUtil : supprimer (GlideRecord taskGR, nom de chaîne)

    Supprime la propriété de bloc-notes spécifiée de la table bloc-notes [sn_sb_scratchpad].

    Remarque :
    Les suppressions ne sont pas synchronisées avec d’autres ServiceNow instances. Les propriétés du bloc-notes sont automatiquement supprimées dans un nombre de jours spécifié après la désactivation ou la suppression de l’enregistrement de tâche associé.
    Tableau 9. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur associée à la propriété de bloc-notes spécifiée.

    Tables : Tâche distante [sn_sb_con_remote_task] et Tâche fournisseur [sn_sb_con_provider_task].
    nom Chaîne Nom de la propriété bloc-notes à supprimer de la table bloc-notes [sn_sb_scratchpad].
    Tableau 10. Renvoie
    Type Description
    Néant

    L’exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
rtGR.setLimit(1); 
rtGR.query();  
rtGR.next() 
if (rtGR.isValidRecord()) {
  var util = new sn_sb_con.CSBScratchpadUtil();
  util.update(rtGR, "name1", "value1"); 
  util.remove(rtGR, “name1”);
  gs.info(util.get(rtGR, "name1")); 
}

    Sortie :

    undefined

    CSBScratchpadUtil : update(GlideRecord taskGR, nom de chaîne, valeur de chaîne, booléen client_side_accessible)

    Insère une propriété ou met à jour la valeur d’une propriété dans la table bloc-notes [sn_sb_scratchpad].

    Remarque :
    Le nombre maximal de propriétés que vous pouvez mettre à jour en un seul appel est de 50.
    Tableau 11. Paramètres
    Nom Type Description
    taskGR GlideRecord GlideRecord de la tâche distante active ou de la tâche du fournisseur associée à la propriété de bloc-notes spécifiée.

    Tables : Tâche distante [sn_sb_con_remote_task] et Tâche fournisseur [sn_sb_con_provider_task]
    nom Chaîne Nom d’une propriété de bloc-notes nouvelle ou existante. Ce nom doit être unique dans toutes les propriétés du bloc-notes.
    valide Chaîne Valeur de la propriété bloc-notes.

    Maximum : 4 000 caractères.
    client_side_accessible Booléen Facultatif. Marqueur indiquant si cette propriété est disponible pour le g_scratchpad côté client lorsque populateClientScratchpadBR est appelé à partir d’une règle métier d’affichage.
    Valeurs valides :
    • vrai : la propriété est disponible.
    • faux : la propriété n’est pas disponible.

    Valeur par défaut : false
    Tableau 12. Renvoie
    Type Description
    Néant

    L’exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_con_remote_task");
rtGR.setLimit(1); 
rtGR.query();
rtGR.next()
if (rtGR.isValidRecord()) {
  var util = new sn_sb_con.CSBScratchpadUtil();
  util.update(rtGR, "name1", "value2");
  gs.info(util.get(rtGR, "name1")); 
}

    Sortie :

    "value2"