新增自訂說明內容

文章
07/06/2017

發佈日期： 2016年11月

適用對象： Dynamics CRM 2015

在 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新，系統管理員可以設定在整個組織或針對特定實體會顯示哪個說明內容頁面。具有高度自訂系統的組織，特別是那些使用自訂實體的組織，將會發覺應用程式說明內容的實用性有限。系統管理員可以對系統進行設定，藉由指定要開啟的 URL 來覆寫預設說明內容。要開啟的頁面可能會是 SharePoint 網站上的靜態頁面、網際網路上的網頁，或是使用 Web 資源建立並隨附於解決方案中的自訂說明應用程式。

開發人員需要了解可用選項，以及可透過 URL 傳遞的內容資訊，以便建立頁面來顯示適當的內容。您也可以在主題自訂您的 CRM 系統：自訂說明經驗找到詳細資訊。

本主題內容

自訂說明選項

關聯式查詢字串參數

使用 Web 資源提供說明內容

自訂說明選項

自訂說明行為會根據 Organization 實體中儲存的資料和每個實體的 EntityMetadata 定義，如下表所述。

系統或實體設定	資料	類型	描述
系統設定：使用可自訂實體的自訂說明	Organization.GlobalHelpUrlEnabled	布林值	指示是否針對組織啟用自訂說明。
系統設定：全域自訂說明 URL	Organization.GlobalHelpUrl	字串	組織的全域說明 URL。
系統設定：附加參數至 URL	Organization.GlobalAppendUrlParametersEnabled	布林值	表示有內容資訊的查詢字串參數是否附加至說明 URL。其他資訊：關聯式查詢字串參數
實體設定：使用自訂說明	EntityMetadata.EntityHelpUrlEnabled	布林值	指示是否針對實體啟用自訂說明。
實體設定：說明 URL	EntityMetadata.EntityHelpUrl	字串	顯示此實體的自訂說明頁面。

已套用之設定組合會控制哪個說明主題會顯示。下表描述選項。

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	行為
false	N/A	N/A	N/A	預設說明頁面開啟
True	否	false	N/A	預設說明頁面開啟
True	否	True	否	預設說明頁面開啟
True	否	True	是	實體說明頁面開啟
True	是	True	是	實體說明頁面開啟
True	是	True	否	全域 URL 頁面開啟
True	是	false	N/A	全域 URL 頁面開啟

備註

當全域說明啟用，只要使用應用程式的任何說明按鈕，自訂頁面會顯示，包括與應用程式可自訂區域無關的頁面。由於這隱藏對系統管理員來說重要的內容，一般自訂說明應該是在每個實體的基礎套用。

關聯式查詢字串參數

當 Organization.GlobalAppendUrlParametersEnabled 是 true 時，下列查詢字串參數值可能會附加至自訂說明 URL。

參數	描述
entrypoint	開啟說明之來源頁面類型。可能的值是 form 和 hierarchychart。如果說明從清單檢視表開啟，不包含此參數。
formid	開啟說明之來源表單或階層圖表的 GUID 值。
typename	開啟說明內容之來源實體的邏輯名稱。
userlcid	目前使用者使用的語言識別代碼。您可以在地區設定識別碼 (LCID) 表找到有效的地區設定識別碼值。

存取查詢字串值

下列 HTML 提供範例，顯示如何使用 JavaScript 存取這些查詢字串值。此頁面會顯示表格，列出傳遞之參數的值。

<!DOCTYPE html>
<html>
<head>
 <title>Help topic</title>
 <style>
  body {
   font-family: 'Segoe UI';
  }
 </style>
 <script type="text/javascript">
  function getQueryStringParameter(parameter) {
   /// <summary>Parses query string values passed to the page and returns the value for the requested parameter or 'null'</summary>
   /// <param name="parameter" type="String">The parameter value to look for</param>
   /// <returns type="String" />
   var query = window.location.search.substring(1); 
   var params = query.split("&");
   for (var i = 0; i < params.length; i++) {
    var pair = params[i].split("=");
    if (pair[0] == parameter) {
     return pair[1];
    }
   }
   return "null";
  }


  document.onreadystatechange = function () {
   if (document.readyState == "complete") {

    var entrypointValue = getQueryStringParameter("entrypoint");
    var formidValue = getQueryStringParameter("formid");
    var typenameValue = getQueryStringParameter("typename");
    var userlcidValue = getQueryStringParameter("userlcid");

    if ((document.documentMode) && (document.documentMode <= 8))
    {
     //If page is being displayed in IE Compatibility mode
     document.getElementById("entrypointValue").innerText = entrypointValue;
     document.getElementById("formidValue").innerText = formidValue;
     document.getElementById("typenameValue").innerText = typenameValue;
     document.getElementById("userlcidValue").innerText = userlcidValue;
    }
    else
    {
     document.getElementById("entrypointValue").textContent = entrypointValue;
     document.getElementById("formidValue").textContent = formidValue;
     document.getElementById("typenameValue").textContent = typenameValue;
     document.getElementById("userlcidValue").textContent = userlcidValue;
    }


   }
  }

 </script>
</head>
<body>
 <p>This is a custom help topic that can accept query string parameters</p>
 <table>
  <thead><tr><th>Parameter</th><th>Value</th></tr></thead>
  <tbody>
   <tr><td>entrypoint</td><td id="entrypointValue">null</td></tr>
   <tr><td>formid</td><td id="formidValue">null</td></tr>
   <tr><td>typename</td><td id="typenameValue">null</td></tr>
   <tr><td>userlcid</td><td id="userlcidValue">null</td></tr>
  </tbody>
 </table>

</body>
</html>

使用 Web 資源提供說明內容

使用 HTML Web 資源做為說明內容，好處是它們可以一起包含在描述的任何自訂實體的解決方案中。也可以在這些頁面中使用 JavaScript，存取 Dynamics 365 資料和中繼資料，提供可反映目前表單欄位的動態內容或取得關於指派給使用者的權限資訊。

Organization.GlobalHelpUrl 和 EntityMetadata.EntityHelpUrl 欄位是簡單的字串值，不含需要有效通訊協定的任何格式。這允許使用 URL 相對路徑描述代表 Web 資源，因此當解決方案用來在組織之間移動說明內容時，Web 資源的參照能運作而不需修改。使用相對 URL 可參照特定 Web 資源，如下所示：

/WebResources/new_/help/content/account.htm

重要

當使用者屬於伺服器上的多個組織時，此路徑一律參考使用者預設組織。如果使用者不使用預設組織，而且預期的 Web 資源未包含在使用者的預設組織內，則會發生「找不到檔案」錯誤，即使 Web 資源確實發生在使用者目前工作所在的組織中。如果預設組織中存在同名的 Web 資源，該組織的 Web 資源將會顯示，且對目前的組織可能不正確。

如果這對組織的使用者造成問題，可以更新設定的 URL 值，將基本組織 URL 附加至組織中 Web 資源的相對 URL 前面。

另請參閱

EntityMetadata
自訂您的 CRM 系統：自訂說明經驗
 Microsoft Dynamics CRM 2015 開發人員自訂指南
 Microsoft Dynamics CRM 2015 的 Web 資源
 網頁 (HTML) Web 資源

分享方式：

新增自訂說明內容

本主題內容

自訂說明選項

關聯式查詢字串參數

存取查詢字串值

使用 Web 資源提供說明內容

另請參閱

更多資源