This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

The callback functions provide access to the cross tabulation data cube data structure.

The data cube is an n-dimensional array (cube) that holds counts for each cell in the cross tabulation request. The data cube structure differs from the structure presented to the SuperSTAR end user in SuperCROSS.

The following diagram shows a table in SuperCROSS with three fields (two fields in the row and one in the column):

When represented by a data cube, each field is represented in its own unique dimension that can be referenced by an integer value:

Dimension Functions

GetDimensionCountT()

Retrieve the number of dimensions in the data cube.

The type of a dimension can either be summation or classification.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionCountT(PreJobInfoT *JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionCountT(JobInfoT *JobInfo) 
Arguments
JobInfoInputInformation about the current job.
ReturnsThe number of dimensions in the cube.

GetDimensionTypeT()

Retrieve the dimension type.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionTypeT(PreJobInfoT *JobInfo, int Dimension) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionTypeT(JobInfoT *JobInfo, int Dimension) 
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
Returns
DIM_TYPE_INVALIDThe dimension index is invalid.
DIM_TYPE_CROSS_TABThe dimension is a cross tabulation.
DIM_TYPE_SUMMATIONThe dimension is a summation.

Field Functions

GetDimensionFieldCountT()

Retrieve the number of fields for the specified dimension.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldCountT(PreJobInfoT *JobInfo, int Dimension) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldCountT(JobInfoT *JobInfo, int Dimension) 
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index to return the fields for.
Returns
1There is one field on the dimension.
1+There are concatenated fields on the dimension.
0The dimension index is invalid.

GetDimensionFieldIdentifierT()

Return the ID of a field within the specified dimension.

The ID is derived from the name of the column in the source database that this field is associated with. For SXV4 databases, field IDs are only useful internally within SuperSTAR and are generated when the SXV4 is built in SuperCHANNEL.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldIdentifierT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldIdentifierT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the field ID for.
ReturnsThe field ID or NULL if the dimension index or field offset are invalid.

GetDimensionFieldLabelT()

Return the label of a field within the specified dimension.

The label is the "display name" shown to end users in the clients (e.g. "Gender"/"Area").

If the field has been recoded then this function returns the renamed/recoded label (use GetDimensionBaseFieldLabelT to retrieve the original label).

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldLabelT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldLabelT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the label for.
ReturnsThe field label or NULL if the dimension index or field offset are invalid.

GetDimensionFieldBaseIdentifierT()

Return the ID of a field within the specified dimension.

The ID is derived from the name of the column in the source database that this field is associated with. For SXV4 databases, field IDs are only useful internally within SuperSTAR and are generated when the SXV4 is built in SuperCHANNEL.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldBaseIdentifierT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldBaseIdentifierT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the field ID for.
ReturnsThe field ID or NULL if the dimension index or field offset are invalid.

GetDimensionFieldBaseLabelT()

Return the label of a field within the specified dimension.

The label is the "display name" shown to end users in the clients (e.g. "Gender"/"Area").

This function always returns the original label for this field that was set when the SXV4 was generated in SuperCHANNEL, even if the field has subsequently been recoded.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldBaseLabelT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldBaseLabelT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the label for.
ReturnsThe field label or NULL if the dimension index or field offset are invalid.

GetDimensionFieldTypeT()

Return the type of a field.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldTypeT(PreJobInfoT* JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldTypeT(JobInfoT* JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the type of.
Returns

The field type.

If the return type is NATIVE_SUM then you can use GetDimensionStatisticalFieldTypeT to find its statistical function.

IsDimensionFieldVisibleT()

Return the visibility of a given field within a dimension, in regards to the end user (i.e., can the end user see the field?)

Fields added by SuperSERVER, for example summation options added via PreJob AppendSummation methods, will be invisible. Fields requested by the end user are visible.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDimensionFieldIdentifierT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the visibility for.
Returns
1Visible
0Invisible

Field Item Functions

Each dimension contains a number of DimensionFieldItems. For example, the Area field has field items called New South Wales, Victoria etc.

GetDimensionFieldItemCountT()

Return the number of field items in a given dimension for a given field.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldItemCountT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldItemCountT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the item count for.
ReturnsThe field item count or -1 if the dimension index or field offset are invalid.

GetDimensionFieldItemContributorsT()

Return the classification values that are related to a field item.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldItemContributorsT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const SourceValueInfoT** Values, int* IndexLen) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldItemContributorsT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const SourceValueInfoT** Values, int* IndexLen)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the label for.
WhichItemInputThe item index within the dimension field.
ValuesOutput

The array of returned values.

IndexLenOutput

The size of the returned array.

If the operation is successful, but the result set is empty, then IndexLen will be set to zero and Values will be NULL.

Returns
1Success.
0Failed.

GetDimensionFieldItemIdentifierT()

Return the ID of a field item.

Each DimensionFieldItem has an ID and a label (display name). For example, for the dimension containing the Gender field:

  • GetDimensionFieldItemIdentifierT will return codes such as M and F.
  • GetDimensionFieldItemLabelT will return labels such as Male and Female.
Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldItemIdentifierT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldItemIdentifierT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the ID for.
WhichItemInputThe item index to return the ID for.
ReturnsThe field ID or NULL if the dimension index, field offset, or item index are invalid.

GetDimensionFieldItemLabelT()

Return the label (display name) of a field item.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldItemLabelT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldItemLabelT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the label for.
WhichItemInputThe item index to return the label for.
ReturnsThe field label or NULL if the dimension index, field offset, or item index are invalid.

GetDimensionFieldItemTypeT()

Return the type of a field item.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldItemTypeT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldItemTypeT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to return the type of.
WhichItemInputThe item index to return the type of.
Returns

One of the following item types:

CAT_TYPE_INVALID

-1

An invalid dimension index or dimension item index was supplied.

CAT_TYPE_PLAIN

0

Item represents a normal classification field.

CAT_TYPE_HIERARCHY

1

Item represents an hierarchic classification field.

CAT_TYPE_GRAND_TOTAL

2

Item represents a recode total that contains all classification values within the field.

CAT_TYPE_SUB_TOTAL

3

Item represents a recode total that contains a strict subset of classifications values within the field.

CAT_TYPE_OVERLAPPED

4

Place holder (not currently supported).

Overlapped totals can occur in hierarchical fields whose definition is a directed acyclic graphs (DAG) rather than a tree. In a DAG the same leaf item may be counted multiple times depending on which higher level nodes in the hierarchy are present in the recode.

CAT_TYPE_STORED_TOTAL

5

Item represents a stored total computed by the server and stored in an SXV4 cube.

Totals and Field Types

AreAllCubeTotalsAdditiveT()

For the item type CAT_TYPE_GRAND_TOTAL, the totals may be additive or non-additive. This function provides a way to identify whether the totals are additive or non-additive.

Available To
PrepareJob
PerformJob
CleanUpJob
AreAllCubeTotalsAdditiveT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns
1The totals are additive.
0One or more cube totals are not additive.

DoesFieldItemContainUnclassifiedValuesT()

Determine whether the field Item contains unclassifiable data.

Unclassifiable data may be caused by null input values when data is channelled in to a SuperSTAR database, or by classification User Defined Fields that are based on the results of illegal mathematical operations such as division by zero.

Unclassified data may be grouped with other underlying field items. In this situation, the Grouped output variable will be set to true. Your application can then use the function GetDimensionFieldItemContributorsT to determine which items have been grouped.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

DoesFieldItemContainUnclassifiedValuesT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, int* Grouped)

