Skip to end of metadata
Go to start of metadata

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.

Available To
PreJob
GetQualifiedWeightFieldIdentifierT(PreJobInfoT *JobInfo, int Dimension,int FieldOffset, QualifiedFieldIdentifierT* const QualifiedFieldIdentifier)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to query.
QualifiedFieldIdentifierOutputThe qualified weight field ID for this field.
Returns
1Success
0The 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.

Available To
PreJob
AppendSummationFieldT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier)
Arguments
JobInfoInputInformation about the current job.
FieldIdentifierInputThe summation field to append. This should refer to a native summation field from the SXV4 database.
Returns
1Success.
0Failed.

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.

Available To
PreJob
AppendSummationFieldWithStatisticFunctionT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier, StatisticalFieldTypeE FunctionType)
Arguments
JobInfoInputInformation about the current job.
FieldIdentifierInputThe summation field to append. This should refer to a native summation field from the SXV4 database.
FunctionTypeInput

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
1Success.
0Failed.

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.

Available To
PreJob
AppendSummationFieldWithWeightedStatisticFunctionT(PreJobInfoT* JobInfo, const QualifiedFieldIdentifierT* FieldIdentifier, StatisticalFieldTypeE FunctionType, const QualifiedFieldIdentifierT* WeightFieldIdentifier)
Arguments
JobInfoInputInformation about the current job.
FieldIdentifierInputThe summation field to append. This should refer to a native summation field from the SXV4 database.
FunctionTypeInput

One of the following statistical function types:

  • StatisticalFieldTypeE.STATISTIC_FIELD_SUM
  • StatisticalFieldTypeE.STATISTIC_FIELD_MEAN
  • StatisticalFieldTypeE.ASSOCIATED_FIELD_SUM
WeightFieldIdentifierInputThe weighted field. This should refer to a native summation field from the SXV4 database.
Returns
1Success.
0Failed.

GetDefaultSummationFactTableIdentifierT()

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

Available To
PreJob
GetDefaultSummationFactTableIdentifierT(PreJobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe table ID or NULL on failure.

GetDefaultSummationFactTableLabelT()

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

Available To
PreJob
GetDefaultSummationFactTableLabelT(PreJobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
ReturnsThe table label or NULL on failure.

GetDimensionFieldFactTableLabelT()

Retrieve the label of the fact table that the specific field belongs to.

Available To
PreJob
GetDimensionFieldFactTableLabelT(PreJobInfoT *JobInfo, int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index.
FieldOffsetInput

The field index within this dimension to return the label for.

Pass 0 if there are no concatenated fields.

ReturnsThe table label, or NULL on failure.

GetLastFunctionStatusT()

Query the status code and message for the most recently executed function (excludes GetAPIVersionT()).

Available To
PreJob
GetLastFunctionStatusT(PreJobInfoT* JobInfo, const char** Message)
Arguments
JobInfoInputInformation about the current job.
MessageOutputThe status message.
ReturnsA status code.
  • No labels