KbArticle (Article) Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the knowledge base article entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is KbArticle.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the Metadata for Your Organization.

In This Topic

Entity Metadata

Privilege Metadata

Attribute Metadata

One-to-Many Relationships

Many-to-Many Relationships

Many-to-One Relationships

Entity Metadata

The following table shows the metadata for the knowledge base article entity.

Metadata property Value

OTC

127

EntityLogicalName

kbarticle

DisplayName

Article

OwnershipType

OrganizationOwned

IsCustomizable

True

Description

Structured content that is part of the knowledge base.

IsAvailableOffline

True

IsAuditEnabled

False

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

True

CanCreateForms

False

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

False

IsActivityParty

False

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

True

IsDuplicateDetectionEnabled

True

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

kbarticleid

PrimaryNameAttribute

title

ReportViewName

FilteredKbArticle

RecurrenceBaseEntityLogicalName

x

DisplayCollectionName

Articles

Privilege Metadata

The following table shows the privilege metadata for the knowledge base article entity.

PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

prvAppendArticle

f7466aa7-6d39-400d-89c9-ddb6a25cbea8

Append

False

False

True

False

prvAppendToArticle

d6478086-f814-4c83-a347-d9e4d4a15f80

AppendTo

False

False

True

False

prvCreateArticle

af39db82-2283-4cb2-8381-9d10a0963501

Create

False

False

True

False

prvDeleteArticle

78197094-97c9-4dc7-a95b-b46947f3378f

Delete

False

False

True

False

prvPublishArticle

4ea4a25d-d0b9-427d-bc53-c82a0e983c7f

None

False

False

True

False

prvReadArticle

437c1f0e-7d06-42fb-94b9-631805033daa

Read

False

False

True

False

prvWriteArticle

4e90f305-3eec-4c50-ac7c-b2868e6e9d7f

Write

False

False

True

False

Attribute Metadata

The following table shows the attribute metadata for the knowledge base article entity.

LogicalName Description Type SchemaName IsCustomAttribute IsCustomizable RequiredLevel IsValidForCreate IsValidForRead IsValidForUpdate CanBeSecuredForCreate CanBeSecuredForRead CanBeSecuredForUpdate IsAuditEnabled IsManaged IsPrimaryId IsPrimaryName IsRenameable IsSecured IsValidForAdvancedFind DisplayName DeprecatedVersion

articlexml

XML data for the knowledge base article.

Memo

ArticleXml

False

True

None

True

True

True

False

False

False

True

True

False

False

False

False

False

Article XML

comments

Comments regarding the knowledge base article.

Memo

Comments

False

True

None

True

True

True

False

False

False

True

True

False

False

False

False

False

Comments

content

Description of the content of the knowledge base article.

Memo

Content

False

True

None

False

True

False

False

False

False

True

True

False

False

False

False

False

Content

createdby

Unique identifier of the user who created the knowledge base article.

Lookup

CreatedBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created By

createdon

Date and time when the knowledge base article was created.

DateTime

CreatedOn

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created On

createdonbehalfby

Unique identifier of the delegate user who created the article.

Lookup

CreatedOnBehalfBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Created By (Delegate)

description

Description of the knowledge base article.

Memo

Description

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Description

exchangerate

Decimal

ExchangeRate

False

True

None

False

True

False

False

False

False

True

True

False

False

True

False

True

Exchange Rate

importsequencenumber

Unique identifier of the data import or data migration that created this record.

Integer

ImportSequenceNumber

False

True

None

True

True

False

False

False

False

True

True

False

False

True

False

True

Import Sequence Number

kbarticleid

Unique identifier of the knowledge base article.

Uniqueidentifier

KbArticleId

False

True

SystemRequired

True

True

False

False

False

False

False

True

True

False

True

False

True

Article

kbarticletemplateid

Unique identifier of the template associated with the knowledge base article.

Lookup

KbArticleTemplateId

False

True

SystemRequired

True

True

True

False

False

False

True

True

False

False

False

False

True

Base Template

keywords

Keywords to be used for searches in knowledge base articles.

Memo

KeyWords

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Key Words

languagecode

Language of the Article Template

Integer

LanguageCode

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Language

modifiedby

Unique identifier of the user who last modified the knowledge base article.

Lookup

ModifiedBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified By

modifiedon

Date and time when the knowledge base article was last modified.

DateTime

ModifiedOn

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified On

modifiedonbehalfby

Unique identifier of the delegate user who last modified the kbarticle.

Lookup

ModifiedOnBehalfBy

False

True

None

False

True

False

False

False

False

False

True

False

False

True

False

True

Modified By (Delegate)

number

Knowledge base article number.

String

Number

False

True

None

False

True

False

False

False

False

True

True

False

False

True

False

True

Number

organizationid

Unique identifier of the organization associated with the article.

Lookup

OrganizationId

False

False

SystemRequired

False

True

False

False

False

False

False

True

False

False

False

False

False

Organization

overriddencreatedon

Date and time that the record was migrated.

DateTime

OverriddenCreatedOn

False

True

None

True

True

False

False

False

False

True

True

False

False

True

False

True

Record Created On

statecode

Status of the knowledge base article.

State

StateCode

False

True

SystemRequired

False

True

False

False

False

False

True

True

False

False

True

False

True

Status

statuscode

Reason for the status of the knowledge base article.

Status

StatusCode

False

True

None

False

True

True

False

False

False

True

True

False

False

False

False

False

Status Reason

subjectid

Unique identifier of the subject associated with the knowledge base article.

Lookup

SubjectId

False

True

SystemRequired

True

True

True

False

False

False

True

True

False

False

True

False

True

Subject

title

Title of the knowledge base article.

String

Title

False

True

ApplicationRequired

True

True

True

False

False

False

True

True

False

True

True

False

True

Title

transactioncurrencyid

Lookup

TransactionCurrencyId

False

True

None

True

True

True

False

False

False

True

True

False

False

True

False

True

Currency

versionnumber

Title of the knowledge base article.

BigInt

VersionNumber

False

False

None

False

True

False

False

False

False

False

True

False

False

False

False

False

Title

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the knowledge base article entity.

Relationship schema name Referencing Entity

KbArticle_Annotation

annotation

KbArticle_AsyncOperations

asyncoperation

KbArticle_BulkDeleteFailures

bulkdeletefailure

KbArticle_DocumentIndex

documentindex

KbArticle_DuplicateBaseRecord

duplicaterecord

KbArticle_DuplicateMatchingRecord

duplicaterecord

kbarticle_incidents

incident

kbarticle_comments

kbarticlecomment

kbarticle_principalobjectattributeaccess

principalobjectattributeaccess

KbArticle_ProcessSessions

processsession

KbArticle_SharepointDocumentLocation

sharepointdocumentlocation

userentityinstancedata_kbarticle

userentityinstancedata

Many-to-Many Relationships

There are no many-to-many relationships for the knowledge base article entity.

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the knowledge base article entity.

Relationship schema name Referenced Entity

kb_article_template_kb_articles

kbarticletemplate

organization_kb_articles

organization

subject_kb_articles

subject

lk_kbarticle_modifiedonbehalfby

systemuser

lk_kbarticlebase_modifiedby

systemuser

lk_kbarticle_createdonbehalfby

systemuser

lk_kbarticlebase_createdby

systemuser

TransactionCurrency_KbArticle

transactioncurrency

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

KbArticle (Article) Entity Messages and Methods
KbArticle (Article) Entity Privileges

Microsoft Dynamics CRM 2011
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.