Controle de pesquisa da base de dados de conhecimento do Parature (referência do cliente)

Artigo
07/06/2017

Publicado: novembro de 2016

Aplicável a: Dynamics CRM 2015

Com o Atualização 1 do Microsoft Dynamics CRM Online 2015 ou posterior, quando uma organização tiver a integração do Parature habilitada, poderá adicionar um novo controle de pesquisa da base de dados de conhecimento a formulários. Esse controle oferece suporte para programação para automatizar ou aprimorar a experiência do usuário ao utilizar esse controle.

Importante

Para organizações que utilizam o Microsoft Dynamics CRM Online, esse recurso só estará disponível se a sua organização tiver atualizado para a Atualização 1 do Dynamics CRM Online 2015. Este recurso não está disponível para o Dynamics CRM (local).

Esses eventos e métodos não estão conectados diretamente a qualquer API do Parature. No entanto, se o controle estiver presente no formulário, uma conexão com o Parature já deverão estar estabelecida de forma que você possa fazer chamadas diretas à API do Parature sem exigir um token de segurança. Entretanto, essas serão solicitações entre domínios e, portanto, você deverá usar o compartilhamento de recursos entre origens (CORS).

O controle de pesquisa de gerenciamento da base de dados de conhecimento é um controle Xrm.Page.ui e, portanto, dá suporte a todos os métodos padrão que controles têm. Mas também oferece suporte a eventos e métodos adicionais. Para obter informações sobre os métodos de controle padrão, consulte Controle Xrm.Page.ui (referência do cliente).

Se você souber o nome de controle, poderá acessá-lo usando a opção a seguir, onde <nome> representa o nome de controle…

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

Observação

Quando o controle de pesquisa da base de dados de conhecimento for adicionado ao painel social, o nome será "searchwidgetcontrol_notescontrol". Esse nome não pode ser alterado.

Todos os exemplos abaixo usarão kbSearchControl para representar o controle de pesquisa da base de dados de conhecimento no formulário.

Eventos

Use os eventos para esse controle para permitir que o código responda ao item selecionado ou aberto.

OnResultOpened

Esse evento ocorre quando um artigo da base de dados de conhecimento é aberto no controle de pesquisa da base de dados de conhecimento em linha ou por meio da ação pop-out. Use os métodos addOnResultOpened e removeOnResultOpened para gerenciar manipuladores de eventos para esse evento.

OnSelection

Esse evento ocorre quando um artigo da base de dados de conhecimento é selecionado no controle de pesquisa da base de dados de conhecimento. Use os métodos addOnSelection e removeOnSelection para gerenciar manipuladores de eventos para esse evento.

Métodos

Use os métodos para o controle de pesquisa da base de dados de conhecimento para definir ou remover manipuladores de evento e interagir com a consulta de pesquisa e com os resultados da pesquisa.

addOnResultOpened

Use esse método para adicionar um manipulador de eventos ao evento OnResultOpened.

Parâmetro: função. A função a ser adicionada.

Exemplo: adicione a função chamada myFunction ao evento OnResultOpened.

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

Use esse método para adicionar um manipulador de eventos ao evento OnSelection.

Parâmetro: função. A função a ser adicionada.

Exemplo: adicione a função chamada myFunction ao evento OnSelection.

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

Use esse método para obter o texto usado como critério de pesquisa para o controle de gerenciamento da base de dados de conhecimento.

Valor de Retorno: cadeia de caracteres. O texto da consulta de pesquisa.

Exemplo: defina a variável searchQuery para o texto da consulta de pesquisa.

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResult

Use esse método para obter o resultado no controle de pesquisa selecionado atualmente. O resultado atualmente selecionado também representa o resultado atualmente aberto.

Valor de Retorno: KBSearchResult. O resultado atualmente selecionado.

Exemplo: defina a variável kbSearchResult para o resultado atualmente selecionado.

var kbSearchResult = kbSearchControl.getSelectedResult();

Propriedades de KBSearchResult

A tabela a seguir descreve as propriedades do objeto KBSearchResult.

Propriedade	Tipo	Descrição
answer	String	A marcação HTML que contém o conteúdo de artigo. Você poderia passar esse conteúdo para uma ação personalizada que poderia incluí-lo em um email a ser enviado para o cliente.
articleId	String	A ID do artigo em um departamento do Parature. Esse valor é usado como uma chave alternativa. Você poderá usá-lo para verificar se o artigo já existe no CRM ou não.
articleUid	String	A ID do artigo exclusiva para o sistema Parature. Isso conterá a ID de conta do Parature e também a ID do departamento, por exemplo, "7924/8112/Article/25". Esse valor é usado como uma chave alternativa. Essa ID é necessária para criar um novo registro da base de dados de conhecimento, associando um artigo caso ainda não exista um.
createdOn	Date	A data em que o artigo foi criado. Talvez você queira usar a idade do artigo em sua lógica de negócios.
expiredDate	Date	A data em que o artigo expirou ou vai expirar. É possível comparar essa data aos dados atuais para determinar se o artigo expirou ou não. O valor atual usa o fuso horário e o formato do usuário atual.
isAssociated	Boolean	Indica se o artigo está associado ao registro principal ou não. Você pode verificar esse valor antes de associar o artigo ao registro atual usando scripts de formulário ou em outro processo iniciado por scripts de formulário.
lastModifiedOn	Date	Data em que o artigo foi modificado pela última vez. Esse valor estará no fuso horário e no formato do usuário atual.
publicUrl	String	URL do portal de suporte do artigo. Use uma ação personalizada para incluir isso em um link no conteúdo de um email a ser enviado para um cliente.
published	Boolean	Indica se o artigo está em estado publicado ou de rascunho. Verifique se o artigo está publicado antes de enviar informações sobre ele a um cliente.
question	String	O título do artigo. Se você planeja referenciar o artigo em qualquer processo empresarial, poderá fazer referência a ele por nome usando esse valor.
rating	Number	A classificação do artigo.
searchBlurb	String	Um pequeno trecho do conteúdo do artigo que contém as áreas onde a consulta de pesquisa foi atingida. Use essa opção para fornecer uma pequena amostra do artigo para os usuários na lista de pesquisa e para ajudá-los a determinar se este é o artigo que eles estão procurando.
serviceDeskUri	String	Link para o artigo na central de serviços do Parature. Use este link para abrir o artigo usando a central de serviços do Parature.
timesViewed	Number	O número de vezes que um artigo é exibido no portal do Parature pelos clientes.

removeOnResultOpened

Use esse método para remover um manipulador de eventos do evento OnResultOpened.

Parâmetro: função. A função a ser removida.

Exemplo: remova a função chamada myFunction do evento OnResultOpened.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

Use esse método para remover um manipulador de eventos do evento OnSelection.

Parâmetro: função. A função a ser removida.

Exemplo: remova a função chamada myFunction do evento OnSelection.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

Use esse método para definir o texto usado como critério de pesquisa para o controle de gerenciamento da base de dados de conhecimento.

Parâmetro: cadeia de caracteres. O texto da consulta de pesquisa.

Exemplo: defina o texto da consulta de pesquisa como "How to solve the problem".

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

Confira Também

Integrar o Microsoft Dynamics CRM 2015 ao Parature
Referência de programação do cliente
Criar códigos para os formulários do Microsoft Dynamics CRM 2015
Escrever as extensões do aplicativo do cliente

Compartilhar via