---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# sb: Umfang, global

# sb: Umfang, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 Minuten Lesedauer

Die SB Die Skripteinbindung bietet Methoden, mit denen Sie Vorgänge ausführen können Service BridgeKonfigurationsdatensätze.  
Es gibt drei Typen von Service BridgeKonfigurationsdatensätze, für die Sie mit diesem Skript Vorgänge ausführen können, umfassen:

* Grundlagendaten-Synchronisierung
* Remote-Datensatzersteller (RRP)
* Remote-Aufgabendefinition (RTD)

Sie können Folgendes ausführen Service BridgeVorgänge für diese Konfigurationsdatensätze:

* 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 stellt ihn für die Verwendung durch den Kunden bereit.
* Archivieren: Archiviert eine inaktive Version eines angegebenen Konfigurationsdatensatzes und macht ihn für Kunden nicht verfügbar.
* Stilllegen: Deaktiviert alle Versionen eines angegebenen Konfigurationsdatensatzes und macht sie für Kunden nicht verfügbar.
* Virtuelles Feld aktualisieren: Füllt virtuelle Felder in einer Aufgabentabelle in einer Zielinstanz aus, wenn verwendet wird Service BridgeRemote-Aufgaben.

Für zusätzliche Informationen zu Service BridgeKonfigurationsdatensätze, siehe [Create configuration revisions](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US).

Um auf diese API zuzugreifen, die Service BridgeFür die Anbieteranwendung (sn_sb_pro) und die Service BridgeBasis-Plugins (sn_sb) müssen auf Ihrer Instanz installiert sein.

Sie rufen die Methoden in dieser API mit auf SB Skripteinbindung. Der Code für diese Methoden befindet sich jedoch in PSBPublicAPIUtil Skripteinbindung.  
Verwenden Sie beim Aufrufen dieser Methoden aus dem globalen Bereich die folgende Syntax:

    sb.checkout(glideRecord);
    sb.publish(glideRecord);
    sb.archive(glideRecord);
    sb.retire(glideRecord);

Verwenden Sie diese Syntax, wenn Sie sie aus einer bereichsbezogenen Anwendung aufrufen:

    global.sb.checkout(glideRecord);
    global.sb.publish(glideRecord);
    global.sb.archive(glideRecord);
    global.sb.retire(glideRecord);

## sb -- Archive (glideRecord) {#ariaid-title2}

