2.4.283 SXFDB

The SXFDB record specifies properties for a cache field within a PivotCache.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

ifdbParent

ifdbBase

citmUnq

csxoper

cisxoper

catm

stFieldName (variable)

...

A - fAllAtoms (1 bit): A bit that specifies whether this cache field has a collection of cache items. If fSomeUnhashed is equal to 1, this value MUST be equal to 0.

B - fSomeUnhashed (1 bit): Undefined, and MUST be ignored. If the fAllAtoms field is equal to 1, MUST be equal to 0.

C - fUsed (1 bit): Undefined, and MUST be ignored.

D - fHasParent (1 bit):  A bit that specifies whether ifdbParent specifies a reference to a parent grouping cache field. For more information, see Grouping. If the fCalculatedField field is equal to 1, then this field MUST be equal to 0.

E - fRangeGroup (1 bit):  A bit that specifies whether this cache field is grouped by using numeric grouping or date grouping, as specified by Grouping. If this field is equal to 1, then this record MUST be followed by a sequence of SXString records, as specified by the GRPSXOPER rule. The quantity of SXString records is specified by csxoper. If this field is equal to 1, then this record MUST be followed by a sequence of records that conforms to the SXRANGE rule that specifies the grouping properties for the ranges of values.

F - fNumField (1 bit): A bit that specifies whether the cache items in this cache field contain at least one numeric cache item, as specified by SXNum. If fDateInField is equal to 1, this field MUST be equal to 0.

G - unused1 (1 bit): Undefined and MUST be ignored.

H - fTextEtcField (1 bit):  A bit that specifies whether the cache items contain text data. If fNumField is 1, this field MUST be ignored.

I - fnumMinMaxValid (1 bit):  A bit that specifies whether a valid minimum or maximum value can be computed for the cache field. MUST be equal to 1 if fDateInField or fNumField is equal to 1.

J - fShortIitms (1 bit): A bit that specifies whether there are more than 255 cache items in this cache field. If catm is greater than 255, this value MUST be equal to 1; otherwise it MUST be 0.

K - fNonDates (1 bit):  A bit that specifies whether the cache items in this cache field contain values that are not time or date values. If this cache field is a grouping cache field, as specified by Grouping, then this field MUST be ignored. Otherwise, if fDateInField is equal to 1, then this field MUST be 0.

L - fDateInField (1 bit):  A bit that specifies whether the cache items in this cache field contain at least one time or date cache item, as specified by SXDtr. If fNonDates is equal to 1, then this field MUST be equal to 0.

M - unused2 (1 bit): Undefined and MUST be ignored.

N - fServerBased (1 bit):  A bit that specifies whether this cache field is a server-based page field when the corresponding pivot field is on the page axis of the PivotTable view, as specified in source data.

This value applies only to an ODBC PivotCache. MUST NOT be equal to 1 if fCantGetUniqueItems is equal to 1. If fCantGetUniqueItems is equal to 1, then the ODBC connection cannot provide a list of unique items for the cache field.

MUST be 0 for a cache field in a non-ODBC PivotCache.

O - fCantGetUniqueItems (1 bit): A bit that specifies whether a list of unique values for the cache field was not available while refreshing the source data. This field applies only to a PivotCache that uses ODBC source data and is intended to be used in conjunction with optimization features. For example, the application can optimize memory usage when populating PivotCache records if it has a list of unique values for a cache field before all the records are retrieved from the ODBC connection. Or, the application can determine the appropriate setting of fServerBased based on this value.

MUST be 0 for fields in a non-ODBC PivotCache.

P - fCalculatedField (1 bit): A bit that specifies whether this field is a calculated field. The formula (section 2.2.2) of the calculated field is stored in a directly following SXFormula record. If fHasParent is equal to 1, this field MUST be equal to 0.

ifdbParent (2 bytes): An unsigned integer that specifies the cache field index, as specified by Cache Fields, of the grouping cache field for this cache field. MUST be greater than or equal to 0x0000 and less than the cfdbTot field of the SXDB record of this PivotCache. If fHasParent is equal to 0, then this field MUST be ignored. If fHasParent is equal to 1, and fRangeGroup is equal to 1, and the iByType field of the SXRng record of this cache field is greater than 0, then the fRangeGroup of the SXFDB record of the cache field specified by ifdbParent MUST be 1 and the iByType field of the SXRng record of the cache field specified by ifdbParent MUST be greater than the iByType field of the SXRng record of this cache field.

ifdbBase (2 bytes): An unsigned integer that specifies the cache field index, as specified by Cache Fields, of the base cache field, as specified by Grouping, for the cache field specified by this record. MUST be greater than or equal to 0x0000 and less than the value of the  cfdbdb field of the SXDB record of this PivotCache. If the cache field specified by this record is not a grouping cache field, then this field MUST be ignored.

citmUnq (2 bytes):  Undefined and MUST be ignored.

csxoper (2 bytes):  An unsigned integer that specifies the number of cache items in this cache field when this cache field is a grouping cache field, as specified by Grouping. There MUST be an equivalent number of sequences of records that conform to the GRPSXOPER rule following this record that specify the cache items.  If the fRangeGroup field and the fCalculatedField field are equal to 0 and this cache field corresponds to a source data entity, this field MUST be equal to 0. If the fRangeGroup field is equal to 1, this value MUST be greater than or equal to 1.

cisxoper (2 bytes): An unsigned integer that specifies the number of cache items in the base cache field that are grouped by this cache field. There MUST be an equivalent number of SxIsxoper records following this record that specify which cache item in this cache field groups each of the cache items in the base cache field.  For more information, see Grouping.

catm (2 bytes):  An unsigned integer that specifies the number of cache items in the collection sequences of records that conform to the SRCSXOPER rule in this cache field. If fAllAtoms is 0, then this field MUST be equal to 0x0000. If this cache field corresponds to source data entities then there MUST be an equal number of SRCSXOPER rules in this cache field.

stFieldName (variable): An XLUnicodeString structure that specifies the name of the cache field. MUST be less than or equal to 255 characters long.