Parature サポート情報の検索コントロール (クライアント側の参照)

[アーティクル]
07/06/2017

公開日: 2016年11月

対象: Dynamics CRM 2015

Microsoft Dynamics CRM Online 2015 更新プログラム 1 またはそれ以降では、組織で Parature の統合が有効になっているとき、フォームに新しいサポート情報検索コントロールを追加できます。このコントロールは、このコントロールを使用するときにユーザーのエクスペリエンスを自動化または強化するプログラムのサポートを提供します。

重要

Microsoft Dynamics CRM Online 組織の場合、この機能は、組織が Dynamics CRM Online 2015 更新プログラム 1 に更新されている場合にのみ使用できます。この機能は内部設置型の Dynamics CRM では使用できません。

これらのイベントとメソッドは、Parature API には直接接続されません。ただし、このコントロールがフォームに存在する場合、Parature との接続はすでに確立されているはずなので、セキュリティトークンなしで、Parature API を直接呼び出すことができます。ただし、これはクロスドメイン要求なので、クロスオリジンリソース共有 (CORS) を使用する必要があります。

サポート情報管理の検索コントロールは、Xrm.Page.ui コントロールなので、コントロールが所有するすべての標準メソッドをサポートします。しかし、追加のイベントとメソッドもサポートします。標準のコントロールメソッドについては、「Xrm.Page.ui コントロール (クライアント側の参照)」を参照してください。

コントロールの名前が分かっている場合は、次の形式を使用してそのコントロールにアクセスできます。ここで、<name> はコントロールの名前を表します。

kbSearchControl = Xrm.Page.getControl("<name>");

注意

サポート情報の検索コントロールがソーシャルウィンドウに追加されると、その名前は searchwidgetcontrol_notescontrol となります。この名前は変更できません。

以下のすべての例では、フォーム内のサポート情報の検索コントロールを表すために kbSearchControl が使用されています。

イベント

このコントロールのイベントを使用して、コードを選択した項目または開いた項目に対応させることができます。

OnResultOpened

このイベントは、サポート技術情報の記事が、インラインで、またはポップアップ操作によって、サポート情報の検索コントロールで開かれたときに発生します。addOnResultOpened と removeOnResultOpened メソッドを使用して、このイベントのイベントハンドラーを管理します。

OnSelection

このイベントは、サポート技術情報の記事がサポート情報の検索コントロールで選択されているときに発生します。addOnSelection と removeOnSelection メソッドを使用して、このイベントのイベントハンドラーを管理します。

メソッド

サポート情報の検索コントロールのメソッドを使用して、イベントハンドラーの設定または除去と、検索のクエリおよび結果結果とのやり取りを行います。

addOnResultOpened

このメソッドを使用して、イベントハンドラーを OnResultOpened イベントに追加します。

パラメーター: 関数。追加する関数。

例: myFunction という名前の関数を OnResultOpened イベントに追加します。

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

このメソッドを使用して、イベントハンドラーを OnSelection イベントに追加します。

パラメーター: 関数。追加する関数。

例: myFunction という名前の関数を OnSelection イベントに追加します。

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

このメソッドを使用して、サポート情報管理のコントロールの検索条件として使用するテキストを取得します。

戻り値: 文字列。検索クエリのテキスト。

例: searchQuery 変数を検索クエリのテキストに設定します。

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResult

このメソッドを使用して、検索コントロールの現在選択した結果を取得します。現在選択した結果も、現在開かれている結果を表します。

戻り値: KBSearchResult。現在選択されている結果。

例: 変数 kbSearchResult を現在選択されている結果に設定します。

var kbSearchResult = kbSearchControl.getSelectedResult();

KBSearchResult プロパティ

次の表に、KBSearchResult オブジェクトのプロパティを説明します。

プロパティ	種類	説明
answer	String	記事のコンテンツを含む HTML マークアップ。このコンテンツは、顧客に送信する電子メールにそのコンテンツを組み込むことができるユーザー定義アクションに渡すことができます。
articleId	String	Parature の部署内の記事の ID この値は、代替キーとして使用されます。この値を使用して、この記事が CRM 内に既に存在するかどうかを確認できます。
articleUid	String	Parature システムの一意の記事 ID。これには、Parature 取引先企業 ID と部署 ID も格納されます (例: "7924/8112/Article/25")。この値は、代替キーとして使用されます。この ID は、記事がまだ存在しない場合に、記事の関連付けの間に新しいサポート情報レコードを作成するために必要です。
createdOn	Date	記事が作成された日付。記事の経過年数をビジネスロジックで使用する場合は、使用することもできます。
expiredDate	Date	記事の期限が切れた日付、また切れる日付。この日付と現在の日付を比較して、記事が期限切れになったかどうかを比較できます。この値では、ユーザーの現在のタイムゾーンと形式が使用されます。
isAssociated	Boolean	記事が親レコードに関連付けられているかどうかを示します。フォームスクリプトを使用して、またはフォームスクリプトによって起動された別のプロセスで、記事を現在のレコードに関連付ける前に、この値を確認できます。
lastModifiedOn	Date	記事が最後に修正された日付。この値では、ユーザーの現在のタイムゾーンと形式が使用されます。
publicUrl	String	記事のポータル URL をサポートします。ユーザー定義アクションを使用して、これを、顧客に送信する電子メールのコンテンツ内のリンクに組み込みます。
published	Boolean	記事が公開済みの状態にあるか、下書き状態にあるかを示します。記事に関する情報を顧客に送信する前に、記事が公開されているかどうかを確認する必要があります。
question	String	記事のタイトル。どのビジネスプロセスにおいても記事を参照する場合に、この値を使用して名前で記事を参照できます。
rating	Number	記事の評価。
searchBlurb	String	検索クエリで見つかった領域を含む、記事のコンテンツの短い断片。これを使用して、検索リスト内でユーザーに記事を少しだけ見せて、これが探している記事であるかどうかの判断を助けます。
serviceDeskUri	String	Parature サービスデスク内の記事へのリンク。 Parature サービスデスクを使用して記事を開くには、このリンクを使用します。
timesViewed	Number	顧客によって Parature ポータルで記事が閲覧された回数。

removeOnResultOpened

このメソッドを使用して、イベントハンドラーを OnResultOpened イベントから取り外します。

パラメーター: 関数。取り外す関数。

例: myFunction という名前の関数を OnResultOpened イベントから取り外します。

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

このメソッドを使用して、イベントハンドラーを OnSelection イベントから取り外します。

パラメーター: 関数。取り外す関数。

例: myFunction という名前の関数を OnSelection イベントから取り外します。

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

このメソッドを使用して、サポート情報管理のコントロールの検索条件として使用するテキストを設定します。

パラメーター: 文字列。検索クエリ用テキスト。

例: 検索クエリのテキストを How to solve the problem に設定します。

kbSearchControl.setSearchQuery("How to solve the problem");

次の方法で共有