PrepareJob, PerformJob or CleanUpJob:

DoesFieldItemContainUnclassifiedValuesT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, int* Grouped)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
WhichItemInputThe item index to query.
GroupedOutputWill be set to 1 if the field item contains an unclassifiable data field item.
Returns
1The item contains unclassified values.
0The item does not contain unclassified values.

GetDimensionStatisticalFieldTypeT()

Retrieve the type of a statistical field. This function does not take a WhichItem argument because summation fields can only have 1 item.

For a string representation of a summation field use GetDimensionFieldLabel to get the base summation option and GetDimensionFieldItemIdentifier to get the statistical function used.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDimensionStatisticalFieldTypeT(JobInfoT* JobInfo,int Dimension, int FieldOffset) 
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
Returns

One of the following item types:

STATISTIC_FIELD_NOT_SUMMATION-2The dimension and field index refer to a non-summation field.
STATISTIC_FIELD_INVALID-1The dimension and field Index do not refer to a valid dimension field.
STATISTIC_FIELD_SUM0The total of all the values. This is the default statistical operation on summation fields.
STATISTIC_FIELD_VARIANCE1How spread out a distribution is. The variance is defined as the average squared deviation of each number from its mean.
STATISTIC_FIELD_COUNT_DISTINCT2A count of the number of distinct results.
STATISTIC_FIELD_RKEYXOR3The record key (used to implement perturbation algorithms).
STATISTIC_FIELD_MEAN4The sum of all the values divided by the number of values.
STATISTIC_FIELD_STANDDEV5How spread out a distribution is. This is defined as the square root of the variance.
STATISTIC_FIELD_STANDSEM6The standard error of the mean (SEM). This is the standard deviation of the sample divided by the square root of the sample size.
STATISTIC_FIELD_FIRST_QUARTILE7The value that separates the lowest 25% of values from the rest of the population.
STATISTIC_FIELD_MEDIAN8The middle of a distribution; the median cuts the data set in half.
STATISTIC_FIELD_LAST_QUARTILE9The value that separates the highest 25% of values from the rest of the population.
STATISTIC_FIELD_FIRST_DECILE10The value that separates the lowest 10% of values from the rest of the population.
STATISTIC_FIELD_SECOND_DECILE11The value that separates the lowest 20% of values from the rest of the population.
STATISTIC_FIELD_THIRD_DECILE12The value that separates the lowest 30% of values from the rest of the population.
STATISTIC_FIELD_FOURTH_DECILE13

