The following callback functions available to PreJob provide access to the tabulation query. These functions allow your module to modify the query before it is processed.
GetQualifiedWeightFieldIdentifierT()
Query the qualified weight field ID for the summation field specified by the Dimension and FieldOffset.
The default summation does not have a statistical function or an associated weight field.
Clients are responsible for creating and destroying QualifiedFieldIdentifierT itself but not its members (such as QualifiedFieldIdentifierT.m_TableIdentifier and QualifiedFieldIdentifierT.m_FieldIdentifier); these are managed by SuperSERVER.
CPP
GetQualifiedWeightFieldIdentifierT(PreJobInfoT *JobInfo, int Dimension,int FieldOffset, QualifiedFieldIdentifierT* const QualifiedFieldIdentifier)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| Dimension | Input | The dimension index within the data cube. |
|---|
| FieldOffset | Input | The field index within this dimension to query. |
|---|
| QualifiedFieldIdentifier | Output | The qualified weight field ID for this field. |
|---|
|
|---|
| Returns | | 1 | Success |
|---|
| 0 | The specified dimension and offset are not correct, or the summation has no associated weight field. |
|---|
|
|---|
AppendSummationFieldT()
Append a summation field to the existing summation dimension.
If the job does not have an existing summation dimension, AppendSummationFieldT() will ensure the job contains the default summation with the added summation options on a new dimension in the query.
CPP
AppendSummationFieldT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| FieldIdentifier | Input | The summation field to append. This should refer to a native summation field from the SXV4 database. |
|---|
|
|---|
| Returns | |
|---|
AppendSummationFieldWithStatisticFunctionT()
Append a summation field to the existing summation dimension and apply a statistic function to this summation field.
If the job does not have an existing summation dimension, AppendSummationFieldWithStatisticFunctionT() will ensure the job contains the default summation with the added summation options on a new dimension in the query, and apply a statistic function to this newly added summation field.
CPP
AppendSummationFieldWithStatisticFunctionT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier, StatisticalFieldTypeE FunctionType)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| FieldIdentifier | Input | The summation field to append. This should refer to a native summation field from the SXV4 database. |
|---|
| FunctionType | Input | One of the following statistical function types: - StatisticalFieldTypeE.STATISTIC_FIELD_SUM
- StatisticalFieldTypeE.STATISTIC_FIELD_VARIANCE
- StatisticalFieldTypeE.STATISTIC_FIELD_COUNT_DISTINCT
- StatisticalFieldTypeE.STATISTIC_FIELD_MEAN
- StatisticalFieldTypeE.STATISTIC_FIELD_STANDDEV
- StatisticalFieldTypeE.STATISTIC_FIELD_STANDSEM
- StatisticalFieldTypeE.STATISTIC_FIELD_MEDIAN
|
|---|
|
|---|
| Returns | |
|---|
AppendSummationFieldWithWeightedStatisticFunctionT()
Append a summation field to the existing summation dimension and apply a weighted statistic function to this summation field.
If the job does not have an existing summation dimension, AppendSummationFieldWithWeightedStatisticFunctionT() will ensure the job contains the default summation with the added summation options on a new dimension in the query, and apply a weighted statistic function to this newly added summation field.
CPP
AppendSummationFieldWithWeightedStatisticFunctionT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier, StatisticalFieldTypeE FunctionType, const QualifiedFieldIdentifierT* WeightFieldIdentifier)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| FieldIdentifier | Input | The summation field to append. This should refer to a native summation field from the SXV4 database. |
|---|
| FunctionType | Input | One of the following statistical function types: - StatisticalFieldTypeE.STATISTIC_FIELD_SUM
- StatisticalFieldTypeE.STATISTIC_FIELD_MEAN
- StatisticalFieldTypeE.ASSOCIATED_FIELD_SUM
|
|---|
| WeightFieldIdentifier | Input | The weighted field. This should refer to a native summation field from the SXV4 database. |
|---|
|
|---|
| Returns | |
|---|
GetDefaultSummationFactTableIdentifierT()
Retrieve the ID of the fact table that the default summation belongs to.
CPP
GetDefaultSummationFactTableIdentifierT(PreJobInfoT *JobInfo)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
|
|---|
| Returns | The table ID or NULL on failure. |
|---|
GetDefaultSummationFactTableLabelT()
Retrieve the label of the fact table that the default summation belongs to.
CPP
GetDefaultSummationFactTableLabelT(PreJobInfoT *JobInfo)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
|
|---|
| Returns | The table label or NULL on failure. |
|---|
GetDimensionFieldFactTableLabelT()
Retrieve the label of the fact table that the specific field belongs to.
CPP
GetDimensionFieldFactTableLabelT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| Dimension | Input | The dimension index. |
|---|
| FieldOffset | Input | The field index within this dimension to return the label for. Pass 0 if there are no concatenated fields. |
|---|
|
|---|
| Returns | The table label, or NULL on failure. |
|---|
GetLastFunctionStatusT()
Query the status code and message for the most recently executed function (excludes GetAPIVersionT()).
CPP
GetLastFunctionStatusT(PreJobInfoT* JobInfo, const char** Message)
| Arguments | | JobInfo | Input | Information about the current job. |
|---|
| Message | Output | The status message. |
|---|
|
|---|
| Returns | A status code. |
|---|
