Compartilhar via

Trabalhar com artigos de conhecimento no Dynamics 365

  • Artigo

 

Publicado: janeiro de 2017

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

Os novos artigos de conhecimento no Microsoft Dynamics 365 permitem criar artigos de conhecimento avançados junto com o suporte para o controle de versão e tradução. Quando você criar e publicar um artigo de conhecimento, ele ficará disponível para os usuários da instância do Dynamics 365 de forma que eles possam usar as informações nos artigos de forma eficiente para atender os clientes. Use o KnowledgeArticle para armazenar e gerenciar nativamente o conhecimento no Dynamics 365. Se estiver usando o conhecimento de Parature, use a entidade do KnowledgeBaseRecord de forma programática para usar os artigos da base de dados de conhecimento de Parature.

Este tópico fornece informações sobre como trabalhar com os novos recursos de gerenciamento de conhecimento do Dynamics 365 de modo nativo. Se você usar Parature como a fonte de conhecimento no Dynamics 365, consulte Usar o conhecimento do Parature no Dynamics 365.

Observação

Se estiver usando o modelo mais antigo da entidade do artigo da base de conhecimento (KBArticle), consulte Trabalhar com artigos da base de conhecimento do Dynamics 365 mais adiante neste tópico.

Não é possível habilitar de forma programática o recurso de gerenciamento da base de dados de conhecimento para entidades na instância do Dynamics 365; isso só pode ser feito usando o cliente web do Dynamics 365.Para obter mais informações:Ajuda e Treinamento: configurar o gerenciamento do conhecimento no CRM

Neste tópico

Criar um artigo de conhecimento

Crie uma versão principal e secundária do artigo de conhecimento

Criar uma tradução do artigo de conhecimento

Ciclo de vida de artigos de conhecimento: Alterar o estado de um artigo de conhecimento

Associar um registro do artigo de conhecimento a uma instância de entidade do Dynamics 365

Contagem de exibição do artigo de conhecimento do incremento

Pesquisar artigos de conhecimento usando a pesquisa de texto completo

Trabalhar com artigos da base de conhecimento do Dynamics 365

Criar um artigo de conhecimento

Quando você cria um registro de artigo de conhecimento, o Dynamics 365 cria internamente um artigo raiz do registro. O artigo raiz atua como um contêiner do artigo primário de conhecimento criado por você em conjunto com as versões e traduções de artigos que podem ser criados no futuro. O diagrama a seguir ilustra o módulo de entidade para a entidade KnowledgeArticle.

Módulo de entidade KnowledgeArticle

Quando você cria um registro de artigo de conhecimento, ele é criado no estado Draft. Usando a nova entidade do KnowledgeArticle, você pode criar um artigo especificando seu conteúdo e formatação no formato HTML comparado ao uso da entidade KbArticle antiga no qual você teve que associá-lo a um modelo que descreveu as seções e formatação do artigo. Você pode especificar seu próprio valor para o atributo do KnowledgeArticle.ArticlePublicNumber ao criar um registro de artigo de conhecimento de forma programática; caso contrário, o valor é gerado automaticamente com base no formato especificado na área configurações no cliente web do Dynamics 365. O atributo KnowledgeArticle.ArticlePublicNumber armazena o ID exposto aos clientes, parceiros e outros usuários externos para fazer referência e procurar artigos de conhecimento e manter as mesmas versões do artigo de conhecimento e traduções.

O código de exemplo a seguir mostra como criar um registro do artigo de conhecimento:

KnowledgeArticle newKnowledgeArticle = new KnowledgeArticle
{
   Title = "Sample Knowledge Article",
   Content = "<p>This is the article content.</p>"
};
knowledgeArticleId = _serviceProxy.Create(newKnowledgeArticle);
Console.WriteLine("Created {0}", newKnowledgeArticle.Title);

Crie uma versão principal e secundária do artigo de conhecimento

Quando você cria um registro de artigo de conhecimento, a versão principal é automaticamente definida como 1 e 0 para a versão secundária. Use CreateKnowledgeArticleVersion Action (API da Web) ou CreateKnowledgeArticleVersionRequest (serviço da organização) para criar uma versão maior ou menor de um artigo da base de dados de conhecimento. Na mensagem de solicitação, defina IsMajor como true para criar uma versão principal; defina-a como false para criar uma versão secundária. O registro da nova versão criada usa:

  • KnowledgeArticle.RootArticleId atributo para manter a associação ao registro de artigo de conhecimento raiz.

  • KnowledgeArticle.PreviousArticleContentId atributo para apontar para a versão anterior do registro.

