Metadata Load Options

For each metadata load option, the following table lists the constant that identifies the option and the corresponding Name property — either the constant or the name can be passed to IHsvLoadExtractOptions.Item. The table also describes each option and the type of information to be passed to IHsvLoadExtractOption.CurrentValue. (See Item and CurrentValue.)

Tip:

The options for loading dimension members default to TRUE, and the options for clearing previously loaded members default to FALSE.

Table 76. Metadata Load Options

Constant

Load Option Information

HSV_METALOAD_OPT_ACCOUNTS

Name property: Accounts

Usage: Specifies whether Account dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load accounts, otherwise FALSE.

HSV_METALOAD_OPT_ACCOUNTS_SYSTEM

Name property: SystemAccounts

Usage: Specifies whether system accounts are loaded.

Pass to CurrentValue: Boolean — TRUE to load system accounts, otherwise FALSE. These are system members, so if this option is set to TRUE you must also set the LoadSystemMembers option to TRUE.

By default, this option is set to FALSE.

HSV_METALOAD_OPT_APP_SETTINGS

Name property: AppSettings

Usage: Specifies whether application settings are loaded.

Pass to CurrentValue: Boolean — TRUE to load application settings, otherwise FALSE.

HSV_METALOAD_OPT_CHECK_INTEGRITY

Name property: CheckIntegrity

Usage: Specifies whether to validate the integrity of the metadata file against the metadata in the current application.

Note:

If integrity errors occur, they are noted in the log file and no portion of the file is loaded into the application.

Pass to CurrentValue: Boolean — TRUE to check integrity, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_ACCOUNTS

Name property: ClearAccounts

Usage: Specifies whether previously loaded Account dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded accounts, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CONSOL_METHODS

Name property: ClearConsolMethods

Usage: Specifies whether existing consolidation methods are cleared before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded consolidation methods, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CURRENCIES

Name property: ClearCurrencies

Usage: Specifies whether previously loaded currencies are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded currencies, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CUSTOM1

Name property: ClearCustom1

Usage: Specifies whether previously loaded Custom 1 dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded Custom 1 members, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CUSTOM2

Name property: ClearCustom2

Usage: Specifies whether previously loaded Custom 2 dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded Custom 2 members, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CUSTOM3

Name property: ClearCustom3

Usage: Specifies whether previously loaded Custom 3 dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded Custom 3 members, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_CUSTOM4

Name property: ClearCustom4

Usage: Specifies whether previously loaded Custom 4 dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded Custom 4 members, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_ENTITIES

Name property: ClearEntities

Usage: Specifies whether previously loaded Entity dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded entities, otherwise FALSE.

HSV_METALOAD_OPT_CLEAR_SCENARIOS

Name property: ClearScenarios

Usage: Specifies whether previously loaded Scenario dimension members are deleted before metadata is loaded.

Pass to CurrentValue: Boolean — TRUE to delete previously loaded scenarios, otherwise FALSE.

HSV_METALOAD_OPT_CONSOL_METHODS

Name property: ConsolMethods

Usage: Specifies whether consolidation methods are loaded.

Pass to CurrentValue: Boolean — TRUE to load consolidation methods, otherwise FALSE.

HSV_METALOAD_OPT_CURRENCIES

Name property: Currencies

Usage: Specifies whether currencies are loaded.

Pass to CurrentValue: Boolean — TRUE to load currencies, otherwise FALSE.

HSV_METALOAD_OPT_CUSTOM1

Name property: Custom1

Usage: Specifies whether Custom 1 dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Custom 1 dimension members, otherwise FALSE.

HSV_METALOAD_OPT_CUSTOM2

Name property: Custom2

Usage: Specifies whether Custom 2 dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Custom 2 dimension members, otherwise FALSE.

HSV_METALOAD_OPT_CUSTOM3

Name property: Custom3

Usage: Specifies whether Custom 3 dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Custom 3 dimension members, otherwise FALSE.

HSV_METALOAD_OPT_CUSTOM4

Name property: Custom4

Usage: Specifies whether Custom 4 dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Custom 4 dimension members, otherwise FALSE.

HSV_METALOAD_OPT_DELIMITER_CHAR

Name property: Delimiter

Usage: Specifies a load file’s delimiter.

Pass to CurrentValue: String — a valid delimiter character. Note that the ValidationList property returns the valid delimiters.

HSV_METALOAD_OPT_ENTITIES

Name property: Entities

Usage: Specifies whether Entity dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load entities, otherwise FALSE.

HSV_METALOAD_OPT_FILE_FORMAT

Name property: FileFormat

Usage: Specifies whether the metadata load file is in an ASCII text or XML format.

Pass to CurrentValue: Specify one of the constants in Table 78, Metadata File Format Constants. By default, ASCII text files are loaded.

HSV_METALOAD_OPT_ICP

Name property: ICPs

Usage: Specifies whether Intercompany Partner dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Intercompany Partner dimension members, otherwise FALSE. These are system members, so if this option is set to TRUE you must also set the LoadSystemMembers option to TRUE.

HSV_METALOAD_OPT_LOAD_SYSTEM_MEMBERS

Name property: LoadSystemMembers

Usage: Specifies whether system members are loaded.

Pass to CurrentValue: Boolean — TRUE to load system members, otherwise FALSE.

Note:

If this option is set to TRUE, you must also set to TRUE the options for the system members to be loaded.

HSV_METALOAD_OPT_LOG_FILE_APPEND

For internal use.

HSV_METALOAD_OPT_MAX

For internal use.

HSV_METALOAD_OPT_MIN

For internal use.

HSV_METALOAD_OPT_PRESCAN

Name property: Prescan

Usage: Specifies whether a load file is loaded or is merely scanned for syntax accuracy when Load is called.

Pass to CurrentValue: Boolean — TRUE to scan without loading, FALSE to load the metadata. By default, this option is set to FALSE.

HSV_METALOAD_OPT_SCENARIOS

Name property: Scenarios

Usage: Specifies whether Scenario dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load scenarios, otherwise FALSE.

HSV_METALOAD_OPT_USE_REPLACE_MODE

Name property: UseReplaceMode

Usage: Specifies whether the metadata replaces or is merged with existing metadata.

Pass to CurrentValue: Boolean — TRUE to replace existing metadata, FALSE to merge with existing metadata. Note that this option is set to FALSE by default.

HSV_METALOAD_OPT_VALUE

Name property: Values

Usage: Specifies whether Value dimension members are loaded.

Pass to CurrentValue: Boolean — TRUE to load Value dimension members, otherwise FALSE. These are system members, so if this option is set to TRUE you must also set the LoadSystemMembers option to TRUE.