Parature 知识库搜索控件（客户端引用）

项目
07/06/2017

发布日期： 2016年11月

适用于： Dynamics CRM 2015

使用 Microsoft Dynamics CRM Online 2015 更新 1 或更高版本，当某组织启用 Parature 集成时，他们能把新的知识库搜索控件添加到窗体。此控件提供可编程支持以在用户使用此工具时自动化或增强用户体验。

重要

对于 Microsoft Dynamics CRM Online 组织，只有当您的组织更新到 Dynamics CRM Online 2015 更新 1 时才可以使用此功能。此功能不适用于 Dynamics CRM（本地）。

这些事件和方法不直接连接到任何 Parature API。但是，如果存在于窗体中，则应该已经创建了与 Parature 的连接，以便可以直接进行 Parature API 调用，无需安全令牌。不过，这些将是跨域请求，因此必须使用跨原始资源共享 (CORS)。

知识库管理搜索控件是 Xrm.Page.ui 控件，因此，它支持控件具有的所有标准方法。但同时也支持其他事件和方法。有关标准控件方法的信息，请参阅 Xrm.Page.ui 控制方法（客户端引用）。

如果知道控件名称，您可以使用以下方法访问，其中，<name> 表示控件的名称...

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

备注

当知识库搜索控件添加到社交窗格时，名称将是“searchwidgetcontrol_notescontrol”。无法更改此名称。

下面的所有示例将使用 kbSearchControl 表示窗体中的知识库搜索控件。

事件

使用此控件的事件可以允许代码响应选定或打开的项目。

OnResultOpened

当知识库文章直接在知识库搜索控件中打开或通过弹出操作打开时，将发生此事件。使用 addOnResultOpened 和 removeOnResultOpened 方法管理此事件的事件处理程序。

OnSelection

当知识库文章在知识库搜索控件中被选择时，将发生此事件。使用 addOnSelection 和 removeOnSelection 方法管理此事件的事件处理程序。

方法

使用知识库搜索控件方法来设置或删除事件处理程序，并与搜索查询和搜索结果交互。

addOnResultOpened

使用该方法将事件处理程序添加到 OnResultOpened 事件。

参数：函数。要添加的函数。

示例：将名为 myFunction 的函数添加到 OnResultOpened 事件中。

kbSearchControl.addOnResultOpened(myFunction);

addOnSelection

使用该方法将事件处理程序添加到 OnSelection 事件。

参数：函数。要添加的函数。

示例：将名为 myFunction 的函数添加到 OnSelection 事件中。

kbSearchControl.addOnSelection(myFunction);

getSearchQuery

使用此方法来获取用作知识库管理控件搜索条件的文本。

返回值：字符串。搜索查询的文本。

示例：将 searchQuery 变量设置为搜索查询的文本。

var searchQuery = kbSearchControl.getSearchQuery();

getSelectedResult

使用此方法来获取当前选择的搜索控件的结果。当前选择的结果还表示当前处于打开状态的结果。

返回值：KBSearchResult。当前所选结果。

示例：将变量 kbSearchResult 设置为当前选择的结果。

var kbSearchResult = kbSearchControl.getSelectedResult();

KBSearchResult 属性

下表介绍了 KBSearchResult 对象的属性。

属性	Type	说明
answer	String	包含文章内容的 HTML 标记。您可以将此内容传递到自定义操作，可以将其包含在电子邮件中发送给客户。
articleId	String	Parature 部门内的文章 ID 此值作为备用键使用。您可以使用它来查看此文章是否已存在于 CRM 中。
articleUid	String	Parature 系统的唯一文章 ID。这将包含 Parature 客户 ID 以及部门 ID，例如，“7924/8112/Article/25”。此值作为备用键使用。在关联一个不存在的文章时，需要使用此 ID 创建新的知识库记录。
createdOn	Date	创建文章的日期。您可能想要在您的业务逻辑使用文章的存在时间。
expiredDate	Date	文章过期或即将过期的日期。可以比较此日期与当前日期，以确定文章是否已过期。此值使用当前用户的时区和格式。
isAssociated	Boolean	指示文章是否与父记录关联。您可以使用窗体脚本或在窗体脚本启动的其他流程中在关联文章与当前记录之前检查此值。
lastModifiedOn	Date	文章最后修改的日期。此值将使用当前用户的时区和格式。
publicUrl	String	支持文章的门户 URL。使用自定义操作可以将其包含在电子邮件内容的链接中发送给客户。
published	Boolean	指示文章处于“已发布”状态还是“草稿”状态。在您发送有关文章的信息给客户之前，您应检查文章是否发布。
question	String	文章的标题。如果您打算在任何业务流程中引用文章，可以使用此值按名称引用。
rating	Number	文章的评级。
searchBlurb	String	包含命中搜索查询的区域的文章内容的简短片段。使用它可以让用户在搜索列表中看到文章，帮助他们确定其是否是他们要查找的文章。
serviceDeskUri	String	Parature 服务台中文章的链接。使用此链接可以使用 Parature 服务台打开文章。
timesViewed	Number	文章在 Parature 门户被客户查看的次数。

removeOnResultOpened

使用该方法将事件处理程序从 OnResultOpened 事件中移除。

参数：函数。要删除的函数。

示例：将名为 myFunction 的函数从 OnResultOpened 事件中删除。

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

使用该方法将事件处理程序从 OnSelection 事件中移除。

参数：函数。要删除的函数。

示例：将名为 myFunction 的函数从 OnSelection 事件中删除。

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

使用此方法来设置用作知识库管理控件搜索条件的文本。

参数：字符串。搜索查询的文本。

示例：搜索查询的文本设置为“How to solve the problem”.

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

另请参阅

将 Microsoft Dynamics CRM 2015 与 Parature 集成
 客户端编程引用
 为 Microsoft Dynamics CRM 2015 窗体编写代码
 编写客户端应用程序扩展

通过