2.4.146 BrtBeginPCDHierarchy
The BrtBeginPCDHierarchy record specifies properties of a cache hierarchy (section 2.2.5.2.7) and specifies the beginning of a collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF. The collection of records specifies a cache hierarchy in the PivotCache (section 2.2.5.2).
No more than one of the following fields of this record MUST be 1: fMeasure, fSet, fMeasureHierarchy and fTimeHierarchy.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
C |
D |
E |
F |
G |
H |
I |
J |
K |
L |
M |
N |
cLevels |
|||||||||||||||||
|
... |
isetParent |
||||||||||||||||||||||||||||||
|
... |
iconSet |
||||||||||||||||||||||||||||||
|
... |
O |
P |
Q |
R |
S |
T |
U |
wAttributeMemberValueType |
|||||||||||||||||||||||
|
... |
stUnique (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stCaption (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDimUnq (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDefaultUnq (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stAllUnq (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stAllDisp (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDispFld (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stMeasGrp (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
A - fMeasure (1 bit): A bit that specifies whether this cache hierarchy is a measure (section 2.2.5.2.7.1).
-
If this value is 1, the fMeasure field of at least one of the BrtBeginDim (section 2.4.52) records in the BrtBeginDims collection MUST be equal to 1. If this value is 0, the BrtBeginDim record where the stUnique field case-insensitively matches the stDimUnq field in this record MUST NOT have fMeasure equal to 1.
-
This value MUST be 0 if fUnbalancedRealKnown is 1 and fUnbalancedReal is 1.
-
This value MUST be 0 if fUnbalancedGroupKnown is 1 and fUnbalancedGroup is 1.
-
This value MUST be 0 if fAttributeHierarchy is 1 or fKeyAttributeHierarchy is 1.
-
This value MUST be 0 if fSet, fMeasureHierarchy or fTimeHierarchy is 1.
B - fSet (1 bit): A bit that specifies whether this cache hierarchy is a named set (section 2.2.5.2.7.3). This value MUST be 0 if fUnbalancedRealKnown is 1 and fUnbalancedReal is 1, or if fUnbalancedGroupKnown is 1 and fUnbalancedGroup is 1. This value MUST be 0 if fAttributeHierarchy is 1 or fKeyAttributeHierarchy is 1. This value MUST be 0 if fMeasure, fMeasureHierarchy, or fTimeHierarchy is 1.
C - fAttributeHierarchy (1 bit): A bit that specifies whether this cache hierarchy is an attribute hierarchy.
D - fMeasureHierarchy (1 bit): A bit that specifies whether this cache hierarchy is the measure's OLAP hierarchy. This value MUST be 0 if fMeasure, fSet, or fTimeHierarchy is 1.
E - fOnlyOneField (1 bit): A bit that specifies whether this cache hierarchy is associated with only one cache field (section 2.2.5.2.2). This value MUST be 1 if fMeasure is 1.
F - fTimeHierarchy (1 bit): A bit that specifies whether this cache hierarchy is a time hierarchy. This value MUST be 1 if fAttributeMemberValueTypeKnown is 1 and wAttributeMemberValueType is equal to 0x0007. This value MUST be 0 if fMeasure, fSet or fMeasureHierarchy is 1.
G - fKeyAttributeHierarchy (1 bit): A bit that specifies whether this cache hierarchy is a key attribute hierarchy. This value MUST be 1 if fAttributeMemberValueTypeKnown is 1.
H - fAttributeMemberValueTypeKnown (1 bit): A bit that specifies whether wAttributeMemberValueType contains the data type of an attribute. The possible values for this field are listed in the following table.
-
Value
Meaning
0
The value of the wAttributeMemberValueType field is ignored.
1
The wAttributeMemberValueType field contains the data type of an attribute.
-
I - fUnbalancedRealKnown (1 bit): A bit that specifies whether it is known if this cache hierarchy is an unbalanced OLAP hierarchy when no OLAP grouping (section 2.2.5.2.8) has been applied. The possible values for this field are listed in the following table.
-
Value
Meaning
0
The value of fUnbalancedReal is ignored.
1
fUnbalancedReal specifies whether this cache hierarchy is an unbalanced OLAP hierarchy.
-
J - fUnbalancedReal (1 bit): A bit that specifies whether this cache hierarchy is an unbalanced OLAP hierarchy when no OLAP grouping has been applied. MUST be ignored if fUnbalancedRealKnown is 0.
K - fUnbalancedGroupKnown (1 bit): A bit that specifies whether it is known if this cache hierarchy is an unbalanced OLAP hierarchy when OLAP grouping has been applied to any OLAP members belonging to this PivotCache. The possible values for this field are listed in the following table.
-
Value
Meaning
0
The value of fUnbalancedGroup is ignored.
1
The value of fUnbalancedGroup specifies whether this cache hierarchy is an unbalanced OLAP hierarchy when OLAP members belonging to this PivotCache have been grouped.
-
L - fUnbalancedGroup (1 bit): A bit that specifies whether this cache hierarchy is an unbalanced OLAP hierarchy when OLAP members belonging to this PivotCache have been grouped. This value MUST be ignored if fUnbalancedGroupKnown is 0.
M - fHidden (1 bit): A bit that specifies whether this cache hierarchy is hidden.
N - reserved1 (3 bits): This value MUST be 0, and MUST be ignored.
cLevels (4 bytes): An unsigned integer that specifies the number of OLAP levels associated with the OLAP hierarchy associated with this cache hierarchy.
isetParent (4 bytes): A signed integer that specifies the cache hierarchy that all the OLAP members of this cache hierarchy belong to. This value MUST be ignored if fSet is 0. This value MUST be less than the number of BrtBeginPCDHierarchy records in the BrtBeginPCDHierarchies collection (section 2.4.145). This value MUST be a value from the following table.
-
Value
Meaning
-1
The cache hierarchy that the OLAP members of this cache hierarchy belong to is unknown or does not exist in the PivotCache.
A value greater than or equal to zero
Specifies a cache hierarchy index that specifies the cache hierarchy that all the OLAP members of this cache hierarchy belong to.
iconSet (4 bytes): A KPISets (section 2.5.86) that specifies the icon set to use to visualize a key performance indicator (KPI) trend or status expression. This value MUST NOT be equal to 0xFFFFFFFF.
O - fLoadDimUnq (1 bit): A bit that specifies whether stDimUnq exists.
P - fLoadDefaultUnq (1 bit): A bit that specifies whether stDefaultUnq exists.
Q - fLoadAllUnq (1 bit): A bit that specifies whether stAllUnq exists.
R - fLoadAllDisp (1 bit): A bit that specifies whether stAllDisp exists.
S - fLoadDispFld (1 bit): A bit that specifies whether stDispFld exists.
T - fLoadMeasGrp (1 bit): A bit that specifies whether stMeasGrp exists. This value MUST be 0 if fMeasure is 0.
U - reserved2 (2 bits): This value MUST be 0, and MUST be ignored.
wAttributeMemberValueType (2 bytes): An unsigned integer that specifies the data type of an OLAP dimension attribute returned by the OLAP provider. If the attribute is 0x0007, the attribute is treated as a date attribute; otherwise, it is not treated as a date attribute.
stUnique (variable): An XLWideString (section 2.5.169) that specifies the MDX unique name of this cache hierarchy. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters.
stCaption (variable): An XLWideString that specifies a display name of this cache hierarchy. The length of this value MUST be greater than or equal to zero. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters.
stDimUnq (variable): An optional XLWideString that specifies a unique name of the OLAP dimension to which this cache hierarchy belongs. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters. This value MUST be specified if fSet is 0 and fMeasure is 0 and fHidden is 0. This value MUST match stUnique (using a case-insensitive comparison) in BrtBeginDim record in the BrtBeginDims collection. This value MUST exist if and only if fLoadDimUnq is 1.
stDefaultUnq (variable): An optional XLWideString that specifies the MDX unique name of the default OLAP member of this cache hierarchy. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters. This value MUST exist if and only if fLoadDefaultUnq is 1.
stAllUnq (variable): An optional XLWideString that specifies the unique name of the ALL member of this cache hierarchy. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters. This value MUST exist if and only if fLoadAllUnq is 1.
stAllDisp (variable): An optional XLWideString that specifies the display name of the ALL member of this cache hierarchy. If the bVerCacheCreated field of the BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this value MUST be less than 32768 characters; otherwise, it MUST be less than 256 characters. This value MUST exist if and only if fLoadAllDisp is 1.
stDispFld (variable): An optional XLWideString that specifies the display folder of this cache hierarchy. The length of this value MUST be less than 65,536 characters. This value MUST exist if and only if fLoadDispFld is 1.
stMeasGrp (variable): An optional XLWideString that specifies the name of the measure (section 2.2.5.2.7.1) group to which this cache hierarchy belongs. The length of this value MUST be less than 65,536 characters. This value MUST exist if and only if fLoadMeasGrp is 1.