Touchpointsのはじめかた
Touchpointsのはじめかた
最終更新日:2024年2月27日
対象製品:MindTouch(現行バージョン)|必要な権限:管理者
はじめに
Touchpoints(タッチポイント)は、さまざまなWebサイトやアプリケーションにExpertのヘルプコンテンツを埋め込むための、シンプルで直感的な統合機能です。
お使いのExpertライセンスパッケージにTouchpointsが含まれているか、またその数については、ご契約内容をご確認ください。含まれていない、または追加を希望する場合は、担当のカスタマーサクセスマネージャーにお問い合わせください。
Touchpointsの作成からブランド設定、埋め込みまでの流れは、以下のステップで案内されています:
-
Touchpointの作成、ブランディング、配置手順(全4ページ)
コンテキストヘルプの種類
Contextual Help、Embedded Contextual Help、Contextual Help Buttonは、いずれもExpert上のコンテンツを外部のWebサイトやアプリケーションに埋め込むためのTouchpointです。
-
Contextual HelpおよびContextual Help Buttonは、ポップアップウィンドウ内で記事を表示し、別タブやページ遷移を必要としません。
-
Embedded Contextual Helpは、対象ページ内に記事の内容を直接表示します。
これらのTouchpointを使えば、ユーザーが別ページに移動せずに必要な情報にアクセスできるため、サポート効率が向上します。
各Touchpointの特長
-
Contextual Help Touchpoint
CSSクラスセレクタに基づいて、指定リンク(例:カスタムボタンやアイコン)をコンテキストヘルプウィンドウで開く仕組みです。1つの埋め込みコードで、すべての対象リンクに適用されます。 -
Contextual Help Button / Embedded Contextual Help
特定のExpertページにリンクするための埋め込みコードで、再利用が可能です。ただし、それぞれ1ページへのリンクに限定されます。
上級統合機能(Advanced Integration Programming)を使用すれば、埋め込み先でリンク先ページを動的に変更することも可能です。
使用場面の使い分け
使用シーン | 推奨Touchpoint |
---|---|
多数のリンクを動的にコンテキストヘルプ化したい | Contextual Help |
ヘルプウィンドウではなく、ページ内で直接表示したい | Embedded Contextual Help |
決まった1ページへのリンクボタンを複数箇所に配置したい | Contextual Help Button |
Content IDは使えるか?
はい。Contextual Helpでは、任意のHTMLリンク(<a>
タグ)に指定されたCSSクラスを基に、href
属性の値に応じた記事をヘルプウィンドウで表示します。href
にContent IDのURLを設定すれば、対応する記事を読み込みます。
Touchpointsの埋め込みと統合
シングルページアプリケーション(SPA)でも使えるか?
はい。TouchpointsはSPAにも対応しています。
特にContextual Help Touchpointは、ドキュメント全体を対象としており、表示されていない部分も含めて、リンクがクリックされたタイミングでクラスを確認し、適切にページを読み込みます。手動で再読み込みやダイアログの起動を行う必要はありません。
唯一の要件は、対象リンクにTouchpointで指定したクラス名が設定されていることです。
ローカルアプリケーションでも使用可能か?
Touchpointsを使用するには、信頼されたホスト名の指定が必要です。これはCORS(クロスオリジンリソース共有)に基づく業界標準のセキュリティ対策です。
IPアドレスの指定は可能か?
いいえ。IPアドレスではなく信頼されたホスト名のみが許可されます。
Touchpointsで他にできることは?
複数のTouchpointを同じページに埋め込むことで、相互に通信・データ連携を行うことが可能です。これにより、単一のTouchpointでは実現できない複雑な統合処理も可能になります。
さらに、同じ通信機構を利用して、Expert以外のウィジェットやアプリケーションの要素との連携も可能です。
これらの高度な機能については、「Advanced Integration Programming with Touchpoints」を参照してください。
Touchpointsは安全か?使用されている技術は?
Touchpointsの仕組みやセキュリティについては、エンジニアリングチームによる解説ブログが用意されています。公開・非公開コンテンツの埋め込みが安全に行える理由についても詳しく説明されています。
Here are some interesting things about...