PSBPublicAPIUtil : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’include de script PSBPublicAPIUtil fournit des méthodes qui vous permettent d’effectuer des opérations sur Pont de services les enregistrements de configuration.

    Il existe deux types d’enregistrements de configuration sur lesquels vous pouvez effectuer des opérations à l’aide de Pont de services ce script :
    • Créateurs d’enregistrements distants (RRP)
    • Définition de la tâche distante (RTD)
    Vous pouvez effectuer l’une des opérations suivantes Pont de services sur ces enregistrements de configuration :
    • Sortie : crée une version brouillon d’un enregistrement de configuration spécifié. Toute version publiée est toujours disponible pour l’utilisation du client.
    • Publier : publie la version brouillon d’un enregistrement de configuration spécifié et le met à la disposition du client.
    • Archiver : archive une version inactive d’un enregistrement de configuration spécifié et le rend indisponible pour les clients.
    • Mettre hors service : met hors service toutes les versions d’un enregistrement de configuration spécifié et les rend indisponibles pour les clients.

    Pour plus d’informations sur les enregistrements de configuration, reportez-vous Pont de services à la section Create configuration revisions.

    Pour accéder à cette API, l’application Pont de services For Providers (sn_sb_pro) et l’application Pont de services Base (sn_sb) doivent être installées sur votre instance.

    Vous appelez les méthodes de cette API à l’aide du script include sb . Le code de ces méthodes, cependant, réside dans l’include de script PSBPublicAPIUtil .

    Lors de l’appel de ces méthodes à partir du périmètre global, utilisez la syntaxe suivante :
    sb.checkout(glideRecord);
sb.publish(glideRecord);
sb.archive(glideRecord);
sb.retire(glideRecord);
    Lorsque vous les appelez à partir d’une application incluse dans le périmètre, utilisez la syntaxe suivante :
    global.sb.checkout(glideRecord);
global.sb.publish(glideRecord);
global.sb.archive(glideRecord);
global.sb.retire(glideRecord);

    PSBPublicAPIUtil : archive(glideRecord)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement est dans l’état « inactif ». Si cette validation réussit, archive l’enregistrement de configuration spécifié, laissant toutes les autres versions du même enregistrement de configuration intactes.

    Pour plus d’informations sur les révisions de configuration et leurs états associés, reportez-vous à la section Create configuration revisions.

    Tableau 1. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à archiver.
    Cet enregistrement peut être l’un des suivants :
    • Créateurs d’enregistrement distants (RRP) : enregistrements situés dans la table Créateur d’enregistrement distant [sn_sb_pro_remote_record_producer].
    • Définition de tâche distante (RTD) : enregistrements situés dans la table de définition de tâche distante [sn_sb_pro_remote_task_def].
    Tableau 2. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’enregistrement de configuration a été archivé.
    Valeurs possibles :
    • true : l’enregistrement de configuration a été archivé.
    • false : une erreur s’est produite ; L’enregistrement de configuration n’a pas été archivé.

    L’exemple de code suivant montre comment appeler cette méthode à partir du champ d’application global sur un enregistrement de configuration FDS.

    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)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement se trouve à l’état « publié ». Si cette validation réussit, une nouvelle version de l’enregistrement de configuration spécifié est créée et le champ État est défini sur « Brouillon ».

    Tableau 3. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à contrôler.
    Cet enregistrement peut être l’un des suivants :
    • Créateurs d’enregistrement distants (RRP) : enregistrements situés dans la table Créateur d’enregistrement distant [sn_sb_pro_remote_record_producer].
    • Définition de tâche distante (RTD) : enregistrements situés dans la table de définition de tâche distante [sn_sb_pro_remote_task_def].
    Tableau 4. Renvoie
    Type Description
    GlideRecord En cas de réussite, renvoie l’enregistrement de configuration nouvellement créé avec le champ d’état défini sur « Brouillon ».

    Si une erreur s’est produite, renvoie null.

    L’exemple de code suivant montre comment appeler cette méthode à partir du champ d’application global sur un enregistrement de configuration RTD.

    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 : publier (glideRecord)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement se trouve à l’état « brouillon ». Si cette validation réussit, la version brouillon de l’enregistrement de configuration est publiée.

    Tableau 5. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à publier.
    Cet enregistrement peut être l’un des suivants :
    • Créateurs d’enregistrement distants (RRP) : enregistrements situés dans la table Créateur d’enregistrement distant [sn_sb_pro_remote_record_producer].
    • Définition de tâche distante (RTD) : enregistrements situés dans la table de définition de tâche distante [sn_sb_pro_remote_task_def].
    Tableau 6. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’enregistrement de configuration a été publié.
    Valeurs possibles :
    • vrai : l’enregistrement de configuration a été publié.
    • false : une erreur s’est produite ; L’enregistrement de configuration n’a pas été publié.

    L’exemple de code suivant montre comment appeler cette méthode à partir du champ d’application global sur un enregistrement de configuration RRP.

    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)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement se trouve dans un état valide. Si cette validation réussit, la version spécifiée de l’enregistrement de configuration est mise hors service ainsi que toutes les autres révisions de ce même enregistrement de configuration.

    Pour plus d’informations sur les révisions de configuration et leurs états associés, reportez-vous à la section Create configuration revisions.

    Tableau 7. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à mettre hors service.
    Cet enregistrement peut être l’un des suivants :
    • Créateurs d’enregistrement distants (RRP) : enregistrements situés dans la table Créateur d’enregistrement distant [sn_sb_pro_remote_record_producer].
    • Définition de tâche distante (RTD) : enregistrements situés dans la table de définition de tâche distante [sn_sb_pro_remote_task_def].
    Tableau 8. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’enregistrement de configuration a été mis hors service.
    Valeurs possibles :
    • vrai : l’enregistrement de configuration a été mis hors service.
    • false : une erreur s’est produite ; L’enregistrement de configuration n’a pas été mis hors service.

    L’exemple de code suivant montre comment appeler cette méthode à partir du champ d’application global sur un enregistrement de configuration RTD.

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