사용자 지정 도움말 콘텐츠 추가

아티클
03/04/2017

게시 날짜: 2017년 1월

적용 대상: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Microsoft Dynamics 365(온라인 및 온-프레미스)를 사용하여 관리자는 전체 조직 또는 특정 엔터티에 대해 어떤 콘텐츠 페이지가 나타날지 구성할 수 있습니다. 조직은 고도로 사용자 지정된 시스템을 갖추고 있습니다. 특히 사용자 지정 엔터티를 사용하는 조직은 응용 프로그램 도움말 콘텐츠의 사용이 제한되어 있다는 것을 알게 됩니다. 관리자는 대신 열려는 URL을 지정하여 기본 도움말 콘텐츠를 재정의하도록 시스템을 구성할 수 있습니다. 열려는 페이지는 SharePoint 사이트의 정적 페이지, 인터넷의 웹 페이지 또는 웹 리소스를 사용하여 만들었거나 솔루션에 포함된 사용자 지정 도움말 응용 프로그램일 수 있습니다.

개발자는 사용 가능한 옵션 및 적절한 콘텐츠를 표시할 페이지를 만들 수 있도록 URL을 사용하여 어떤 상황별 정보를 전달할 수 있는지 이해하고 있어야 합니다.CRM 시스템 사용자 지정: 도움말 환경 사용자 지정 항목에서도 자세한 정보를 찾을 수 있습니다.

이 항목의 내용

사용자 지정 도움말 옵션

상황에 맞는 쿼리 문자열 매개 변수

웹 리소스를 사용하여 도움말 내용을 제공

사용자 지정 도움말 옵션

사용자 지정 도움말 동작은 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	해당 없음	해당 없음	해당 없음	기본 도움말 페이지가 열립니다.
true	아니요	false	해당 없음	기본 도움말 페이지가 열립니다.
true	아니요	true	아니요	기본 도움말 페이지가 열립니다.
true	아니요	true	예	엔터티 도움말 페이지가 열립니다.
true	예	true	예	엔터티 도움말 페이지가 열립니다.
true	예	true	아니요	전역 URL 페이지가 열립니다.
true	예	false	해당 없음	전역 URL 페이지가 열립니다.

참고

전역 도움말이 사용되는 응용 프로그램에서 도움말 단추를 사용할 때마다 응용 프로그램의 사용자 지정 가능한 영역과 관련이 없는 페이지를 포함하여 사용자 지정 페이지가 나타납니다. 이는 관리자에게 유용할 수 있는 콘텐츠를 숨기므로 일반적으로 사용자 지정 도움말은 엔터티 단위로 적용해야 합니다.

상황에 맞는 쿼리 문자열 매개 변수

Organization.GlobalAppendUrlParametersEnabled이 true일 때 다음 쿼리 문자열 매개 변수 값이 사용자 지정 도움말 URL에 추가될 수 있습니다.

매개 변수	설명
entrypoint	도움말이 열린 페이지의 형식입니다. 가능한 값은 form 및 hierarchychart입니다. 이 매개 변수는 도움말이 목록 보기에서 열린 경우는 포함하지 않습니다.
formid	도움말이 열린 양식 또는 계층 구조 차트에 대한 GUID 값입니다.
typename	도움말 내용이 열린 엔터티의 논리적 이름입니다.
userlcid	현재 사용자가 사용하는 언어 코드 식별자입니다.유효한 로캘 ID 값은 LCID(로캘 ID) 차트에서 확인할 수 있습니다.

쿼리 문자열 값에 액세스

다음 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>

웹 리소스를 사용하여 도움말 내용을 제공

HTML 웹 리소스를 도움말 내용으로 사용하면 설명하는 사용자 지정 엔터티에 대한 솔루션에 함께 포함할 수 있다는 이점이 있습니다. 또한 이러한 페이지의 JavaScript을 사용하여 Dynamics 365 데이터에 액세스하고 메타데이터를 사용하여 양식에 있는 현재 필드를 반영할 수 있는 동적 콘텐츠를 제공하거나 사용자에게 할당된 권한에 대한 정보를 얻을 수도 있습니다.

Organization.GlobalHelpUrl 및 EntityMetadata.EntityHelpUrl 필드는 유효한 프로토콜을 요구하는 서식이 없는 간단한 문자열 값입니다. 따라서 솔루션을 한 조직에서 다른 조직으로 도움말 내용을 이동하는 데 사용할 때 웹 리소스 참조를 수정하지 않고 사용할 수 있도록 웹 리소스를 나타내는 URL에 대한 상대 경로 설명을 사용할 수 있습니다. 특정 웹 리소스는 다음과 같은 상대 URL을 사용하여 참조할 수 있습니다.

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

중요

사용자가 서버에서 둘 이상의 조직에 속할 경우 이 경로는 항상 사용자의 기본 조직을 참조합니다. 사용자가 기본 조직을 사용하고 있지 않으며 예상되는 웹 리소스가 사용자의 기본 조직에 포함되어 있지 않은 경우에는 사용자가 현재 작업하고 있는 조직에 웹 리소스가 발생해도 “파일 발견되지 않음” 오류가 발생합니다. 기본 조직에 같은 이름의 웹 리소스가 존재하는 경우, 그 조직의 웹 리소스가 표시될 것이며 현재 조직을 위해 정확하지 않을 수 있습니다.

이로 인해 조직의 사용자에게 문제를 초래하는 경우 조직에 있는 웹 리소스에 대한 상대 URL에 대한 기본 조직 URL을 추가하기 위해 설정의 URL 값을 업데이트할 수 있습니다.

참고 항목

EntityMetadata
CRM 시스템 사용자 지정: 도움말 환경 사용자 지정
Microsoft Dynamics 365 응용 프로그램 사용자 지정
Microsoft Dynamics 365용 웹 리소스
웹 페이지(HTML) 웹 리소스

Microsoft Dynamics 365

다음을 통해 공유

사용자 지정 도움말 콘텐츠 추가

이 항목의 내용

사용자 지정 도움말 옵션

상황에 맞는 쿼리 문자열 매개 변수

쿼리 문자열 값에 액세스

웹 리소스를 사용하여 도움말 내용을 제공

참고 항목

추가 리소스