Control de búsqueda de knowledge base de Parature (referencia del lado del cliente)

Artigo
07/06/2017

Publicado: noviembre de 2016

Se aplica a: Dynamics CRM 2015

Con Actualización 1 de Microsoft Dynamics CRM Online 2015 o posterior, cuando una organización tiene la integración de Parature habilitada puede agregar un nuevo control de búsqueda en knowledge base a los formularios. Este control proporciona compatibilidad de programabilidad para automatizar o mejorar la experiencia del usuario cuando esa este control.

Importante

En las organizaciones de Microsoft Dynamics CRM Online, esta característica solo está disponible si su organización se ha actualizado a la Actualización 1 de Dynamics CRM Online 2015. Esta característica no está disponible para Dynamics CRM (local).

Estos eventos y métodos no estén conectados directamente a ninguna API de Parature. Sin embargo, si el control se encuentra en el formulario, ya deberá estar establecida una conexión con Parature para poder realizar directamente llamadas API de Parature sin requerir un token de seguridad. Sin embargo, estas serán solicitudes entre dominios, por lo que debe usar uso compartido de recursos de origen cruzado (CORS).

El control de búsqueda de la administración de knowledge base es un control Xrm.Page.ui, por lo que es compatible con todos los métodos estándar que tienen los controles. Pero también admite eventos y métodos adicionales. Para obtener información sobre métodos de control estándar, consulte Control Xrm.Page.ui (referencia de cliente).

Si conoce el nombre del control, puede tener acceso a él mediante lo siguiente donde <name> representa el nombre del control...

kbSearchControl = Xrm.Page.getControl("<name>");

Nota

Cuando el control de búsqueda de knowledge base se agrega al panel social el nombre será "searchwidgetcontrol_notescontrol". Este nombre no se puede cambiar.

Todos los ejemplos siguientes utilizarán kbSearchControl para representar el control de búsqueda de knowledge base en el formulario.

Eventos

Use los eventos para este control para permitir que el código responda al elemento seleccionado o abierto.

OnResultOpened

Este evento se produce cuando un artículo de KB se abre en el control de búsqueda de knowledge base en línea o mediante la acción de extracción. Use los métodos addOnResultOpened, removeOnResultOpened para administrar controladores de eventos para este evento.

OnSelection

Este evento se produce cuando un artículo de KB se selecciona en el control de búsqueda de knowledge base. Use los métodos addOnSelection, removeOnSelection para administrar controladores de eventos para este evento.

Métodos

Use los métodos para el control de búsqueda de knowledge base para establecer o quitar controladores de eventos e interactuar con la consulta de búsqueda y los resultados de la búsqueda.

addOnResultOpened

Use este método para agregar un controlador de eventos al evento OnResultOpened.

Tipo de parámetro: Función. La función a agregar.

Ejemplo: Agregue la función llamada myFunction al evento OnResultOpened.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Use este método para agregar un controlador de eventos al evento OnSelection.

Tipo de parámetro: Función. La función a agregar.

Ejemplo: Agregue la función llamada myFunction al evento OnSelection.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Use este método para obtener el texto usado como criterio de búsqueda para el control de administración de knowledge base.

Valor devuelto: Cadena. El texto de la consulta de búsqueda.

Ejemplo:: Establezca la variable searchQuery en el texto de la consulta de búsqueda.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResult

Use este método para obtener el resultado seleccionado actualmente del control de búsqueda. El resultado seleccionado actualmente también representa el resultado que está abierto actualmente.

Valor devuelto: KBSearchResult. El resultado seleccionado actualmente.

Ejemplo: Establezca la variable kbSearchResult como el resultado seleccionado actualmente.

var kbSearchResult = kbSearchControl.getSelectedResult();

Propiedades de KBSearchResult

En la siguiente tabla se describen las propiedades del objeto KBSearchResult.

Propiedad	Tipo	Descripción
answer	String	El formato HTML que contiene el contenido del artículo. Podría pasar este contenido a una acción personalizada que pudiera incluirla en un correo electrónico para enviar al cliente.
articleId	String	El Id. del artículo en un departamento de Parature Este valor se usa como clave alternativa. Puede usarlo para averiguar si este artículo ya existe en CRM o no.
articleUid	String	El Id. único de artículo para el sistema Parature. Este contendrá Id. de cuenta y también Id. de departamento de Parature, por ejemplo, "7924/8112/Article/25". Este valor se usa como clave alternativa. Este Id. es necesario para crear un nuevo registro de KB mientras asocia un artículo si aún no existe uno.
createdOn	Date	Fecha en que se creó el artículo. Es posible que desee usar la antigüedad del artículo de la lógica de negocios.
expiredDate	Date	Fecha en que el artículo expiró o expirará. Puede comparar esta fecha los datos actuales para determinar si el artículo ha expirado o no. El valor usa la zona horaria y el formato del usuario actual.
isAssociated	Boolean	Indica si el artículo está asociado con el registro primario o no. Puede comprobar esta valor antes de asociar el artículo con el registro actual usando scripts de formulario o en otro proceso iniciado por scripts de formulario.
lastModifiedOn	Date	Fecha en la que el elemento se modificó por última vez. Este valor usará la zona horaria y el formato del usuario actual.
publicUrl	String	Dirección URL del portal de soporte técnico del artículo. Use una acción personalizada para incluir esto en un víonculo en el contenido de un correo electrónico para enviar a un cliente.
published	Boolean	Indica si el artículo está en estado publicado o de borrador. Debe comprobar si el artículo está publicado antes de enviar la información sobre él a un cliente.
question	String	Título del artículo. Si va a hacer referencia al artículo en cualquier proceso de negocio, puede hacer referencia a él por nombre mediante este valor.
rating	Number	Calificación del artículo.
searchBlurb	String	Un breve fragmento del contenido del artículo que contiene las áreas que ha encontrado la consulta de búsqueda. Use esta opción para ofrecer un vistazo del artículo a los usuarios en la lista de búsqueda y ayudarles a determinar si este es el artículo que están buscando.
serviceDeskUri	String	Vínculo al artículo en el panel de servicio de Parature. Use este vínculos para abrir el artículo con el panel de servicio de Parature.
timesViewed	Number	El número de veces que los clientes ven un artículo en el portal de Parature.

removeOnResultOpened

Use este método para quitar un controlador de eventos del evento OnResultOpened.

Tipo de parámetro: Función. Función a quitar.

Ejemplo: Quite la función llamada myFunction del evento OnResultOpened.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Use este método para quitar un controlador de eventos del evento OnSelection.

Tipo de parámetro: Función. Función a quitar.

Ejemplo: Quite la función llamada myFunction del evento OnSelection.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Use este método para establecer el texto usado como criterio de búsqueda para el control de administración de knowledge base.

Parámetro: Cadena. El texto de la consulta de búsqueda.

Ejemplo:: Establezca el texto de la consulta de búsqueda como "How to solve the problem".

kbSearchControl.setSearchQuery("How to solve the problem");

Ver también

Integración de Microsoft Dynamics CRM 2015 con Parature
Referencia de programación del lado del cliente
Escriba código para formularios de Microsoft Dynamics CRM 2015
Extensiones de la aplicación cliente

Compartir por