Page Template in portals
URL of the .aspx page used to create new webpages.
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.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
| Parameter | Value | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| groupList |
| entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | PageTemplate/(resolvedAttributes)/pageTemplateId | attribute |
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | PageTemplate/(resolvedAttributes)/stateCode | attribute |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| 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 |
| 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 | "Adx_pagetemplate" | string |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| createdOn | Date and time when the record was created. | portals/PageTemplate |
| createdBy | Shows who created the record. | portals/PageTemplate |
| modifiedOn | Date and time when the record was modified. | portals/PageTemplate |
| modifiedBy | Shows who last updated the record. | portals/PageTemplate |
| createdOnBehalfBy | Shows who created the record on behalf of another user. | portals/PageTemplate |
| modifiedOnBehalfBy | Shows who last updated the record on behalf of another user. | portals/PageTemplate |
| overriddenCreatedOn | Date and time that the record was migrated. | portals/PageTemplate |
| importSequenceNumber | Sequence number of the import that created this record. | portals/PageTemplate |
| ownerId | Owner Id | portals/PageTemplate |
| ownerIdType | The type of owner, either User or Team. | portals/PageTemplate |
| owningBusinessUnit | Unique identifier for the business unit that owns the record | portals/PageTemplate |
| owningUser | Unique identifier of the user that owns the activity. | portals/PageTemplate |
| owningTeam | Unique identifier for the team that owns the record. | portals/PageTemplate |
| timeZoneRuleVersionNumber | For internal use only. | portals/PageTemplate |
| UTCConversionTimeZoneCode | Time zone code that was in use when the record was created. | portals/PageTemplate |
| versionNumber | Version Number | portals/PageTemplate |
| pageTemplateId | Unique identifier for entity instances | portals/PageTemplate |
| stateCode | Status of the Page Template | portals/PageTemplate |
| stateCode_display | portals/PageTemplate | |
| statusCode | Reason for the status of the Page Template | portals/PageTemplate |
| statusCode_display | portals/PageTemplate | |
| name | Shows the name of the custom entity. | portals/PageTemplate |
| isDefault | portals/PageTemplate | |
| rewriteURL | portals/PageTemplate | |
| websiteId | Unique identifier for Website associated with Page Template. | portals/PageTemplate |
| description | portals/PageTemplate | |
| entityName | portals/PageTemplate | |
| type | The type of the record. | portals/PageTemplate |
| type_display | portals/PageTemplate | |
| useWebsiteHeaderAndFooter | Control whether this web template page template will be rendered using the website header and footer, or control rendering of all page content. | portals/PageTemplate |
| webTemplateId | Unique identifier for Web Template associated with Page Template. | portals/PageTemplate |
createdOn
Date and time when the record was created.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created On |
| description | Date and time when the record 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.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.time
is.dataFormat.date
createdBy
Shows who created the record.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created By |
| description | Shows who created the record. |
| 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
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
modifiedOn
Date and time when the record was modified.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified On |
| description | Date and time when the record was 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.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.time
is.dataFormat.date
modifiedBy
Shows who last updated the record.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified By |
| description | Shows who last updated the record. |
| 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
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
createdOnBehalfBy
Shows who created the record on behalf of another user.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Created By (Delegate) |
| description | Shows who created the record on behalf of another user. |
| 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
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
modifiedOnBehalfBy
Shows who last updated the record on behalf of another user.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Modified By (Delegate) |
| description | Shows who last updated the record on behalf of another user. |
| 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
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
overriddenCreatedOn
Date and time that the record was migrated.
First included in: portals/PageTemplate (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.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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.dataFormat.time
is.dataFormat.date
importSequenceNumber
Sequence number of the import that created this record.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Import Sequence Number |
| description | Sequence number of the import 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 |
| 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 |
| 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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-2147483648" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
ownerId
Owner Id
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owner |
| description | Owner Id |
| dataFormat | guid |
| sourceName | ownerid |
Traits
List of traits for the ownerId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "ownerid" | string |
is.CDS.owner
contains a User or Team ID
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
ownerIdType
The type of owner, either User or Team.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owner Type |
| description | The type of owner, either User or Team. |
| dataFormat | string |
| isReadOnly | true |
| sourceName | owneridtype |
Traits
List of traits for the ownerIdType attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.entityName
[deprecated] use the standalone 'means.entityName' trait instead.
means.entityName
a string value is the name of a CDM 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.linkedEntity.name
Marks an attribute that contains the entity name or 'class' for the situation where one entity links to (uses as an attribute) a set of possible entities.
is.readOnly
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "owneridtype" | string |
is.CDS.owner
contains a User or Team ID
is.dataFormat.character
is.dataFormat.array
owningBusinessUnit
Unique identifier for the business unit that owns the record
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning Business Unit |
| description | Unique identifier for the business unit that owns the record |
| dataFormat | guid |
| isNullable | true |
| sourceName | owningbusinessunit |
Traits
List of traits for the owningBusinessUnit attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "owningbusinessunit" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
owningUser
Unique identifier of the user that owns the activity.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning User |
| description | Unique identifier of the user that owns the activity. |
| dataFormat | guid |
| isNullable | true |
| sourceName | owninguser |
Traits
List of traits for the owningUser attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
means.userId
contains a userId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "owninguser" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
owningTeam
Unique identifier for the team that owns the record.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Owning Team |
| description | Unique identifier for the team that owns the record. |
| dataFormat | guid |
| isNullable | true |
| sourceName | owningteam |
Traits
List of traits for the owningTeam attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "owningteam" | string |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
timeZoneRuleVersionNumber
For internal use only.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Time Zone Rule Version Number |
| description | For internal use only. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "timezoneruleversionnumber" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | UTC Conversion Time Zone Code |
| description | Time zone code that was in use when the record was created. |
| dataFormat | int32 |
| maximumValue | 2147483647 |
| minimumValue | -1 |
| isNullable | true |
| sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "utcconversiontimezonecode" | string |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| minimumValue | "-1" | decimal | |
| maximumValue | "2147483647" | decimal |
is.dataFormat.integer
versionNumber
Version Number
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Version Number |
| description | Version Number |
| dataFormat | int64 |
| isNullable | true |
| sourceName | versionnumber |
Traits
List of traits for the versionNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
means.measurement.version
is.CDS.standard
identifies attributes that are part of the cdsStandard base set.
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 |
| 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 |
| 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 | "versionnumber" | string |
is.dataFormat.integer
is.dataFormat.big
pageTemplateId
Unique identifier for entity instances
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Page Template |
| description | Unique identifier for entity instances |
| isPrimaryKey | true |
| dataFormat | guid |
| sourceName | adx_pagetemplateid |
Traits
List of traits for the pageTemplateId 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
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | PageTemplate/(resolvedAttributes)/pageTemplateId | attribute |
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 |
| 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 |
| 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 | "adx_pagetemplateid" | 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
stateCode
Status of the Page Template
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status | |||||||||
| description | Status of the Page Template | |||||||||
| dataFormat | int32 | |||||||||
| sourceName | statecode | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
Traits
List of traits for the stateCode attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
means.entityState
the attribute represents the current state of the entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | PageTemplate/(resolvedAttributes)/stateCode | attribute |
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 |
| 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 |
| 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 | "statecode" | 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.dataFormat.integer
stateCode_display
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the stateCode_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 | "stateCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
statusCode
Reason for the status of the Page Template
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Status Reason | ||||||||||||
| description | Reason for the status of the Page Template | ||||||||||||
| dataFormat | int32 | ||||||||||||
| isNullable | true | ||||||||||||
| sourceName | statuscode | ||||||||||||
| defaultValue |
|
Traits
List of traits for the statusCode attribute are listed below.
is.dataFormat.integer
is.constrainedList.correlated
the values of an attribute are taken from or looked up from a fixed list of possibilities that represent correlated status
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| any |
is.correlatedWith
the attribute value is correlated with the sourceAttribute
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| sourceAttribute | "stateCode" | attributeName |
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 |
| 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 |
| 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 | "statuscode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "26" | integer |
is.dataFormat.integer
statusCode_display
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the statusCode_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 | "statusCode" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
name
Shows the name of the custom entity.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Name |
| description | Shows the name of the custom entity. |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | adx_name |
Traits
List of traits for the name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
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 |
| 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 |
| 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 | "adx_name" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "33" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "100" | integer |
is.dataFormat.character
is.dataFormat.array
isDefault
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Is Default |
| dataFormat | boolean |
| isNullable | true |
| sourceName | adx_isdefault |
Traits
List of traits for the isDefault 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 |
| 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 | "adx_isdefault" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "34" | integer |
is.dataFormat.boolean
rewriteURL
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Rewrite Url |
| dataFormat | string |
| maximumLength | 100 |
| isNullable | true |
| sourceName | adx_rewriteurl |
Traits
List of traits for the rewriteURL attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.reference.URL
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 |
| 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 | "adx_rewriteurl" | 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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "100" | integer |
is.dataFormat.character
is.dataFormat.array
websiteId
Unique identifier for Website associated with Page Template.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Website |
| description | Unique identifier for Website associated with Page Template. |
| dataFormat | guid |
| isNullable | true |
| sourceName | adx_websiteid |
Traits
List of traits for the websiteId 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 | "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 |
| 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 |
| 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 | "adx_websiteid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "37" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
description
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Description |
| dataFormat | string |
| maximumLength | 2000 |
| isNullable | true |
| sourceName | adx_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 | "recommended" | 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 |
| 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 | "adx_description" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "39" | integer |
is.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2000" | integer |
is.dataFormat.character
is.dataFormat.array
entityName
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Entity Name |
| dataFormat | string |
| maximumLength | 250 |
| isNullable | true |
| sourceName | adx_entityname |
Traits
List of traits for the entityName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
means.identity.name
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 |
| 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 | "adx_entityname" | 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.constrained
maximum length or value constraints
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "250" | integer |
is.dataFormat.character
is.dataFormat.array
type
The type of the record.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| displayName | Type | |||||||||
| description | The type of the record. | |||||||||
| dataFormat | int32 | |||||||||
| isNullable | true | |||||||||
| sourceName | adx_type | |||||||||
| valueConstrainedToList | true | |||||||||
| defaultValue |
|
Traits
List of traits for the type attribute are listed below.
is.dataFormat.integer
does.haveDefault
An attribute has a default value
| Parameter | Value | Data type | Explanation | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| default |
| 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 | "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 |
| 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 |
| 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 | "adx_type" | 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.integer
type_display
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the type_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 | "type" | attributeName | output parameter naming the attribute that is being supported |
is.dataFormat.character
is.dataFormat.array
useWebsiteHeaderAndFooter
Control whether this web template page template will be rendered using the website header and footer, or control rendering of all page content.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Use Website Header and Footer |
| description | Control whether this web template page template will be rendered using the website header and footer, or control rendering of all page content. |
| dataFormat | boolean |
| isNullable | true |
| sourceName | adx_usewebsiteheaderandfooter |
Traits
List of traits for the useWebsiteHeaderAndFooter 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 |
| 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 |
| 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 | "adx_usewebsiteheaderandfooter" | 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.dataFormat.boolean
webTemplateId
Unique identifier for Web Template associated with Page Template.
First included in: portals/PageTemplate (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Web Template |
| description | Unique identifier for Web Template associated with Page Template. |
| dataFormat | guid |
| isNullable | true |
| sourceName | adx_webtemplateid |
Traits
List of traits for the webTemplateId 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 |
| 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 |
| 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 | "adx_webtemplateid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| ordinal | "45" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array