ナレッジベースの連携

最終更新日:

Pendoのナレッジベースインテグレーションにより、リソースセンター内で状況に沿ったオンデマンドのヘルプをユーザーに提供できます。

サポート対象プロバイダー

現在サポートされているナレッジベースプロバイダーは次のとおりです。

  • Zendesk
  • Wordpress(WP Engineでホストされているサイトのみ)
  • HelpDocs
  • Helpscout
  • Swiftype
  • Algolia

サポートされていないプロバイダーを使用している場合は、営業担当者またはカスタマーサクセスマネージャーにお問い合わせください。

プロバイダー固有の機能

Pendoはプロバイダーに応じて、リソースセンター内の記事のレンダリングに関わるさまざまなレベルの機能に対応しています。インテグレーションはプロバイダーのAPIに大きく依存しているため、プロバイダーの許可する範囲でできる限り多くの機能を提供しています。

記事全文のレンダリング

full.png

  • Zendesk
  • Wordpress
    • WP Engineでホストされているサイトが必要です
    • サイトのパーマリンク設定をデフォルト以外に設定する必要があります。詳しくは、Wordpressのパーマリンクの使用の記事をご覧ください。

上記のプロバイダーについては、リソースセンター内の記事のレンダリングを完全にサポートしています。

部分的な記事のレンダリング

partial.png
  • HelpDocs
  • Helpscout
  • Swiftype

上記のプロバイダーについては、リソースセンター内の部分的な記事のレンダリングをサポートしています。部分的な記事のレンダリングとは、記事のプレビューを表示した後、その記事のウェブ版にリンクする[記事全文を読む(Read full article)]ボタンを追加することです。

*現在、Algoliaの記事のレンダリングには対応しておりません。検索した結果は常に新しいブラウザタブでウェブ版のコンテンツとして開かれます。

はじめに

config.png

ナレッジベースインテグレーションの設定は、[インテグレーション(Integrations)]で行うことができます。いずれかのタイルを選択すると、設定ウィンドウが表示されます。

インテグレーションを初めて追加する

confirm.png

設定後、[インテグレーションを追加(Add integration)]>[はい、確定します(Yes, confirm)]を選択すると、ステージング環境でインテグレーションが有効になります。

本番環境へステージング設定を公開する

publish.png

適切に追加または保存すると、本番環境にインテグレーションを公開するオプションが表示されます。[本番環境に公開(publish to production)]を選択すると、本番環境でのインテグレーションが有効になります。

インテグレーションを無効化する

disable.png

インテグレーションを無効にするには、設定ウィンドウの右上隅にある[オン/オフ(On - Off)]トグルを切り替えます。

注:ステージング設定を本番環境に公開する前に、ステージング環境でインテグレーションを無効にする必要があります。無効化したステージングインテグレーションを本番環境に公開すると、本番環境のインテグレーションが無効になります。

設定オプション

状況に即したヘルプ

contextualHelp.png

お勧めの記事のパス

ユーザーに表示されるコンテンツがコンテキストに沿ったものであることを確認してください。

ここで設定する数値は、ユーザーが表示しているページのURLのセクションに対応します。お勧めの結果を生成する際、URLのそのセクションの値を使用します。以下はその例です。

お勧めの記事のパス:1 
URL: https://acmecorp.com/foo/bar/abc 
結果:お勧めの記事を取得する際、"foo"という語を使用します。

お勧めの記事のパス:2 
URL: https://acmecorp.com/foo/bar/abc 
結果:お勧めの記事を取得する際、"bar"という語を使用します。

お勧めの記事のパス:3 
URL: https://acmecorp.com/foo/bar/abc 
結果:お勧めの記事を取得する際、"abc"という語を使用します。

パスを組み合わせる

パスの組み合わせが有効になっている場合、上で設定したお勧めの記事のパスを含む使用可能なすべてのURLセクションを組み合わせます。以下はその例です。

お勧めの記事のパス: 2 
URL: https://acmecorp.com/foo/bar/abc 
結果:お勧めの記事を取得する際、"foo""bar"という語を使用します。

お勧めの記事のパス:3 
URL: https://acmecorp.com/foo/bar/abc 
結果:お勧めの記事を取得する際、"foo""bar""abc"という語を使用します。