O código de exemplo a seguir mostra como criar uma versão principal de um registro do artigo de conhecimento usando CreateKnowledgeArticleVersionRequest.

CreateKnowledgeArticleVersionRequest versionRequest = new CreateKnowledgeArticleVersionRequest
{
   Source = new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId),
   IsMajor = true
};
CreateKnowledgeArticleVersionResponse versionResponse = (CreateKnowledgeArticleVersionResponse)_serviceProxy.Execute(versionRequest);

Criar uma tradução do artigo de conhecimento

Use CreateKnowledgeArticleTranslation Action (API da Web) ou CreateKnowledgeArticleTranslationRequest (serviço da organização) para criar uma tradução de um registro do artigo de conhecimento. Você pode traduzir o artigo de conhecimento em mais de 150 idiomas, e as informações sobre os idiomas suportados está disponível na nova entidade LanguageLocale.Para obter mais informações:Mensagens de entidade e métodos de LanguageLocale (idiomas)

Usar CreateKnowledgeArticleTranslation Action (API da Web) ou CreateKnowledgeArticleTranslationRequest (serviço da organização) cria um novo registro do artigo de conhecimento com o título, conteúdo, descrição e palavras-chaves copiados do registro de origem para o novo registro e o idioma do novo conjunto de registro para o outro especificado na solicitação. Também é necessário especificar se o novo registro será de uma versão principal ou secundária. O novo registro usa o atributo KnowledgeArticle.ParentArticleContentId para manter a associação ao registro do artigo de conhecimento principal.

Após executar esta mensagem e receber uma resposta, recupere o registro do artigo de conhecimento do objeto de resposta e atualize o título, o conteúdo, a descrição e as palavras-chaves para adicionar ao conteúdo traduzido.

O código de exemplo a seguir mostra como criar uma tradução do artigo de conhecimento usando CreateKnowledgeArticleTranslationRequest:

CreateKnowledgeArticleTranslationRequest translationRequest = new CreateKnowledgeArticleTranslationRequest
{
   Source = new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId),
   Language = new EntityReference(LanguageLocale.EntityLogicalName, languageLocaleId), //languageLocaleId = GUID of the Primary Key of LanguageLocale record
   IsMajor = true    // Creating a major version 
};
CreateKnowledgeArticleTranslationResponse translationResponse = (CreateKnowledgeArticleTranslationResponse)_serviceProxy.Execute(translationRequest);

// Retrieve the new knowledge article record
KnowledgeArticle respObject = (KnowledgeArticle)_serviceProxy.Retrieve(KnowledgeArticle.EntityLogicalName, 
      translationResponse.CreateKnowledgeArticleTranslation.Id, new ColumnSet(true));

Observação

O valor GUID de chave primária (LanguageLocaleId) para cada registro de idioma na entidade LanguageLocale é o mesmo entre todas organizações Dynamics 365.

Ciclo de vida de artigos de conhecimento: Alterar o estado de um artigo de conhecimento

Durante seu ciclo de vida, um artigo de conhecimento pode estar nos seguintes estados:

  • 0: Rascunho (após a criação do artigo de conhecimento)

  • 1: Aprovado (depois que o artigo de conhecimento é aprovado)

  • 2: Programado (depois que um artigo de conhecimento é agendado para ser publicado)

  • 3. Publicado (depois que um artigo de conhecimento é publicado)

  • 4: Expirado (depois que um artigo de conhecimento expira, conforme a data de validade especificada durante a publicação)

  • 5: Arquivado (depois que o artigo de conhecimento é arquivado)

  • 6: Descartado (depois que o artigo de conhecimento é descartado)

Para alterar o estado do artigo, use a mensagem Update no registro do artigo de conhecimento para atualizar o atributo KnowledgeArticle.StateCode. Para tipos de associação precoce, use a enumeração KnowledgeArticleState para definir os possíveis estados.Para obter mais informações:Executar operações especializadas usando Atualização.

O código de exemplo a seguir mostra como publicar um registro do artigo de conhecimento.

