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 物件的屬性。

屬性	類型	描述
answer	String	包含文章內容的 HTML 標記。您可將此內容傳遞至自訂動作，該動作可將此內容包含在電子郵件中傳送給客戶。
articleId	String	Parature 部門中的文章識別碼此值做為其他索引鍵使用。您可以用它查看此文章是否已存在 CRM 中。
articleUid	String	Parature 系統的唯一文章識別碼。這也會包含 Parature 帳戶識別碼與部門識別碼，例如，"7924/8112/Article/25"。此值做為其他索引鍵使用。此識別碼是建立新的知識庫記錄同時建立文章關聯時所需 (如果尚未存在的話)。
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 表單的程式碼
 撰寫用戶端應用程式擴充功能

共用方式為