KMコントロール (ホストされたコントロール)
公開日: 2016年11月
対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2013、Dynamics CRM 2015、Dynamics CRM 2016
ホストされたコントロールの KM コントロール タイプを使用して、エージェント アプリケーションで Microsoft Dynamics 365 または Parature のサポート情報記事を表示します。 新しいホストされたコントロールを使用して、サービス エージェントは、アプリケーションを切り替えずに、記事を検索し、記事をサポート案件に関連付けまたは関連付けを解除し、記事へのリンクをコピーし、それを電子メール経由または会話で送信できます。詳細:効果的な顧客の取り組みに Dynamics 365 または Parature サポート情報を使用する および Dynamics 365 または Parature サポート情報で Unified Service Desk を構成する
このトピックの内容
KM コントロールのホストされたコントロールを作成する
事前定義 UII アクション
定義済みのイベント
KM コントロールのホストされたコントロールを作成する
新しいホストされたコントロールを作成中、[新しいホストされたコントロールを] 画面は、作成するホストされたコントロールの種類により異なります。 このセクションは、ホストされたコントロールのKM コントロールタイプに固有の特定のフィールドに関する情報を提供します。 ホストされたコントロールの作成方法の詳細については、「ホストされたコントロールの作成または編集」を参照してください。
[新しいホストされたコントロール] 画面で以下を実行します。
[Unified Service Desk] 領域で、[KM コントロール] を [USD コンポーネントの種類] ドロップダウン リストから選択します。
複数ページの許可 ドロップダウン リストは、このホストされたコントロールの種類ではサポートされていません。
ホストの種類ドロップ ダウン リストは、このコントロールをホストする方法を指定します。[IE プロセス] (既定値) または [内部 WPF] を選択することができます。 詳細については、「ホストされたコントロールのホスティング方法を選択する」を参照してください。
共通プロパティ 領域で、アプリケーションはグローバルチェック ボックスをオンにし、ホストされたコントロールをグローバルとして設定します。 グローバルなホストされたコントロールは、顧客のセッションの外部で表示できます。 エージェントのダッシュ ボード、ウォールまたは検索などのコントロールは、グローバルなホストされたコントロールの一般的な用途です。 グローバルなホストされたコントロールは、セッション固有の状態を持たないため、セッションを変更しても、これら同じグローバルなホストされたコントロールは残ります。 チェック ボックスが選択されていない場合、ホストされたコントロールがセッション ベースになります。 セッション ベースのコントロールは、ユーザー セッションのコンテキストに存在します。 ユーザーが別のセッションに変更された場合は、前のセッションからのすべてのセッションのページは非表示になります。
[表示グループ] フィールドに、ホストされたコントロールが表示されるパネルが表示されます。 ナレッジ マネージメント パッケージで、KM コントロールはRighPanelに表示されます。ただし、必要に応じて、LeftPanel またはMainPanel に表示することができます。Unified Service Deskで利用できる種々のパネルに関する詳細は、Unified Service Desk でのパネル、パネルの種類、およびパネルのレイアウトを参照してください。
その他の [全般] フィールドについては、「ホストされたコントロールの作成または編集」を参照してください。
事前定義 UII アクション
これらは、このホストされたコントロール タイプの定義済みアクションです。
関連付け
Dynamics 365 または Parature のサポート情報レコードを、[KM コントロール] の親エンティティ レコードに関連付けます。
パラメーター |
説明 |
---|---|
entitytypename |
サポート情報のレコードに関連付ける親エンティティの論理名。 例: entitytypename=incident |
recordid |
サポート情報のレコードに関連付けるエンティティ レコードのID。 |
articleuniqueid |
関連付ける記事の一意の ID。 例: articleuniqueid=7924/8112/Article/41 |
articletitle |
関連付ける記事のタイトルを表す文字列値。 例: articletitle=Diffused Sunlight and Weather Conditions |
articleprivateurl |
関連付ける Parature の記事の一意のプライベート URL。 例: articleprivateurl=https://demo.parature.com/ics/km/kmRefEdit.asp?questionID=41 注意 このパラメーターはネイティブ Dynamics 365 のサポート情報を使用している場合には適用されません。Parature のサポート情報の場合にのみ適用されます。 |
articlepublicurl |
関連付ける記事のパブリック URL。 ネイティブ Dynamics 365 サポート情報を使用している場合、このパラメーターで記事の URL を使用できるように、記事が既に外部ポータル (Dynamics 365 の [サポート情報管理設定] ダイアログ ボックスで [外部ポータルの使用] を選択します) に公開されている必要があります。 例: articlepublicurl=https://support.microsoft.com/kb/{kbnum} |
閉じる
KM コントロールのホストされたコントロールを閉じます。
関連付け解除
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" で始まる名前を持つ Dynamics 365 または Parature からのサポート情報記事を取得します。 |
結果 |
ホストされたコントロールに表示される検索結果数を表す整数値。 たとえば、results=5を指定すると、ホストされたコントロールには 5 つの検索結果が表示されます。 このデータ パラメーターに値が指定されない、または間違った値が指定された場合は、既定値 (10) が使用されます。 データ パラメーターに対して許可されている最大値は 20 です。 |
フィルター |
ホストされたコントロールに表示されるサポート技術情報の記事のタイプを表す整数値。
たとえば、filter=3を指定して、公開済みのサポート情報記事のみが表示されるように指定します。 値が指定されない、または間違った値が指定された場合は、既定値 (1) が使用されます。 |
blockClick |
検索結果がホストされたコントロールでクリックされたときにコンテンツ インラインの表示をブロックするかどうかを示す整数値。0 に設定すると、クリック時にコンテンツ インラインは開き、1 に設定すると、コンテンツ インラインの表示はブロックされます。 例: blocked=1 値が指定されない、または間違った値が指定された場合は、既定値 (0) が使用されます。 値を1に設定すると、コンテンツはブロックされますが、ResultOpen イベントは実行されます。 |
sort |
検索結果のサポート情報記事の並び替えオプションを示す整数値:
たとえば、評価に基づいて記事を並べ替えるには、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 オブジェクト。 |
関連項目
効果的な顧客の取り組みに Dynamics 365 または Parature サポート情報を使用する
Dynamics 365 または Parature サポート情報で Unified Service Desk を構成する
チュートリアル 8: エージェント アプリケーションで Parature のサポート情報を使用する
ホストされたコントロールの種類とアクション/イベント リファレンス
Unified Service Desk 2.0
© 2017 Microsoft. All rights reserved. 著作権