The value that separates the lowest 40% of values from the rest of the population.

There is no specific item type for the 5th decile because it is the same as the median.
STATISTIC_FIELD_SIXTH_DECILE14The value that separates the lowest 60% of values from the rest of the population.
STATISTIC_FIELD_SEVENTH_DECILE15The value that separates the lowest 70% of values from the rest of the population.
STATISTIC_FIELD_EIGHTH_DECILE16The value that separates the lowest 80% of values from the rest of the population.
STATISTIC_FIELD_LAST_DECILE17The value that separates the lowest 90% of values from the rest of the population.
STATISTIC_FIELD_GINI18A measure of inequality of a distribution.
STATISTIC_FIELD_LARGE_N19The maximum and next 3 largest values from contributing unit records.
STATISTIC_FIELD_SMALL_N20The minimum and next 3 smallest values from contributing unit records.
STATISTIC_FIELD_ASSOCIATED_SUM21An associated sum.

GetDimensionStatisticFunctionTypeT()

Retrieve the type of a statistical function being applied to a summation field.

Available To
PreJob
GetDimensionStatisticFunctionTypeT(PreJobInfoT* JobInfo,int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
Returns

One of the following item types:

STATISTIC_FIELD_NOT_SUMMATION-2The dimension and field index refer to a non-summation field.
STATISTIC_FIELD_INVALID-1The dimension and field Index do not refer to a valid dimension field.
STATISTIC_FIELD_SUM0The total of all the values. This is the default statistical operation on summation fields.
STATISTIC_FIELD_VARIANCE1How spread out a distribution is. The variance is defined as the average squared deviation of each number from its mean.
STATISTIC_FIELD_COUNT_DISTINCT2A count of the number of distinct results.
STATISTIC_FIELD_RKEYXOR3The record key (used to implement perturbation algorithms).
STATISTIC_FIELD_MEAN4The sum of all the values divided by the number of values.
STATISTIC_FIELD_STANDDEV5How spread out a distribution is. This is defined as the square root of the variance.
STATISTIC_FIELD_STANDSEM6The standard error of the mean (SEM). This is the standard deviation of the sample divided by the square root of the sample size.
STATISTIC_FIELD_FIRST_QUARTILE7The value that separates the lowest 25% of values from the rest of the population.
STATISTIC_FIELD_MEDIAN8The middle of a distribution; the median cuts the data set in half.
STATISTIC_FIELD_LAST_QUARTILE9The value that separates the highest 25% of values from the rest of the population.
STATISTIC_FIELD_FIRST_DECILE10The value that separates the lowest 10% of values from the rest of the population.
STATISTIC_FIELD_SECOND_DECILE11The value that separates the lowest 20% of values from the rest of the population.
STATISTIC_FIELD_THIRD_DECILE12The value that separates the lowest 30% of values from the rest of the population.
STATISTIC_FIELD_FOURTH_DECILE13

The value that separates the lowest 40% of values from the rest of the population.

There is no specific item type for the 5th decile because it is the same as the median.
STATISTIC_FIELD_SIXTH_DECILE14The value that separates the lowest 60% of values from the rest of the population.
STATISTIC_FIELD_SEVENTH_DECILE15The value that separates the lowest 70% of values from the rest of the population.
STATISTIC_FIELD_EIGHTH_DECILE16The value that separates the lowest 80% of values from the rest of the population.
STATISTIC_FIELD_LAST_DECILE17The value that separates the lowest 90% of values from the rest of the population.
STATISTIC_FIELD_GINI18A measure of inequality of a distribution.
STATISTIC_FIELD_LARGE_N19The maximum and next 3 largest values from contributing unit records.
STATISTIC_FIELD_SMALL_N20The minimum and next 3 smallest values from contributing unit records.
STATISTIC_FIELD_ASSOCIATED_SUM21An associated sum.

GetDimensionFieldTotalsT()

Retrieve the indexes of the totals within a dimension.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldTotalsT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, const int** Values, int *IndexCount) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldTotalsT(JobInfoT *JobInfo, int Dimension, int FieldOffset, const int** Values, int *IndexCount) 
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
ValuesOutput

