Channel Integration Framework (ホストされたコントロール)

[アーティクル]
06/27/2024

Channel Integration Framework 型のホストされたコントロールを使用して、チャネルプロバイダーを Unified Service Desk クライアントアプリケーションと統合します。異なるチャンネルをホストするために、複数の Channel Integration Framework 型のホストされたコントロールを作成できます。詳細については Channel Integration Framework を使用してチャネルを統合するを参照してください。

Channel Integration Framework 型のホストされたコントロールを作成するには、Channel Integration Framework のホストされたコントロールを作成するを参照してください。

事前定義 UII アクション

この種類のホストされたコントロールでは、以下のアクションがサポートされます。

[閉じる]

この操作は、ホストされたコントロールを閉じるために使用します。

FireEvent

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

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

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

MoveToPanel

このアクションを使用して、ホストされたコントロールを実行時にパネル間で移動します。

パラメーター	内容
アプリ	移動するホストされたコントロールの名前。
パネル	ホストされたコントロールのターゲットパネルです。

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

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

RunScript

このアクションは、アプリケーションのメインフレームに JavaScript を挿入します。

パラメーター	説明
	データパラメーターは、フォームに挿入される JavaScript です。注: 置換パラメーターは、スクリプトで使用され、スクリプトが実行される前に置き換えられます。

SetSize

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

パラメーター	内容
幅	ホストされるコントロールの幅。
height	ホストされたコントロールの高さ。

SetUserCanClose

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

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

RaiseCifClientEvent

このアクションは、クライアント側のイベントで発生したデータをホストされたコントロールに送信します。

パラメーター	説明
イベント	データを発生させたい場所からのクライアント側のイベント。
data	データパラメーターは eventData 値を取ります。置換パラメーターを使用して、イベントから受け取った文字列としてデータを渡します。 `data = [[data]+]`。サポートされるクライアント側のイベントを以下に示します: OnClickToAct SendKbArticleEvent onpagenavigate のイベント (CIF JavaScript リファレンス)

UpdateCifContext

このアクションは、クライアントからチャネルプロバイダーにデータを送信します。

パラメーター	説明
corrId	UpdateCifContext が結果を取り戻すために、一意識別子はチャネルプロバイダーから初期イベントで渡された識別子と同じである必要があります。
アクション	promise オブジェクトを承認または却下するパラメータ。 `accept` または `reject` の値をとります。 `accept` を渡すと API は成功関数を呼び出し、それはさらに結果パラメータを実行します。 `reject` を渡すと API はエラー関数を呼び出します。
結果	クライアントからチャネルプロバイダーに送信する必要があるデータ。

定義済みのイベント

この種類のホストされたコントロールでは以下のイベントがサポートされます。

CreateRecord

エンティティを作成するために対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	エンティティの論理名。
data	新しいエンティティレコードの属性および値を定義する文字列。
corrId	発生した CreateRecord イベントの一意識別子。

詳細については createRecord (CIF JavaScript API 参照) を参照してください。

RetrieveRecord

エンティティを取得するために対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	取得するレコードのエンティティの論理名。
entityId	取得するエンティティレコードの GUID。
corrId	発生した RetrieveRecord イベントの一意識別子。
オプション	データを取得する OData システムクエリオプション、$select および $expand。プロパティ名のコンマ区切りリストを含めることにより返されるプロパティを制限するためには $select システムクエリオプションを使用します。これは重要なパフォーマンスのベストプラクティスです。プロパティが $select を使用して指定されない場合は、すべてのプロパティが返されます。 $expand システムクエリオプションを使用して、関連エンティティからどのデータが返されるかをコントロールします。単にナビゲーションプロパティ名を含めた場合は、関連レコードのすべてのプロパティが表示されます。ナビゲーションプロパティ名の後にかっこで示される $select システムクエリオプションを使用して、関連レコードに対して返されるプロパティを制限できます。これは、単一値とコレクション値のナビゲーションプロパティの両方で使用します。 `?` で始まるクエリオプションを指定します。クエリオプションを `&` で区切って複数のクエリオプションを指定することもできます。たとえば、次のようなものです。 `?$select=name&$expand=primarycontactid($select=contactid,fullname)`

詳細については retrieveRecord (CIF JavaScript API 参照) を参照してください。

UpdateRecord

