Dynamics 365의 참조 자료 문서 작업
게시 날짜: 2017년 1월
적용 대상: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Microsoft Dynamics 365의 새로운 참조 문서를 사용하면 버전 제어 및 번역 지원과 더불어 풍부한 참조 문서를 만들 수 있습니다. 참조 문서를 만들고 게시하면 문서의 정보를 사용하여 고객에게 효과적으로 서비스를 할 수 있도록 Dynamics 365 인스턴스를 사용할 수 있게 됩니다. Dynamics 365에서는 기본적으로 KnowledgeArticle 항목을 사용하여 참조 문서를 저장하고 관리합니다. Parature의 참조 자료를 사용하는 경우 KnowledgeBaseRecord 엔터티를 사용하여 Parature의 참조 자료 문서를 프로그래밍 방식으로 사용합니다.
이 항목에서는 새로운 기본 Dynamics 365 참조 자료 관리 기능 작업에 대한 정보를 제공합니다. Parature를 Dynamics 365의 참조 자료 소스로 사용하는 경우 Dynamics 365에서 Parature 참조 자료 사용을 참조하십시오.
참고
이전 참조 자료 문서(KBArticle) 엔터티 모델을 사용하는 경우 이 항목 뒷부분의 이전 Dynamics 365 참조 자료 문서 작업를 참조하십시오.
Dynamics 365 인스턴스에서 엔터티에 대한 참조 자료 관리 기능을 프로그래밍 방식으로 활성화할 수 없으며 Dynamics 365 웹 클라이언트를 사용해야만 수행할 수 있습니다.추가 정보:도움말 및 교육: CRM에서 지식 관리 설정
이 항목의 내용
참조 문서 만들기
참조 자료 문서의 주 버전 및 부 버전 만들기
참조 자료 문서 번역 만들기
참조 자료 문서 수명 주기: 참조 자료 문서 상태 변경
참조 자료 문서 레코드를 Dynamics 365 엔터티 인스턴스와 연결
참조 자료 문서 보기 횟수 증가
전체 텍스트 검색을 사용하여 참조 자료 문서 검색
이전 Dynamics 365 참조 자료 문서 작업
참조 문서 만들기
기술 자료 문서 레코드를 만들면 Dynamics 365는 내부적으로 레코드의 루트 문서를 만듭니다. 루트 문서는 사용자가 향후 만들 수 있는 모든 문서 버전 및 번역과 함께 사용자가 만든 기본 참조 자료 문서를 위한 컨테이너 역할을 합니다. 다음 다이어그램은 KnowledgeArticle 엔터티에 대한 엔터티 모델을 설명합니다.
.jpeg "KnowledgeArticle 엔터티 모델")
참조 자료 문서 레코드를 만들면 Draft 상태로 만들어집니다. 새로운 KnowledgeArticle 엔터티를 사용하면 컨텐츠를 지정하고 문서의 섹션과 서식을 설명하는 템플릿애 연결해야 하는 기존 KbArticle 엔터티를 사용하는 것과 비교하여 HTML 형식으로 서식을 지정하여 문서를 만들 수 있습니다. 참조 자료 문서 레코드를 프로그래밍 방식으로 만들면서 KnowledgeArticle.ArticlePublicNumber 특성의 자체 값을 지정할 수 있습니다. 그렇지 않으면 이 값은 웹 클라이언트의 Dynamics 365 설정 영역에 지정된 형식을 기반으로 자동으로 생성됩니다.KnowledgeArticle.ArticlePublicNumber 특성은 고객, 파트너 및 기타 외부 사용자에게 노출된 ID를 저장하여 참조 자료 문서를 참조하고 조회하며 참조 자료 문서 버전 및 번역과 동일하게 유지됩니다.
다음 샘플 코드는 참조 자료 문서 레코드를 만드는 방법을 보여 줍니다.
KnowledgeArticle newKnowledgeArticle = new KnowledgeArticle
{
Title = "Sample Knowledge Article",
Content = "<p>This is the article content.</p>"
};
knowledgeArticleId = _serviceProxy.Create(newKnowledgeArticle);
Console.WriteLine("Created {0}", newKnowledgeArticle.Title);
참조 자료 문서의 주 버전 및 부 버전 만들기
참조 자료 문서 레코드를 생성할 때 대버전은 자동으로 1, 소버전은 0으로 설정됩니다.CreateKnowledgeArticleVersion Action(웹 API) 또는 CreateKnowledgeArticleVersionRequest(조직 서비스)를 사용하여 참조 자료 문서의 대 또는 소 버전을 생성하십시오. 요청 메시지에서 IsMajor를 true로 설정하여 주 버전을 만들고 false로 설정하여 부 버전을 만듭니다. 만들어지는 새로운 버전 레코드는 다음을 사용합니다.
근본 참조 자료 문서 레코드와의 연계를 유지하기 위한 KnowledgeArticle.RootArticleId 특성.
이전 버전의 레코드를 가리키기 위한 KnowledgeArticle.PreviousArticleContentId 특성.
다음 샘플 코드는 CreateKnowledgeArticleVersionRequest를 사용하여 참조 자료 문서 레코드의 주 버전을 만드는 방법을 보여줍니다.
CreateKnowledgeArticleVersionRequest versionRequest = new CreateKnowledgeArticleVersionRequest
{
Source = new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId),
IsMajor = true
};
CreateKnowledgeArticleVersionResponse versionResponse = (CreateKnowledgeArticleVersionResponse)_serviceProxy.Execute(versionRequest);
참조 자료 문서 번역 만들기
CreateKnowledgeArticleTranslation Action(웹 API) 또는 CreateKnowledgeArticleTranslationRequest(조직 서비스)를 사용하여 참조 자료 문서 레코드를 위한 번역을 만듭니다. 150개 이상의 언어로 참조 자료 문서를 번역할 수 있으며 이러한 지원되는 언어에 대한 정보는 새로운 LanguageLocale 엔터티에서 사용할 수 있습니다.추가 정보:LanguageLocale(언어) 엔터티 메시지 및 메서드
CreateKnowledgeArticleTranslation Action(웹 API) 또는 CreateKnowledgeArticleTranslationRequest(조직 서비스)를 사용하여 소스 레코드에서 새 레코드로 복사한 제목, 콘텐츠, 설명 및 키워드가 있는 새로운 참조 자료 문서 레코드를 만들고 새로운 레코드의 언어를 요청에 지정된 언어로 설정합니다. 또한 새 레코드를 주 버전 또는 부 버전으로 할 것인지 여부를 지정해야 합니다. 새로운 레코드는 KnowledgeArticle.ParentArticleContentId 특성을 사용하여 주 참조 자료 문서 레코드와의 연결을 유지합니다.
이 메시지를 실행하고 응답을 받은 후 응답 개체에서 참조 자료 문서 레코드를 검색한 다음 제목, 컨텐츠, 설명 및 키워드를 업데이트하여 번역된 컨텐츠를 추가합니다.
다음 샘플 코드는 CreateKnowledgeArticleTranslationRequest를 사용하여 참조 자료 문서 번역을 만드는 방법을 보여줍니다.
CreateKnowledgeArticleTranslationRequest translationRequest = new CreateKnowledgeArticleTranslationRequest
{
Source = new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId),
Language = new EntityReference(LanguageLocale.EntityLogicalName, languageLocaleId), //languageLocaleId = GUID of the Primary Key of LanguageLocale record
IsMajor = true // Creating a major version
};
CreateKnowledgeArticleTranslationResponse translationResponse = (CreateKnowledgeArticleTranslationResponse)_serviceProxy.Execute(translationRequest);
// Retrieve the new knowledge article record
KnowledgeArticle respObject = (KnowledgeArticle)_serviceProxy.Retrieve(KnowledgeArticle.EntityLogicalName,
translationResponse.CreateKnowledgeArticleTranslation.Id, new ColumnSet(true));
참고
LanguageLocale 엔터티의 각 언어 레코드를 위한 기본 키(LanguageLocaleId)의 GUID 값은 모든 Dynamics 365 조직에 걸쳐 똑같습니다.
참조 자료 문서 수명 주기: 참조 자료 문서 상태 변경
수명 주기 동안 참조 자료 문서는 다음 상태일 수 있습니다.
0: 초안(참조 자료 문서를 만든 후)
1: 승인됨(참조 자료 문서 승인)
2: 예약됨(참조 자료 문서가 게시 예약된 후)
3: 게시됨(참조 자료 문서를 게시한 후)
4: 만료됨(게시하는 동안 지정된 만료 날짜에 따라 참조 자료 문서가 만료된 후)
5: 보관됨(참조 자료 문서가 보관된 후)
6: 삭제됨(참조 자료 문서가 삭제된 후)
문서 상태를 변경하려면 참조 자료 문서 레코드의 Update 메시지를 사용하여 KnowledgeArticle.StateCode 특성을 업데이트합니다. 초기 바인딩 유형의 경우 KnowledgeArticleState 열거형을 사용하여 가능한 상태를 설정합니다.추가 정보:업데이트를 사용하여 특수한 작업 수행.
다음 샘플 코드는 참조 자료 문서 레코드를 게시하는 방법을 보여 줍니다.
// Retrieve the knowledge article record
KnowledgeArticle myKnowledgeArticle = (KnowledgeArticle)_serviceProxy.Retrieve(
KnowledgeArticle.EntityLogicalName, knowledgeArticleId, new ColumnSet("statecode"));
// Update the knowledge article record
myKnowledgeArticle.StateCode = new OptionSetValue((int)KnowledgeArticleState.Published);
UpdateRequest updateKnowledgeArticle = new UpdateRequest
{
Target = myKnowledgeArticle
};
_serviceProxy.Execute(updateKnowledgeArticle);
참조 자료 문서 레코드를 Dynamics 365 엔터티 인스턴스와 연결
웹 클라이언트를 사용하여 Dynamics 365에서 엔터티에 대한 내장된 참조 자료 검색을 활성화하면 다대다 관계인 msdyn_<Entity_Name>_knowledgearticle이 자동으로 만들어집니다. 이 관계를 사용하여 Dynamics 365 엔터티 인스턴스와 KnowledgeArticle 인스턴스를 프로그래밍 방식으로 연결할 수 있습니다.KnowledgeArticle 인스턴스를 엔터티 인스턴스와 연결하면 관계 레코드가 msdyn_<Entity_Name>_knowledgearticle이라는 교차 엔터티가 만들어집니다. 예를 들어, 처음으로 KnowledgeArticle 인스턴스를 Account 인스턴스와 연결하면 msdyn_account_knowledgearticle라고 하는 교차 엔터티가 만들어지고 연결 매핑이 있는 레코드가 이 교차 엔터티에 만들어집니다. 기본적으로 Incident(서비스 케이스) 엔터티가 내장된 참조 자료 검색에 대해 활성화되고 KnowledgeArticle 레코드를 Incident 레코드에 연결하면 KnowledgeArticleIncident 교차 엔터티에 연결 레코드가 만들어집니다.
다음 샘플 코드는 KnowledgeArticle 인스턴스를 Account 인스턴스와 연결하는 방법을 보여줍니다.
// Associate the knowledge article record with an account record
// Step 1: Create a collection of knowledge article records that will be
// associated to the account. In this case, we have only a single
// knowledge article record to be associated.
EntityReferenceCollection relatedEntities = new EntityReferenceCollection();
relatedEntities.Add(new EntityReference(KnowledgeArticle.EntityLogicalName, knowledgeArticleId));
// Step 2: Create an object that defines the relationship between knowledge article record and account record.
// Use the many-to-many relationship name (msdyn_account_knowledgearticle) between knowledge article
// record and account record.
Relationship newRelationship = new Relationship("msdyn_account_knowledgearticle");
// Step 3: Associate the knowledge article record with the account record.
_serviceProxy.Associate(Account.EntityLogicalName, accountId, newRelationship, relatedEntities);
참조 자료 문서 보기 횟수 증가
IncrementKnowledgeArticleViewCountRequest 메시지를 사용하여 KnowledgeArticleViews 엔터티에서 지정된 날짜에 참조 자료 문서 레코드의 보기 개수를 증가시킵니다. 지정된 날짜에 참조 문서 레코드에 대한 레코드가 존재하지 않는 경우 레코드를 만든 다음 KnowledgeArticleViews.KnowledgeArticleView 특성에서 지정된 보기 개수 값을 설정합니다. 지정된 날짜의 참조 문서 레코드에 대한 레코드가 이미 있는 경우 기존 레코드의 KnowledgeArticleViews.KnowledgeArticleView 특성에서 보기 개수를 증가시킵니다.
전체 텍스트 검색을 사용하여 참조 자료 문서 검색
해당 버전과 번역을 포함하여 Dynamics 365의 참조 자료 문서는 전체 텍스트 인덱싱되어 있고 SQL Server 전체 텍스트 검색을 지원합니다. 전체 텍스트 검색에 대한 자세한 내용은 SQL Server: 전체 텍스트 검색을 참조하십시오.
FullTextSearchKnowledgeArticleRequest 메시지를 사용하여 응용 프로그램에서 참조 자료 문서를 검색하여 원하는 정보를 찾습니다.FullTextSearchKnowledgeArticleRequest 메시지를 사용하면 어형 변화의 어간 일치를 사용하고(검색 텍스트를 대체할 시제 또는 어형 변화 허용) 쿼리 기준을 지정(필터링, 순서 지정, 정렬 및 페이징을 지정하기 위해 FetchXML 또는 QueryExpression 사용)하여 지정된 텍스트가 있는 참조 자료 문서를 찾을 수 있습니다. 또한 검색 결과에서 동일한 문서의 여러 버전을 제거하고 텍스트를 검색하는 동안 참조 자료 문서 상태를 필터링할 수도 있습니다.
이전 Dynamics 365 참조 자료 문서 작업
참고
이 섹션에서는 Dynamics 365의 참조 자료 관리를 위해 이전의 참조 자료 문서 엔터티 모델 작업에 대한 정보를 제공합니다. 이 섹션에서 언급한 엔터티는 여전히 최신 버전에 사용할 수 있지만 앞에서 언급한 참조 자료 관리 엔터티를 사용하여 향상된 참조 자료 관리 환경을 이용해야 합니다.
참조 자료 문서는 그 라이프사이클 동안 다음 상태에 있을 수 있습니다:
1: 초안(문서를 만든 후)
2: 승인 안 됨(편집하는 동안)
3: 게시됨(문서를 게시한 후)
문서의 상태를 변경하려면 SetStateRequest 메시지를 사용합니다. 초기 바인딩 유형의 경우 KbArticleState 열거형을 사용하여 가능한 상태를 설정합니다.
문서를 만들 때 템플릿 및 주제에 연결해야 합니다. 문서 템플릿은 문서의 섹션 및 서식에 대해 설명합니다. 주제는 그룹 서비스 케이스(문제), 영업 홍보 자료 및 제품에도 사용되는 비즈니스 범주별로 문서를 구조화하는 데 사용됩니다. 최상의 방법은 문서를 만들기 전에 주제 트리 계층 구조와 필요한 모든 문서 템플릿을 만드는 것입니다.
참고
Microsoft Dynamics 365은 몇 가지 문서 템플릿을 제공합니다. 표준 문서, 문제에 대한 해결책, 절차 및 기타 템플릿이 포함됩니다. 문서 템플릿은 Microsoft Dynamics 365 웹 응용 프로그램을 사용하여 만드는 방법을 권장합니다. 문서 템플릿을 프로그래밍 방식으로 만들려는 경우 기존 문서 템플릿을 포함할 정보 및 데이터 서식을 지정하는 방법의 예제로 사용합니다.
문서를 템플릿에 연결하려면 KbArticle.KbArticleTemplateId 특성을 사용합니다. 주제를 지정하여 문서를 특정 범위에 넣으려면 KbArticle.SubjectId 특성을 사용합니다.
검색에 사용할 키워드와 문서 제목을 지정합니다. 문서를 설명하려면 KbArticle.Description 특성을 사용할 수 있어야 합니다. 문서의 내용을 추가하려면 KbArticle.Content 특성을 사용합니다.Kbarticle.ArticleXml 특성을 사용하여 문서에 대해 XML 데이터를 추가합니다.KbArticle.LanguageCode 값은 문서를 언어별로 정렬하는 쿼리를 작성하는 데 도움이 되도록 템플릿에서 가져옵니다.
문서를 만들면 초안으로 저장됩니다. 그 후에, 귀하는 문서 상태를 “초안”에서 “미승인”으로 변경할 수 있습니다. 미승인 문서의 내용을 수정하고 게시 준비를 할 수 있습니다. 문서를 게시할 준비가 되면 상태를 "승인 안 됨"에서 "게시됨"으로 변경합니다.
게시되지 않은 문서는 템플릿에서 서식 설정을 가져옵니다. 템플릿 서식을 변경하면 변경 내용이 자동으로 "초안" 및 "승인 안 됨" 상태의 문서에 전파됩니다.
문서를 게시한 후 메모(KbArticleComment)를 추가할 수 있지만 권한에 상관 없이 편집할 수는 없습니다. 모든 상태의 문서에 메모를 추가할 수 있습니다.
참고
초안, 승인 안 됨, 게시됨 등 모든 상태의 문서에 메모를 추가할 수 있습니다.
문서를 수정하거나 업데이트하려면 게시를 취소해야 합니다. 문서를 게시 취소할 준비가 되면 문서의 상태를 게시됨에서 승인 안 됨으로 변경합니다.Microsoft Dynamics 365 데이터베이스에서 문서를 삭제하려면 문서의 상태를 게시됨에서 승인 안 됨 또는 초안으로 변경합니다.
참고
참조 자료 문서는 게시됨 상태에 있을 경우 삭제할 수 없습니다.
참조 자료의 문서를 만들고, 업데이트, 편집 및 찾는 방법에 대한 자세한 내용은 도움말 및 교육: 참조 자료의 문서 사용을 참조하십시오.
참고 항목
참조 자료 관리 엔터티
Dynamics 365에서 Parature 참조 자료 사용
KnowledgeArticle 엔터티 메시지 및 메서드
KnowledgeArticleViews 엔터티 메시지 및 메서드
KnowledgeBaseRecord 엔터티 메시지 및 메서드
LanguageLocale(언어) 엔터티 메시지 및 메서드
KbArticle(문서) 엔터티 메시지 및 메서드
Microsoft Dynamics 365
© 2017 Microsoft. All rights reserved. 저작권 정보