ナレッジベースの連携

概要

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

注:ナレッジベースインテグレーションを利用する場合は、ガイドセンターの「スライド」テンプレートを使用することをお勧めします。リソースセンターの表示寸法を拡大することで、エンドユーザーがコンテンツを閲覧しやすくなります。

 

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

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

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

サポート対象外のプロバイダーをご利用の場合は、そのプロバイダーのサポートを検討させていただきます。詳細については、営業担当者またはカスタマーサクセスマネージャーにお問い合わせください。

プロバイダー固有の機能

Pendoはプロバイダーに応じて、リソースセンター内の記事のレンダリングに関わるさまざまなレベルの機能に対応しています。すべてのプロバイダーを全面的にサポートするのが理想ですが、残念ながら実現できていません。インテグレーションはプロバイダーのAPIに大きく依存しているため、プロバイダーの許可する範囲でできる限り多くの機能を提供しています。

記事全文のレンダリング

full.png
  • Zendesk
  • Wordpress(以下の要件を参照)

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

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

partial.png
  • HelpDocs
  • Helpscout
  • Swiftype

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

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

はじめに

config.png

ナレッジベースインテグレーションは、Pendoのインテグレーションページのこちらで設定できます。いずれかのタイルをクリックすると、設定オプションのある設定ウィンドウが表示されます。

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

confirm.png

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

本番環境へのステージング設定の公開

publish.png

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

インテグレーションの無効化

disable.png

何らかの理由でインテグレーションを無効にする必要がある場合は、設定ウィンドウの右上にある[オン - オフ(On - Off)]スイッチを切り替えて無効にします。

 

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

 

設定オプション

状況に即したヘルプ

contextualHelp.png

ナレッジベースで非常に重要なのは、ユーザーに提示するコンテンツを必ず状況に即したものにすることです。Pendoのナレッジベースインテグレーションは、まさにそれを実現します。

お勧めの記事のパス

ここで設定する数値は、ユーザーが表示しているページの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ヘルプセンターインテグレーションに置き換えられました。インテグレーションと導入方法について、詳しくはこちらをご覧ください。

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

このオプションの設定方法については、Zendeskのドキュメントを参照してください

カスタムクラス

 

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

 

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

スタイル

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

分析

Pendoは、パラメータ化されたURL機能を使用することで、コンテンツを検索している訪問者とアカウント、コンテンツの検索に使われたキーワードで結果を得られたもの、結果が得られなかったキーワード、閲覧された記事といった指標を取得し、表示します。これらの分析を設定するには、次の手順に従ってください。

 

ページルールを作成する

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)」という名前のグループを作成し、これらのルールをグループに追加してください。

 

よくある質問

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

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

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

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

ナレッジベースの画像が読み込まれないのはなぜですか(Zendesk)?

注:この問題は、新しいZendeskヘルプセンターインテグレーションにより解決されました。インテグレーションと導入方法について、詳しくはこちらをご覧ください。

画像が読み込まれない最も一般的な理由は、ヘルプセンターの記事に画像が追加される方法、およびその画像の閲覧に認証が必要かどうかということにあります。ヘルプセンターが制限されている場合、あるいは独自のシングルサインオン(SSO)ソリューションでヘルプセンターの認証を設定している場合は、これらの画像が破損して表示されることがあります。

Pendo Zendeskナレッジベースインテグレーションで画像が破損する場合は、画像がログインの壁の向こうでホストされている可能性があります。それが問題の原因かどうかがわからない場合は、ブラウザのコンソールを開いて、「リソースの読み込みに失敗しました(Failed to load resource)」というエラーが出ていないか確認してください。エラーが表示されている場合、それが画像の破損の原因です。

画像の破損を回避するには、Zendeskヘルプセンターの記事アセット(画像)をZendesk以外の場所でホストし、記事内からそれらのリソースにリンクを貼ります。