Article Template in applicationCommon

Template for a knowledge base article that contains the standard attributes of an article.

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributeArticleTemplate/(resolvedAttributes)/kbArticleTemplateIdattribute

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/core/applicationCommon/ArticleTemplate.cdm.json
/ArticleTemplate/hasAttributes
/attributesAddedAtThisScope
entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enArticle Template
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTemplate for a knowledge base article that contains the standard attributes of an article.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"KbArticleTemplate"string

Attributes

Name Description First Included in Instance
kbArticleTemplateId Unique identifier of the knowledge base article template. applicationCommon/ArticleTemplate
structureXml XML structure of the knowledge base article. applicationCommon/ArticleTemplate
organizationId Unique identifier of the organization associated with the template. applicationCommon/ArticleTemplate
formatXml XML format of the knowledge base article template. applicationCommon/ArticleTemplate
title Title of the knowledge base article template. applicationCommon/ArticleTemplate
versionNumber applicationCommon/ArticleTemplate
description Description of the knowledge base article template. applicationCommon/ArticleTemplate
isActive Information about whether the knowledge base article is active. applicationCommon/ArticleTemplate
createdBy Unique identifier of the user who created the knowledge base article template. applicationCommon/ArticleTemplate
modifiedBy Unique identifier of the user who last modified the knowledge base article template. applicationCommon/ArticleTemplate
createdOn Date and time when the knowledge base article template was created. applicationCommon/ArticleTemplate
modifiedOn Date and time when the knowledge base article template was last modified. applicationCommon/ArticleTemplate
overriddenCreatedOn Date and time that the record was migrated. applicationCommon/ArticleTemplate
languageCode Language of the Article Template applicationCommon/ArticleTemplate
importSequenceNumber Unique identifier of the data import or data migration that created this record. applicationCommon/ArticleTemplate
kbArticleTemplateIdUnique For internal use only. applicationCommon/ArticleTemplate
componentState For internal use only. applicationCommon/ArticleTemplate
componentState_display applicationCommon/ArticleTemplate
solutionId Unique identifier of the associated solution. applicationCommon/ArticleTemplate
overwriteTime For internal use only. applicationCommon/ArticleTemplate
createdOnBehalfBy Unique identifier of the delegate user who created the kbarticletemplate. applicationCommon/ArticleTemplate
modifiedOnBehalfBy Unique identifier of the delegate user who last modified the kbarticletemplate. applicationCommon/ArticleTemplate
isManaged applicationCommon/ArticleTemplate
isCustomizable Information that specifies whether this component can be customized. applicationCommon/ArticleTemplate
introducedVersion Version in which the form is introduced. applicationCommon/ArticleTemplate

kbArticleTemplateId

Unique identifier of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameArticle Template
descriptionUnique identifier of the knowledge base article template.
isPrimaryKeytrue
dataFormatguid
sourceNamekbarticletemplateid

Traits

List of traits for the kbArticleTemplateId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity

ParameterValueData typeExplanation
attributeArticleTemplate/(resolvedAttributes)/kbArticleTemplateIdattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enArticle Template
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"kbarticletemplateid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"1"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

structureXml

XML structure of the knowledge base article.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameStructure XML
descriptionXML structure of the knowledge base article.
dataFormatstring
maximumLength1073741823
isNullabletrue
sourceNamestructurexml

Traits

List of traits for the structureXml attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStructure XML
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enXML structure of the knowledge base article.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"structurexml"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"2"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1073741823"integer

is.dataFormat.character
is.dataFormat.array

organizationId

Unique identifier of the organization associated with the template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameOrganization
descriptionUnique identifier of the organization associated with the template.
dataFormatguid
sourceNameorganizationid

Traits

List of traits for the organizationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganization
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the organization associated with the template.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/Organization.cdm.json/OrganizationorganizationId
entitya reference to the constant entity holding the list of entity references

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"organizationid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"3"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

formatXml

XML format of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameFormat XML
descriptionXML format of the knowledge base article template.
dataFormatstring
maximumLength1073741823
isNullabletrue
sourceNameformatxml

Traits

List of traits for the formatXml attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFormat XML
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enXML format of the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"formatxml"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"5"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1073741823"integer

is.dataFormat.character
is.dataFormat.array

title

Title of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameTitle
descriptionTitle of the knowledge base article template.
dataFormatstring
maximumLength500
isNullabletrue
sourceNametitle

Traits

List of traits for the title attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"required"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTitle
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTitle of the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"title"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"7"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"500"integer

is.dataFormat.character
is.dataFormat.array

versionNumber

First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
dataFormatint64
isNullabletrue
sourceNameversionnumber

Traits

List of traits for the versionNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"versionnumber"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"8"integer

is.dataFormat.integer
is.dataFormat.big

description

Description of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameDescription
descriptionDescription of the knowledge base article template.
dataFormatstring
maximumLength2000
isNullabletrue
sourceNamedescription

Traits

List of traits for the description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription of the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"description"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"9"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2000"integer

is.dataFormat.character
is.dataFormat.array

isActive

Information about whether the knowledge base article is active.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameStatus
descriptionInformation about whether the knowledge base article is active.
dataFormatboolean
isNullabletrue
sourceNameisactive

Traits

List of traits for the isActive attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStatus
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInformation about whether the knowledge base article is active.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"isactive"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"10"integer

is.dataFormat.boolean

createdBy

