Fonctions disponibles dans le code global et le Intégrable au web code de composant

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 3 minutes de lecture

    • ServiceNow L’API Embeddables vous permet d’intégrer ServiceNow des composants dans vos sites web externes. Ces fonctions fournissent des fonctionnalités essentielles pour l’initialisation, l’authentification, la gestion des composants et la gestion des événements.

    Code global

    Le script incorporé inclut les méthodes suivantes dans le cadre du code global. Les détails suivants vous aident à comprendre leur fonctionnement.
    Méthode d’initialisation
    • Objectif : initialise le cadre de travail des intégrables avec les paramètres de configuration.
    • Modèle d’utilisation : 
      await init({
	theme: 'fad87d2ca304121029a4d1aed31e610f', //sys_id of theme,
	baseURL: 'https://demo.servicenow.com',
	authCallback: getTokenCallBack, // Authentication callback function 
       locale: 'ja', // Language/locale for components
       interceptSessionTimeout: true, // Handle session timeouts (default: true)
	// cacheComponents: [ //Pre-cache component for performance  "sn-embedx-case-form", "sn-embedx-case-list", "sn-embedx-case-view" ]
});
    • Paramètres :
      • authCallback (fonction) : renvoie le jeton d’authentification pour l’utilisateur actuel.
      • baseURL (chaîne) : URL de base de l’instance ServiceNow .
      • locale (chaîne, facultatif) : paramètre de langue/de paramètres régionaux (par exemple, « en », « es ») qui met à jour les préférences linguistiques de l’utilisateur pour ServiceNow l’utilisateur authentifié.
      • thème (chaîne) : sys_id du thème à appliquer.
      • interceptSessionTimeout (booléen, facultatif) : activez la gestion du délai d’expiration de session. Par défaut, elle est définie sur vrai.
      • cacheComponents (tableau, facultatif) : liste des noms de balises de composants à pré-mettre en cache.
    • Comportements clés :
      • Doit être appelé avant toute autre fonction intégrable.
      • Charge les ressources nécessaires et établit une connexion.
      • Configure éventuellement des intercepteurs pour la gestion des sessions.
      • Met à jour la préférence de langue de l’utilisateur authentifié si les paramètres régionaux sont fournis.
      • Pré-met en cache les composants spécifiés pour améliorer les performances.
    connexion()
    • Objectif : authentifie l’utilisateur avec l’instance ServiceNow .
    • Modèle d’utilisation :
      await login();
    • Comportements clés :
      • Appelle la fonction authCallback fournie lors de l’initialisation.
      • S’authentifie avec le jeton renvoyé : Répartit l’événement SN_EMBEDDABLES_LOGIN_SUCCESS en cas de réussite.
    • Prérequis : init() doit d’abord être appelé avec un authCallback valide - la fonction authCallback doit renvoyer un jeton d’authentification valide.
    déconnexion()
    • Objectif : Déconnecte l’utilisateur de ServiceNow la session.
    • Modèle d’utilisation : 
      await logout();
    • Comportements clés : Répartit l’événement SN_EMBEDDABLES_LOGOUT_SUCCESS en cas de réussite.
    • Prérequis : init() doit être appelé en premier avec une baseURL valide - L’utilisateur doit être connecté.

    Code de composant

    Le script incorporé inclut les méthodes suivantes dans le cadre du code de composant. Les détails suivants vous aident à comprendre leur fonctionnement.
    getEmbeddables
    • Objectif : Charge et initialise les composants intégrables spécifiés.
    • Modèle d’utilisation : 
      // Load components by providing array of component tag names
getEmbeddables(["sn-embedx-case-view", "sn-embedx-case-form"]);
    • Paramètres : composants (tableau) : tableau de noms de balises de composants à charger
    setProperties(componentElement, propriétés)
    • Objectif : Définit les propriétés sur les instances de composants intégrables.
    • Modèle d’utilisation :
      const caseViewComponent = document.querySelector('sn-embedx-case-view');
setProperties(snEmbedxCaseView,{
		table:sn_customerservice_case,
		sysId:221a69cd3b411300b5c42479b3efc480,
		playbookExperience:playbookExperience,
		selectedPlaybookContextId:85d9f349ff766210e9d3ffffffffffce,
		selectedStageContextId:9da56770ff7a2210e9d3ffffffffffd9,
		selectedActivityContextId:5d8bf1805d8bf8205d8b54d05d8be070 });
    • Paramètres : componentElm (HTMLElement) : L’élément DOM de composant - properties (Object) : paires clé-valeur de propriétés à définir.
    setEvents (componentElement, eventHandlers)
    • Objectif : Joint des écouteurs d’événements à des composants intégrables.
    • Modèle d’utilisation : 
      const caseViewComponent = document.querySelector('sn-embedx-case-view');
const eventHandlers = {'
'SN_EMBEDX_CASE_VIEW#COMPONENT_READY': (e) => { 
console.log('Component is ready and usable'); }, 
'SN_EMBEDX_CASE_VIEW#COMPONENT_ERROR': (e) => { const 
{ errorMessage, errorType } = e.detail.payload;
console.log('Component error:', errorMessage, errorType); },
};
setEvents(caseViewComponent, eventHandlers);
    • Paramètres : componentElm (élément HTML) : élément DOM de composant - eventHandlers (Objet) : paires clé-valeur où les clés sont des noms d’événements et les valeurs sont des fonctions de gestionnaire.

    Considérations clés

    Voici quelques considérations clés pour vous aider à implémenter cela efficacement :
    • Assurez-vous d’appeler init() en premier. Il jette les bases de toutes les autres fonctions.
    • Utilisez des gestionnaires d’événements pour le cycle de vie du composant. Il surveille également l’état de préparation et les erreurs des composants.
    • Mettez en cache les composants fréquemment utilisés. Utilisez cacheComponents dans init() pour de meilleures performances.
    • Implémenter