EssIncrementalBuildDim

Builds dimensions with the specified rules file and data source. Can be called multiple times within the incremental dimension build protocol.

EssBeginIncrementalBuildDim() must be called before EssIncrementalBuildDim() gets called.

Syntax

ESS_FUNC_M EssIncrementalBuildDim(hCtx, RulesObj, DataObj, MbrUser, ErrorName, bOverwrite, usBuildOption, szTmpOtlFile)
ParameterData TypeDescription

hCtx

ESS_HCTX_T

Essbase API context handle.

RulesObj

ESS_POBJDEF_T

Pointer to rules file object definition structure.

DataObj

ESS_POBJDEF_T

Pointer to data file object definition structure.

MbrUser

ESS_PMBRUSER_T

SQL user structure (if data source is SQL database).

A NULL SQL user structure indicates a non SQL data source.

ErrorName

ESS_STR_T

Name of error output file on client.

bOverwrite

ESS_BOOL_T

Indicates overwrite or append error message to the error file.

usBuildOption

ESS_USHORT_T

Valid values:

  • ESS_INCDIMBUILD_BUILD

    Build members only.

  • ESS_INCDIMBUILD_VERIFY

    Build members and verify the outline.

  • ESS_INCDIMBUILD_SAVEOTL

    Build members and save the outline to a temp outline file.

  • ESS_INCDIMBUILD_ALL

    Build members, verify the outline, and restructure.

szTmpOtlFile

ESS_STR_T

The temp outline file name. Essbasecreates a temporary outline file with extension "otb" if the resulting outline in this round of dimension build has outline verification errors.

Return Value

Returns zero if successful; error code if unsuccessful.

Example

See EssBeginIncrementalBuildDim.

See Also