Configurer l’instance de composant d’affichage d’article de la base de connaissances

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 5 minutes de lecture
  • Configurez l’instance du composant d’affichage d’article de la base de connaissances afin que vos utilisateurs puissent l’intégrer sur leur site web pour accéder directement aux articles de la base de connaissances de leur site web.

    Avant de commencer

    Vous devez disposer de la configuration suivante pour configurer l’instance du composant d’affichage d’article de la base de connaissances :

    Rôle requis : sn_embeddable_core.emb_admin

    Procédure

    1. Accédez à la Tous > Intégrables Web > Page d'accueil.
    2. Sur la page d’accueil, sélectionnez Créer un module ou utilisez le module existant.
      Pour plus d’informations sur la création d’un nouveau module, reportez-vous à la section Créer un module.
    3. Sur la page du module, dans l’onglet Composants, ajoutez une instance de composant d’affichage d’article de la base de connaissances à un groupe existant ou nouveau.
      Pour plus d’informations sur la création d’un groupe, puis sur l’ajout d’une instance de composant, reportez-vous à la section Créer un groupe et ajouter une instance de composant.
    4. Facultatif : Activez l’option Afficher l’aperçu statique pour afficher une représentation visuelle d’un composant lorsqu’un aperçu en direct n’est pas disponible.
      Remarque :
      Lorsque cette option est activée, les changements apportés aux propriétés globales ou aux propriétés de composant n’apparaissent pas dans l’onglet Aperçu en temps réel.
    5. Configurez les propriétés d’instance du composant d’affichage d’article de la base de connaissances.
    6. Sélectionnez l’onglet Règles CORS pour configurer les règles CORS.
    7. Sélectionnez l’onglet Composants .
      Si un message s’affiche sur le périmètre de l’application, remplacez le périmètre par Composants Web pour que le Service clientèle puisse modifier l’enregistrement.
    8. Sélectionnez Obtenir du code intégré.
      Une fenêtre contextuelle apparaît pour afficher à la fois le code global et le code de composant.
    9. Dans l’onglet Code global, examinez le code généré et sélectionnez Copier le code global.
      Le code global ne doit être ajouté qu’une seule fois à votre page Web tierce.
      import { init, login, logout, startGuestSession } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';
      
      await init({
          theme: 'fad87d2ca304121029a4d1aed31e610f',  /* sys_id of the theme to use for the embeddable components in your website */
          baseURL: 'https://demo.servicenow.com', /* Base URL of the instance to be used for the embeddable components in your website */
          authCallback: getTokenCallBack, /* Function which returns the auth token for the current user, required for auth setup */
          module: '591800ffc1243610f87714367ed47c6a', /* Demo module */
          pageName: document.title, /* Uses the browser's document title as the page name in User analytics experience */
          guestTokenCallback: getGuestJWTTokenCallBack, /* Function which returns the guest token for the current user, required for guest validation setup */
          cacheComponents: [] /* Pre-caches resources for improved performance. Update component list as per your usage */
      });
      
      function getTokenCallBack() {
          var idToken; /* Get the id token for the current user */
          return Promise.resolve(idToken);
      }
      
      function getGuestJWTTokenCallBack() {
          var guestToken; /* Get the guest token for the current user */
          return Promise.resolve(guestToken);
      }
      
      /* Uncomment below function to handle guest session */
      // await startGuestSession();
      
      /* Uncomment below functions to handle login and logout once the user logs into your website */
      // await login();
      // await logout();
    10. Facultatif : Dans l’onglet Code de composant, faites glisser le commutateur Activer le gestionnaire d’événements pour gérer les événements déclenchés par les interactions de l’utilisateur sur la page Web.
      Remarque :
      L’activation du gestionnaire d’événements modifie également le code de composant. Pour plus d’informations sur les gestionnaires d’événements dans , reportez-vous Gestionnaire d’événements dans le composant d’affichage d’article de la base de connaissancesà Intégrable au web.
    11. Dans l’onglet Code de composant, examinez le code généré et sélectionnez Copier le code de composant.
      Ce code généré inclut également des gestionnaires d’événements.
      <!--  
          Module: Demo module
          Group: Group 1
          Instance: Knowledge article view 1
      -->
      <sn-embedx-kb-article-view record-id="9d25b5b8dbd92200d75270f5bf96198b"></sn-embedx-kb-article-view>
      <!--
       The component also includes the following additional properties:
       hide-header
       hide-language-selector
       hide-author-information
       hide-reading-time
       hide-last-updated
       hide-view-count
       hide-average-rating
       hide-attachments
       hide-helpful-option
       hide-article-rating
       disable-displaying-latest-article-version
       hide-errors
       hide-notifications
      -->
      
      <script type="module">
      	import { getEmbeddables, setEvents, setProperties } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';
      	
      	const snEmbedxKbArticleView = document.querySelector('sn-embedx-kb-article-view');
      
      	getEmbeddables(["sn-embedx-kb-article-view"]);
      
      	const eventHandlers = {
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#BACK_BUTTON_CLICKED' : (e) => {
      			// Event for back button clicked on mobile variant of knowledge article view.
      			//Redirect to the knowledge browse page
      			open('/knowledgebrowse', '_self');
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#RATING_CLICKED' : (e) => {
      			// This event is dispatched when rating is provided for the article
      			var {rating} = e.detail.payload;
      			console.log(rating);
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#LANGUAGE_DROPDOWN_CLICKED' : (e) => {
      			// This event is dispatched when language dropdown selection is clicked
      			var {articleID} = e.detail.payload;
      
      			// Set properties for the knowledge article view
      			setProperties(snEmbedxKbArticleView, {recordId: articleID});
      			
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#NOTIFICATION_LINK_CLICKED' : (e) => {
      			// This event is dispatched when link present on notification has been clicked
      			var {table, sys_id} = e.detail.payload;
      
      			if(table == 'kb_knowledge') {
      				// Set properties for the knowledge article view
      				setProperties(snEmbedxKbArticleView, {recordId: sys_id});
      			}
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#COMPONENT_READY' : (e) => {
      			// This event is dispatched when a component is ready and usable.
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#COMPONENT_ERROR' : (e) => {
      			// This event is dispatched when a property validation or internal error occurs.
      			var {errorMessage, errorType} = e.detail.payload;
      			console.log(errorMessage, errorType);
      		},
      		'SN_EMBEDX_KNOWLEDGE_ARTICLE_VIEW#LINK_CLICKED' : (e) => {
      			// This event is dispatched when a record link has been clicked inside article body
      			var {table, sys_id} = e.detail.payload;
      			console.log(table, sys_id);
      		}
      	};
      
      	setEvents(snEmbedxKbArticleView, eventHandlers);
      </script>
      

    Résultats

    Les codes globaux et de composant sont prêts à être partagés avec l’administrateur tiers pour intégrer l’instance du composant d’affichage d’article de la base de connaissances sur leur site Web tiers.

    Que faire ensuite

    Incorporer l’instance de composant Vue d’article de la base de connaissances sur le site web tiers