ケースリストコンポーネントインスタンスの構成

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:8分
  • ユーザーが Web サイトに埋め込み、Web サイトからすべてのケースのリストに直接アクセスできるように、ケースリストコンポーネントのインスタンスを構成します。

    始める前に

    ケースリストコンポーネントのインスタンスを構成するには、次のセットアップが必要です。

    必要なロール:sn_embeddable_core.emb_admin

    手順

    1. 移動先 すべて > Web 埋め込み可能 > ホームページ.
    2. ホームページで、[モジュールの作成] を選択するか、既存のモジュールを使用します。
      新しいモジュールの作成の詳細については、「 モジュールを作成」を参照してください。
    3. モジュールページの [コンポーネント] タブで、ケースリストコンポーネントインスタンスを既存または新しいグループに追加します。
      グループを作成してからコンポーネントインスタンスを追加する方法の詳細については、「 グループの作成とコンポーネントインスタンスの追加」を参照してください。
    4. オプション: [ 静的プレビューを表示 ] オプションを切り替えて、ライブプレビューが利用できないときにコンポーネントの視覚的表現を表示します。
      注:
      有効にすると、グローバルプロパティまたはコンポーネントプロパティへの変更は [プレビュー] タブにリアルタイムで表示されません。
    5. ケースリストコンポーネントのインスタンスプロパティを設定します。
      • [プレビュー] タブには、コンポーネントプロパティで設定された選択肢に従ってリアルタイムデータが表示されます。
      • ケースリストコンポーネントインスタンスに関連するコンポーネントプロパティの説明については、「 ケースリストのコンポーネントプロパティ」を参照してください。
    6. [ CORS ルール ] タブを選択して、CORS ルールを構成します。
      CORS ルールの構成の詳細については、「 ServiceNowコンポーネントを埋め込む前に CORS (クロスオリジンリソース共有) ルールを構成する」を参照してください。
    7. [コンポーネント] タブを選択します。
      アプリケーションスコープに関するメッセージが表示された場合は、スコープを [カスタマーサービスの Web コンポーネント ] に変更して、レコードを編集できるようにします。
    8. [埋め込みコードの取得] を選択します。
      グローバルコードとコンポーネントコードの両方を表示するポップアップウィンドウが表示されます。
    9. [グローバル コード] タブで、生成されたコードを確認し、[ グローバル コードのコピー] を選択します。
      グローバル コードは、サードパーティの Web ページに一度だけ追加する必要があります。
      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. オプション: [コンポーネント コード] タブで、[ イベント ハンドラーを有効にする ] 切り替えスイッチをスライドさせて、Web ページでのユーザー操作によってトリガーされたイベントを処理します。
      注:
      イベントハンドラーを有効にすると、コンポーネントコードも変更されます。Web 埋め込み可能 におけるイベントハンドラーの詳細については、「ケースリストコンポーネントのイベントハンドラー」を参照してください。
    11. [コンポーネントコード] タブで、生成されたコードを確認し、[コンポーネントコードをコピー (Copy component code)] を選択します。
      この生成されたコードには、イベントハンドラーも含まれます。
      <!--  
          Module: Demo module
          Group: Group 1
          Instance: Case list 1
      -->
      <sn-embedx-case-list
      	table="sn_customerservice_case"
      	limit="20"
      	list-title="List of Cases"
      	query="state=10"
      	columns="number,short_description,sys_updated_on,state">
      </sn-embedx-case-list>
      <!--
       The component also includes the following additional properties:
       hide-header
       hide-last-refreshed-text
       hide-record-count
       hide-search
       hide-refresh
       show-filters
       hide-when-empty
       disable-column-resizing
       hide-errors
       view
      -->
      
      <script type="module">
      	import { getEmbeddables, setEvents, setProperties } from 'https://demo.servicenow.com/uxasset/externals/sn_embeddable_core/index.jsdbx';
      	
      	const snEmbedxCaseList = document.querySelector('sn-embedx-case-list');
      
      	getEmbeddables(["sn-embedx-case-list"]);
      
      	const eventHandlers = {
      		'SN_EMBEDX_CASE_LIST#RECORD_SELECTED' : (e) => {
      			// This event is dispatched when a record is selected.
      			var {table, record_sys_id} = e.detail.payload;
      			// the logic to construct the URL for the Case View component. Add your portal URL here.
      			const caseViewURL = '/caseview?emb_table='+table+'&emb_recordid='+record_sys_id;
      			// Redirect to the Case View component page
      			open(caseViewURL,'_self');
      		},
      		'SN_EMBEDX_CASE_LIST#COMPONENT_READY' : (e) => {
      			// This event is dispatched when a component is ready and usable.
      		},
      		'SN_EMBEDX_CASE_LIST#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(snEmbedxCaseList, eventHandlers);
      </script>
      

    タスクの結果

    グローバルコードとコンポーネントコードをサードパーティアドミニストレーターと共有して、ケースリストコンポーネントインスタンスをサードパーティ Web サイトに埋め込む準備ができました。

    次のタスク

    サードパーティ Web サイトへのケースリストコンポーネントインスタンスの埋め込み