sb: Bereichsbezogen, global

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

    • Die sb -Skripteinbindung stellt Methoden bereit, mit denen Sie Vorgänge für Konfigurationsdatensätze Service Bridge durchführen können.

    Es gibt drei Arten von Service Bridge -Konfigurationsdatensätzen, für die Sie mit dieser Skripteinbindung Vorgänge ausführen können:
    • Grundlagendaten-Synchronisierung
    • Remote-Datensatzersteller (RRP)
    • Definition der Remoteaufgabe (RTD)
    Sie können jeden der folgenden Vorgänge Service Bridge für diese Konfigurationsdatensätze ausführen:
    • Auschecken: Erstellt eine Entwurfsversion eines angegebenen Konfigurationsdatensatzes. Jede veröffentlichte Version ist weiterhin für die Verwendung durch Kunden verfügbar.
    • Veröffentlichen: Veröffentlicht die Entwurfsversion eines angegebenen Konfigurationsdatensatzes und macht sie für die Verwendung durch Kunden verfügbar.
    • Archivieren: Archiviert eine inaktive Version eines angegebenen Konfigurationsdatensatzes und macht sie für Kunden nicht verfügbar.
    • Außerkraftsetzen: Legt alle Versionen eines angegebenen Konfigurationsdatensatzes still und macht sie für Kunden nicht verfügbar.
    • Virtuelles Feld aktualisieren: Füllt virtuelle Felder in einer Aufgabentabelle auf einer Zielinstanz aus, wenn Remoteaufgaben Service Bridge verwendet werden.

    Weitere Informationen zu Konfigurationsdatensätzen für Service Bridge finden Sie unter Create configuration revisions.

    Um auf diese API zuzugreifen, müssen die Plugins Service Bridge für Provider-Anwendungen (sn_sb_pro) und Service Bridge Base (sn_sb) auf Ihrer -Instanz installiert sein.

    Die Methoden in dieser API werden mit der sb -Skripteinbindung aufgerufen. Der Code für diese Methoden befindet sich jedoch in der Skripteinbindung PSBPublicAPIUtil.

    Wenn Sie diese Methoden aus dem globalen Bereich aufrufen, verwenden Sie die folgende Syntax:
    sb.checkout(glideRecord);
sb.publish(glideRecord);
sb.archive(glideRecord);
sb.retire(glideRecord);
    Wenn Sie sie aus einer bereichsbezogenen Anwendung aufrufen, verwenden Sie diese Syntax:
    global.sb.checkout(glideRecord);
global.sb.publish(glideRecord);
global.sb.archive(glideRecord);
global.sb.retire(glideRecord);

    sb: archive(glideRecord)

    Überprüft, ob der angegebene GlideRecord ein gültiger Service Bridge -Konfigurationsdatensatz ist und ob sich der Datensatz im Status „inaktiv“ befindet. Wenn diese Validierung bestanden wird, archiviert den angegebenen Konfigurationsdatensatz und lässt alle anderen Versionen desselben Konfigurationsdatensatzes unverändert.

    Weitere Informationen zu Konfigurationsüberarbeitungen und den zugehörigen Status finden Sie unter Create configuration revisions.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    glideRecord GlideRecord Zu archivierender Konfigurationsdatensatz.
    Bei diesem Datensatz kann es sich um einen der folgenden Datensätze handeln:
    • Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendaten-Anbieterangebot“ [sn_fds_pro_offering].
    • Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller“ [sn_sb_pro_remote_record_producer].
    • Remoteaufgaben-Definition (RTD): Datensätze in der Tabelle „Remoteaufgabendefinition“ [sn_sb_pro_remote_task_def].
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der Konfigurationsdatensatz archiviert wurde.
    Mögliche Werte:
    • „wahr“: Der Konfigurationsdatensatz wurde archiviert.
    • false: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht archiviert.

    Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich für einen FDS-Konfigurationsdatensatz aufgerufen wird.

    var grConfig = new GlideRecord('sn_fds_pro_offering’’'); // Configuration table that contains the desired record 
grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
var isExecuted = sb.archive(grConfig);

    sb: checkout(glideRecord)

    Überprüft, ob der angegebene GlideRecord ein gültiger Service Bridge -Konfigurationsdatensatz ist und ob sich der Datensatz im Status „veröffentlicht“ befindet. Wenn diese Validierung bestanden wird, erstellt eine neue Version des angegebenen Konfigurationsdatensatzes und legt das Statusfeld auf „Entwurf“ fest.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    glideRecord GlideRecord Konfigurationsdatensatz zum Auschecken.
    Bei diesem Datensatz kann es sich um einen der folgenden Datensätze handeln:
    • Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendaten-Anbieterangebot“ [sn_fds_pro_offering].
    • Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller“ [sn_sb_pro_remote_record_producer].
    • Remoteaufgaben-Definition (RTD): Datensätze in der Tabelle „Remoteaufgabendefinition“ [sn_sb_pro_remote_task_def].
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    GlideRecord Bei Erfolg wird der neu erstellte Konfigurationsdatensatz zurückgegeben, wobei das Statusfeld auf „Entwurf“ festgelegt ist.

    Wenn ein Fehler aufgetreten ist, wird NULL zurückgegeben.

    Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich für einen RTD-Konfigurationsdatensatz aufgerufen wird.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
