Applications.DataWarehouse.DataMeasures Entity

Namespace: Applications.DataWarehouse

Contains the data measures of the General data warehouse. Entity: Dw_Data_Measures (Introduced in version 18.2)

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Applications.DataWarehouse.DataMeasures

Attributes

Name	Type	Description
Code	string (16)	Unique measure code. `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
GreenZoneSpreadPercent	decimal (3, 2)	The plus or minus percent, by which the goal can be missed, but still considered achieved. `Required` `Default(0.2)` `Filter(eq)`
HorizontalTrend SpreadPercent	decimal (3, 2)	The change in percents, which is considered neutral. Higher positive/negative changes are considered positive/negative trends. `Required` `Default(0.01)` `Filter(eq)`
Id	guid
Name	string (254)	The name of the measure (multilanguage). `Required` `Filter(eq;like)`
Notes	string (max) nullable	Notes for this DataMeasure.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Period	Period	The period for which the data is collected. D=Day, M=Month, Q=Quarter, Y=Year. `Required` `Default("Q")` `Filter(eq)`

References

Name	Type	Description
DataMeasureGroup	DataMeasureGroups	The group to which this measure belongs. `Required` `Filter(multi eq)`

Attribute Details

Code

Unique measure code. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

GreenZoneSpreadPercent

The plus or minus percent, by which the goal can be missed, but still considered achieved. Required Default(0.2) Filter(eq)

Type: decimal (3, 2)
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: 0.2
Show in UI: ShownByDefault

HorizontalTrendSpreadPercent

The change in percents, which is considered neutral. Higher positive/negative changes are considered positive/negative trends. Required Default(0.01) Filter(eq)

Type: decimal (3, 2)
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: 0.01
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

The name of the measure (multilanguage). Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Notes

Notes for this DataMeasure.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Period

The period for which the data is collected. D=Day, M=Month, Q=Quarter, Y=Year. Required Default("Q") Filter(eq)

Type: Period
Category: System
Allowed values for the Period(Applications.DataWarehouse.DataMeasures.md#period) data attribute
Allowed Values (Applications.DataWarehouse.DataMeasuresRepository.Period Enum Members)

Value	Description
Day	Day value. Stored as 'D'. Database Value: 'D' Model Value: 0 Domain API Value: 'Day'
Month	Month value. Stored as 'M'. Database Value: 'M' Model Value: 1 Domain API Value: 'Month'
Quarter	Quarter value. Stored as 'Q'. Database Value: 'Q' Model Value: 2 Domain API Value: 'Quarter'
Year	Year value. Stored as 'Y'. Database Value: 'Y' Model Value: 3 Domain API Value: 'Year'

Supported Filters: Equals
Supports Order By: False
Default Value: Quarter
Show in UI: ShownByDefault

Reference Details

DataMeasureGroup

The group to which this measure belongs. Required Filter(multi eq)

Type: DataMeasureGroups
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST