Channel Integration Framework (control hospedado)

Use el tipo de control hospedado Channel Integration Framework para integrar su proveedor de canal con la aplicación cliente de Unified Service Desk. Puede crear varios tipos de control hospedado Channel Integration Framework para hospedar diferentes canales. Para obtener más información, consulte Integrar canal mediante Channel Integration Framework.

Para crear un tipo de control hospedado Channel Integration Framework, consulte Crear un control hospedado Channel Integration Framework

Acciones de UII predefinidas

Se admiten las acciones siguientes para este tipo de control hospedado.

Cerrar

Esta acción sirve para cerrar el control hospedado.

FireEvent

Desencadena un evento definido por el usuario desde este control hospedado.

Parámetro	Descripción
nombre	Nombre del evento definido por el usuario.

Todos los pares posteriores de nombre=valor se convierten en los parámetros para el evento. Para obtener más información sobre cómo crear un evento definido por el usuario, consulte Crear un evento definido por el usuario.

MoveToPanel

Esta acción sirve para mover los controles hospedados entre paneles en tiempo de ejecución.

Parámetro	Descripción
Aplicación	Nombre del control hospedado que se moverá.
panel	Panel de destino para el control hospedado.

Ventana emergente

Aparece una dirección URL del control hospedado y ejecuta las reglas de navegación de ventanas con ella para enrutar el mensaje emergente a la ubicación correspondiente.

Parámetro	Descripción
url	Enruta un mensaje emergente desde este control hospedado utilizando esta dirección URL como si fuera un mensaje emergente solicitado desde el control mostrado.
frame	El marco desde el que se originó este mensaje emergente.

RunScript

Esta acción inyecta JavaScript en el cuadro principal de la aplicación.

Parámetro	Descripción
	El parámetro de datos es el JavaScript que se insertará en el formulario. Nota: Los parámetros de sustitución se pueden usar en el script y se sustituirán antes de que se ejecute el script.

SetSize

Esta acción establece explícitamente el ancho y el alto del control hospedado. Resulta especialmente útil cuando se usa "auto" en los diseños de panel.

Parámetro	Descripción
ancho	El ancho del control hospedado.
height	El alto del control hospedado.

SetUserCanClose

Permite al usuario cerrar el control hospedado haciendo clic en el icono de X en la esquina superior derecha de la pestaña del control hospedado.

Parámetro	Descripción
UserCanClose	Defina esto como true para permitir que el usuario cierre el control hospedado. De lo contrario, establezca como falso.

RaiseCifClientEvent

Esta acción envía los datos obtenidos del evento del lado del cliente al control hospedado.

Parámetro	Descripción
evento	Los eventos del lado cliente de donde desea obtener los datos.
Datos de	El parámetro de datos toma valores de eventData. Pase los datos como una cadena que se ha recibido del evento usando parámetros de sustitución. data = [[data]+]. Los eventos del lado del cliente admitidos son los siguientes: OnClickToAct SendKbArticleEvent evento onpagenavigate (Referencia API de CIF JavaScript)

UpdateCifContext

Esta acción envía los datos del cliente al proveedor de canal.

Parámetro	Descripción
corrId	El identificador único debe ser el mismo que el pasado en el evento inicial del proveedor de canal de modo que UpdateCifContext obtenga el resultado.
acción	El parámetro de aceptar o rechazar el objeto de la promesa. Toma el valor como accept o reject. Si pasa accept, la API llama a la función correcta, que seguirá ejecutando el parámetro de resultado. si pasa reject, la API llama a la función de error.
resultado	Los datos que desea enviar del cliente al proveedor de canal.

Eventos predefinidos

Se admiten los eventos siguientes para este tipo de control hospedado.

CreateRecord

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para crear una entidad. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad.
Datos de	Cadena que define los atributos y valores del registro de entidad nuevo.
corrId	El identificador único para el evento CreateRecord activado.

Para obtener más información, consulte createRecord (Referencia de API JavaScript CIF)

RetrieveRecord

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para recuperar una entidad. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad del registro que desea recuperar.
entityId	GUID del registro de entidad que desea recuperar.
corrId	El identificador único para el evento RetrieveRecord activado.
opciones	Opciones de consulta del sistema OData, $select y $expand, para recuperar los datos. Use la opción de consulta del sistema $select para limitar las propiedades devueltas incluyendo una lista separada por comas de nombres de propiedad. Esta es una práctica recomendada importante de rendimiento. Si las propiedades no se especifican con $select, se devolverán todas las propiedades. Use la opción de consulta del sistema $expand para controlar qué datos de entidades relacionadas se devuelven. Si incluye solo el nombre de la propiedad de navegación, recibirá todas las propiedades de registros relacionados. Puede limitar las propiedades devueltas para registros relacionados con la opción de la consulta del sistema $select entre paréntesis después del nombre de propiedad de navegación. Use esta opción para las propiedades de navegación de un solo valor y valoradas como colección. Especifique las opciones de consulta comenzando con ?. Puede especificar también varias opciones de consulta usando & para separar las opciones de consulta. Por ejemplo: ?$select=name&$expand=primarycontactid($select=contactid,fullname)

