CSBScratchpadUtil – Scoped

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer
  • Mit der CSBScratchpadUtil- API können Verbraucher „zusätzliche“ Informationen, die sich außerhalb eines anderen Service Bridge-Service befinden, mit ihren Anbietern teilen.

    Diese Informationen werden als Name-Wert-Paare in der Scratchpad-Tabelle [sn_sb_scratchpad] gespeichert. Die freigegebenen Informationen müssen Aufgaben zugeordnet werden, die einen von zwei Typen aufweisen: Provider-Aufgaben oder Remote-Aufgaben.

    Wenn die zugeordnete Aufgabe aktiv ist, werden die aktualisierten Scratchpad-Informationen mit der Verbraucherinstanz synchronisiert. Wenn eine Aufgabe deaktiviert oder gelöscht wird, werden die Informationen im Scratchpad nach einer bestimmten Anzahl von Tagen ebenfalls gelöscht. standardmäßig drei. Dieser Standardwert ist in der Eigenschaft sn_sb.scratchpad.autodelete.days definiert.

    Sowohl Anbieter als auch Verbraucher können der Scratchpad-Tabelle Informationen hinzufügen, aktualisieren und entfernen. Produzenten aktualisieren diese Informationen mit der PSBScratchpadUtil- API.

    Für den Zugriff auf diese API muss die Anwendung Service Bridge for Consumers installiert sein. Diese API wird im Namespace sn_sb_con ausgeführt.

    CSBScratchpadUtil – get(GlideRecord taskGR, String name)

    Gibt den Wert einer angegebenen Scratchpad-Eigenschaft zurück.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, die der angegebenen Scratchpad-Eigenschaft zugeordnet ist. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Name Zeichenfolge Name der Scratchpad-Eigenschaft, deren Wert abgerufen werden soll. Befindet sich in der Scratchpad-Tabelle [sn_sb_scratchpad].
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Zeichenfolge oder NULL Wert der angeforderten Scratchpad-Eigenschaft. NULL, wenn die Eigenschaft nicht gefunden wird.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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"));
    }

    Ausgabe:

    "value1"

    CSBScratchpadUtil – getAll(GlideRecord taskGR)

    Gibt die Eigenschaftsnamen und -werte (Name-Wert-Paare) aller Scratchpad-Eigenschaften zurück, die der angegebenen Aufgabe zugeordnet sind.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, deren zugeordnete Scratchpad-Eigenschaften zurückgegeben werden sollen. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt Alle Eigenschaftsnamen und -werte, die in der angegebenen Aufgabe enthalten sind. Im Formular:

    { name1: value1, name2: value2, … }

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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))); 
    }

    Ausgabe:

    { "name1": "value1" }

    CSBScratchpadUtil – getNames(GlideRecord taskGR)

    Gibt die Liste der Namen aller Scratchpad-Eigenschaften zurück, die dem angegebenen Aufgabendatensatz zugeordnet sind.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, für die die Liste der Namen aller zugeordneten Scratchpad-Eigenschaften zurückgegeben werden soll. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Zeichenfolgen-Array Liste der Namen der Scratchpad-Eigenschaften, die dem angegebenen Aufgabendatensatz zugeordnet sind.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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))); 
    }

    Ausgabe:

    [ "name1" ]

    CSBScratchpadUtil – populateClientScratchpadBR(GlideRecord taskGR)

    Platziert die Scratchpad-Eigenschaften, die der angegebenen Remote-Aufgabe oder Provider-Aufgabe zugeordnet sind, im g_scratchpad des Clients.

    Sie können diese Methode aus einer UI-Anzeige-Business Rule aufrufen.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, deren zugeordnete Scratchpad-Einträge im g_scratchpad des Clients platziert werden sollen. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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

    CSBScratchpadUtil – remove(GlideRecord taskGR, String name)

    Löscht die angegebene Scratchpad-Eigenschaft aus der Scratchpad-Tabelle [sn_sb_scratchpad].

    Hinweis:
    Löschungen werden nicht mit anderen ServiceNow Instanzen synchronisiert. Scratchpad-Eigenschaften werden innerhalb einer bestimmten Anzahl von Tagen automatisch gelöscht, nachdem der zugehörige Aufgabendatensatz deaktiviert oder gelöscht wurde.
    Tabelle : 9. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, die der angegebenen Scratchpad-Eigenschaft zugeordnet ist. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Name Zeichenfolge Name der Scratchpad-Eigenschaft, die aus der Scratchpad-Tabelle [sn_sb_scratchpad] entfernt werden soll.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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")); 
    }

    Ausgabe:

    undefined

    CSBScratchpadUtil – update(GlideRecord taskGR, String name, String value, Boolean client_side_accessible)

    Fügt eine Eigenschaft ein oder aktualisiert den Wert einer Eigenschaft in der Scratchpad-Tabelle [sn_sb_scratchpad].

    Hinweis:
    Die maximale Anzahl von Eigenschaften, die Sie in einem Aufruf aktualisieren können, beträgt 50.
    Tabelle : 11. Parameter
    Name Typ Beschreibung
    taskGR GlideRecord GlideRecord der aktiven Remote-Aufgabe oder Provider-Aufgabe, die der angegebenen Scratchpad-Eigenschaft zugeordnet ist. Diese Datensätze befinden sich in den Tabellen „Remote-Aufgabe“ [sn_sb_con_remote_task] und „Provider-Aufgabe“ [sn_sb_con_provider_task].
    Name Zeichenfolge Name einer neuen oder vorhandenen Scratchpad-Eigenschaft. Dieser Name muss für alle Scratchpad-Eigenschaften eindeutig sein.
    Wert Zeichenfolge Wert der Scratchpad-Eigenschaft.

    Maximum: 4000 Zeichen.

    client_side_accessible Boolean Optional. Kennzeichnung, die angibt, ob diese Eigenschaft für das clientseitige g_scratchpad verfügbar ist, wenn populateClientScratchpadBR von einer Anzeige-Business Rule aufgerufen wird.
    Gültige Werte:
    • true: Eigenschaft ist verfügbar.
    • false: Eigenschaft ist nicht verfügbar.

    Standardwert: false

    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    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")); 
    } 

    Ausgabe:

    "value2"