var checkoutGr = sb.checkout(grConfig);

    sb: veröffentlichen (glideRecord)

    Überprüft, ob der angegebene GlideRecord ein gültiger Service Bridge -Konfigurationsdatensatz ist und ob sich der Datensatz im Status „Entwurf“ befindet. Wenn diese Validierung bestanden wird, veröffentlicht die Entwurfsversion des Konfigurationsdatensatzes.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    glideRecord GlideRecord Zu veröffentlichender Konfigurationsdatensatz.
    Bei diesem Datensatz kann es sich um einen der folgenden Datensätze handeln:
    • Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendaten-Anbieterangebot“ [sn_fds_pro_offering].
    • Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller“ [sn_sb_pro_remote_record_producer].
    • Remoteaufgaben-Definition (RTD): Datensätze in der Tabelle „Remoteaufgabendefinition“ [sn_sb_pro_remote_task_def].
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der Konfigurationsdatensatz veröffentlicht wurde.
    Mögliche Werte:
    • „wahr“: Der Konfigurationsdatensatz wurde veröffentlicht.
    • false: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht veröffentlicht.

    Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich für einen RRP-Konfigurationsdatensatz aufgerufen wird.

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer’'); // Configuration table that contains the desired record 
grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
var isExecuted = sb.publish(grConfig);

    sb: retire(glideRecord)

    Überprüft, ob der angegebene GlideRecord ein gültiger Service Bridge -Konfigurationsdatensatz ist, und stellt sicher, dass der Datensatz einen gültigen Status aufweist. Wenn diese Validierung bestanden wird, wird die angegebene Version des Konfigurationsdatensatzes zusammen mit allen anderen Überarbeitungen desselben Konfigurationsdatensatzes stillgelegt.

    Weitere Informationen zu Konfigurationsüberarbeitungen und den zugehörigen Status finden Sie unter Create configuration revisions.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    glideRecord GlideRecord Zurückzuziehender Konfigurationsdatensatz.
    Bei diesem Datensatz kann es sich um einen der folgenden Datensätze handeln:
    • Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendaten-Anbieterangebot“ [sn_fds_pro_offering].
    • Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller“ [sn_sb_pro_remote_record_producer].
    • Remoteaufgaben-Definition (RTD): Datensätze in der Tabelle „Remoteaufgabendefinition“ [sn_sb_pro_remote_task_def].
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der Konfigurationsdatensatz stillgelegt wurde.
    Mögliche Werte:
    • „wahr“: Der Konfigurationsdatensatz wurde deaktiviert.
    • false: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht stillgelegt.

    Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich für einen RTD-Konfigurationsdatensatz aufgerufen wird.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