An array of dimension item indexes within the dimension that are totals (i.e., have the type 1, 2, 3 or 4).

This will be NULL if there are no totals in the dimension.

IndexCountOutput

The number of field item indexes returned by the function call. This will contain -1 if an invalid dimension index or an invalid dimension item index were specified.

Returns
1Success.
0Failed.

GetDimensionFieldTotalItemsT()

Retrieve the indexes of the items that make up a field total item.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldTotalItemsT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const int** Values, int *IndexCount) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldTotalItemsT(JobInfoT *JobInfo, int Dimension, int FieldOffset, int WhichItem, const int** Values, int *IndexCount) 
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
ValuesOutput

An array of dimension item indexes within the dimension that are part of the total.

This will be NULL if the dimension item is not a total.

IndexCountOutput

The number of dimension item indexes returned by the function call. This will contain -1 if an invalid dimension index or an invalid dimension item index were specified.

Returns
1Success.
0Failed.

Default Summation

GetDefaultSummationIdentifierT()

Retrieve the ID of the default summation that is used when no summation is explicitly added to a table.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDefaultSummationIdentifierT(PreJobInfoT *JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetDefaultSummationIdentifierT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The default summation ID or NULL on failure.

GetDefaultSummationFieldTypeT()

Retrieve the field type of the default summation that is used when no summation is explicitly added to a table.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDefaultSummationFieldTypeT(PreJobInfoT* JobInfo)

PrepareJob, PerformJob or CleanUpJob:

GetDefaultSummationFieldTypeT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The default summation field type or NULL on failure.

GetDefaultSummationTableIdentifierT()

Retrieve the table ID of the table the default summation belongs to.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDefaultSummationTableIdentifierT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The table ID or NULL on failure.

GetDefaultSummationLabelT()

Retrieve the label of the default summation that is used when no summation is explicitly added to a table.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDefaultSummationLabelT(PreJobInfoT *JobInfo)  

PrepareJob, PerformJob or CleanUpJob:

GetDefaultSummationLabelT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The default summation label or NULL on failure.

GetDefaultSummationTableLabelT()

Retrieve the label of the table the default summation belongs to.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDefaultSummationTableLabelT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The table label or NULL on failure.

GetDimensionFieldFactTableIdentifierT()

Retrieve the ID of the table a field belongs to.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetDimensionFieldFactTableIdentifierT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset) 

PrepareJob, PerformJob or CleanUpJob:

GetDimensionFieldFactTableIdentifierT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
Returns

The table ID or NULL on failure.

GetDefaultSummationTableLabelT()

Retrieve the label of the table a field belongs to.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDimensionFieldFactTableLabelT(JobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInputThe field index within this dimension to query.
Returns

The table label or NULL on failure.

Summation Functions

AreSummationTotalsAdditiveT()

Determine whether all the totals for a given summation are additive with respect to the related cells. Additivity is the property that a given total can be determined by adding up all the contributing cells.
If all the totals are additive, then the totals can be recalculated with help from GetDimensionFieldTotalItemsT to determine the contributors.

If the query involves multiple fact tables with a many-to-many relationship between them, this will return false for all summations.

Available To
PrepareJob
PerformJob
CleanUpJob
AreSummationTotalsAdditiveT(JobInfoT *JobInfo, int SummationOffset)
Arguments
JobInfoInputInformation about the current job.
SummationOffsetInputThe summation index of the summation to check for additivity. This is equilvalent to the field index within the dimension which has type DIM_TYPE_SUMMATION
Returns
1Additive
0Not additive, or error

Database Functions

GetNumberRecordsInTableT()

Retrieve the number of records in the specified table.

Available To
PrepareJob
PerformJob
CleanUpJob
GetNumberRecordsInTableT(JobInfoT *JobInfo, const char * tableName, double * result)
Arguments
JobInfoInputInformation about the current job.
tableNameInputThe name of the table to query.
resultOutputThe number of records.
Returns
1Success.
0Failed.

GetDatabaseCodePageT()

Retrieve the system codepage ID for the SXV4 database.

Available To
PrepareJob
PerformJob
CleanUpJob
GetDatabaseCodePageT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns

The system codepage, or 0 if there is no codepage set for the database.

  • No labels