KM コントロール (ホストされたコントロール)

[アーティクル]
04/19/2023

ホストされたコントロールの KM コントロール型を使用して、エージェントアプリケーションでのサポート情報記事を表示します。新しいホストされたコントロールを使用して、サービスエージェントは、アプリケーションを切り替えずに、記事を検索し、記事をサポート案件に関連付けまたは関連付けを解除し、記事へのリンクをコピーし、それを電子メール経由または会話で送信できます。詳細: 効率的な Customer Engagement のためにサポート情報を活用するとモデル駆動型アプリを使用するように Unified Service Desk を構成する

KM コントロールのホストされたコントロールを作成する

新しいホストされたコントロールを作成中、新しいホストされたコントロールを画面は、作成するホストされたコントロールの種類により異なります。このセクションは、ホストされたコントロールの KM コントロールタイプに固有の特定のフィールドに関する情報を提供します。ホストされたコントロールの作成方法の詳細については、「ホストされたコントロールの作成または編集」を参照してください。

KM コントロールホストされたコントロール。

新しいホストされたコントロール画面で以下を実行します。

Unified Service Desk 領域で、 KM コントロール を Unified Service Desk コンポーネントタイプ ドロップダウンリストから選択します。
複数ページの許可ドロップダウンリストは、このホストされたコントロールの種類ではサポートされていません。
ホストの種類ドロップダウンリストは、このコントロールをホストする方法を指定します。 Chrome プロセス を選択できます。詳細については、「ホストされたコントロールのホスティング方法を選択する」を参照してください。
共通プロパティ領域で、アプリケーションはグローバルチェックボックスをオンにし、ホストされたコントロールをグローバルとして設定します。グローバルなホストされたコントロールは、顧客のセッションの外部で表示できます。エージェントのダッシュボード、ウォールまたは検索などのコントロールは、グローバルなホストされたコントロールの一般的な用途です。グローバルなホストされたコントロールは、セッション固有の状態を持たないため、セッションを変更しても、これら同じグローバルなホストされたコントロールは残ります。チェックボックスが選択されていない場合、ホストされたコントロールがセッションベースになります。セッションベースのコントロールは、ユーザーセッションのコンテキストに存在します。ユーザーが別のセッションに変更された場合は、前のセッションからのすべてのセッションのページは非表示になります。
表示グループフィールドに、ホストされたコントロールが表示されるパネルが表示されます。ナレッジマネージメントパッケージで、KM コントロールは RightPanel に表示されます。ただし、必要に応じて LeftPanel または MainPanel に表示することができます。 Unified Service Desk で利用できるさまざまな種類のパネルの詳細については、Unified Service Desk でのパネル、パネルの種類、およびパネルのレイアウトを参照してください。

その他の概要フィールドについては、「ホストされたコントロールの作成または編集」を参照してください。

事前定義 UII アクション

これらは、このホストされたコントロールタイプの定義済みアクションです。

パラメーター	説明
entitytypename	サポート情報のレコードに関連付ける親エンティティの論理名。例: `entitytypename=incident`
recordid	サポート情報のレコードに関連付けるエンティティレコードのID。
articleuniqueid	関連付ける記事の一意の ID。例: `articleuniqueid=7924/8112/Article/41`
articletitle	関連付ける記事のタイトルを表す文字列値。例: `articletitle=Diffused Sunlight and Weather Conditions`
articlepublicurl	関連付ける記事のパブリック URL。ネイティブ Dataverse サポート情報を使用している場合、このパラメーターで記事の URL を使用できるように、記事が既に外部ポータル ( Dataverse で外部ポータルの使用をサポート情報管理設定ダイアログボックスで選択します) に公開されている必要があります。例: `articlepublicurl=https://support.microsoft.com/kb/{kbnum}`

クローズ

KM コントロールのホストされたコントロールを閉じます。

パラメーター	内容
`articleuniqueid`	関連付けを解除する記事の一意の ID。例: `articleuniqueid=7924/8112/Article/41`
`relatedentityrecordid`	サポート情報のレコードと関連付けられている親エンティティレコードのID。
`entityname`	サポート情報のレコードが関連付けられる親エンティティの論理名。例: `entitytypename=incident`

FireEvent

KM コントロールのホストされたコントロールからユーザー定義イベントを発生させます。

パラメーター	説明
`name`	ユーザー定義イベントの名前。

後続のすべての名前と値が等しい組み合わせは、イベントに対するパラメーターとなります。ユーザー定義イベントの作成の詳細については、「ユーザー定義イベントの作成」を参照してください。

MoveToPanel

ホストされたコントロールを、実行時に、Unified Service Desk で選択したパネルに移動します。

パラメーター	説明設定
`app`	移動するホストされたコントロールの名前。
`panel`	ホストされたコントロールを移動した対象パネルの名前です。

ホストされたコントロールから URL がポップアップし、ポップアップを適切な場所にルーティングするために、URL に対してウィンドウナビゲーションルールを実行します。

パラメーター	内容
`url`	この URL を使用して、表示されているコントロールからの要求されたポップアップであるかのように、ホストされているコントロールからのポップアップをルーティングします。
`frame`	ポップアップの発生元のフレーム。

RealignWindow

モニタ上の指定された場所に、ホストされたコントロールを表示します。ホストされたコントロールは最大 2 台のモニタに表示できます。この操作は、USDFloatingPanel または USDFloatingToolPanel のパネルの種類に配置されるように構成されているホストされたコントロールのインスタンスに適用されます。

