PSBPublicAPIUtil: Bereichsbezogen, global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 4 Minuten Lesedauer
  • Die PSBPublicAPIUtil-Skripteinbindung stellt Methoden bereit, mit denen Sie Vorgänge für die Konfigurationsdatensätze Service Bridge durchführen können.

    Es gibt zwei Arten von Service Bridge -Konfigurationsdatensätzen, für die Sie mit dieser Skripteinbindung Vorgänge ausführen können:
    • 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.

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

    Um auf diese API zuzugreifen, müssen die Anwendungen 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);

    PSBPublicAPIUtil – 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:
    • 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. Ergebnisse
    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_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.archive(grConfig);

    PSBPublicAPIUtil – 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:
    • 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. Ergebnisse
    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);

    PSBPublicAPIUtil – 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:
    • 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. Ergebnisse
    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);

    PSBPublicAPIUtil – 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:
    • 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. Ergebnisse
    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);