참조 자료 검색 컨트롤(클라이언트 쪽 참조)

아티클
03/04/2017

게시 날짜: 2017년 1월

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

참조 자료 관리 기능이 활성화된 Dynamics 365 인스턴스에서 엔터티에 참조 자료 검색 컨트롤을 추가할 수 있습니다. 이 컨트롤을 사용하여 Dynamics 365의 참조 자료 사용을 위해 컨트롤을 사용할 때 사용자 검색 경험을 프로그래밍 방식으로 자동화하거나 향상시킬 수 있습니다.추가 정보:참조 자료 관리 엔터티

참고

참조 자료 관리 및 검색을 위한 소스로 기본 Dynamics 365 지식 또는 Parature 지식을 선택할 수 있습니다.Parature를 참조 자료 소스로 사용하고 참조 자료 검색 컨트롤을 양식에 제공하는 경우 보안 토큰을 요구하지 않고 직접Parature API를 호출할 수 있도록 Parature와의 연결이 이미 설정되어 있어야 합니다. 그러나 이는 도메인간 요청이므로 원본간 리소스 공유(CORS)를 사용해야 합니다.

CRM Online 2016 업데이트 1 및 Dynamics 365 서비스 팩 1(온-프레미스)에 도입된 다음 새 클라이언트 API는 소스로 기술 자료(PostSearch 이벤트, addOnPostSearch, removeOnPostSearch, getTotalResultCount, 및 openSearchResult)로 Parature를 사용할 경우에는 지원되지 않습니다.
CRM Online 2016 업데이트 1 및 Dynamics 365 SP1(온-프레미스) 릴리스를 통해, 참조 자료 검색 컨트롤이 Dynamics 365 모바일 클라이언트(휴대폰 및 태블릿)에도 지원됩니다.

참조 자료 검색 컨트롤은 Xrm.Page.ui 컨트롤이므로 컨트롤이 가지고 있는 모든 표준 메서드를 지원합니다. 하지만 추가 이벤트 및 메서드도 지원합니다. 표준 컨트롤 메서드에 대한 자세한 내용은 Xrm.Page.ui 컨트롤(클라이언트 쪽 참조)를 참조하십시오.

컨트롤 이름을 알고 있는 경우 다음 코드를 사용하여 액세스할 수 있습니다. 여기서 *<name>*은 컨트롤의 이름을 나타냅니다.

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

참고

참조 자료 검색 컨트롤이 소셜 창에 추가되면 이름은 "searchwidgetcontrol_notescontrol"이 됩니다. 이 이름은 변경할 수 없습니다.

이 항목의 모든 예제는 kbSearchControl을 사용하여 양식에 있는 참조 자료 검색 컨트롤을 나타냅니다.

이 항목의 내용

참조 자료 검색 컨트롤 이벤트

참조 자료 검색 컨트롤 메서드

참조 자료 검색 컨트롤 이벤트

이 컨트롤에 대한 이벤트를 사용하여 코드가 선택된 항목 또는 열린 항목에 응답할 수 있습니다.

OnResultOpened

이 이벤트는 인라인으로 또는 팝아웃 동작을 통해 참조 자료 문서가 참조 자료 검색 컨트롤에서 열릴 때 발생합니다.addOnResultOpened 및 removeOnResultOpened 메서드를 사용하여 이 이벤트에 대한 이벤트 처리기를 관리합니다.

OnSelection

이 이벤트는 참조 자료 문서가 참조 자료 검색 컨트롤에서 선택된 경우에 발생합니다.addOnSelection 및 removeOnSelection 메서드를 사용하여 이 이벤트에 대한 이벤트 처리기를 관리합니다.

PostSearch

이 이벤트는 검색이 완료되어 결과가 표시될 때 발생합니다. 새로운 addOnPostSearch 및 removeOnPostSearch 메서드를 사용하여 이 이벤트에 대한 이벤트 처리기를 관리합니다.

참조 자료 검색 컨트롤 메서드