Unique identifier of the user who created the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameCreated By
descriptionUnique identifier of the user who created the knowledge base article template.
dataFormatguid
isNullabletrue
sourceNamecreatedby

Traits

List of traits for the createdBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the user who created the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdby"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"11"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedBy

Unique identifier of the user who last modified the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameModified By
descriptionUnique identifier of the user who last modified the knowledge base article template.
dataFormatguid
isNullabletrue
sourceNamemodifiedby

Traits

List of traits for the modifiedBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the user who last modified the knowledge base article template.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedby"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"12"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

createdOn

Date and time when the knowledge base article template was created.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameCreated On
descriptionDate and time when the knowledge base article template was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the knowledge base article template was created.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"13"integer

is.dataFormat.time
is.dataFormat.date

modifiedOn

Date and time when the knowledge base article template was last modified.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the knowledge base article template was last modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.modify
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the knowledge base article template was last modified.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"14"integer

is.dataFormat.time
is.dataFormat.date

overriddenCreatedOn

Date and time that the record was migrated.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdateTime
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
means.measurement.date.creation
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time that the record was migrated.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"22"integer

is.dataFormat.time
is.dataFormat.date

languageCode

Language of the Article Template
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameLanguage
descriptionLanguage of the Article Template
dataFormatstring
maximumValue2147483647
minimumValue0
isNullabletrue
sourceNamelanguagecode

Traits

List of traits for the languageCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.language
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"required"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLanguage
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLanguage of the Article Template
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"languagecode"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"23"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"0"decimal
maximumValue"2147483647"decimal

is.dataFormat.character
is.dataFormat.array

importSequenceNumber

Unique identifier of the data import or data migration that created this record.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionUnique identifier of the data import or data migration that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the data import or data migration that created this record.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"24"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.dataFormat.integer

kbArticleTemplateIdUnique

For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
descriptionFor internal use only.
dataFormatguid
sourceNamekbarticletemplateidunique

Traits

List of traits for the kbArticleTemplateIdUnique attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"kbarticletemplateidunique"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"27"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

componentState

For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameComponent State
descriptionFor internal use only.
dataFormatint32
sourceNamecomponentstate
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enPublished0
enUnpublished1
enDeleted2
enDeleted Unpublished3

Traits

List of traits for the componentState attribute are listed below.

is.dataFormat.integer
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enPublished0
enUnpublished1
enDeleted2
enDeleted Unpublished3
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enComponent State
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"componentstate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"28"integer

is.dataFormat.integer

componentState_display

First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

Traits

List of traits for the componentState_display attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.displayText
is.readOnly
is.addedInSupportOf

ParameterValueData typeExplanation
inSupportOf"componentState"attributeNameoutput parameter naming the attribute that is being supported

is.dataFormat.character
is.dataFormat.array

solutionId

Unique identifier of the associated solution.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameSolution
descriptionUnique identifier of the associated solution.
dataFormatguid
sourceNamesolutionid

Traits

List of traits for the solutionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSolution
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the associated solution.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"solutionid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"30"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

overwriteTime

For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameRecord Overwrite Time
descriptionFor internal use only.
dataFormatdateTime
sourceNameoverwritetime

Traits

List of traits for the overwriteTime attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Overwrite Time
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFor internal use only.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overwritetime"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"31"integer

is.dataFormat.time
is.dataFormat.date

createdOnBehalfBy

Unique identifier of the delegate user who created the kbarticletemplate.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameCreated By (Delegate)
descriptionUnique identifier of the delegate user who created the kbarticletemplate.
dataFormatguid
isNullabletrue
sourceNamecreatedonbehalfby

Traits

List of traits for the createdOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the delegate user who created the kbarticletemplate.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdonbehalfby"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"32"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

modifiedOnBehalfBy

Unique identifier of the delegate user who last modified the kbarticletemplate.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameModified By (Delegate)
descriptionUnique identifier of the delegate user who last modified the kbarticletemplate.
dataFormatguid
isNullabletrue
sourceNamemodifiedonbehalfby

Traits

List of traits for the modifiedOnBehalfBy attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified By (Delegate)
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier of the delegate user who last modified the kbarticletemplate.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/applicationCommon/User.cdm.json/UsersystemUserId
entitya reference to the constant entity holding the list of entity references

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedonbehalfby"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"36"integer

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

isManaged

First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
dataFormatboolean
sourceNameismanaged

Traits

List of traits for the isManaged attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ismanaged"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"40"integer

is.dataFormat.boolean

isCustomizable

Information that specifies whether this component can be customized.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameCustomizable
descriptionInformation that specifies whether this component can be customized.
dataFormatboolean
sourceNameiscustomizable

Traits

List of traits for the isCustomizable attribute are listed below.

is.dataFormat.boolean
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCustomizable
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInformation that specifies whether this component can be customized.
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"iscustomizable"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"41"integer

is.dataFormat.boolean

introducedVersion

Version in which the form is introduced.
First included in: applicationCommon/ArticleTemplate (this entity)

Properties

NameValue
displayNameIntroduced Version
descriptionVersion in which the form is introduced.
dataFormatstring
maximumLength48
isNullabletrue
sourceNameintroducedversion

Traits

List of traits for the introducedVersion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.measurement.version
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIntroduced Version
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVersion in which the form is introduced.
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"introducedversion"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"43"integer

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"48"integer

is.dataFormat.character
is.dataFormat.array