sb : dans le champ d’application, global

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 9 minutes de lecture
  • L’include de script sb fournit des méthodes qui vous permettent d’effectuer des opérations sur Pont de services les enregistrements de configuration.

    Il existe trois types d’enregistrements de configuration sur lesquels vous pouvez effectuer des opérations à l’aide de Pont de services ce script include :
    • Synchronisation des données de base (FDS)
    • Créateurs d’enregistrement 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 :
    • Contrôler : crée une version brouillon d’un enregistrement de configuration spécifié. Toute version publiée est toujours disponible pour l’usage client.
    • Publier : publie la version brouillon d’un enregistrement de configuration spécifié et la 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.
    • Mettre à jour le champ virtuel : remplit les champs virtuels d’une table de tâches sur une instance cible lors de l’utilisation Pont de services de tâches à distance.

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

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

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

    Lorsque vous appelez 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 cette syntaxe :
    global.sb.checkout(glideRecord);
    global.sb.publish(glideRecord);
    global.sb.archive(glideRecord);
    global.sb.retire(glideRecord);

    sb : archive(glideRecord)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement est à l’état « inactif ». Si cette validation réussit, archive l’enregistrement de configuration spécifié, en laissant intactes toutes les autres versions du 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 1. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à archiver.
    Cet enregistrement peut être l’un des suivants :
    • Synchronisation des données de base (FDS) : enregistrements situés dans la table Offre fournisseur de données de base [sn_fds_pro_offering].
    • Créateurs d’enregistrements 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 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 :
    • vrai : l’enregistrement de configuration a été archivé.
    • faux : 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_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 : paiement (glideRecord)

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

    Tableau 3. Paramètres
    Nom Type Description
    glideRecord GlideRecord Enregistrement de configuration à vérifier.
    Cet enregistrement peut être l’un des suivants :
    • Synchronisation des données de base (FDS) : enregistrements situés dans la table Offre fournisseur de données de base [sn_fds_pro_offering].
    • Créateurs d’enregistrements 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 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);

    sb : publier (glideRecord)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement est à 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 :
    • Synchronisation des données de base (FDS) : enregistrements situés dans la table Offre fournisseur de données de base [sn_fds_pro_offering].
    • Créateurs d’enregistrements 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 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é.
    • faux : 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 périmètre 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);

    sb : mettre hors service (glideRecord)

    Valide que le GlideRecord spécifié est un enregistrement de configuration valide Pont de services et vérifie que l’enregistrement est dans un état valide. Si cette validation réussit, met hors service la version spécifiée de l’enregistrement de configuration 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 :
    • Synchronisation des données de base (FDS) : enregistrements situés dans la table Offre fournisseur de données de base [sn_fds_pro_offering].
    • Créateurs d’enregistrements 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 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.
    • faux : 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 périmètre 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);

    sb : updateVirtualField(GlideRecord remoteTaskGr, chaîne virtualField, chaîne virtualValue, chaîne virtualDisplayValue)

    Renseigne les champs virtuels d’une table de tâches sur une instance cible lors de l’utilisation Pont de services de tâches à distance.

    Un champ virtuel est un champ qui existe dans une table de tâches cible, mais qui n’existe pas dans la table de tâches source. Cette méthode permet de transmettre les valeurs d’un champ virtuel de l’instance source à l’instance cible. Cette méthode stocke les valeurs spécifiées pour le champ virtuel au format JSON dans la section de formulaire de la tâche distante spécifiée. Cette tâche distante est ensuite synchronisée avec l’instance cible où les valeurs sont stockées dans le champ mappé de la table de tâches cible.

    Les champs virtuels sont définis dans les définitions de tâches distantes. Les définitions de tâches distantes contiennent des tables de mappage entrantes et sortantes qui mappent les champs entre les tables de tâches dans les instances source et cible. Lorsqu’une table source ne contient pas de champ qui existe dans une table cible, le champ est configuré dans la définition de tâche distante en tant que champ virtuel. Le consommateur peut ensuite utiliser Pont de services des transformations ou cette méthode pour mettre à jour les valeurs de ces champs virtuels dans l’enregistrement de tâche cible associé.

    La section suivante décrit un exemple de cas d’utilisation sur la façon d’implémenter des champs virtuels, puis d’utiliser la méthode updateVirtualField() pour renseigner les valeurs du champ virtuel. Dans cet exemple, les deux tables de tâches liées par une définition de tâche distante sont la table Ticket fournisseur et la table Incident consommateur. Lorsqu’un enregistrement d’incident est créé ou mis à jour sur l’instance de consommateur, il est configuré pour se synchroniser avec la table de ticket du fournisseur. Le champ Instances affectées de la table Ticket est un champ obligatoire mais n’existe pas dans la table Incident. Pour gérer cette situation, le champ Instances affectées doit être défini comme un champ virtuel dans le mappage entrant de la définition de tâche distante associée.
    1. Le fournisseur crée une définition de tâche distante pour la table Ticket du fournisseur et la table Incident du consommateur.
    2. Dans l’onglet Champs entrants dans les liens connexes de la définition de tâche distante, le fournisseur mappe les champs entre la table Incident et la table Ticket.
      Lors de la définition du champ Instances affectées, le fournisseur coche la case Virtuel , puis sélectionne Instances affectées dans le champ Cible de l’onglet Mappage cible .
      Remarque :
      Lors de la définition d’un champ virtuel, aucun champ source n’est défini, car il n’existe pas.
    3. Le fournisseur publie ensuite la définition de tâche distante, qui est synchronisée avec l’instance du consommateur.
    4. Le consommateur crée une tâche à distance pour la table Incident. Une charge utile JSON qui contient toutes les valeurs des champs mappés, y compris les informations sur les champs virtuels, est incluse dans une section de formulaire dans la tâche distante.
    5. L’instance de consommateur appelle la méthode updateVirtualField(), comme dans une règle métier qui s’exécute lorsque les enregistrements de la table Incident sont mis à jour, pour définir les valeurs du champ Instances affectées dans la tâche distante.
      Remarque :
      Même si vous pouvez renseigner les données dans la table cible à tout moment, les champs obligatoires configurés en tant que champs virtuels doivent être renseignés dans la tâche distante avant que la tâche distante ne soit envoyée à l’instance du créateur.
    6. La tâche distante est synchronisée avec l’instance du fournisseur et crée un enregistrement de ticket sur l’instance du fournisseur.

    Pour en savoir plus sur la création d’une définition de tâche distante, reportez-vous à la section Create a remote task definition in Service Exchange for Providers.

    Pour en savoir plus sur la création d’une Pont de services transformation, reportez-vous à la section Transform data with the Service Exchange transform framework.

    Avertissement :
    Vous ne devez appeler cette méthode que dans une règle métier avant, car elle met à jour la tâche à distance pour laquelle elle est appelée. Si vous appelez cette méthode dans une règle post-métier, vous devez inclure des conditions strictes qui empêchent la mise à jour du champ virtuel sur la tâche distante de déclencher la règle métier, car cela peut provoquer une boucle infinie.
    Tableau 9. Paramètres
    Nom Type Description
    remoteTaskGr GlideRecord Objet GlideRecord de la tâche distante pour laquelle il faut définir les valeurs de champ virtuel spécifiées.
    champ virtuel Chaîne Nom du champ virtuel pour lequel les informations associées doivent être mises à jour. Définis dans l’onglet connexe Champs sortants de la définition de tâche distante associée.
    Valeur virtuelle Chaîne Valeur à définir pour ce champ sur l’instance cible.
    virtualDisplayValue Chaîne Valeur d’affichage à définir pour ce champ sur l’instance cible
    Tableau 10. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre comment appeler cette méthode.

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