var isExecuted = sb.retire(grConfig);

    sb: updateVirtualField(GlideRecord remoteTaskGr, String virtualField, String virtualValue, String virtualDisplayValue)

    Füllt virtuelle Felder in einer Aufgabentabelle auf einer Zielinstanz aus, wenn Remoteaufgaben Service Bridge verwendet werden.

    Ein virtuelles Feld ist ein Feld, das in einer Zielaufgabentabelle, aber nicht in der Quellaufgabentabelle vorhanden ist. Diese Methode verwenden Sie, um die Werte für ein virtuelles Feld von der Quellinstanz an die Zielinstanz zu übergeben. Diese Methode speichert die angegebenen Werte für das virtuelle Feld als JSON im Formularabschnitt der angegebenen Remoteaufgabe. Diese Remoteaufgabe wird dann mit der Zielinstanz synchronisiert, in der die Werte im zugeordneten Feld in der Zielaufgabentabelle gespeichert werden.

    Virtuelle Felder werden in Remoteaufgabendefinitionen definiert. Remote-Aufgabendefinitionen enthalten eingehende und ausgehende Zuordnungstabellen, die Felder zwischen Aufgabentabellen in Quell- und Zielinstanzen zuordnen. Wenn eine Quelltabelle ein Feld nicht enthält, das in einer Zieltabelle vorhanden ist, wird das Feld in der Remoteaufgaben-Definition als virtuelles Feld konfiguriert. Der Verbraucher kann dann entweder Service Bridge -Transformationen oder diese Methode verwenden, um die Werte dieser virtuellen Felder im zugehörigen Zielaufgaben-Datensatz zu aktualisieren.

    Im folgenden Abschnitt wird anhand eines Beispielanwendungsfalls beschrieben, wie virtuelle Felder implementiert und anschließend die Methode updateVirtualField() zum Ausfüllen von Werten im virtuellen Feld verwendet wird. In diesem Beispiel sind die beiden Aufgabentabellen, die durch eine Remoteaufgabendefinition miteinander verbunden sind, die Falltabelle des Anbieters und die Verbraucher-Incident-Tabelle. Wenn ein Incident-Datensatz in der Verbraucherinstanz erstellt oder aktualisiert wird, wird er für die Synchronisierung mit der Falltabelle des Anbieters konfiguriert. Das Feld „Betroffene Instanzen“ in der Falltabelle ist ein Pflichtfeld, in der Incident-Tabelle jedoch nicht vorhanden. Um mit dieser Situation umzugehen, muss das Feld „Betroffene Instanzen“ als virtuelles Feld in der eingehenden Zuordnung der zugehörigen Remoteaufgabendefinition definiert werden.
    1. Der Anbieter erstellt eine Remoteaufgabendefinition für die Falltabelle des Anbieters und die Verbraucher-Incident-Tabelle.
    2. Auf der Registerkarte Eingehende Felder in den Zugehörigen Links der Definition der Remoteaufgabe ordnet der Anbieter die Felder zwischen der Incident-Tabelle und der Falltabelle zu.
      Bei der Definition des Felds „Betroffene Instanzen“ aktiviert der Anbieter das Kontrollkästchen Virtuell und wählt dann auf der Registerkarte Zielzuordnung im Feld Zieldie Option Betroffene Instanzen aus.
      Hinweis:
      Beim Definieren eines virtuellen Felds wird kein Quellfeld definiert, da es nicht vorhanden ist.
    3. Der Anbieter veröffentlicht dann die Remoteaufgabendefinition, die mit der Verbraucherinstanz synchronisiert wird.
    4. Der Verbraucher erstellt eine Remoteaufgabe für die Incident-Tabelle. Eine JSON-Nutzlast, die alle Werte für die zugeordneten Felder enthält, einschließlich der Informationen zu virtuellen Feldern, wird in einem Formularabschnitt in der Remoteaufgabe enthalten.
    5. Die Verbraucherinstanz ruft die Methode updateVirtualField() auf, z. B. in einer Geschäftsregel, die ausgeführt wird, wenn Datensätze in der Incident-Tabelle aktualisiert werden, um die Werte des Felds Betroffene Instanzen in der Remoteaufgabe festzulegen.
      Hinweis:
      Obwohl Sie die Daten in der Zieltabelle jederzeit füllen können, müssen als virtuelle Felder konfigurierte Pflichtfelder in der Remoteaufgabe ausgefüllt werden, bevor die Remoteaufgabe an die Herstellerinstanz gesendet wird.
    6. Die Remoteaufgabe wird mit der Anbieterinstanz synchronisiert und erstellt einen Falldatensatz in der Anbieterinstanz.

    Informationen zum Erstellen einer Remote-Aufgabendefinition finden Sie unter Create remote task definitions in Service Bridge for Providers.

    Informationen zum Erstellen einer Service Bridge -Transformation finden Sie unter Transform data with the Service Bridge transform framework.

    Warnung:
    Sie sollten diese Methode nur in einer Vor-Business-Regel aufrufen, da sie die Remoteaufgabe aktualisiert, für die sie aufgerufen wird. Wenn Sie diese Methode in einer Nach-Business-Regel aufrufen, müssen Sie strenge Bedingungen einbeziehen, die verhindern, dass die Aktualisierung des virtuellen Felds in der Remoteaufgabe die Business-Regel auslöst, da dies zu einer Endlosschleife führen kann.
    Tabelle : 9. Parameter
    Name Typ Beschreibung
    remoteTaskGr GlideRecord GlideRecord-Objekt der Remoteaufgabe, für die die angegebenen virtuellen Feldwerte festgelegt werden sollen.
    virtualField Zeichenfolge Feldname des virtuellen Felds, für das die zugehörigen Informationen aktualisiert werden sollen. Definiert auf der zugehörigen Registerkarte Ausgehende Felder der zugehörigen Remoteaufgaben-Definition.
    virtualValue Zeichenfolge Wert, der für dieses Feld in der Zielinstanz festgelegt werden soll.
    virtualDisplayValue Zeichenfolge Anzeigewert, der für dieses Feld in der Zielinstanz festgelegt werden soll
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie diese Methode aufgerufen wird.

    var remoteTaskGr = new GlideRecord("");
/** Remote Task table name,
** Table name vary based on which instance the script is being executed.
**/

remoteTaskGr.get(""); // Remote Task record sys_id

global.sb.updateVirtualField(remoteTaskGr,"<virtual outbound field name>", "<value to set on target field>", "<display value to set on target field>");