Partilhar via

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

  • Artigo

 

Publicado: janeiro de 2017

Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Você pode adicionar um controle de pesquisa da base de dados de conhecimento a formulários de entidade na sua instância do Dynamics 365 que tem o recurso de gerenciamento de conhecimento ativado. Com esse controle, você pode automatizar ou aperfeiçoar de forma programática as experiências de pesquisa dos usuários quando eles usam o controle para consumir conhecimento no Dynamics 365.Para obter mais informações:Entidades do gerenciamento do conhecimento

Observação

  • Você pode escolher o conhecimento do Dynamics 365 nativo ou o conhecimento do Parature como fonte para gerenciamento de conhecimento e pesquisa. Se usar o Parature como sua fonte de base de dados de conhecimento e o controle de pesquisa da base de dados de conhecimento estiver presente no formulário, uma conexão Parature já deve estar estabelecida para que você possa fazer chamadas diretas à API do Parature sem a necessidade de 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).

    As novas APIs de cliente a seguir, introduzidas no CRM Online 2016 Atualização 1 e no Dynamics 365 Service Pack 1 (local), não terão suporte se você estiver usando o Parature como sua fonte de base de dados de conhecimento: evento PostSearch, addOnPostSearch, removeOnPostSearch, getTotalResultCount e openSearchResult.

  • No CRM Online 2016 Atualização 1 e na versão do Dynamics 365 SP1 (local), o controle de pesquisa da base de dados de conhecimento também tem suporte dos clientes móveis do Dynamics 365 (telefones e tablets).

O controle de pesquisa da base de dados de conhecimento é um controle Xrm.Page.ui e, portanto, é compatível com todos os métodos padrão que os 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 o código 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 neste tópico usarão kbSearchControl para representar o controle de pesquisa da base de dados de conhecimento no formulário.

Neste tópico

Eventos do controle de pesquisa da base de dados de conhecimento

Métodos do controle de pesquisa da base de dados de conhecimento

Eventos do controle de pesquisa da base de dados de conhecimento

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.

PostSearch

Esse evento ocorre quando a pesquisa for concluída, e os resultados forem exibidos. Use os novos métodos addOnPostSearch e removeOnPostSearch para gerenciar os manipuladores de eventos para esse evento.

Métodos do controle de pesquisa da base de dados de conhecimento

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.

addOnPostSearch

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

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

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

kbSearchControl.addOnPostSearch(myFunction);

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();

getSelectedResults

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.getSelectedResults();

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 no Dynamics 365 ou em um departamento do Parature.

Esse valor é usado como uma chave alternativa. Você poderá usá-lo para verificar se o artigo já existe no Dynamics 365 ou não.

articleUid

String

A ID do artigo exclusiva no Dynamics 365 ou sistema do Parature.

Ao usar o Parature como fonte de conhecimento, ele conterá a ID da conta do Parature e 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.

attachmentCount

Número

Número de anexos no artigo.

Só é aplicável durante o uso do Parature como fonte de conhecimento.

createdOn

Date

A data em que o artigo foi criado. Esse valor estará no fuso horário e no formato do usuário atual.

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. Será nulo ao usar o Dynamics 365 como fonte de conhecimento.

É 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.

folderHref

Cadeia de caracteres

O link para o caminho da pasta do artigo no Parature.

Só é aplicável durante o uso do Parature como fonte de conhecimento.

href

Cadeia de caracteres

O link direto para o artigo na API do Parature, que pode ser usado para obter diretamente o conteúdo.

Só é aplicável durante o uso do Parature como fonte de conhecimento.

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. Se a opção de URL do portal estiver desativada, ele estará em branco.

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.True, se publicado, caso contrário, False.

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 no Dynamics 365 ou na central de serviços do Parature.

Use este link para abrir o artigo usando o Dynamics 365 ou a central de serviços do Parature.

timesViewed

Number

O número de vezes que um artigo é exibido no portal do pelos clientes.

getTotalResultCount

Obtém a contagem de resultados localizados no controle de pesquisa.

Valor de Retorno: inteiro. A contagem de resultados da pesquisa.

Exemplo: defina a variável searchCount como a contagem dos resultados da pesquisa no controle de pesquisa.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

Abre os resultados de uma pesquisa no controle de pesquisa especificando o número de resultados.

var openResultStatus = kbSearchControl.openSearchResult(resultNumber, mode);

Argumentos

  • resultNumber (Integer): valor numérico que especifica o número de resultados a serem abertos. O número de resultados começa com 1. Necessário.

  • mode (String): especifique "Inline" ou "Popout". Opcional. Se você não especificar um valor para o argumento, a opção padrão ("Inline") será usada.

    O modo "Inline" abre o resultado embutido no painel de leitura do controle ou em uma guia do painel de referência na ocorrência do painel de referência. O modo "Popout" abre o resultado em uma janela de pop-out.

Valor de Retorno: booliano. Status da abertura dos resultados da pesquisa especificada. Retornará 1, se bem-sucedido, ou 0, se malsucedido. O método retornará -1 se o valor resultNumber especificado não estiver presente ou se o valor mode especificado for inválido.

removeOnPostSearch

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

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

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

kbSearchControl.removeOnPostSearch(myFunction);

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

Trabalhar com artigos de conhecimento no Dynamics 365
Usar o conhecimento do Parature no Dynamics 365
Referência de programação do cliente
Crie códigos para os formulários do Microsoft Dynamics 365
Estender o Microsoft Dynamics 365 no cliente

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais