統一インターフェイス ページ (ホストされたコントロール)
統一インターフェイス ページのホストされたコントロール タイプを使用して、モデル駆動型アプリの統一インターフェイス アプリから URL またはページを読み込みます。 モデル駆動型アプリのページがこの種類のホストされたコントロールに読み込まれると、エンティティからのデータのページが自動的にスキャンされ、置換パラメーターが自動的に入力されます。
このホストされたコントロールタイプは、リスト操作アクションやクイック検索や高度な検索ページを表示する検索アクションなど、モデル駆動型アプリ Windows の処理に固有の定義済みの UII アクションや多くのイベントを利用できます。
統一インターフェイス ページのホストされたコントロールを作成する
新しいホストされたコントロールを作成している間、新規ホストされたコントロール 画面のフィールドは、作成するホストコントロールのタイプによって異なります。 このセクションでは、統一インターフェイス ページのホストされたコントロールの種類に固有の特定のフィールドに関する情報を提供します。
新規ホストされたコントロール画面で以下を実行します。
Unified Service Desk の領域で、Unified Interface ページを Unified Service Desk コンポーネントの種類ドロップダウン リストから選択します。
データの事前取得を選択して、エンティティ レコードの関連情報をエンティティ レコード ページと一緒にコンテクストに読み込むことができます。 取得されたエンティティ情報は Unified Service Desk コンテキストに入力されるため、これにより、ホストされたコントロールがクライアント アプリケーションに関連するエンティティ情報を迅速に表示できるようになります。 これにより、エージェントが迅速な対応をしたり、顧客との話し合いを開始したりすることができ、重要な対話の時間を節約することができます。
複数ページを許可するドロップダウン リストから、いいえ (既定) を選択して現在表示されているモデル駆動型アプリのページを置き換え、Unified Service Desk がナビゲーション アクション コールを受信するか、またはページがタブにルーティングされると、ブラウザーの履歴を更新します。はいを選択して、2 番目の URL が呼び出されるか、ウィンドウ ナビゲーション ルールによりページがタブ移動する際に、ドロップ ダウン リストを自動的に作成します。これにより、ユーザーはこのコントロールに関連付けられているモデル駆動型アプリのページ間をすばやく検索できます。 また、はいを選択した場合、追加のフィールド最大ブラウザーが、ドロップダウン リストに表示されるページの最大数を指定できるようになります。
共通プロパティ領域で、グローバルなアプリケーション チェック ボックスをオンにし、ホストされたコントロールをグローバルとして設定します。 グローバルなホストされたコントロールは、顧客のセッションの外部で表示できます。 エージェントのダッシュ ボード、ウォールや検索などのコントロールは、グローバルなホストされたコントロールの一般的な用途です。 グローバルなホストされたコントロールは、セッション固有の状態を持たないため、セッションを変更しても、同じグローバルなホストされたコントロールは残ります。 チェック ボックスが選択されていない場合は、ホストされたコントロールがセッション ベースになります。 セッション ベースのコントロールは、ユーザー セッションのコンテキストに存在します。 ユーザーが別のセッションに変更した場合、前のセッションのページはすべて非表示になります。
表示グループフィールドに、ホストされたコントロールが表示されるパネルが表示されます。 MainPanel は、このホストされたコントロールの種類で最も一般的です。
詳細情報 : ホストされたコントロールの作成または編集
事前定義 UII アクション
以下は、このホストされたコントロール タイプの定義済みアクションです。
AssociatedView
このアクションは関連付けられた特定のビューを読み込みます。 これらのビューは、通常、ナビゲーション バーのエンティティ レコード名の横にある下向き矢印を展開し、関連付けられたエンティティを選択して関連付けます。
| パラメーター | 内容 |
|---|---|
| etn | 関連するエンティティのレコードの一覧を読み込むエンティティの名前です。 これは必須パラメーターです。 |
| ID | 関連付けられたエンティティ レコードを表示する、メイン エンティティ レコードの ID。 |
| navItemId | 関連付けられたエンティティに対応するナビゲーション項目の ID です。 詳細: formContext.ui.navigation |
| hideCommandBar | このパラメーターが指定されて False の場合、モデル駆動型アプリ コマンド バーとともにページが表示されます。 |
| hideNavigationBar | このパラメーターが指定されて False の場合、モデル駆動型アプリ ナビゲーション バーとともにページが表示されます。 |
[閉じる]
この操作は、ホストされたコントロールを閉じるために使用します。 CloseActive アクションとは違い、このタブ (ホストされたコントロール) が複数のページを表示している場合、エージェント アプリケーション内のタブに表示されているすべてのページを閉じます。
CloseActive
このホストされたコントロール内のアクティブなウィンドウを閉じるには、このアクションが使用されます。 アクティブなウィンドウがホストされたコントロールに表示される唯一のウィンドウの場合、ホストされたコントロール自体が閉じられます。 統一インターフェイス ページの種類のホストされたコントロールでは、複数ページは許可されず (複数ページの許可 = いいえ)、このアクションは閉じるアクションに相当します。
CloseAndPrompt
このアクションによりホストされたコントロールが閉じられますが、ユーザーには閉じる前に変更を保存するか放棄するよう促します。
検索
指定されたエンティティの簡易検索リスト ビューに移動します。
| パラメーター | 内容 |
|---|---|
| 説明を参照する | データ パラメーターには、表示する簡易検索リスト ビューのエンティティの論理名を指定します。 いくつかの特殊なサポート案件の値もあります。 - サポート案件またはインシデントを使用して、サポート案件のための簡易検索一覧ビューを表示します。 - 活動(複数)または活動(単数)を使用して、活動に使用する簡易検索一覧ビューを表示します。 |
| hideNavigationBar | ナビゲーション バーを非表示にするには True に設定し、それ以外の場合は False に設定します。 |
| hideCommandBar | コマンド バーを非表示にするには True に設定し、それ以外の場合は False に設定します。 |
FireEvent
このホストされたコントロールからユーザー定義イベントを発生させます。
| パラメーター | 内容 |
|---|---|
| 名前 | ユーザー定義イベントの名前です。 |
後続のすべての名前/値の組み合わせがイベントのパラメーターとなります。 詳細情報 : ユーザー定義イベントの作成
GetSelectedIds
このアクションは、リストから選択した ID を取得するために使用します。
| パラメーター | 内容 |
|---|---|
| 説明を参照する | データ パラメーターには、選択した ID を取得するリスト名を指定する必要があります。 |
戻り値には、選択した項目を格納している ID のセミコロンで区切った一覧が含まれます。
GetSelectedCount
このアクションは、選択されている項目の数を取得します。 エンティティの実際の ID 一覧を取得するには、GetSelectedIds アクションを使用します。
| パラメーター | 内容 |
|---|---|
| 説明を参照する | データ パラメーターには、選択した ID を取得するためのリスト名を指定する必要があります。 |
戻り値には、選択した品目の数量を表す数値が含まれます。
GoHome
この操作は、ブラウザー インスタンスで指定された初期 URL に移動します。
GoBack
この操作は、ブラウザー インスタンスの [戻る] ボタンを選択することと同じです。
GoForward
この操作は、ブラウザー インスタンスの [進む] ボタンを選択することと同じです。
MoveToPanel
この操作により、実行時に統一インターフェイス ページのホストされたコントロールが別のパネルに移動します。
| パラメーター | 内容 |
|---|---|
| 説明を参照する | データ パラメーターは、ホストされたコントロールを移動するために対象のパネルの名前を指定する必要があります (例 : FloatingPanel)。 |
移動
この操作は、モデル駆動型アプリの URL に移動するために使用します。 アプリ モジュールの選択ウィンドウから選択するアプリで使用するアプリ ID が自動的に追加されます。
| パラメーター | 説明 |
|---|---|
| url | 移動先のURL。 これは必須パラメーターです。 |
| HideCommandBar | このパラメーターが与えられていて、True の場合、モデル駆動型アプリのコマンド バーを読み込まなくても、内部フレームが表示されます。 |
| HideNavigationBar | このパラメーターが与えられていて、True の場合、モデル駆動型アプリのナビゲーション バーを読み込まなくても、フォームが表示されます。 |
| フレーム | ページ上にフレームが存在する場合、このパラメーターは、メイン ウィンドウを移動させるのではなく、移動するフレームの名前を指定します。 |
| postdata | HTTP POST トランザクションの一部としてサーバーに送信されるデータです。 POST トランザクションは、通常、HTML ページによって収集されたデータの送信に使用されます。 Unified Service Desk では、このデータは、"`https://event/?`" を使用して発生したイベントから取得されます。 例: [[postdata]+] または、データは、意図した形式のヘッダー タイプでエンコードされた文字列として渡されます。 |
| ヘッダー | サーバーに送信する追加の HTTP ヘッダーを含む文字列値。 postdata パラメータが ナビゲートアクション で使用されている場合は、ヘッダーパラメータに適切な値を指定する必要があります (例 : Content-Type:application/x-www-form-urlencoded) Unified Service Desk POST イベントがナビゲート操作をトリガーする場合、このパラメーターの規定値は header=[[header]+] です 複数のヘッダーを追加する場合、このパラメーターの値は次の値になります: header=$Multiline(改行で区切られたヘッダー) 例: header=$Multiline(accessToken;dummyAccessToken==refreshToken;dummyRefreshToken===) |
New_CRM_Page
指定されたエンティティの新しいレコードを作成するページを作成し、そのページを指定したホストされたコントロールのポップアップ ウィンドウとして扱います。 ウィンドウ ナビゲーション ルールは、エンティティ レコードを作成するページが表示される場所を決定するために評価されます。
| パラメーター | 内容 |
|---|---|
| LogicalName | 新しいインスタンスを作成するためのエンティティの論理名です。 |
Note
残りのパラメーターは名前/値のペアで構成する必要があります。 これらは、指定されたエンティティの新しいレコードを作成するための、フォーム内で事前設定される追加の値です。
Open_CRM_Page
ID が指定し、識別したエンティティの既存のインスタンスを開き、指定したホストされたコントロールからのポップアップ ウィンドウとしてページを扱います。 ウィンドウのナビゲーションルールでは、ポップアップ ウィンドウを表示する場所が決定されます。
| パラメーター | 内容 |
|---|---|
| LogicalName | 開くエンティティの論理名。 |
| ID | 開くエンティティ レコードの ID。 |
ポップアップ
ホストされたコントロールから URL をポップアップし、ポップアップウィンドウを適切な場所にルーティングするウィンドウ ナビゲーション ルールを実行します。
| パラメーター | 内容 |
|---|---|
| URL | この URL を使用して、表示されているコントロールから要求されたポップアップ ウィンドウであるかのように、ホストされたコントロールからのポップアップをルーティングします。 |
| フレーム | このポップアップ ウィンドウの元となるフレーム。 |
RealignWindow
モニタ上の指定された場所に、ホストされたコントロールを表示します。 ホストされたコントロールは最大で 2 台のモニタに表示できます。 この操作は、USDFloatingPanel または USDFloatingToolPanel のパネルの種類に配置されるように構成されているホストされたコントロールのインスタンスに適用されます。
| パラメーター | 説明 |
|---|---|
| screen | ホストされたコントロールを表示する画面を指定します。 有効な値は 1 または 2 です。 このパラメーターを指定しない場合、既定で 1 が渡されます。 |
| 左 | ホストされたコントロールが表示される対象モニタの画面の左からの位置を、パーセンテージで指定します。 有効な値は 0 から 100 です。 このパラメーターを指定しない場合、既定で 0 が渡されます。 |
| 上位 | ホストされたコントロールが表示される対象モニタの画面の右からの位置を、パーセンテージで指定します。 有効な値は 0 から 100 です。 このパラメーターを指定しない場合、既定で 0 が渡されます。 |
| 幅 | 対象モニタに表示されるホストされたコントロールのウィンドウの幅を、パーセンテージで指定します。 有効な値は 1 から 100 です。 このパラメーターを指定しない場合、既定で 100 が渡されます。 |
| height | 対象モニタに表示されるホストされたコントロールのウィンドウの高さを、パーセンテージで指定します。 有効な値は 1 から 100 です。 このパラメーターを指定しない場合、既定で 100 が渡されます。 |
最新の状態に更新
この操作は、現在のページを更新します。
RunScript
このアクションは、アプリケーションのメイン フレームに JavaScript を挿入します。 このアクションでは、Microsoft Dataverse クライアント SDK 呼び出しの使用を避ける必要があります。代わりに、RunXrmCommand アクションを使用します。
| パラメーター | 内容 |
|---|---|
| 説明を参照する | データ パラメーターは、フォームに挿入される JavaScript です。 注: 置換パラメータはスクリプト内で使用することができ、スクリプトが実行される前に置換されます。 |
| フレーム | ページ上にフレームが存在する場合、このパラメーターは JavaScript を挿入するフレームの名前を指定します。 |
RunXrmCommand
このアクションは、モデル駆動型アプリの クライアント API 参照 を使用する JavaScript を統一インターフェイス ページ (エンティティ フォームおよびグリッド) に対して実行するために使用します。
スクリプトをモデル駆動型アプリの JavaScript webResource として構成する必要があります。 関数の最初のパラメーターは、以下の値のいずれかを持つ可能性がある、コンテキスト パラメーター (予約済みパラメーター) です。
- エンティティ フォーム ページ上の FormContext
- エンティティ グリッド ページ上の GridContext
- 他のページ上の未定義
| パラメーター | 内容 |
|---|---|
| webResourceName | 実行する JavaScript 関数が存在する Web リソースの名前です。 |
| functionName | 関数の名前です。 |
関数に対する他のパラメーターはユーザーが定義でき、Unified Service Desk の置換パラメーターを実行時に渡すために使用することができます。 このアクションはキーなしでオプション パラメーターの一覧を受け入れます。 オプション パラメーターの一覧は、実行時にコンテキストが置換された後の 2 番目の位置から、同じ順番で引数として渡されます。
例
エンティティ フォームのフォーム属性に入力するため RunXrmCommand アクションを実行します。ここでエンティティ フォームは統一インターフェイスのページ タイプのホスト コントロールによりホストされます。 入力する値は、Unified Service Desk の観点から見て、置換パラメータ —[[$Context.Key1]] です。
アクションを実行するには、JavaScript タイプの Web リソース (webResource1 など) を記述してから、Web リソースで関数を記述する必要があります。
function fillAttributeValue(context, attrValue)
{
context.getAttribute(<attributeName>).setValue(attrValue);
}
次のように、アクション コール内のデータを構成する必要があります。
webResourceName = webResource1
functionName = fillAttributeValue
'[[$Context.Key1]]'
Note
上の例では、置換パラメータ [[$Context.Key1]] の周りにシングル クォーテーション マークが付いていることに注目してください。 Unified Service Desk はパラメーターの値 (データ タイプではない) のみを考慮して、コンテキスト内の置換された値の文字すべてを JavaScript 関数に渡します。 構成中はデータの種類を注意深く扱う必要があります。
SetSize
このアクションは、ホストされたコントロールの高さと幅を明示的に設定します。 これは、パネルのレイアウトで「自動」を使用するときに特に有用です。
| パラメーター | 内容 |
|---|---|
| 幅 | ホストされるコントロールの幅。 |
| 高さ | ホストされたコントロールの高さ。 |
SaveAndClose
このアクションはモデル駆動型アプリ フォームの 「ダーティ」 データを保存し、ホストされたコントロールを終了します。
SaveAll
このアクションは、複数のページを表示できるように (複数ページを許可する = はい)、すべてのフォームのホストされたコントロールを保存します。 ホストされたコントロールが単一ページの表示のみを許可する場合 (Allow Multiple Pages = No)、保存アクションと同等です。
上書き保存
このアクションは現在の統一インターフェイス ページを保存します。
定義済みのイベント
次の定義済みイベントは、このホストされたコントロールの種類に関連付けられています。
ActiveClosed
CloseActive アクションを使用してアクティブ状態のホストされたコントロールを閉じると発生します。
| パラメーター | 内容 |
|---|---|
| URL | ホストされたコントロールが閉じられたときに、そこに表示されていた URL。 |
DataReady
エンティティの関連情報が Unified Service Desk コンテキストにロードされると直ちに発生します。 このイベントは PageReadyFor イベントの前に発生します。 コントロール インスタンスでデータの事前取得オプションがオンの場合、このイベントはイベント データが異なる並列コールでサーバーに取得されると直ちに発生し、ページ全体を読み込むまで待機しません。 エンティティ データは事前にフェッチされ、DataReady イベントはインラインナビゲーションでも発生します。
Note
ダッシュボード、Web リソース、検索ページには、DataReady イベントは発生しません。
RefreshRequested
現在のページでリフレッシュが必要な時に発生します。 リフレッシュは、F5 キーを押すか、アプリケーションでリフレッシュ アクションを呼び出して要求できます。
| パラメーター | 説明 |
|---|---|
| URL | リフレッシュが要求されたときに表示される URL。 |
保存済み
モデル駆動型アプリ ページのレコードが保存された後に発生します。
| パラメーター | 説明 |
|---|---|
| newId | 新しく作成されるレコードに割り当てられる ID。 |
NavigationRequested
統一インターフェイス アプリ内でナビゲーションが発生した場合に発生します。
| パラメーター | 内容 |
|---|---|
| URL | ナビゲーションされるページの URL。 |
PageReady
ページの読み込みが完了したときに発生します。 統一インターフェイス ページタイプのホストされたコントロールでは、このイベントはデータが置換パラメーター リストに保存された後に発生します。
| パラメーター | 説明設定 |
|---|---|
| url | 読み込みを完了したページの URL。 |
Note
ダッシュボード、Web リソース、検索ページには、DataReady イベントは発生しません。
BrowserWindowReady
BrowserWindowReadyイベントは、Unified Service Desk クライアント アプリケーション内でブラウザ ウィンドウの準備ができた際に呼び出されます。 ダッシュボードと Web リソース用 BrowserWindowReady。
OnClickToAct
ユーザーがフォームで送信の通信 (ClickToAct) を選択すると、OnClickToAct イベントが呼び出されます。
チャネル統合フレームワークの ClickToAct ウィンドウのイベントを呼び出し、ビジネス要件として eventData を渡すカスタム コントロールを作成することもできます。
詳細情報 :onclicktoact
OnSendKbArticle
OnSendKbArticle イベントは、ユーザーがサポート情報コントロールの 送信 ボタンを選択すると呼び出されます。 eventData は、渡す必要のあるサポート情報記事の URL とタイトルです。
詳細情報 : onsendkbarticle
Note
モデル駆動型のアプリフォームでは window.IsUSD を使用せず、代わりにこのトピックに記載されている PageReady イベントやその他のイベントを使用することをお勧めします。
関連項目
Unified Service Desk の統一インターフェイス アプリのサポート
Unified Service Desk および統一インターフェイス構成のチュートリアル
チュートリアル 1: 統一インターフェイス アプリの単純エージェント アプリケーションを構築する
チュートリアル 2: エージェント アプリケーションに外部 Web ページを表示する
チュートリアル 3: ユーザーのエージェント アプリケーションに統一インターフェイス アプリのレコードを表示する
チュートリアル 4: ユーザーのエージェント アプリケーション内のセッションに統一インターフェイス アプリのレコードを表示する
チュートリアル 5: セッション名と概要データを表示することにより、拡張セッション情報を表示する
チュートリアル 6: エージェント アプリケーションで、デバッガのホストされたコントロールを構成する
チュートリアル 7: エージェント アプリケーションでエージェントスクリプトを構成する