FRAMES | NO FRAMES
SummarizationInfo Type

Properties of a summarization variable.

Availability: Business Analyst Server.

class SummarizationInfo

Property Description
Alias Variable alias name. Type String.
AvgBase (optional) Field name for the denominator that is used to help calculate the average value of this variable for the total value. The AvgBase and Percentage properties are mutually exclusive. Type String. Available with Business Analyst Server 10.0 SP1.
Category Variable category. Type String.
Decimals The number of decimal places after the decimal point for this variable. Type Int32. Available with Business Analyst Server 10.0 SP1.
Groups (optional) Collection of groups this variable belongs to. Type String[]. Available with Business Analyst Server 10.0 SP3.
IndexBase Value of this variable for the whole country for the year. If the AvgBase or Percentage property specifies a denominator variable, the IndexBase property specifies a ratio of this variable with respect to the denominator variable for the whole country for the year. Zero value means missing value. Type Double. Available with Business Analyst Server 10.0 SP1.
Keywords (optional) Keywords associated with the variable. Type String[]. Available with Business Analyst Server 10.0 SP2.
LongDescription Variable long description. Type String.
Name Variable name. Type String.
Percentage (optional) Field name for the denominator that is used to help calculate the percentage for this variable. The AvgBase and Percentage properties are mutually exclusive. Type String. Available with Business Analyst Server 10.0 SP1.
Units Variable units. Available units are "count" (variable without units), "pct" (variable with percentage units), "currency" (variable with currency units), and "other" (nonnumeric variable). Type String. Available with Business Analyst Server 10.0 SP1.
Vintage (optional) The year or the range of years the variable belongs to. Type String. Available with Business Analyst Server 10.0 SP3.

See Also