Платформа интеграции каналов (размещенный элемент управления)

Статья
2025-05-08

Используйте размещенный элемент управления типа Channel Integration Framework для интеграции поставщика каналов с клиентским приложением Unified Service Desk. Вы можете создать несколько типов размещенного элемента управления Channel Integration Framework для размещения разных каналов. Дополнительные сведения см. в статье Интеграция канала с помощью Channel Integration Framework.

Сведения о создании размещенного элемента управления типа Channel Integration Framework см. в разделе Создание размещенного элемента управления Channel Integration Framework

Предопределенные действия UII

Для этого типа размещенного элемента управления поддерживаются следующие действия.

Закрывать

Это действие используется для закрытия размещенного элемента управления.

Событие FireEvent

Запускает определяемое пользователем событие из этого размещенного элемента управления.

Параметр	Описание
имя	Имя определяемого пользователем события.

Все последующие пары имя=значение становятся параметрами события. Дополнительные сведения о создании пользовательского события см. в разделе Создание пользовательского события.

Переместить кпанели

Это действие используется для перемещения размещенных элементов управления между панелями во время выполнения.

Параметр	Описание
приложение	Имя размещенного элемента управления, который необходимо переместить.
панель	Целевая панель для размещенного элемента управления.

Выводит всплывающий URL-адрес из размещенного элемента управления и запускает для него правила навигации по окну для маршрутизации всплывающего окна в нужное местоположение.

Параметр	Описание
URL-адрес	Направляет всплывающее окно из этого размещенного элемента управления с использованием этого URL-адреса, как если бы оно было всплывающим окном, запрошенным из отображаемого элемента управления.
рамка	Кадр, из которого возник этот поп-ап.

RunScript

Это действие внедряет JavaScript в основной фрейм приложения.

Параметр	Описание
	Параметр data — это JavaScript, который будет внедрен в форму. Заметка: Параметры замены могут быть использованы в скрипте, и они будут заменены до выполнения скрипта.

SetSize (УстановитьРазмер)

Это действие явно задает ширину и высоту размещенного элемента управления. Это особенно полезно при использовании "auto" в макетах панелей.

Параметр	Описание
Ширина	Ширина размещенного элемента управления.
высота	Высота размещенного элемента управления.

SetUserCanClose (УстановитьUserCanClose)

Позволяет пользователю закрыть размещенный элемент управления, щелкнув значок X в правом верхнем углу вкладки размещенного элемента управления.

Параметр	Описание
ПользовательCanClose	Установите этот параметр, чтобы `true` пользователь мог закрыть размещенный элемент управления. В противном случае установите false.

RaiseCifClientEvent

Это действие отправляет данные, полученные из события на стороне клиента, в размещенный элемент управления.

Параметр Описание

событие События на стороне клиента, из которых вы хотите поднять данные.

данные

Параметр	Описание
событие	События на стороне клиента, из которых вы хотите поднять данные.
данные	Параметр data принимает значения eventData. Передайте данные в виде строки, полученной из события с помощью параметров замены. `data = [[data]+]`. Поддерживаются следующие события на стороне клиента: OnClickToAct Событие SendKbArticleEvent событие onpagenavigate (справочник CIF JavaScript API)

Параметр data принимает значения eventData.

Передайте данные в виде строки, полученной из события с помощью параметров замены.
data = [[data]+].

Поддерживаются следующие события на стороне клиента:

UpdateCifContext (ОбновлениеCifContext)

Это действие отправляет данные от клиента к поставщику канала.

Параметр	Описание
corrId	Уникальный идентификатор должен совпадать с идентификатором, переданным в исходном событии от поставщика канала, чтобы UpdateCifContext получал обратно результат.
действие	Параметр для принятия или отклонения объекта промиса. Он принимает значение как `accept` или `reject`. Если вы передаете `accept`, API вызывает функцию success, которая в дальнейшем выполнит параметр result. если вы прошли `reject`, API вызывает функцию ошибки.
результат	Данные, которые вы хотите отправить от клиента к поставщику канала.

Предопределенные события

Для этого типа размещенного элемента управления поддерживаются следующие события.

СоздатьЗапись

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для создания сущности. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности.
данные	Строка, определяющая атрибуты и значения для новой записи сущности.
corrId	Уникальный идентификатор для сгенерированного события CreateRecord .

Чтобы узнать больше, см. createRecord (Справочник по API JavaScript CIF )

RetrieveRecord (ВосстановитьRecord)

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для получения сущности. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя объекта, которое требуется получить.
entityId	GUID записи сущности, которую требуется получить.
corrId	Уникальный идентификатор для сгенерированного события RetrieveRecord .
опции	Параметры системных запросов OData $select и $expand для получения данных. Используйте параметр системного запроса $select , чтобы ограничить возвращаемые свойства, включив список имен свойств, разделенных запятыми. Это важная рекомендация по повышению производительности. Если свойства не указаны с помощью $select, будут возвращены все свойства. Используйте параметр системного запроса $expand для управления тем, какие данные от связанных сущностей возвращаются. Если вы просто включите имя свойства навигации, вы получите все свойства для связанных записей. Свойства, возвращаемые для связанных записей, можно ограничить с помощью параметра системного запроса $select в скобках после имени свойства навигации. Используйте его как для однозначных свойств, так и для свойств навигации с значением коллекции . Параметры запроса указываются, начиная с `?`. Вы также можете указать несколько параметров запроса, разделив `&` параметры запроса. Рассмотрим пример. `?$select=name&$expand=primarycontactid($select=contactid,fullname)`

