Metadata Extract Options

For each metadata extract 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 extracting dimension members default to TRUE. An exception is the option for system-generated accounts, which defaults to FALSE.

Table 77. Metadata Extract Options

Constant	Extract Option Information
HSV_METAEXTRACT_OPT_ACCOUNTS	Name property: Accounts Usage: Specifies whether Account dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract accounts, otherwise FALSE.
HSV_METAEXTRACT_OPT_ACCOUNTS_SYSTEM	Name property: SystemAccounts Usage: Specifies whether system-generated Account dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract system accounts, otherwise FALSE. If this option is set to TRUE you must also set the ExtractSystemMembers option to TRUE.
HSV_METAEXTRACT_OPT_APP_SETTINGS	Name property: AppSettings Usage: Specifies whether application settings are extracted. Pass to CurrentValue: Boolean — TRUE to extract application settings, otherwise FALSE.
HSV_METAEXTRACT_OPT_CONSOL_METHODS	Name property: ConsolMethods Usage: Specifies whether consolidation methods are extracted. Pass to CurrentValue: Boolean — TRUE to extract consolidation methods, otherwise FALSE.
HSV_METAEXTRACT_OPT_CURRENCIES	Name property: Currencies Usage: Specifies whether currencies are extracted. Pass to CurrentValue: Boolean — TRUE to extract currencies, otherwise FALSE.
HSV_METAEXTRACT_OPT_CUSTOM1	Name property: Custom1 Usage: Specifies whether Custom 1 dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Custom 1 members, otherwise FALSE.
HSV_METAEXTRACT_OPT_CUSTOM2	Name property: Custom2 Usage: Specifies whether Custom 2 dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Custom 2 members, otherwise FALSE.
HSV_METAEXTRACT_OPT_CUSTOM3	Name property: Custom3 Usage: Specifies whether Custom 3 dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Custom 3 members, otherwise FALSE.
HSV_METAEXTRACT_OPT_CUSTOM4	Name property: Custom4 Usage: Specifies whether Custom 4 dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Custom 4 members, otherwise FALSE.
HSV_METAEXTRACT_OPT_DELIMITER_CHAR	Name property: Delimiter Usage: Specifies an extract file’s delimiter. Pass to CurrentValue: String — a valid delimiter character. The ValidationList property returns the valid delimiters.
HSV_METAEXTRACT_OPT_ENTITIES	Name property: Entities Usage: Specifies whether Entity dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract entities, otherwise FALSE.
HSV_METAEXTRACT_OPT_EXTRACT_SYSTEM_MEMBERS	Name property: ExtractSystemMembers Usage: Specifies whether system members are extracted. Pass to CurrentValue: Boolean — TRUE to extract 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 extracted.
HSV_METAEXTRACT_OPT_FILE_FORMAT	Name property: FileFormat Usage: Specifies whether the metadata extract 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, metadata is extracted to ASCII text files.
HSV_METAEXTRACT_OPT_ICP	Name property: ICPs Usage: Specifies whether Intercompany Partner dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Intercompany Partner dimension members, otherwise FALSE. These are system members, so if this option is set to TRUE you must also set the ExtractSystemMembers option to TRUE.
HSV_METAEXTRACT_OPT_MAX	For internal use.
HSV_METAEXTRACT_OPT_MIN	For internal use.
HSV_METAEXTRACT_OPT_PERIODS	Name property: Periods For internal use.
HSV_METAEXTRACT_OPT_SCENARIOS	Name property: Scenarios Usage: Specifies whether Scenario dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract scenarios, otherwise FALSE.
HSV_METAEXTRACT_OPT_VALUE	Name property: Values Usage: Specifies whether Value dimension members are extracted. Pass to CurrentValue: Boolean — TRUE to extract Value dimension members, otherwise FALSE. These are system members, so if this option is set to TRUE you must also set the ExtractSystemMembers option to TRUE.
HSV_METAEXTRACT_OPT_VIEWS	Name property: Views For internal use.
HSV_METAEXTRACT_OPT_YEARS	Name property: Years For internal use.