パラメーター	説明
screen	ホストされたコントロールを表示する画面を指定します。有効な値は 1 または 2 です。このパラメーターを指定しない場合、既定で 1 が渡されます。
left	ホストされたコントロールが表示される対象モニタの画面の左からの位置を、パーセンテージで指定します。有効な値は 0 ～ 100 です。このパラメーターを指定しない場合、既定で 0 が渡されます。
top	ホストされたコントロールが表示される対象モニタの画面の右からの位置を、パーセンテージで指定します。有効な値は 0 ～ 100 です。このパラメーターを指定しない場合、既定で 0 が渡されます。
width	対象モニタに表示されるホストされたコントロールのウィンドウの幅を、パーセンテージで指定します。有効な値は 1 ～ 100 です。このパラメーターを指定しない場合、既定で 100 が渡されます。
height	対象モニタに表示されるホストされたコントロールのウィンドウの高さを、パーセンテージで指定します。有効な値は 1 ～ 100 です。このパラメーターを指定しない場合、既定で 100 が渡されます。

検索する

パラメーターとして検索文字列を渡すことで KM コントロール内のレコードを検索します。

パラメーター	説明
クエリ	ホストされたコントロールで検索する文字列値。例: `query=contoso`。これはモデル駆動型アプリから "contoso" で始まる名前を持つサポート情報記事を取得します。
個の結果	ホストされたコントロールに表示される検索結果数を表す整数値。たとえば、`results=5`を指定すると、ホストされたコントロールには 5 つの検索結果が表示されます。このデータパラメーターに値が指定されない、または間違った値が指定された場合は、既定値 (10) が使用されます。データパラメーターに対して許可されている最大値は 20 です。
フィルター	ホストされたコントロールに表示されるサポート技術情報の記事のタイプを表す整数値。 - `1`: すべて (既定) - `2`: すべて下書き - `3`: すべて公開済み - `4`: 公開済み-プライベート - `5`: 公開済み-パブリック - `6`: 公開済み-期限切れたとえば、`filter=3`を指定して、公開済みのサポート情報記事のみが表示されるように指定します。値が指定されない、または間違った値が指定された場合は、既定値 (1) が使用されます。
blockClick	検索結果がホストされたコントロールでクリックされたときにコンテンツインラインの表示をブロックするかどうかを示す整数値。 `0` に設定すると、クリック時にコンテンツインラインは開き、`1` に設定すると、コンテンツインラインの表示はブロックされます。例: `blocked=1` 値が指定されない、または間違った値が指定された場合は、既定値 (0) が使用されます。値を 1 に設定すると、コンテンツはブロックされますが ResultOpen イベントは実行されます。
並べ替え	検索結果のサポート情報記事の並び替えオプションを示す整数値: - `1`: 関連性 (既定) - `2`: 評価 - `3`: ビュー数 - `4`: 最終変更日 (古い順) - `5`: 最終変更日 (新しい順) たとえば、評価に基づいて記事を並べ替えるには、`sort=2` を指定します。このデータパラメーターに値が指定されない、または間違った値が指定された場合は、データパラメーターに既定値 (1) が使用されます。

SetArticleContext

KM コントロールの現在のサポート情報記事にデータを追加します。

パラメーター	説明
`articleapplication`	サポート情報記事が表示されるホストされたコントロールの名前。
`articledata`	ResultOpen イベントから渡された記事レコードオブジェクト値。

SetSearchProps

KM コントロールのサポート情報記事の検索に別の種類のフィルターを許可します。

パラメーター	説明
`showFilter`	記事タイプのフィルターをサポート情報記事の検索に許可するかどうかを示します。 `0`を設定すると、フィルターを非表示にし、`1` を設定すると、フィルターを表示します。例: `showFilter=1`。値が指定されない、または間違った値が指定された場合は、既定値 (0) が使用されます。
`showLang`	言語タイプのフィルターをサポート情報記事の検索に許可するかどうかを示します。 `0`を設定すると、フィルターを非表示にし、`1` を設定すると、フィルターを表示します。例: `showLang=1`。値が指定されない、または間違った値が指定された場合は、既定値 (0) が使用されます。
`showDept`	部門タイプのフィルターをサポート情報記事の検索に許可するかどうかを示します。 `0`を設定すると、フィルターを非表示にし、`1` を設定すると、フィルターを表示します。例: `showDept=1`。値が指定されない、または間違った値が指定された場合は、既定値 (0) が使用されます。

SetSize

ホストされたコントロールの高さと幅を設定します。これは、パネルのレイアウトで「自動」を使用するときに特に有用です。

パラメーター	説明
`width`	ホストされるコントロールの幅。
`height`	ホストされたコントロールの高さ。

SetUserCanClose

ホストされたコントロールのタブの右上隅の [X] アイコンをクリックすることによってホストされたコントロールを閉じることができます。

パラメーター	説明
`UserCanClose`	`true` に設定すると、ユーザーがホストされたコントロールを閉じることができるようになります。そうでなければ、`false`に設定します。

定義済みのイベント

次の定義済みイベントは、このホストされたコントロールの種類に関連付けられています。

PopupRouted

システムによりポップアップがルートされた後に発生します。

パラメーター	説明
`url`	ルートされたポップアップの URL です。

ResultOpen

検索内容が KM コントロールのコンテンツを読み取るために開く際に起こります。

パラメーター	内容
`postdata`	サポート情報記事のフォームのフィールドおよびその値を表す一連のキー/値のペアを含む formdata オブジェクト。

SearchComplete

サポート情報記事の検索が完了し、検索結果がホストされたコントロールにロードされた後に発生します。

SelectionChange

結果が KM コントロールの選択された時に発生します。

パラメーター	内容
`postdata`	サポート情報記事のフォームのフィールドおよびその値を表す一連のキー/値のペアを含む formdata オブジェクト。

次の方法で共有