// Retrieve the knowledge article record
KnowledgeArticle myKnowledgeArticle = (KnowledgeArticle)_serviceProxy.Retrieve(
        KnowledgeArticle.EntityLogicalName, knowledgeArticleId, new ColumnSet("statecode"));

// Update the knowledge article record
myKnowledgeArticle.StateCode = new OptionSetValue((int)KnowledgeArticleState.Published);
UpdateRequest updateKnowledgeArticle = new UpdateRequest
{
    Target = myKnowledgeArticle
};
_serviceProxy.Execute(updateKnowledgeArticle);

Associar um registro do artigo de conhecimento a uma instância de entidade do Dynamics 365

Quando você habilita a pesquisa de conhecimento incorporada de uma entidade no Dynamics 365 usando o cliente web, um relacionamento muitos para muitos, msdyn_<Entity_Name>_knowledgearticle, é criada automaticamente. Você pode usar esse relacionamento para associar ou vincular programaticamente uma instância de KnowledgeArticle a uma instância de entidade do Dynamics 365. Ao associar uma instância de KnowledgeArticle a uma instância de entidade, será criado um registro para o relacionamento em uma entidade de interseção chamado: msdyn_<Entity_Name>_knowledgearticle. Por exemplo, ao associar uma instância KnowledgeArticle a uma instância Account pela primeira vez, uma entidade de interseção msdyn_account_knowledgearticle é criada, e é criado um registro com o mapeamento de associação nessa entidade de interseção. Por padrão, a entidade Incident (Caso) é habilitada para a pesquisa de conhecimento incorporada e quando você vincula um KnowledgeArticle record to an Incident registro, um registro de associação é criado na entidade de intersecção KnowledgeArticleIncident.

O código de exemplo a seguir demonstra como associar uma instância KnowledgeArticle a uma instância Account:

// Associate the knowledge article record with an account record

// Step 1: Create a collection of knowledge article records that will be 
// associated to the account. In this case, we have only a single
// knowledge article record to be associated.
EntityReferenceCollection relatedEntities = new EntityReferenceCollection();
relatedEntities.Add(new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId));

// Step 2: Create an object that defines the relationship between knowledge article record and account record.
// Use the many-to-many relationship name (msdyn_account_knowledgearticle) between knowledge article
// record and account record.
Relationship newRelationship = new Relationship("msdyn_account_knowledgearticle");

// Step 3: Associate the knowledge article record with the account record.
_serviceProxy.Associate(Account.EntityLogicalName, accountId, newRelationship, relatedEntities);

Contagem de exibição do artigo de conhecimento do incremento

Use a mensagem IncrementKnowledgeArticleViewCountRequest para incrementar a contagem de visualizações de um registro do artigo de conhecimento de um determinado dia na entidade KnowledgeArticleViews. Se não houver um registro de um artigo de conhecimento para determinado dia, ele criará um registro e definirá o valor de contagem de visualizações especificado no atributo KnowledgeArticleViews.KnowledgeArticleView. Se já existir um registro de um artigo de conhecimento para determinado dia, ele apenar incrementará a contagem de visualizações no atributo KnowledgeArticleViews.KnowledgeArticleView.

Pesquisar artigos de conhecimento usando a pesquisa de texto completo

Artigos de conhecimento no Dynamics 365, incluindo as versões e traduções são indexadas ao texto completo e suportam pesquisa de texto completo do SQL Server. Para obter mais informações sobre a pesquisa de texto completo, consulte SQL Server: Pesquisa de texto completo.

Use a mensagem FullTextSearchKnowledgeArticleRequest para pesquisar o artigo de conhecimento em seus aplicativos para localizar as informações que você está procurando. A mensagem FullTextSearchKnowledgeArticleRequest permite usar a correspondência de radical flexivo (permite que um tempo diferente ou uma inflexão sejam substituídos pelo texto da pesquisa) e especifique os critérios de consulta (por meio FetchXML ou QueryExpression especifique a filtragem, ordenação, classificação e busca) para localizar artigos de conhecimento com texto especificado. Você também pode optar por remover várias versões dos mesmos artigos nos resultados de pesquisa e o filtro no estado do artigo de conhecimento ao procurar um texto.

Trabalhar com artigos da base de conhecimento do Dynamics 365

