Configuration in Framework(BIConfiguration)

Article
02/22/2022

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	BIConfiguration/(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	Configuration

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Framework/BIConfiguration
AfterUpdateScript		Framework/BIConfiguration
ConnectionString		Framework/BIConfiguration
CreateCubes		Framework/BIConfiguration
CreateDimensions		Framework/BIConfiguration
CreateRoles		Framework/BIConfiguration
DataSourceName		Framework/BIConfiguration
DataSourceType		Framework/BIConfiguration
EnableCurrencyConversion		Framework/BIConfiguration
EnableLogging		Framework/BIConfiguration
LogFilePath		Framework/BIConfiguration
OpenGeneratedProject		Framework/BIConfiguration
OpenUpdatedProject		Framework/BIConfiguration
OverwriteTranslations		Framework/BIConfiguration
PerformTranslation		Framework/BIConfiguration
ProjectFilename		Framework/BIConfiguration
ProjectName		Framework/BIConfiguration
ProjectPath		Framework/BIConfiguration
UpdateCubes		Framework/BIConfiguration
UpdateDateDimensions		Framework/BIConfiguration
UpdateDimensions		Framework/BIConfiguration
UpdateDimensionUsage		Framework/BIConfiguration
UpdateFrameworkDimensionUsage		Framework/BIConfiguration
UpdateHierarchies		Framework/BIConfiguration
UpdateMeasureGroups		Framework/BIConfiguration
CalendarHelperPlugin		Framework/BIConfiguration
UpdatingBIMeasurementJobs		Framework/BIConfiguration
RecordsPerBlock		Framework/BIConfiguration
MaxBlobsInParallel		Framework/BIConfiguration
MaxBlocksInParallel		Framework/BIConfiguration
MaxBlocksInAzureBlob		Framework/BIConfiguration
FullRefreshRecurrence		Framework/BIConfiguration
IncrementalRefreshRecurrence		Framework/BIConfiguration
DisableModelRelationship		Framework/BIConfiguration

RecId

First included in: Framework/BIConfiguration (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	BIConfiguration/(resolvedAttributes)/RecId	attribute

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

AfterUpdateScript

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	After update script
dataFormat	string
isNullable	true

Traits

List of traits for the AfterUpdateScript 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	After update script

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ConnectionString

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ConnectionString 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

CreateCubes

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Create cubes
dataFormat	int32
isNullable	true

Traits

List of traits for the CreateCubes 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	Create cubes

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CreateDimensions

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Create dimensions
dataFormat	int32
isNullable	true

Traits

List of traits for the CreateDimensions 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	Create dimensions

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CreateRoles

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Create roles
dataFormat	int32
isNullable	true

Traits

List of traits for the CreateRoles 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	Create roles

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataSourceName

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DataSourceName 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

DataSourceType

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DataSourceType attribute are listed below.

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

is.dataFormat.integer

EnableCurrencyConversion

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Enable currency conversion
dataFormat	int32
isNullable	true

Traits

List of traits for the EnableCurrencyConversion 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	Enable currency conversion

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

EnableLogging

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Enable logging
dataFormat	int32
isNullable	true

Traits

List of traits for the EnableLogging 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	Enable logging

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

LogFilePath

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Log file
dataFormat	string
isNullable	true

Traits

List of traits for the LogFilePath 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	Log file

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

OpenGeneratedProject

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Open generated project
dataFormat	int32
isNullable	true

Traits

List of traits for the OpenGeneratedProject 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	Open generated project

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

OpenUpdatedProject

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Open updated project
dataFormat	int32
isNullable	true

Traits

List of traits for the OpenUpdatedProject 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	Open updated project

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

OverwriteTranslations

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Overwrite existing translations
dataFormat	int32
isNullable	true

Traits

List of traits for the OverwriteTranslations 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	Overwrite existing translations

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PerformTranslation

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Perform translation
dataFormat	int32
isNullable	true

Traits

List of traits for the PerformTranslation 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	Perform translation

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ProjectFilename

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Project file:
dataFormat	string
isNullable	true

Traits

List of traits for the ProjectFilename 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	Project file:

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ProjectName

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProjectName 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

ProjectPath

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProjectPath 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

UpdateCubes

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update cubes
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateCubes 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	Update cubes

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateDateDimensions

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update date dimensions
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateDateDimensions 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	Update date dimensions

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateDimensions

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update dimensions
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateDimensions 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	Update dimensions

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateDimensionUsage

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update dimension usage
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateDimensionUsage 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	Update dimension usage

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateFrameworkDimensionUsage

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Oracle connection type
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateFrameworkDimensionUsage 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	Oracle connection type

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateHierarchies

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update hierarchies
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateHierarchies 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	Update hierarchies

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

UpdateMeasureGroups

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
displayName	Update measure groups
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdateMeasureGroups 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	Update measure groups

entity

a reference to the constant entity holding the list of localized text

is.dataFormat.integer

CalendarHelperPlugin

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CalendarHelperPlugin 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

UpdatingBIMeasurementJobs

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the UpdatingBIMeasurementJobs attribute are listed below.

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

is.dataFormat.integer

RecordsPerBlock

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the RecordsPerBlock attribute are listed below.

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

is.dataFormat.integer

MaxBlobsInParallel

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MaxBlobsInParallel attribute are listed below.

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

is.dataFormat.integer

MaxBlocksInParallel

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MaxBlocksInParallel attribute are listed below.

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

is.dataFormat.integer

MaxBlocksInAzureBlob

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MaxBlocksInAzureBlob attribute are listed below.

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

is.dataFormat.integer

FullRefreshRecurrence

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the FullRefreshRecurrence attribute are listed below.

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

is.dataFormat.integer

IncrementalRefreshRecurrence

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IncrementalRefreshRecurrence attribute are listed below.

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

is.dataFormat.integer

DisableModelRelationship

First included in: Framework/BIConfiguration (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the DisableModelRelationship attribute are listed below.

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

is.dataFormat.integer

Share via

Configuration in Framework(BIConfiguration)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Feedback

Additional resources