Para obtener más información, consulte retrieveRecord (Referencia de API JavaScript CIF)

UpdateRecord

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para actualizar una entidad. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad del registro que desea actualizar.
entityId	GUID del registro de entidad que desea actualizar.
Datos de	Cadena que contiene pares key: value, donde key es la propiedad de la entidad y value es el valor de la propiedad que desee actualizar.
corrId	El identificador único para el evento UpdateRecord activado.

Para obtener más información, consulte updateRecord (Referencia de API JavaScript CIF)

DeleteRecord

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para eliminar una entidad. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad del registro que desea eliminar.
Datos de	Cadena que define los atributos y valores del registro de entidad nuevo.
entityId	GUID del registro de entidad que desea eliminar.
corrId	El identificador único para el evento DeleteRecord activado.

Para obtener más información, consulte deleteRecord (Referencia de API JavaScript CIF)

GetEntityMetadata

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para devolver los metadatos de entidad para la entidad especificada. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad.
atributos	Los atributos para los que desea para obtener metadatos.
corrId	El identificador único para el evento GetEntityMetadata activado.

Para obtener más información, consulte [getEntityMetadata (Referencia de API JavaScript CIF)](../channel-integration-framework/v1/develop/reference/microsoft-ciframework /getentitymetadata.md)

GetEnvironment

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para obtener los detalles de página y aplicación de la interfaz unificada actual. Los detalles incluyen appId, pageType y recordId (si está disponible). Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

No hay parámetros para este evento.

Para obtener más información, consulte getEnvironment (Referencia de API JavaScript CIF)

OpenForm

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal para abrir un formulario de entidades o un formulario de creación rápida. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
entityFormOptions	Opciones de formulario de entidad para abrir el formulario.
entityFormParameters	Un objeto de diccionario que pasa parámetros adicionales al formulario. Los parámetros no válidos provocarán un error. Para obtener información acerca de cómo pasar parámetros a un formulario, consulte Establecer valores de campo mediante parámetros que se pasan a un formulario y Configurar un formulario para aceptar parámetros de cadena de consulta personalizada
corrId	El identificador único para el evento OpenForm activado.

Para obtener más información, consulte [openForm (Referencia de API JavaScript CIF)](../channel-integration-framework/shared /openform.md)

RenderSearchPage

El evento se produce cuando la API JavaScript Channel Integration Framework correspondiente se llama desde el proveedor de canal lo que permite buscar entre los registros de un tipo de entidad particular. Esta API abre la página de entidad de la interfaz unificada con el campo de búsqueda en ella rellenado previamente con la cadena de búsqueda que se pasa como un parámetro. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad del registro que desea consultar.
searchString	Cadena para buscar entre los atributos de los registros de entidad.
corrId	El identificador único para el evento RenderSearchPage activado.

Para obtener más información, consulte [renderSearchPage (Referencia de API JavaScript CIF)](../channel-integration-framework/shared /rendersearchpage.md)

SearchAndOpenRecords

El evento se produce cuando la API JavaScript Channel Integration Framework se llama desde el proveedor de canal para buscar el registro desde el proveedor de canal durante la comunicación entrante y abre el registro. Los datos pasados en la API también se pasan a la aplicación cliente de Unified Service Desk.

Parámetro	Descripción
Entidad	El nombre lógico de la entidad que se va a buscar y abrir.
queryParmeters	Opciones de consulta del sistema OData, $select y $expand, para recuperar los datos. Use la opción de consulta del sistema $select para limitar las propiedades devueltas incluyendo una lista separada por comas de nombres de propiedad. Esta es una práctica recomendada importante de rendimiento. Si las propiedades no se especifican con $select, se devolverán todas las propiedades. Use la opción de consulta del sistema $expand para controlar qué datos de entidades relacionadas se devuelven. Si incluye solo el nombre de la propiedad de navegación, recibirá todas las propiedades de registros relacionados. Puede limitar las propiedades devueltas para registros relacionados con la opción de la consulta del sistema $select entre paréntesis después del nombre de propiedad de navegación. Use esta opción para las propiedades de navegación de un solo valor y valoradas como colección. Especifique las opciones de consulta comenzando con ?. Puede especificar también varias opciones de consulta usando & para separar las opciones de consulta. Por ejemplo: ?$select=name&$expand=primarycontactid($select=contactid,fullname)
searchOnly	Establezca como false para abrir el registro en la página de la interfaz unificada si el registro de búsqueda es un solo registro. Establezca como false para abrir página de búsqueda si el resultado de la búsqueda tiene varios registros y se utiliza rellenar automáticamente la página de búsqueda con el valor de etiqueta indicado cuando se usó el campo de búsqueda en queryParmeters. Establezca como true solo para obtener los resultados de la búsqueda como resultado de promesa y no abrir el registro o la página de búsqueda.
corrId	El identificador único para el evento SearchAndOpenRecords activado.

Vea también

• Integrar canal mediante Channel Integration Framework
• Crear un control hospedado de Channel Integration Framework