Configurer l’instance de composant de l’élément de catalogue

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 5 minutes de lecture
  • Configurez l’instance du composant Élément de catalogue de sorte que vos utilisateurs puissent l’intégrer sur leur site Web pour demander un élément ou un service à partir de leur site Web.

    Avant de commencer

    Vous devez disposer de la configuration suivante pour configurer l’instance du composant de l’élément de catalogue :

    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 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’élément de catalogue à 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 de l’élément de catalogue.
      • L’onglet Aperçu affiche des données en temps réel en fonction des choix définis dans les propriétés du composant.
      • Pour obtenir une description des propriétés du composant de l’élément de catalogue, reportez-vous à la section Propriétés des composants pour l’élément de catalogue.
    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 l’option Obtenir le 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’élément de catalogueà 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: Catalog item 1
      -->
      <sn-embedx-catalog-item-form
      	sys-id="56c62944c30102003d3b7bfaa2d3ae36"
      	confirmation-text="Request submitted successfully!"
      	confirmation-sub-text="Estimated resolution in 24 hours"
      	reference-number-label="Reference Number :"
      	primary-button-label="View details"
      	secondary-button-label="Browse services">
      </sn-embedx-catalog-item-form>
      <!--
       The component also includes the following additional properties:
       hide-reference-number
       hide-primary-button
       hide-secondary-button
       hide-record-created-confirmation
       hide-errors
       hide-notifications
      -->
      
      <script type="module">
      	import { getEmbeddables, setEvents, setProperties } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';
      	
      	const snEmbedxCatalogItemForm = document.querySelector('sn-embedx-catalog-item-form');
      
      	/* Uncomment this code for the default behaviour of the Catalog item component.
      
      	// Get the catalog item record id from the current URL.
      	// Optionally, get query to pre fill the form.
      	const currentURL = new URL(window.location.href);
      	const urlParams = new URLSearchParams(currentURL.search);
      	const account = urlParams.get('emb_account');
      	const preferred_language = urlParams.get('emb_preferred_language');
      	// Update the sysId of the component property.
      	// Optionally, update the prefill fields property
      	const prefillConfig = {
      			account: account,
      			preferred_language: preferred_language
      	};
      	setProperties(snEmbedxCatalogItemForm,{
      		prefillFields: prefillConfig
      	});
      */
      
      	getEmbeddables(["sn-embedx-catalog-item-form"]);
      
      	const eventHandlers = {
      		'SN_EMBEDX_CATALOG_ITEM_FORM#RECORD_CREATION_FAILED' : (e) => {
      			// This event is dispatched if the record creation has failed.
      		},
      		'SN_EMBEDX_CATALOG_ITEM_FORM#COMPONENT_NOTIFICATION_SENT' : (e) => {
      			// This event is dispatched when the component provides a notification for the end user.
      			var {items} = e.detail.payload;
      			console.log(items);
      		},
      		'SN_EMBEDX_CATALOG_ITEM_FORM#COMPONENT_READY' : (e) => {
      			// This event is dispatched when a component is ready and usable.
      		},
      		'SN_EMBEDX_CATALOG_ITEM_FORM#RECORD_CREATION_SUCCEEDED' : (e) => {
      			// This event is dispatched if the record was successfully created.
      			var {table, record_sys_id} = e.detail.payload;
      			console.log(table, record_sys_id);
      		},
      		'SN_EMBEDX_CATALOG_ITEM_FORM#BUTTON_CLICKED' : (e) => {
      			// This event is dispatched if any button is clicked on the confirmation message.
      			var {table, record_sys_id, button_variant} = e.detail.payload;
      			var primaryURL =  '/caseview'; // Replace with the URL of the case view page
      			var secondaryURL = '/browse'; // Replace with the URL of the secondary page
      
      			if(button_variant == 'primary') {
      				// Construct the URL for the Case View component with URL parameters
      				const caseViewURL = primaryURL+'?emb_table='+table+'&emb_recordid='+record_sys_id;
      				open(caseViewURL,'_self'); // Open case record when primary button is clicked
      			}
      			else {
      				// Open the Case View component in the same tab
      				open(secondaryURL,'_self');
      			}
      		},
      		'SN_EMBEDX_CATALOG_ITEM_FORM#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);
      		}
      	};
      
      	setEvents(snEmbedxCatalogItemForm, 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 de composant de l’élément de catalogue sur son site Web tiers.

    Que faire ensuite

    Incorporer l’instance du composant d’élément de catalogue sur le site Web tiers