Article Template (KbArticleTemplate) entity reference
Template for a knowledge base article that contains the standard attributes of an article.
Messages
| Message | SDK class or method |
|---|---|
| Create | CreateRequest or Create |
| Delete | DeleteRequest or Delete |
| Retrieve | RetrieveRequest or Retrieve |
| RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
| Update | UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | KbArticleTemplates |
| DisplayCollectionName | Article Templates |
| DisplayName | Article Template |
| EntitySetName | kbarticletemplates |
| IsBPFEntity | False |
| LogicalCollectionName | kbarticletemplates |
| LogicalName | kbarticletemplate |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | kbarticletemplateid |
| PrimaryNameAttribute | title |
| SchemaName | KbArticleTemplate |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- Description
- FormatXml
- ImportSequenceNumber
- IntroducedVersion
- IsActive
- IsCustomizable
- KbArticleTemplateId
- LanguageCode
- OverriddenCreatedOn
- StructureXml
- Title
Description
| Property | Value |
|---|---|
| Description | Description of the knowledge base article template. |
| DisplayName | Description |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
FormatXml
| Property | Value |
|---|---|
| Description | XML format of the knowledge base article template. |
| DisplayName | Format XML |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formatxml |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Unique identifier of the data import or data migration that created this record. |
| DisplayName | Import Sequence Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | importsequencenumber |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
IntroducedVersion
| Property | Value |
|---|---|
| Description | Version in which the form is introduced. |
| DisplayName | Introduced Version |
| FormatName | VersionNumber |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | introducedversion |
| MaxLength | 48 |
| RequiredLevel | None |
| Type | String |
IsActive
| Property | Value |
|---|---|
| Description | Information about whether the knowledge base article is active. |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | isactive |
| RequiredLevel | None |
| Type | Boolean |
IsActive Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Active | |
| 0 | Inactive |
DefaultValue: 1
IsCustomizable
| Property | Value |
|---|---|
| Description | Information that specifies whether this component can be customized. |
| DisplayName | Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
KbArticleTemplateId
| Property | Value |
|---|---|
| Description | Unique identifier of the knowledge base article template. |
| DisplayName | Article Template |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | kbarticletemplateid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
LanguageCode
| Property | Value |
|---|---|
| Description | Language of the Article Template |
| DisplayName | Language |
| Format | Language |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | languagecode |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | ApplicationRequired |
| Type | Integer |
OverriddenCreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
StructureXml
| Property | Value |
|---|---|
| Description | XML structure of the knowledge base article. |
| DisplayName | Structure XML |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | structurexml |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
Title
| Property | Value |
|---|---|
| Description | Title of the knowledge base article template. |
| DisplayName | Title |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | title |
| MaxLength | 500 |
| RequiredLevel | ApplicationRequired |
| Type | String |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- IsManaged
- KbArticleTemplateIdUnique
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Published | |
| 1 | Unpublished | |
| 2 | Deleted | |
| 3 | Deleted Unpublished |
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the knowledge base article template. |
| DisplayName | Created By |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the knowledge base article template was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the kbarticletemplate. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
IsManaged
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: 0
KbArticleTemplateIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | kbarticletemplateidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who last modified the knowledge base article template. |
| DisplayName | Modified By |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the knowledge base article template was last modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who last modified the kbarticletemplate. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier of the organization associated with the template. |
| DisplayName | Organization |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | SystemRequired |
| Targets | organization |
| Type | Lookup |
OrganizationIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationidname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OverwriteTime
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
VersionNumber
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- kb_article_template_kb_articles
- KbArticleTemplate_SyncErrors
- KbArticleTemplate_AsyncOperations
- KbArticleTemplate_BulkDeleteFailures
- KbArticleTemplate_ProcessSessions
kb_article_template_kb_articles
Same as the kb_article_template_kb_articles many-to-one relationship for the kbarticle entity.
| Property | Value |
|---|---|
| ReferencingEntity | kbarticle |
| ReferencingAttribute | kbarticletemplateid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | kb_article_template_kb_articles |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
KbArticleTemplate_SyncErrors
Same as the KbArticleTemplate_SyncErrors many-to-one relationship for the syncerror entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | KbArticleTemplate_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
KbArticleTemplate_AsyncOperations
Same as the KbArticleTemplate_AsyncOperations many-to-one relationship for the asyncoperation entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | KbArticleTemplate_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
KbArticleTemplate_BulkDeleteFailures
Same as the KbArticleTemplate_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | KbArticleTemplate_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
KbArticleTemplate_ProcessSessions
Same as the KbArticleTemplate_ProcessSessions many-to-one relationship for the processsession entity.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | KbArticleTemplate_ProcessSessions |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 110 |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_kbarticletemplate_createdonbehalfby
- organization_kb_article_templates
- lk_kbarticletemplate_modifiedonbehalfby
- lk_kbarticletemplatebase_modifiedby
- lk_kbarticletemplatebase_createdby
lk_kbarticletemplate_createdonbehalfby
See the lk_kbarticletemplate_createdonbehalfby one-to-many relationship for the systemuser entity.
organization_kb_article_templates
See the organization_kb_article_templates one-to-many relationship for the organization entity.
lk_kbarticletemplate_modifiedonbehalfby
See the lk_kbarticletemplate_modifiedonbehalfby one-to-many relationship for the systemuser entity.
lk_kbarticletemplatebase_modifiedby
See the lk_kbarticletemplatebase_modifiedby one-to-many relationship for the systemuser entity.
lk_kbarticletemplatebase_createdby
See the lk_kbarticletemplatebase_createdby one-to-many relationship for the systemuser entity.
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for