エンティティを更新するために対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	更新するレコードのエンティティの論理名。
entityId	更新するエンティティレコードの GUID。
data	`key: value` ペアを含む文字列では、`key` はエンティティのプロパティであり、`value` は、更新するプロパティの値です。
corrId	発生した UpdateRecord イベントの一意識別子。

詳細については updateRecord (CIF JavaScript API 参照) を参照してください。

DeleteRecord

エンティティを削除するために対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	削除するレコードのエンティティの論理名。
data	新しいエンティティレコードの属性および値を定義する文字列。
entityId	削除するエンティティレコードの GUID。
corrId	発生した DeleteRecord イベントの一意識別子。

詳細については deleteRecord (CIF JavaScript API 参照) を参照してください。

GetEntityMetadata

特定のエンティティのエンティティメタデータを返すために、対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	エンティティのエンティティ論理名。
属性	メタデータを取得する必要がある属性。
corrId	発生した GetEntityMetadata イベントの一意識別子。

詳細については [getEntityMetadata (CIF JavaScript API 参照)](../channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md) を参照してください。

GetEnvironment

現在の統一インターフェイスアプリやページの詳細を取得するために、対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。詳細には、appId、pageType、および recordId (使用可能な場合) が含まれます。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

このイベントにパラメータはありません。

詳細については getEnvironment (CIF JavaScript API 参照) を参照してください。

OpenForm

エンティティフォームを開くもしくはフォームを簡易作成するために、対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entityFormOptions	フォームを開くためのエンティティフォームオプション。
entityFormParameters	追加のパラメーターをフォームに渡すディクショナリオブジェクト。パラメーターが無効の場合、エラーが発生します。フォームにパラメータを渡す方法の詳細については、フォームに渡すパラメーターを使用してフィールド値を設定するおよびカスタムクエリストリングパラメーターが許可されるフォームの構成を参照してください。
corrId	発生した OpenForm イベントの一意識別子。

詳細については [openForm (CIF JavaScript API 参照)](../channel-integration-framework/shared /openform.md) を参照してください。

RenderSearchPage

特定のエンティティの種類のレコードを検索可能にするために、対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。この API を使用すると、統一インターフェイスエンティティページが開きます。ページ上の検索フィールドには、パラメーターとして渡した検索文字列があらかじめ入力されています。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	クエリするレコードのエンティティの論理名。
searchString	エンティティレコードの属性を検索する文字列。
corrId	発生した RenderSearchPage イベントの一意識別子。

詳細については [renderSearchPage (CIF JavaScript API 参照)](../channel-integration-framework/shared /rendersearchpage.md) を参照してください。

SearchAndOpenRecords

インバウンド通信中にチャネルプロバイダーからレコードを検索しレコードを開くために、対応する Channel Integration Framework の JavaScript API がチャネルプロバイダーから呼び出されたときに、このイベントが発生します。 API で渡されたデータは Unified Service Desk のクライアントアプリケーションにも渡されます。

パラメーター	説明
entity	検索して開くためのエンティティの論理名。
queryParmeters	データを取得する OData システムクエリオプション、$select および $expand。プロパティ名のコンマ区切りリストを含めることにより返されるプロパティを制限するためには $select システムクエリオプションを使用します。これは重要なパフォーマンスのベストプラクティスです。プロパティが $select を使用して指定されない場合は、すべてのプロパティが返されます。 $expand システムクエリオプションを使用して、関連エンティティからどのデータが返されるかをコントロールします。単にナビゲーションプロパティ名を含めた場合は、関連レコードのすべてのプロパティが表示されます。ナビゲーションプロパティ名の後にかっこで示される $select システムクエリオプションを使用して、関連レコードに対して返されるプロパティを制限できます。これは、単一値とコレクション値のナビゲーションプロパティの両方で使用します。 `?` で始まるクエリオプションを指定します。クエリオプションを `&` で区切って複数のクエリオプションを指定することもできます。例: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`
searchOnly	検索レコードが単一レコードの場合は、false を設定して統一インターフェイスページでレコードを開きます。検索結果に複数のレコードがある場合は検索ページを開くには false に設定し、検索フィールドが queryParmeters で使用されているときに指定されたタグ値を検索ページに自動入力します。検索結果を promise 結果として取得し、レコードまたは検索ページを開かない場合にのみ true を設定します。
corrId	発生した SearchAndOpenRecords イベントの一意識別子。

次の方法で共有