Dimension in Reference(DimensionAttribute)

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

Traits

Traits for this entity are listed below.

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

Parameter	Value	Data type	Explanation
attribute	DimensionAttribute/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Dimension	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Reference/DimensionAttribute
BackingEntityKeyFieldId		Reference/DimensionAttribute
BackingEntityKeyFieldName		Reference/DimensionAttribute
BackingEntityTableId		Reference/DimensionAttribute
BackingEntityTableName		Reference/DimensionAttribute
BackingEntityType		Reference/DimensionAttribute
BackingEntityValueFieldId		Reference/DimensionAttribute
BackingEntityValueFieldName		Reference/DimensionAttribute
HashKey		Reference/DimensionAttribute
KeyAttribute		Reference/DimensionAttribute
Name		Reference/DimensionAttribute
NameAttribute		Reference/DimensionAttribute
ReportColumnName		Reference/DimensionAttribute
TranslationKeyFieldId		Reference/DimensionAttribute
TranslationKeyFieldName		Reference/DimensionAttribute
TranslationLanguageIdFieldId		Reference/DimensionAttribute
TranslationLanguageIdFieldName		Reference/DimensionAttribute
TranslationNameFieldId		Reference/DimensionAttribute
TranslationNameFieldName		Reference/DimensionAttribute
TranslationTableId		Reference/DimensionAttribute
TranslationTableName		Reference/DimensionAttribute
Type		Reference/DimensionAttribute
UseTranslationNameMethod		Reference/DimensionAttribute
ValueAttribute		Reference/DimensionAttribute
ViewName		Reference/DimensionAttribute
TranslationViewKeyFieldName		Reference/DimensionAttribute
TranslationViewLanguageIdFieldName		Reference/DimensionAttribute
TranslationViewName		Reference/DimensionAttribute
TranslationViewNameFieldName		Reference/DimensionAttribute
TranslationViewSystemLanguageIdFieldName		Reference/DimensionAttribute
TranslationViewTranslatedNameFieldName		Reference/DimensionAttribute
TranslationViewValueFieldName		Reference/DimensionAttribute
TranslationViewId		Reference/DimensionAttribute
TranslationViewKeyFieldId		Reference/DimensionAttribute
TranslationViewLanguageIdFieldId		Reference/DimensionAttribute
TranslationViewNameFieldId		Reference/DimensionAttribute
TranslationViewSystemLanguageIdFieldId		Reference/DimensionAttribute
TranslationViewTranslatedNameFieldId		Reference/DimensionAttribute
TranslationViewValueFieldId		Reference/DimensionAttribute
DimensionKeyColumnName		Reference/DimensionAttribute
DimensionValueColumnName		Reference/DimensionAttribute
CopyValuesOnCreate		Reference/DimensionAttribute
GiveDerivedDimensionsPrecedence		Reference/DimensionAttribute
IsBalancing_PSN		Reference/DimensionAttribute
BalancingDimension_PSN		Reference/DimensionAttribute

RecId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

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

Parameter	Value	Data type	Explanation
attribute	DimensionAttribute/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

BackingEntityKeyFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the BackingEntityKeyFieldId attribute are listed below.

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

is.dataFormat.integer

BackingEntityKeyFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the BackingEntityKeyFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

BackingEntityTableId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the BackingEntityTableId attribute are listed below.

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

is.dataFormat.integer

BackingEntityTableName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the BackingEntityTableName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

BackingEntityType

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the BackingEntityType attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

BackingEntityValueFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the BackingEntityValueFieldId attribute are listed below.

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

is.dataFormat.integer

BackingEntityValueFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the BackingEntityValueFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

HashKey

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	guid
isNullable	true

Traits

List of traits for the HashKey attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.nullable
The attribute value may be set to NULL.

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

KeyAttribute

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Key field
dataFormat	int32

Traits

List of traits for the KeyAttribute attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Key field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Name

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Dimension name
dataFormat	string

Traits

List of traits for the Name attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Dimension name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

NameAttribute

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Name field
dataFormat	int32
isNullable	true

Traits

List of traits for the NameAttribute attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Name field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ReportColumnName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ReportColumnName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationKeyFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation key field
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationKeyFieldId attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation key field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

TranslationKeyFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation key field name
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationKeyFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation key field name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

TranslationLanguageIdFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation language ID field
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationLanguageIdFieldId attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation language ID field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

TranslationLanguageIdFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation language ID field name
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationLanguageIdFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation language ID field name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

TranslationNameFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation name field
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationNameFieldId attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation name field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

TranslationNameFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation name field name
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationNameFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation name field name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

TranslationTableId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation table ID
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationTableId attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation table ID	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

TranslationTableName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Translation table name
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationTableName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Translation table name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Type

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Type attribute are listed below.

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

is.dataFormat.integer

UseTranslationNameMethod

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Use the translation name method
dataFormat	int32
isNullable	true

Traits

List of traits for the UseTranslationNameMethod attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Use the translation name method	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ValueAttribute

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Value field
dataFormat	int32

Traits

List of traits for the ValueAttribute attribute are listed below.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Value field	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ViewName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ViewName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewKeyFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewKeyFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewLanguageIdFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewLanguageIdFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewNameFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewNameFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewSystemLanguageIdFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewSystemLanguageIdFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewTranslatedNameFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewTranslatedNameFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewValueFieldName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TranslationViewValueFieldName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TranslationViewId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewId attribute are listed below.

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

is.dataFormat.integer

TranslationViewKeyFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewKeyFieldId attribute are listed below.

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

is.dataFormat.integer

TranslationViewLanguageIdFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewLanguageIdFieldId attribute are listed below.

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

is.dataFormat.integer

TranslationViewNameFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewNameFieldId attribute are listed below.

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

is.dataFormat.integer

TranslationViewSystemLanguageIdFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewSystemLanguageIdFieldId attribute are listed below.

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

is.dataFormat.integer

TranslationViewTranslatedNameFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewTranslatedNameFieldId attribute are listed below.

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

is.dataFormat.integer

TranslationViewValueFieldId

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the TranslationViewValueFieldId attribute are listed below.

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

is.dataFormat.integer

DimensionKeyColumnName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	The name of the column that contains the specific instance of the backing entity for the dimension attribute value.
dataFormat	string
isNullable	true

Traits

List of traits for the DimensionKeyColumnName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the column that contains the specific instance of the backing entity for the dimension attribute value.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

DimensionValueColumnName

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	The name of the column that contains the value for the dimension attribute value.
dataFormat	string
isNullable	true

Traits

List of traits for the DimensionValueColumnName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The name of the column that contains the value for the dimension attribute value.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

CopyValuesOnCreate

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Copy values on dimension value creation
dataFormat	int32
isNullable	true

Traits

List of traits for the CopyValuesOnCreate attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Copy values on dimension value creation	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

GiveDerivedDimensionsPrecedence

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Replace existing dimension values with derived values
dataFormat	int32
isNullable	true

Traits

List of traits for the GiveDerivedDimensionsPrecedence attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Replace existing dimension values with derived values	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsBalancing_PSN

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Require the dimension to be balanced
dataFormat	int32
isNullable	true

Traits

List of traits for the IsBalancing_PSN attribute are listed below.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Require the dimension to be balanced	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

BalancingDimension_PSN

First included in: Reference/DimensionAttribute (this entity)

Properties

Name	Value
displayName	Require values for the dimension to be balanced with
dataFormat	int64
isNullable	true

Traits

List of traits for the BalancingDimension_PSN attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Require values for the dimension to be balanced with	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big