Чтобы узнать больше, см. retrieveRecord (Справочник по API JavaScript CIF )

UpdateRecord (ОбновитьЗапись)

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для обновления сущности. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности записи, которую требуется обновить.
entityId	GUID записи сущности, которую требуется обновить.
данные	Строка, содержащая `key: value` пары, где `key` — свойство сущности и `value` — значение свойства, которое вы хотите обновить.
corrId	Уникальный идентификатор для сгенерированного события UpdateRecord .

Чтобы узнать больше, см. updateRecord (Справочник по API JavaScript на основе CIF)

УдалитьЗапись

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для удаления сущности. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности записи, которую требуется удалить.
данные	Строка, определяющая атрибуты и значения для новой записи сущности.
entityId	GUID записи сущности, которую требуется удалить.
corrId	Уникальный идентификатор для сгенерированного события DeleteRecord .

Чтобы узнать больше, см. deleteRecord (Справочник по API JavaScript на основе CIF)

GetEntityMetadata (GetEntityMetadata)

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для возврата метаданных сущности для указанной сущности. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности.
атрибуты	Атрибуты, для которых вы хотите получить метаданные.
corrId	Уникальный идентификатор для сгенерированного события GetEntityMetadata .

Чтобы узнать больше, см. [getEntityMetadata (Справочник CIF по JavaScript API)](.. /channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment (ГетОкружающая среда)

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для получения текущего приложения Unified Interface и сведений о странице. Сведения включают appId, pageType и recordId (если доступно). Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметров для этого события нет.

Чтобы узнать больше, см. getEnvironment (Справочник CIF по JavaScript API)

Открытая форма

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для открытия формы сущности или формы быстрого создания. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
entityFormOptions	Варианты формы сущности для открытия формы.
entityFormParameters	Объект словаря, который передает дополнительные параметры в форму. Неверные параметры приведут к ошибке. Сведения о передаче параметров в форму см. в разделах Установка значений полей с помощью параметров, передаваемых в форму , и Настройка формы для приема пользовательских параметров строки запроса
corrId	Уникальный идентификатор для сгенерированного события OpenForm .

Чтобы узнать больше, см. [openForm (CIF JavaScript API Reference)](.. /channel-integration-framework/shared /openform.md)

RenderSearchPage (Страница рендеринга)

Событие происходит при вызове соответствующего JavaScript API Channel Integration Framework от провайдера канала, что позволяет осуществлять поиск среди записей определенного типа сущности. Этот API открывает страницу сущности Unified Interface с полем поиска на ней, предварительно заполненным строкой поиска, которая передается в качестве параметра. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности записи, к которой требуется выполнить запрос.
searchString	Строка для поиска среди атрибутов записей сущностей.
corrId	Уникальный идентификатор для сгенерированного события RenderSearchPage .

Чтобы узнать больше, см. [renderSearchPage (Справочник по API JavaScript CIF )](.. /channel-integration-framework/shared /rendersearchpage.md)

SearchAndOpenRecords

Событие происходит, когда соответствующий API JavaScript Channel Integration Framework вызывается поставщиком канала для поиска записи от поставщика канала во время входящего взаимодействия и открывает запись. Данные, переданные в API, также передаются в клиентское приложение Unified Service Desk.

Параметр	Описание
Объект	Логическое имя сущности для поиска и открытия.
queryParmeters	Параметры системных запросов OData $select и $expand для получения данных. Используйте параметр системного запроса $select , чтобы ограничить возвращаемые свойства, включив список имен свойств, разделенных запятыми. Это важная рекомендация по повышению производительности. Если свойства не указаны с помощью $select, будут возвращены все свойства. Используйте параметр системного запроса $expand для управления тем, какие данные от связанных сущностей возвращаются. Если вы просто включите имя свойства навигации, вы получите все свойства для связанных записей. Свойства, возвращаемые для связанных записей, можно ограничить с помощью параметра системного запроса $select в скобках после имени свойства навигации. Используйте его как для однозначных свойств, так и для свойств навигации с значением коллекции. Параметры запроса указываются, начиная с `?`. Вы также можете указать несколько параметров запроса, разделив `&` параметры запроса. Например: `?$select=name&$expand=primarycontactid($select=contactid,fullname)`
поискТолько	Установите значение false, чтобы открыть запись на странице Единого интерфейса, если запись поиска является одной записью. Установите false, чтобы открыть страницу поиска, если результат поиска содержит несколько записей, и автоматически заполняйте страницу поиска значением тега, указанным при использовании поля поиска в queryParmeters. Установите значение true только для получения результатов поиска в качестве результата промиса и не открывайте страницу записи или поиска.
corrId	Уникальный идентификатор для сгенерированного события SearchAndOpenRecords .