Validiert, dass der angegebene GlideRecord gültig ist Service BridgeKonfigurationsdatensatz und überprüft, ob sich der Datensatz im Status „inaktiv" befindet. Wenn diese Validierung erfolgreich ist, wird der angegebene Konfigurationsdatensatz archiviert, sodass alle anderen Versionen desselben Konfigurationsdatensatzes unverändert bleiben.
Weitere Informationen zu Konfigurationsüberarbeitungen und den zugehörigen status finden Sie unter [Create configuration revisions](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US).
{#PSBPubUtil-archive_GR__table_wlx_2cn_zbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| GlideRecord | GlideRecord | Zu archivierender Konfigurationsdatensatz. Dieser Datensatz kann einer der folgenden sein: * Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendatenanbieter" \[sn_fds_pro_offering\]. * Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller" \[sn_sb_pro_remote_record_producer\]. * Remote-Aufgabendefinition (RTD): Datensätze in der Tabelle „Remote-Aufgabendefinition" \[sn_sb_pro_remote_task_def\]. |
[Tabelle : 1. Parameter]

{#PSBPubUtil-archive_GR__table_wlx_2cn_zbc} {#PSBPubUtil-archive_GR__table_xlx_2cn_zbc__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der Konfigurationsdatensatz archiviert wurde. Mögliche Werte: * Wahr: Konfigurationsdatensatz wurde archiviert. * Falsch: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht archiviert. |
[Tabelle : 2. Rückgaben]

{#PSBPubUtil-archive_GR__table_xlx_2cn_zbc}  
Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich in einem 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 -- Bezahlvorgang (glideRecord) {#ariaid-title3}

Validiert, dass der angegebene GlideRecord gültig ist Service BridgeKonfigurationsdatensatz und überprüft, ob sich der Datensatz im Status „veröffentlicht" befindet. Wenn diese Validierung erfolgreich ist, wird eine neue Version des angegebenen Konfigurationsdatensatzes erstellt und das Statusfeld auf „Entwurf" festgelegt.
{#PSBPubUtil-checkout_GR__table_x5b_yxm_zbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| GlideRecord | GlideRecord | Konfigurationsdatensatz, der ausgecheckt werden soll. Dieser Datensatz kann einer der folgenden sein: * Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendatenanbieter" \[sn_fds_pro_offering\]. * Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller" \[sn_sb_pro_remote_record_producer\]. * Remote-Aufgabendefinition (RTD): Datensätze in der Tabelle „Remote-Aufgabendefinition" \[sn_sb_pro_remote_task_def\]. |
[Tabelle : 3. Parameter]

{#PSBPubUtil-checkout_GR__table_x5b_yxm_zbc} {#PSBPubUtil-checkout_GR__table_y5b_yxm_zbc__entry__2}

| Typ | Beschreibung |
|-|-|
| GlideRecord | Wenn erfolgreich, wird der neu erstellte Konfigurationsdatensatz zurückgegeben, wobei das Statusfeld auf „Entwurf" festgelegt ist. Wenn ein Fehler aufgetreten ist, wird Null zurückgegeben. |
[Tabelle : 4. Rückgaben]

{#PSBPubUtil-checkout_GR__table_y5b_yxm_zbc}  
Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich in einem 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) {#ariaid-title4}

Validiert, dass der angegebene GlideRecord gültig ist Service BridgeKonfigurationsdatensatz und überprüft, ob sich der Datensatz im Status „Entwurf" befindet. Wenn diese Validierung erfolgreich ist, wird die Entwurfsversion des Konfigurationsdatensatzes veröffentlicht.
{#PSBPubUtil-publish_GR__table_mqz_mbn_zbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| GlideRecord | GlideRecord | Zu veröffentlichender Konfigurationsdatensatz. Dieser Datensatz kann einer der folgenden sein: * Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendatenanbieter" \[sn_fds_pro_offering\]. * Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller" \[sn_sb_pro_remote_record_producer\]. * Remote-Aufgabendefinition (RTD): Datensätze in der Tabelle „Remote-Aufgabendefinition" \[sn_sb_pro_remote_task_def\]. |
[Tabelle : 5. Parameter]

{#PSBPubUtil-publish_GR__table_mqz_mbn_zbc} {#PSBPubUtil-publish_GR__table_nqz_mbn_zbc__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der Konfigurationsdatensatz veröffentlicht wurde. Mögliche Werte: * Wahr: Konfigurationsdatensatz wurde veröffentlicht. * Falsch: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht veröffentlicht. |
[Tabelle : 6. Rückgaben]

{#PSBPubUtil-publish_GR__table_nqz_mbn_zbc}  
Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich in einem 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 -- stilllegen (glideRecord) {#ariaid-title5}

Validiert, dass der angegebene GlideRecord gültig ist Service BridgeKonfigurationsdatensatz und überprüft, ob sich der Datensatz in einem gültigen Status befindet. Wenn diese Validierung erfolgreich ist, werden 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](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-config-rev&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US).
{#PSBPubUtil-retire_GR__table_kqj_hcn_zbc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| GlideRecord | GlideRecord | Konfigurationsdatensatz, der stillgelegt werden soll. Dieser Datensatz kann einer der folgenden sein: * Grundlagendaten-Synchronisierung (FDS): Datensätze in der Tabelle „Grundlagendatenanbieter" \[sn_fds_pro_offering\]. * Remote-Datensatzersteller (RRP): Datensätze in der Tabelle „Remote-Datensatzersteller" \[sn_sb_pro_remote_record_producer\]. * Remote-Aufgabendefinition (RTD): Datensätze in der Tabelle „Remote-Aufgabendefinition" \[sn_sb_pro_remote_task_def\]. |
[Tabelle : 7. Parameter]

{#PSBPubUtil-retire_GR__table_kqj_hcn_zbc} {#PSBPubUtil-retire_GR__table_lqj_hcn_zbc__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob der Konfigurationsdatensatz stillgelegt wurde. Mögliche Werte: * Wahr: Konfigurationsdatensatz wurde stillgelegt. * Falsch: Fehler aufgetreten; Konfigurationsdatensatz wurde nicht stillgelegt. |
[Tabelle : 8. Rückgaben]

{#PSBPubUtil-retire_GR__table_lqj_hcn_zbc}  
Das folgende Codebeispiel zeigt, wie diese Methode aus dem globalen Bereich in einem 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, Zeichenfolge virtualField, Zeichenfolge virtualValue, Zeichenfolge virtualDisplayValue) {#ariaid-title6}

Füllt virtuelle Felder in einer Aufgabentabelle in einer Zielinstanz aus, wenn verwendet wird Service BridgeRemote-Aufgaben.
Ein virtuelles Feld ist ein Feld, das in einer Zielaufgabentabelle vorhanden ist, aber nicht in der Quellaufgabentabelle vorhanden ist. Sie verwenden diese Methode, 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 des angegebenen [Remote-Aufgabe](https://www.servicenow.com/docs/access?context=service-bridge-v2-remote-task-overview&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US). Diese Remote-Aufgabe wird dann mit der Zielinstanz synchronisiert, in der die Werte im zugeordneten Feld in der Zielaufgabentabelle gespeichert werden.

Virtuelle Felder sind in Remote-Aufgabendefinitionen definiert. Remote-Aufgabendefinitionen enthalten eingehende und ausgehende Zuordnungstabellen, die Felder zwischen Aufgabentabellen in Quell- und Zielinstanzen zuordnen. Wenn eine Quelltabelle kein Feld enthält, das in einer Zieltabelle vorhanden ist, wird das Feld in der Remote-Aufgabendefinition als virtuelles Feld konfiguriert. Der Verbraucher kann dann entweder verwenden Service BridgeTransformationen oder diese Methode zum Aktualisieren der Werte dieser virtuellen Felder im zugehörigen Zielaufgabendatensatz.  
Im folgenden Abschnitt wird ein Beispielanwendungsfall beschrieben, wie virtuelle Felder implementiert und dann verwendet werden UpdateVirtualField() Methode zum Ausfüllen von Werten im virtuellen Feld. In diesem Beispiel sind die beiden Aufgabentabellen, die durch eine Remote-Aufgabendefinition verbunden sind, die Anbieterfalltabelle und die Verbraucherincidenttabelle. Wenn ein Incident-Datensatz in der Verbraucherinstanz erstellt oder aktualisiert wird, ist er so konfiguriert, dass er mit der Anbieterfalltabelle synchronisiert wird. Das Feld „Betroffene Instanzen" in der Falltabelle ist ein Pflichtfeld, ist jedoch in der Incident-Tabelle nicht vorhanden. Zur Behandlung dieser Situation muss das Feld „Betroffene Instanzen" in der eingehenden Zuordnung der zugehörigen Remote-Aufgabendefinition als virtuelles Feld definiert werden.

1. Der Anbieter erstellt eine Remote-Aufgabendefinition für die Anbieterfalltabelle und die Verbraucherincidenttabelle.
2. Auf Eingehende Felder Registerkarte in Zugehörige Links Der Remote-Aufgabendefinition ordnet der Anbieter die Felder zwischen der Incident-Tabelle und der Falltabelle zu.  
   Beim Definieren des Felds „Betroffene Instanzen" wählt der Anbieter aus Virtuell Kontrollkästchen und wählt dann aus Betroffene Instanzen Von Zielfeld Auf Zielzuordnung Registerkarte.  
   Hinweis:  
   Beim Definieren eines virtuellen Felds wird kein Quellfeld definiert, da es nicht vorhanden ist.
3. Der Anbieter veröffentlicht dann die Remote-Aufgabendefinition, die mit der Verbraucherinstanz synchronisiert wird.
4. Der Verbraucher erstellt eine Remote-Aufgabe 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, ist in einem Formularabschnitt in der Remote-Aufgabe enthalten.
5. Die Verbraucherinstanz ruft auf UpdateVirtualField() Methode, z. B. in einer Business-Regel, die ausgeführt wird, wenn Datensätze in der Incident-Tabelle aktualisiert werden, zum Festlegen der Werte des Felds „Betroffene Instanzen" in der Remoteaufgabe.  
   Hinweis:  
   Auch wenn Sie Daten in der Zieltabelle jederzeit ausfüllen können, müssen Pflichtfelder, die als virtuelle Felder konfiguriert sind, in der Remote-Aufgabe ausgefüllt werden, bevor die Remote-Aufgabe an die Erstellerinstanz gesendet wird.
6. Die Remote-Aufgabe wird mit der Anbieterinstanz synchronisiert und erstellt einen Falldatensatz in der Anbieterinstanz.
{#updateVirtualField_GR_S_S_S__ul_h45_dvq_dzb}

Informationen zum Erstellen einer Remote-Aufgabendefinition finden Sie unter [Create remote task definitions in Service Exchange for Providers](https://www.servicenow.com/docs/access?context=service-bridge-v2-create-remote-tasks-defs&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US).

Für Informationen zum Erstellen von Service BridgeTransformieren, siehe [Transform data with the Service Exchange transform framework](https://www.servicenow.com/docs/access?context=service-bridge-v2-transform-about&version=yokohama&pubname=yokohama-service-exchange&ft:locale=en-US).  
Warnung:  
Sie sollten diese Methode nur in einer vor-Business-Regel aufrufen, da sie die Remote-Aufgabe aktualisiert, für die sie aufgerufen wird. Wenn Sie diese Methode in einer After-Business-Regel aufrufen, müssen Sie strikte Bedingungen festlegen, die verhindern, dass die Aktualisierung des virtuellen Felds in der Remote-Aufgabe die Business-Regel auslöst, da dies zu einer Endlosschleife führen kann.
{#updateVirtualField_GR_S_S_S__table_l1v_jpm_dzb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| RemoteTaskGr | GlideRecord | GlideRecord-Objekt der Remote-Aufgabe, für die die angegebenen virtuellen Feldwerte festgelegt werden sollen. |
| VirtualField | Zeichenfolge | Feldname Des virtuellen Felds, für das die Zuordnungsinformationen aktualisiert werden sollen. Definiert auf Ausgehende Felder Zugehörige Registerkarte der zugehörigen Remote-Aufgabendefinition. |
| Virtueller Wert | 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 : 9. Parameter]

{#updateVirtualField_GR_S_S_S__table_l1v_jpm_dzb} {#updateVirtualField_GR_S_S_S__table_m1v_jpm_dzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 10. Rückgaben]

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