Observação

Esta seção fornece informações sobre como trabalhar com o modelo mais antigo da entidade artigo da base de dados de conhecimento para o gerenciamento de conhecimento no Dynamics 365. Quando as entidades mencionadas na seção ainda estão disponíveis na versão atual, você deve usar as entidades de gerenciamento de conhecimento mencionadas anteriormente para aproveitar a experiência aprimorada de gerenciamento de conhecimento.

Durante seu ciclo de vida, um artigo da base conhecimento pode estar nos seguintes estados:

  • 1: Rascunho (após a criação do artigo)

  • 2: Não aprovado (durante a edição)

  • 3: Publicado (após a publicação do artigo)

Para alterar o estado do artigo, use a mensagem SetStateRequest. Para tipos de associação precoce, use a enumeração KbArticleState para definir os possíveis estados.

Quando você cria um artigo, deve associá-lo a um modelo e a um assunto. Um modelo de artigo descreve as seções e a formatação do artigo. Assuntos são usados para organizar os artigos por categorias de negócios que também são usadas para agrupar ocorrências (incidentes), especificações e produtos. A prática recomendada é criar uma hierarquia da árvore de assuntos e todos os modelos de artigo necessários antes de criar um artigo.

Observação

O Microsoft Dynamics 365 fornece vários modelos de artigo. Eles incluem um artigo padrão, uma solução para um problema, um procedimento e outros modelos. O método recomendável para criar modelos de artigo é usar o aplicativo Web Microsoft Dynamics 365. Se quiser criar um modelo de artigo de forma programática, use os modelos de artigo existentes como exemplos de quais informações incluir e como formatar os dados.

Para associar um artigo a um modelo, use o atributo KbArticle.KbArticleTemplateId. Para colocar um artigo em uma categoria específica, especificando um assunto, use o atributo KbArticle.SubjectId.

Especifique o título do artigo e as palavras-chave que deseja usar na pesquisa. Para descrever um artigo, você pode usar o atributo KbArticle.Description. Para adicionar o conteúdo do artigo, use o atributo KbArticle.Content. Use o atributo Kbarticle.ArticleXml para adicionar os dados XML para o artigo. O valor de KbArticle.LanguageCode é obtido do modelo para ajudar a escrever as consultas que classificam os artigos pelo idioma.

Ao ser criado, o artigo é salvo como rascunho. Depois disso, você pode alterar o estado do artigo de "Rascunho" para "Não aprovado" Você pode modificar o conteúdo de um artigo para aprovação e torná-lo pronto para publicar. Quando o artigo estiver pronto para ser publicado, altere o estado de “Não aprovado” para ”Publicado”.

Um artigo não publicado ontém as configurações de formato de um modelo. Se você alterar o formato do modelo, as alterações serão propagadas automaticamente para os artigos nos estados “Rascunho” e “Não aprovado”.

Depois que você publicar um artigo, pode adicionar comentários (KbArticleComment), mas não pode editá-lo, independentemente dos seus privilégios. Os comentários podem ser adicionados ao artigo que esteja em qualquer um dos estados.

Observação

Os comentários podem ser adicionados ao artigo em qualquer estado: Rascunho, Não aprovado ou Publicado.

Para revisar ou atualizar o artigo, você deve cancelar sua publicação. Para cancelar a publicação de um artigo, altere o estado do artigo de Publicado para Não aprovado. Para excluir um artigo da base de dados de conhecimento do Microsoft Dynamics 365, altere o estado do artigo publicado de Publicado para Não aprovado ou Rascunho.

Observação

Um artigo da base de dados de conhecimento não pode ser excluído se estiver no estado Publicado.

Para obter mais informações sobre a criação, atualização, edição e localização de um artigo na base de dados de conhecimento, consulte Ajuda e Treinamento: Usar artigos da base de dados de conhecimento.

Confira Também

Entidades do gerenciamento do conhecimento
Usar o conhecimento do Parature no Dynamics 365
Mensagens e métodos da entidade KnowledgeArticle
Mensagens e métodos da entidade KnowledgeArticleViews
Mensagens e métodos da entidade KnowledgeBaseRecord
Mensagens de entidade e métodos de LanguageLocale (idiomas)
Mensagens e métodos da entidade KbArticle (artigo)

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais