2.4.148 BrtBeginPCDKPI
The BrtBeginPCDKPI record specifies an OLAP key performance indicator (KPI) and the beginning of an empty collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
A |
B |
C |
D |
E |
F |
G |
H |
stUnique (variable) |
|||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stCaption (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stDispFolder (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stMeasGrp (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stParent (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stValue (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stGoal (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stStatus (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stTrend (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stWeight (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stCurTimeMbr (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
A - fLoadDispFld (1 bit): A bit that specifies whether stDispFolder exists after the fixed-size portion of the record.
B - fLoadMeasGrp (1 bit): A bit that specifies whether stMeasGrp exists after the fixed-size portion of the record.
C - fLoadParent (1 bit): A bit that specifies whether stParent exists after the fixed-size portion of the record.
D - fLoadGoal (1 bit): A bit that specifies whether stGoal exists after the fixed-size portion of the record.
E - fLoadStatus (1 bit): A bit that specifies whether stStatus is saved after the fixed-size portion of the record.
F - fLoadTrend (1 bit): A bit that specifies whether stTrend exists after the fixed-size portion of the record.
G - fLoadWeight (1 bit): A bit that specifies whether stWeight exists after the fixed-size portion of the record.
H - fLoadCurTimeMbr (1 bit): A bit that specifies whether stCurTimeMbr exists after the fixed-size portion of the record.
stUnique (variable): An XLWideString (section 2.5.169) that specifies the MDX unique name of this KPI. The length of this string MUST be greater than zero. If the bVerCacheCreated of the preceding BrtBeginPivotCacheDef (section 2.4.168) record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, it MUST be less than 256 characters.
stCaption (variable): An XLWideString that specifies the display name of this KPI. The length of this string MUST be greater than zero and MUST be less than 32,768 characters.
stDispFolder (variable): An optional XLWideString that specifies the display folder of this KPI. The length of this string 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 group to which this KPI belongs. The length of this string MUST be less than 65,536 characters. This value MUST exist if and only if fLoadMeasGrp is 1.
stParent (variable): An optional XLWideString that specifies the MDX unique name of the parent KPI for this KPI. If not empty, MUST match the stUnique field in the BrtBeginPCDKPI record that specifies the parent KPI. The length of this string MUST be less than 65,536 characters. This value MUST exist if and only if fLoadParent is 1.
stValue (variable): An XLWideString that specifies the MDX unique name of the measure (section 2.2.5.2.7.1) used for the value component of this KPI. The length of this string MUST be greater than zero. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters.
-
This value MUST be equal to the stUnique value of one of the BrtBeginPCDHierarchy (section 2.4.146) records in the BrtBeginPCDHierarchies collection (section 2.4.145) following the BrtBeginPivotCacheDef record preceding this record. The matching BrtBeginPCDHierarchy record MUST have fMeasure equal to 1.
stGoal (variable): An optional XLWideString that specifies MDX unique name of the measure used for the goal component of this KPI. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters.
-
This value MUST be equal to the stUnique value of one of the BrtBeginPCDHierarchy records in the BrtBeginPCDHierarchies collection following the BrtBeginPivotCacheDef record preceding this record. The matching BrtBeginPCDHierarchy record MUST have fMeasure equal to 1. This value MUST exist if and only if fLoadGoal is 1.
stStatus (variable): An optional XLWideString that specifies the MDX unique name of the measure used for the status component of this KPI. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters.
-
MUST be equal to the stUnique value of one of the BrtBeginPCDHierarchy records in the BrtBeginPCDHierarchies collection following the BrtBeginPivotCacheDef record preceding this record. The matching BrtBeginPCDHierarchy record MUST have fMeasure equal to 1. This value MUST exist if and only if fLoadStatus is 1.
stTrend (variable): An optional XLWideString that specifies the MDX unique name of the measure used for the trend component of this KPI. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters.
-
This value MUST be equal to the stUnique value of one of the BrtBeginPCDHierarchy records in the BrtBeginPCDHierarchies collection following the BrtBeginPivotCacheDef record preceding this record. The matching BrtBeginPCDHierarchy record MUST have fMeasure equal to 1. This value MUST exist if and only if fLoadTrend is 1.
stWeight (variable): An optional XLWideString that specifies the MDX expression used for the weight component of this KPI. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters. This value MUST exist if and only if fLoadWeight is 1.<16>
stCurTimeMbr (variable): An optional XLWideString that specifies the MDX unique name of the current time member for this KPI. If the bVerCacheCreated field of the preceding BrtBeginPivotCacheDef record is greater than or equal to 3, then the length of this string MUST be less than 32,768 characters; otherwise, the length of this string MUST be less than 256 characters. This value MUST exist if and only if fLoadCurTimeMbr is 1.<17>