참조 자료 검색 컨트롤에 대한 메서드를 사용하여 이벤트 처리기를 설정 또는 제거하고 검색 쿼리 및 검색 결과와 상호 작용합니다.

addOnPostSearch

이 메서드를 사용하여 이벤트 처리기를 PostSearch 이벤트에 추가합니다.

매개 변수: 함수. 추가할 함수입니다.

예: myFunction이라는 함수를 PostSearch 이벤트에 추가합니다.

kbSearchControl.addOnPostSearch(myFunction);

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.getSelectedResults();

KBSearchResult 속성

다음 표는 KBSearchResult 개체의 속성을 설명합니다.

속성	유형	설명
answer	String	문서의 콘텐츠를 포함하고 있는 HTML 태그입니다. 고객에게 보낼 전자 메일이 포함할 수 있는 사용자 지정 작업에 이 콘텐츠를 전달할 수 있습니다.
articleId	String	Dynamics 365 또는 Parature 부서의 문서 ID 이 값은 대체 키로 사용됩니다. 이 문서가 Dynamics 365에 이미 있는지 여부를 확인하는 데 사용할 수 있습니다.
articleUid	String	Dynamics 365 또는 Parature 시스템에 대한 고유한 문서 ID입니다. Parature를 참조 자료 소스로 사용하면 Parature 거래처 ID 및 부서 ID를 포함합니다(예: “7924/8112/Article/25”). 이 값은 대체 키로 사용됩니다. 이 ID는 아직 없는 경우 문서에 연결하는 동안 새 참조 자료 레코드를 만드는 데 필요합니다.
attachmentCount	번호	문서에 첨부한 파일의 수입니다. 이것은 Parature를 참조 자료 소스로 사용하는 경우에만 적용됩니다.
createdOn	Date	문서를 만든 날짜입니다. 이 값은 현재 사용자의 표준 시간대와 형식을 사용합니다. 비즈니스 논리에서 문서의 사용 기간을 사용할 수 있습니다.
expiredDate	Date	문서가 만료되었거나 만료될 날짜입니다. Dynamics 365를 참조 자료 소스로 사용하면 null입니다. 문서가 만료되었는지 여부를 확인하기 위해 이 날짜를 현재 날짜와 비교할 수 있습니다. 값은 현재 사용자의 표준 시간대와 형식을 사용합니다.
folderHref	문자열	Parature의 문서 폴더 경로에 대한 링크입니다. 이것은 Parature를 참조 자료 소스로 사용하는 경우에만 적용됩니다.
href	문자열	직접 링크 Parature API를 사용하여 문서 내용을 직접 가져올 수 있습니다. 이것은 Parature를 참조 자료 소스로 사용하는 경우에만 적용됩니다.
isAssociated	Boolean	문서가 상위 레코드와 관련이 있는지 여부를 나타냅니다. 양식 스크립트를 사용하거나 양식 스크립트에서 시작한 다른 프로세스에서 현재 레코드와 문서를 연결하기 전에 이 값을 확인할 수 있습니다.
lastModifiedOn	Date	문서를 마지막으로 수정한 날짜입니다. 이 값은 현재 사용자의 표준 시간대와 형식을 사용합니다.
publicUrl	String	문서의 포털 URL을 지원합니다. 포털 URL 옵션을 해제하는 경우에 비어 있게 됩니다. 사용자 지정 작업을 사용하여 고객에게 보낼 전자 메일의 콘텐츠에 이 링크를 포함합니다.
published	Boolean	문서가 게시된 상태인지 여부를 나타냅니다.True 게시된 경우가 아니라면 False입니다. 고객에게 정보를 보내기 전에 문서가 게시되는지 여부를 확인해야 합니다.
question	String	문서의 제목입니다. 비즈니스 프로세스에서 문서를 참조하려는 경우 이 값을 사용하여 이름으로 참조할 수 있습니다.
rating	Number	문서의 등급입니다.
searchBlurb	String	검색 쿼리가 적중하는 영역을 포함하는 문서 콘텐츠의 간단한 코드 조각입니다. 이를 사용하여 검색 목록에서 사용자에게 문서에 대한 개요를 제공하고 고객이 찾고 있는 문서인지 확인하는 데 도움을 줍니다.
serviceDeskUri	String	Dynamics 365 또는 Parature 서비스 데스크에서 문서에 연결합니다. 이 링크를 사용하여 Dynamics 365 또는 Parature 서비스 데스크를 사용하여 문서를 엽니다.
timesViewed	Number	포털에서 고객이 문서를 보는 횟수입니다.

