Control de búsqueda de knowledge base (referencia del lado del cliente)
Publicado: enero de 2017
Se aplica a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Puede agregar un control de búsqueda en knowledge base a los formularios de entidades en la instancia de Dynamics 365 que tiene la característica de administración del conocimiento habilitada. Con este control, puede automatizar o mejorar mediante programación la experiencia de búsqueda de los usuarios cuando usen el control para consumir conocimiento en Dynamics 365.Más información:Entidades de administración del conocimiento
Nota
-
Puede elegir conocimiento nativo de Dynamics 365 o conocimiento de Parature como origen para la administración del conocimiento y la búsqueda. Si usa control Parature como origen de knowledge base y el control de búsqueda de knowledge base 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).
No se admite las siguientes nuevas API nuevas en Actualización 1 de CRM Online 2016 y Service Pack 1 Dynamics 365 (local) si usa Parature como origen de knowledge base: evento PostSearch, addOnPostSearch, removeOnPostSearch, getTotalResultCount y openSearchResult.
-
Con Actualización 1 de CRM Online 2016 y SP1 Dynamics 365 (local), el control de búsqueda de knowledge base también se admite para clientes móviles de Dynamics 365 (teléfonos y tabletas).
El control de búsqueda 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 el siguiente código 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 de este tema utilizarán kbSearchControl para representar el control de búsqueda de knowledge base en el formulario.
En este tema
Eventos de control de búsqueda de knowledge base
Métodos de control de búsqueda de knowledge base
Eventos de control de búsqueda de knowledge base
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.
PostSearch
Este evento se produce cuando se completa la búsqueda, y se muestran los resultados. Use los nuevos métodos addOnPostSearch, removeOnPostSearch para administrar controladores de eventos para este evento.
Métodos de control de búsqueda de knowledge base
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.
addOnPostSearch
Use este método para agregar un controlador de eventos al evento PostSearch.
Tipo de parámetro: Función. La función a agregar.
Ejemplo: Agregue la función llamada myFunction al evento PostSearch.
kbSearchControl.addOnPostSearch(myFunction);
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();
getSelectedResults
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.getSelectedResults();
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 Dynamics 365 o un departamento de Parature Este valor se usa como clave alternativa. Puede usarlo para averiguar si este artículo ya existe en Dynamics 365 o no. |
articleUid |
String |
El Id. único de artículo en Dynamics 365 o el sistema Parature. Cuando se usa Parature como origen del conocimiento, contendrá el Id. de cuenta y Id. del departamento Parature además, 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. |
attachmentCount |
Número |
Número de datos adjuntos del artículo. Esto es aplicable solo cuando se usa Parature como origen del conocimiento. |
createdOn |
Date |
Fecha en que se creó el artículo. Este valor usará la zona horaria y el formato del usuario actual. 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á. Será nulo cuando se use Dynamics 365 como el origen del conocimiento. 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. |
folderHref |
Cadena |
El vínculo a la ruta de la carpeta del artículo en Parature. Esto es aplicable solo cuando se usa Parature como origen del conocimiento. |
href |
Cadena |
El vínculo directo al elemento en la API de Parature, que se pueden usar para obtener contenido del artículo directamente. Esto es aplicable solo cuando se usa Parature como origen del conocimiento. |
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. Si desconecta la opción de dirección URL del portal, ésta estará en blanco. 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.True si está publicado; si no False. 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 Dynamics 365 o Parature. Use este vínculos para abrir el artículo con el panel de servicio de Dynamics 365 o Parature. |
timesViewed |
Number |
El número de veces que los clientes ven un artículo en el portal de . |
getTotalResultCount
Obtenga el recuento de resultados que se encuentran en el control de búsqueda.
Valor devuelto: Entero. El recuento de resultados de búsqueda.
Ejemplo: Establezca la variable searchCount en el recuento de los resultados de la búsqueda en el control de búsqueda.
var searchCount = kbSearchControl.getTotalResultCount();
openSearchResult
Abre un resultado de la búsqueda en el control de búsqueda especificando el número de resultado.
var openResultStatus = kbSearchControl.openSearchResult(resultNumber, mode);
Argumentos
resultNumber (Integer): Valor numérico que especifica el número de resultado que se abrirá. El número de resultado empieza en 1. Requerido.
mode (String): Especifique "Inline" o "Popout". Opcional. Si no especifica un valor para el argumento, se usa la opción predeterminada ("Inline").
El modo "Inline" abrirá el resultado en línea en el panel de lectura del control o en una pestaña del panel de referencia en caso del panel de referencia. El modo "Popout" abre el resultado en una ventana emergente.
Valor devuelto:: Booleano. Estado de apertura del resultado de búsqueda especificado. Devuelve 1 si es correcto; 0 si es error. El método devolverá -1 si el valor resultNumber especificado no está presente, o si el valor mode especificado no es válido.
removeOnPostSearch
Use este método para quitar un controlador de eventos del evento PostSearch.
Tipo de parámetro: Función. Función a quitar.
Ejemplo: Quite la función llamada myFunction del evento PostSearch.
kbSearchControl.removeOnPostSearch(myFunction);
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
Trabajar con artículos de conocimientos en Dynamics 365
Uso de conocimiento de Parature en Dynamics 365
Referencia de programación del lado del cliente
Escriba código para formularios de Microsoft Dynamics 365
Amplíe Microsoft Dynamics 365 en el cliente
Microsoft Dynamics 365
© 2017 Microsoft. Todos los derechos reservados. Copyright