注:パスを組み合わせるオプションを使用する場合、?(クエリ文字列)の後はすべて無視します。

人気の高いトピックの文字列

お勧めの記事に使われた検索語で何も一致しなかった場合、エンドユーザーに任意でメッセージを表示できます。この設定ボックスに入力した内容がエンドユーザーに表示されます。

詳細オプション

Bearerトークン(Zendeskレガシーインテグレーション)

注:この機能は、新しいZendeskヘルプセンターインテグレーションに置き換えられました。Zendeskインテグレーションの実装方法などの詳細については、Zendeskヘルプセンターインテグレーションの概要を参照してください。

セキュリティで保護したナレッジベースがある場合(ユーザーがヘルプドキュメントにアクセスするにはログインが必要)、ユーザーがコンテンツを検索できるようにBearerトークンを提供する必要があります。ナレッジベースにログインが不要な場合は、このオプションを設定する必要はありません。

詳しくは、Zendeskの記事アプリケーションでのOAuth認証の使用を参照してください。

カスタムクラス

警告:カスタムクラス設定グループは、高度なカスタマイズを行ったガイドセンターで使用するためのものです。Pendoのテクニカルサクセスチームの支援なしで変更しないでください。デフォルトのスライドやアコーディオン式テンプレートを使用している場合は、そのままにしておいてください。

非常に複雑なカスタマイズを行ったリソースセンターを利用する必要がある場合は、Pendoサポートにご連絡の上、インテグレーション機能を意図したとおりに動作させるための手順をお尋ねください。

スタイル

ナレッジベースインテグレーションの内部で表示されるスタイルをカスタマイズする場合は、詳細オプションセクションの最下部にあるスタイルシートをアップロードします。こちらのスターターcssファイルを開いて、インテグレーションで使用されるすべてのクラスにアクセスします。カスタムスタイルをこれらのクラスに追加してアップロードしてください。

分析

パラメータ化されたURLフィーチャーを使用することで、Pendoは次の指標を取得して表示できます。

  • どの訪問者とアカウントがコンテンツを検索しているか
  • 検索結果につながるコンテンツの検索に使用されているキーワード
  • 検索結果が出ないキーワード
  • どの記事が閲覧されているか

これらの分析を設定するには、次の手順に従ってください。

ページルールを作成する

pageRule.png

以下は、分析の収集に必要な4つのページルールです。注意点として、Pendoサブスクリプションに4つの新しいページを作成する必要があり、各ページには以下に指定するページルールのみが含まれています。

名前:お勧めの結果(Suggested Results)//*/search/suggested-results/*parameter*

名前:検索結果(Search Results)//*/search/results/*parameter*

名前:結果なし(No Results)//*/search/no-results/*parameter*

名前:記事(Articles)//*/article/*parameter*

ヒント:「ナレッジベースインテグレーション(Knowledge Base Integration)」というプロダクトエリアを作成して、これらのルールを追加します。

トラブルシューティング

Zendeskのナレッジベースの画像が読み込まれない

この問題は、新しいZendeskヘルプセンターインテグレーションにより解決されました。詳細については、Zendeskヘルプセンターインテグレーションの概要を参照してください。

リソースセンターのKBインテグレーションからAlgoliaのリンクを開くと、「エラー:アクセスが拒否されました(Error: Access Denied)」と表示される。

リンクを記事につなぐために、相対パス(/param1/param2/param3など)を実装している可能性があります。これを解決するには、たとえば、https://www.domain.com/param1/param2/param3のように、記事のURLとして完全なドメインを含めます。Algoliaのサイトにアクセスし、[Search]>[Configure]>[Index]に移動します。次に、記事の一覧でURLを編集し、完全なパスを含めるようにします。

よくある質問

ナレッジベースの検索とPendoガイドの検索を組み合わせることはできますか?

いいえ、現時点ではできません。

URLの一部を利用する以外に、お勧めの記事のクエリを決定する方法はありますか?

URLの利用は、お勧めの記事を決定するために唯一サポートされている方法です。

この記事は役に立ちましたか?
27人中13人がこの記事が役に立ったと言っています