---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# PSBScratchpadUtil : inclus dans le champ d'application

# PSBScratchpadUtil : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes de lecture

L'API PSBScratchpadUtil fournit des méthodes qui permettent aux fournisseurs de partager des informations \<\< supplémentaires \>\> qui sont en dehors de tout autre Pont de services service, avec leurs consommateurs.

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 l'un des deux types suivants : tâches du fournisseur ou tâches à distance.

Si la tâche associée est active, les informations de bloc-notes mises à jour 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 de la table Bloc-notes. Les consommateurs mettent à jour ces informations à l'aide de l'API CSBScratchpadUtil .

Pour accéder à cette API, l'application Pont de services For Providers (sn_sb_pro) doit être installée. Cette API s'exécute dans l'espace `de noms sn_sb_pro` .

## PSBScratchpadUtil : get(GlideRecord, taskGR, nom de chaîne) {#ariaid-title2}

Renvoie la valeur d'une propriété de bloc-notes spécifiée.
{#PSBScrUtil-get_GR_S__table_sm3_fpg_czb__entry__3}

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_provider_task\]. |
| nom | Chaîne | Nom de la propriété de bloc-notes dont la valeur doit être récupérée. Situé dans la table Bloc-notes \[sn_sb_scratchpad\]. |
[Tableau 1. Paramètres]

{#PSBScrUtil-get_GR_S__table_sm3_fpg_czb} {#PSBScrUtil-get_GR_S__table_tm3_fpg_czb__entry__2}

| Type | Description |
|-|-|
| Chaîne ou nul | Valeur de la propriété de bloc-notes demandée. Null si la propriété est introuvable. |
[Tableau 2. Renvoie]

{#PSBScrUtil-get_GR_S__table_tm3_fpg_czb}  
L'exemple de code suivant montre comment appeler cette méthode.

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

Sortie :

    "value1"

## PSBScratchpadUtil : getAll(GlideRecord taskGR) {#ariaid-title3}

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

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_provider_task\]. |
[Tableau 3. Paramètres]

{#PSBScrUtil-getAll_GR__table_ism_vpg_czb} {#PSBScrUtil-getAll_GR__table_jsm_vpg_czb__entry__2}

| Type | Description |
|-|-|
| Objet | Tous les noms et valeurs de propriétés contenus dans la tâche spécifiée. Sous la forme : `{ name1 : value1, name2 : value2, ... }` |
[Tableau 4. Renvoie]

{#PSBScrUtil-getAll_GR__table_jsm_vpg_czb}  
L'exemple de code suivant montre comment appeler cette méthode.

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

Sortie :

    { "name1": "value1" }

## PSBScratchpadUtil : getNames(GlideRecord taskGR) {#ariaid-title4}

Renvoie la liste des noms de toutes les propriétés de bloc-notes associées à l'enregistrement de tâche spécifié.
{#PSBScrUtil-getNames_GR__table_r5k_dqg_czb__entry__3}

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_provider_task\]. |
[Tableau 5. Paramètres]

{#PSBScrUtil-getNames_GR__table_r5k_dqg_czb} {#PSBScrUtil-getNames_GR__table_s5k_dqg_czb__entry__2}

| Type | Description |
|-|-|
| Tableau de chaînes | Liste des noms des propriétés de bloc-notes associées à l'enregistrement de tâche spécifié. |
[Tableau 6. Renvoie]

{#PSBScrUtil-getNames_GR__table_s5k_dqg_czb}  
L'exemple de code suivant montre comment appeler cette méthode.

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

Sortie :

    [ "name1" ]

## PSBScratchpadUtil : populateClientScratchpadBR(GlideRecord taskGR) {#ariaid-title5}

Place les propriétés de 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.
{#PSBScrUtil-popClientScratch_GR__table_ikg_qdb_fzb__entry__3}

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_provider_task\]. |
[Tableau 7. Paramètres]

{#PSBScrUtil-popClientScratch_GR__table_ikg_qdb_fzb} {#PSBScrUtil-popClientScratch_GR__table_jkg_qdb_fzb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 8. Renvoie]

{#PSBScrUtil-popClientScratch_GR__table_jkg_qdb_fzb}  
L'exemple de code suivant montre comment appeler cette méthode.

    new sn_sb_pro.PSBScratchpadUtil().populateClientScratchpadBR(current);

## PSBScratchpadUtil - remove(GlideRecord, taskGR, nom de chaîne) {#ariaid-title6}

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 spécifié de jours après la désactivation ou la suppression de l'enregistrement de tâche associé.
{#PSBScrUtil-remove_GR_S__table_x3b_nqg_czb__entry__3}

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_provider_task\]. |
| nom | Chaîne | Nom de la propriété du bloc-notes à supprimer de la table Bloc-notes \[sn_sb_scratchpad\]. |
[Tableau 9. Paramètres]

{#PSBScrUtil-remove_GR_S__table_x3b_nqg_czb} {#PSBScrUtil-remove_GR_S__table_y3b_nqg_czb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 10. Renvoie]

{#PSBScrUtil-remove_GR_S__table_y3b_nqg_czb}  
L'exemple de code suivant montre comment appeler cette méthode.

    var rtGR = new GlideRecord("sn_sb_pro_remote_task");
    rtGR.setLimit(1); 
    rtGR.query();  
    rtGR.next() 
    if (rtGR.isValidRecord()) {
      var util = new sn_sb_pro.PSBScratchpadUtil();
      util.update(rtGR, "name1", "value1"); 
      util.remove(rtGR, "name1");
      gs.info(util.get(rtGR, "name1")); 
    }

Sortie :

    undefined

## PSBScratchpadUtil : update(GlideRecord taskGR, nom de chaîne, valeur de chaîne, client_side_accessible booléen) {#ariaid-title7}

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.
{#PSBScrUtil-update_GR_S_S_B__table_z4p_4kg_czb__entry__3}

| 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. Ces enregistrements se trouvent dans les tables Tâche distante \[sn_sb_pro_remote_task\] et Tâche du fournisseur \[sn_sb_pro_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 de bloc-notes. |
| valide | Chaîne | Valeur de la propriété bloc-notes. Maximum : 4000 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 : * true : la propriété est disponible. * false : la propriété n'est pas disponible. Valeur par défaut : false |
[Tableau 11. Paramètres]

{#PSBScrUtil-update_GR_S_S_B__table_z4p_4kg_czb} {#PSBScrUtil-update_GR_S_S_B__table_app_4kg_czb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 12. Renvoie]

{#PSBScrUtil-update_GR_S_S_B__table_app_4kg_czb}  
L'exemple de code suivant montre comment appeler cette méthode.

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

Sortie :

    "value2"