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
Parameter | Value | Data type | Explanation |
---|
versionNumber | "1.1" | string | semantic version number of the entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
Parameter | Value | Data type | Explanation |
---|
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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Article Template |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Template for a knowledge base article that contains the standard attributes of an article. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "KbArticleTemplate" | string | |
Attributes
Unique identifier of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Article Template |
description | Unique identifier of the knowledge base article template. |
isPrimaryKey | true |
dataFormat | guid |
sourceName | kbarticletemplateid |
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
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Article Template |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "kbarticletemplateid" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "1" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
XML structure of the knowledge base article.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Structure XML |
description | XML structure of the knowledge base article. |
dataFormat | string |
maximumLength | 1073741823 |
isNullable | true |
sourceName | structurexml |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Structure XML |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | XML structure of the knowledge base article. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "structurexml" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "2" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
maximumLength | "1073741823" | integer | |
is.dataFormat.character
is.dataFormat.array
Unique identifier of the organization associated with the template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Organization |
description | Unique identifier of the organization associated with the template. |
dataFormat | guid |
sourceName | organizationid |
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
Parameter | Value | Data type | Explanation |
---|
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Organization |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the organization associated with the template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
entityReferences | | entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "organizationid" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "3" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
XML format of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Format XML |
description | XML format of the knowledge base article template. |
dataFormat | string |
maximumLength | 1073741823 |
isNullable | true |
sourceName | formatxml |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Format XML |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | XML format of the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "formatxml" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "5" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
maximumLength | "1073741823" | integer | |
is.dataFormat.character
is.dataFormat.array
Title of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Title |
description | Title of the knowledge base article template. |
dataFormat | string |
maximumLength | 500 |
isNullable | true |
sourceName | title |
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
Parameter | Value | Data type | Explanation |
---|
level | "required" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Title |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Title of the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "title" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "7" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
maximumLength | "500" | integer | |
is.dataFormat.character
is.dataFormat.array
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
dataFormat | int64 |
isNullable | true |
sourceName | versionnumber |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values 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.
Parameter | Value | Data type | Explanation |
---|
name | "versionnumber" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "8" | integer | |
is.dataFormat.integer
is.dataFormat.big
Description of the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Description |
description | Description of the knowledge base article template. |
dataFormat | string |
maximumLength | 2000 |
isNullable | true |
sourceName | description |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Description |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Description of the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "description" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "9" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
maximumLength | "2000" | integer | |
is.dataFormat.character
is.dataFormat.array
Information about whether the knowledge base article is active.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Status |
description | Information about whether the knowledge base article is active. |
dataFormat | boolean |
isNullable | true |
sourceName | isactive |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Status |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Information about whether the knowledge base article is active. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "isactive" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "10" | integer | |
is.dataFormat.boolean
Unique identifier of the user who created the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Created By |
description | Unique identifier of the user who created the knowledge base article template. |
dataFormat | guid |
isNullable | true |
sourceName | createdby |
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
Parameter | Value | Data type | Explanation |
---|
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Created By |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the user who created the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
entityReferences | | entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "createdby" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "11" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Unique identifier of the user who last modified the knowledge base article template.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Modified By |
description | Unique identifier of the user who last modified the knowledge base article template. |
dataFormat | guid |
isNullable | true |
sourceName | modifiedby |
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
Parameter | Value | Data type | Explanation |
---|
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Modified By |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the user who last modified the knowledge base article template. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
entityReferences | | entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "modifiedby" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "12" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Date and time when the knowledge base article template was created.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Created On |
description | Date and time when the knowledge base article template was created. |
dataFormat | dateTime |
isNullable | true |
sourceName | createdon |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Created On |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Date and time when the knowledge base article template was created. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "createdon" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "13" | integer | |
is.dataFormat.time
is.dataFormat.date
Date and time when the knowledge base article template was last modified.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Modified On |
description | Date and time when the knowledge base article template was last modified. |
dataFormat | dateTime |
isNullable | true |
sourceName | modifiedon |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Modified On |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Date and time when the knowledge base article template was last modified. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "modifiedon" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "14" | integer | |
is.dataFormat.time
is.dataFormat.date
Date and time that the record was migrated.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Record Created On |
description | Date and time that the record was migrated. |
dataFormat | dateTime |
isNullable | true |
sourceName | overriddencreatedon |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Record Created On |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Date and time that the record was migrated. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "overriddencreatedon" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "22" | integer | |
is.dataFormat.time
is.dataFormat.date
Language of the Article Template
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Language |
description | Language of the Article Template |
dataFormat | string |
maximumValue | 2147483647 |
minimumValue | 0 |
isNullable | true |
sourceName | languagecode |
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
Parameter | Value | Data type | Explanation |
---|
level | "required" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Language |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Language of the Article Template |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "languagecode" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "23" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
minimumValue | "0" | decimal | |
maximumValue | "2147483647" | decimal | |
is.dataFormat.character
is.dataFormat.array
Unique identifier of the data import or data migration that created this record.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Import Sequence Number |
description | Unique identifier of the data import or data migration that created this record. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -2147483648 |
isNullable | true |
sourceName | importsequencenumber |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Import Sequence Number |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the data import or data migration that created this record. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "importsequencenumber" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "24" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
minimumValue | "-2147483648" | decimal | |
maximumValue | "2147483647" | decimal | |
is.dataFormat.integer
For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
description | For internal use only. |
dataFormat | guid |
sourceName | kbarticletemplateidunique |
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | For internal use only. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "kbarticletemplateidunique" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "27" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Component State |
description | For internal use only. |
dataFormat | int32 |
sourceName | componentstate |
valueConstrainedToList | true |
defaultValue | languageTag | displayText | attributeValue |
---|
en | Published | 0 | en | Unpublished | 1 | en | Deleted | 2 | en | Deleted Unpublished | 3 |
|
Traits
List of traits for the componentState attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
Parameter | Value | Data type | Explanation |
---|
default | languageTag | displayText | attributeValue |
---|
en | Published | 0 | en | Unpublished | 1 | en | Deleted | 2 | en | Deleted Unpublished | 3 |
| 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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Component State |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | For internal use only. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "componentstate" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "28" | integer | |
is.dataFormat.integer
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
dataFormat | string |
isReadOnly | true |
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
Parameter | Value | Data type | Explanation |
---|
inSupportOf | "componentState" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
Unique identifier of the associated solution.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Solution |
description | Unique identifier of the associated solution. |
dataFormat | guid |
sourceName | solutionid |
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Solution |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the associated solution. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "solutionid" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "30" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
For internal use only.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Record Overwrite Time |
description | For internal use only. |
dataFormat | dateTime |
sourceName | overwritetime |
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Record Overwrite Time |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | For internal use only. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "overwritetime" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "31" | integer | |
is.dataFormat.time
is.dataFormat.date
Unique identifier of the delegate user who created the kbarticletemplate.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Created By (Delegate) |
description | Unique identifier of the delegate user who created the kbarticletemplate. |
dataFormat | guid |
isNullable | true |
sourceName | createdonbehalfby |
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
Parameter | Value | Data type | Explanation |
---|
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Created By (Delegate) |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the delegate user who created the kbarticletemplate. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
entityReferences | | entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "createdonbehalfby" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "32" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
Unique identifier of the delegate user who last modified the kbarticletemplate.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Modified By (Delegate) |
description | Unique identifier of the delegate user who last modified the kbarticletemplate. |
dataFormat | guid |
isNullable | true |
sourceName | modifiedonbehalfby |
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
Parameter | Value | Data type | Explanation |
---|
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Modified By (Delegate) |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Unique identifier of the delegate user who last modified the kbarticletemplate. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
entityReferences | | entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "modifiedonbehalfby" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "36" | integer | |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
dataFormat | boolean |
sourceName | ismanaged |
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
name | "ismanaged" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "40" | integer | |
is.dataFormat.boolean
Information that specifies whether this component can be customized.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Customizable |
description | Information that specifies whether this component can be customized. |
dataFormat | boolean |
sourceName | iscustomizable |
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
Parameter | Value | Data type | Explanation |
---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Customizable |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Information that specifies whether this component can be customized. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "iscustomizable" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "41" | integer | |
is.dataFormat.boolean
Version in which the form is introduced.
First included in: applicationCommon/ArticleTemplate (this entity)
Properties
Name | Value |
---|
displayName | Introduced Version |
description | Version in which the form is introduced. |
dataFormat | string |
maximumLength | 48 |
isNullable | true |
sourceName | introducedversion |
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
Parameter | Value | Data type | Explanation |
---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Introduced Version |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
localizedDisplayText | languageTag | displayText |
---|
en | Version in which the form is introduced. |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|
name | "introducedversion" | string | |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|
ordinal | "43" | integer | |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|
maximumLength | "48" | integer | |
is.dataFormat.character
is.dataFormat.array