ナレッジ記事ビューコンポーネントインスタンスの構成
ナレッジ記事ビューコンポーネントインスタンスを構成して、ユーザーが Web サイトに埋め込み、Web サイトからナレッジ記事に直接アクセスできるようにします。
始める前に
ナレッジ記事ビューコンポーネントインスタンスを構成するには、次のセットアップが必要です。
- インスタンスで Web 埋め込み可能 を有効にします。詳細については、「Web 埋め込み可能 のアクティブ化」を参照してください。
- カスタム URL をインスタンス URL として設定。
- OpenID Connect (OIDC) 認証または非 OIDC 認証を使用して、 ServiceNow コンポーネントを認証します。詳細については、「OIDC を使用した ServiceNow コンポーネントの認証」と「ServiceNow コンポーネントの非 OIDC 認証」を参照してください。
必要なロール:sn_embeddable_core.emb_admin
手順
- 移動先 すべて > Web 埋め込み可能 > ホームページ.
-
ホームページで、[モジュールの作成] を選択するか、既存のモジュールを使用します。
新しいモジュールの作成の詳細については、「 モジュールを作成」を参照してください。
-
モジュールページの [コンポーネント] タブで、ナレッジ記事ビューコンポーネントインスタンスを既存または新規のグループに追加します。
グループを作成してからコンポーネントインスタンスを追加する方法の詳細については、「 グループの作成とコンポーネントインスタンスの追加」を参照してください。
- オプション:
[ 静的プレビューを表示 ] オプションを切り替えて、ライブプレビューが利用できないときにコンポーネントの視覚的表現を表示します。
注:有効にすると、グローバルプロパティまたはコンポーネントプロパティへの変更は [プレビュー] タブにリアルタイムで表示されません。
-
ナレッジ記事ビューコンポーネントのインスタンスプロパティを設定します。
- [プレビュー] タブには、コンポーネントプロパティで設定された選択肢に従ってリアルタイムデータが表示されます。
- ナレッジ記事コンポーネントインスタンスに関連するコンポーネントプロパティの説明については、「 ナレッジ記事ビューのコンポーネントプロパティ」を参照してください。
-
[ CORS ルール ] タブを選択して、CORS ルールを構成します。
CORS ルールの構成の詳細については、「 ServiceNowコンポーネントを埋め込む前に CORS (クロスオリジンリソース共有) ルールを構成する」を参照してください。
-
[ コンポーネント ] タブを選択します。
アプリケーションスコープに関するメッセージが表示された場合は、スコープを [カスタマーサービスの Web コンポーネント ] に変更して、レコードを編集できるようにします。
-
[埋め込みコードの取得] を選択します。
グローバルコードとコンポーネントコードの両方を表示するポップアップウィンドウが表示されます。
-
[グローバル コード] タブで、生成されたコードを確認し、[ グローバル コードのコピー] を選択します。
グローバル コードは、サードパーティの 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(); - オプション:
[コンポーネント コード] タブで、[ イベント ハンドラーを有効にする ] 切り替えスイッチをスライドさせて、Web ページでのユーザー操作によってトリガーされたイベントを処理します。
注:イベントハンドラーを有効にすると、コンポーネントコードも変更されます。Web 埋め込み可能 におけるイベントハンドラーの詳細については、「ナレッジ記事ビューコンポーネントのイベントハンドラー」を参照してください。
-
[コンポーネントコード] タブで、生成されたコードを確認し、[コンポーネントコードをコピー (Copy component code)] を選択します。
この生成されたコードには、イベントハンドラーも含まれます。
<!-- 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>
タスクの結果
グローバルコードとコンポーネントコードをサードパーティアドミニストレーターと共有して、ナレッジ記事ビューコンポーネントインスタンスをサードパーティ Web サイトに埋め込む準備ができました。