getTotalResultCount

검색 컨트롤에 결과의 수를 가져옵니다.

반환 값: 정수 검색 결과의 수

예: 검색 컨트롤의 검색 결과 수에 대한 변수 searchCount를 설정합니다.

var searchCount = kbSearchControl.getTotalResultCount();

openSearchResult

결과 수를 지정하여 검색 컨트롤의 검색 결과를 엽니다.

var openResultStatus = kbSearchControl.openSearchResult(resultNumber, mode);

인수

resultNumber (Integer): 열 결과 수를 지정하는 숫자 값 결과 번호는 1부터 시작합니다. 필수 특성:
mode (String): 'Inline' 또는 'Popout' 지정 선택 사항. 인수 값을 지정하지 않는 경우, 기본('Inline') 옵션을 사용합니다.

"Inline" 모드에서 참조 패널의 경우 컨트롤의 읽기 창 또는 참조 패널 탭의 결과 인라인을 엽니다. 'Popout' 모드에서 팝업 창의 결과를 엽니다.

반환 값: 부울 지정된 검색 결과를 여는 상태 성공시 1, 실패 시 0 반환 지정된 resultNumber 값이 없거나 지정된 mode 값이 올바르지 않은 경우, 메서드가 -1을 반환합니다.

removeOnPostSearch

이 메서드를 사용하여 PostSearch 이벤트에서 이벤트 처리기를 제거합니다.

매개 변수: 함수. 제거할 함수입니다.

예: PostSearch 이벤트에서 myFunction이라는 함수를 제거합니다.

kbSearchControl.removeOnPostSearch(myFunction);

removeOnResultOpened

이 메서드를 사용하여 OnResultOpened 이벤트에서 이벤트 처리기를 제거합니다.

매개 변수: 함수. 제거할 함수입니다.

예: OnResultOpened 이벤트에서 myFunction이라는 함수를 제거합니다.

kbSearchControl.removeOnResultOpened(myFunction);

removeOnSelection

이 메서드를 사용하여 OnSelection 이벤트에서 이벤트 처리기를 제거합니다.

매개 변수: 함수. 제거할 함수입니다.

예: OnSelection 이벤트에서 myFunction이라는 함수를 제거합니다.

kbSearchControl.removeOnSelection(myFunction);

setSearchQuery

이 메서드를 사용하여 참조 자료 관리 컨트롤에 대한 검색 조건으로 사용되는 텍스트를 설정합니다.

매개 변수: 문자열. 검색 쿼리의 텍스트입니다.

예: 검색 쿼리의 텍스트를 “How to solve the problem”로 설정합니다.

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

참고 항목

Dynamics 365의 참조 자료 문서 작업
Dynamics 365에서 Parature 참조 자료 사용
클라이언트 쪽 프로그래밍 참조
Microsoft Dynamics 365 양식용 코드 작성
클라이언트에서 Microsoft Dynamics 365 확장

Microsoft Dynamics 365

다음을 통해 공유

참조 자료 검색 컨트롤(클라이언트 쪽 참조)

이 항목의 내용

참조 자료 검색 컨트롤 이벤트

OnResultOpened

OnSelection

PostSearch

참조 자료 검색 컨트롤 메서드

addOnPostSearch

addOnResultOpened

addOnSelection

getSearchQuery

getSelectedResult

KBSearchResult 속성

getTotalResultCount

openSearchResult

removeOnPostSearch

removeOnResultOpened

removeOnSelection

setSearchQuery

참고 항목

추가 리소스