Data Extract Options

For each data 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.

Table 80. Data Extract Options

Constant

Extract Option Information

HSV_DATAEXTRACT_OPT_ACCOUNT_SUBSET

Name property: Account Subset

Usage: Specifies the Account dimension members for which data is being extracted.

Pass to CurrentValue: A Long array containing Account dimension member IDs.

HSV_DATAEXTRACT_OPT_CUSTOM1_SUBSET

For internal use.

HSV_DATAEXTRACT_OPT_CUSTOM2_SUBSET

For internal use.

HSV_DATAEXTRACT_OPT_CUSTOM3_SUBSET

For internal use.

HSV_DATAEXTRACT_OPT_CUSTOM4_SUBSET

For internal use.

HSV_DATAEXTRACT_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_DATAEXTRACT_OPT_ENTITY_SUBSET

Name property: Entity Subset

Usage: Specifies the child Entity dimension members for which data is being extracted.

Pass to CurrentValue: A Long array containing Entity dimension member IDs.

HSV_DATAEXTRACT_OPT_EXTRACT_ALL_DATA

For internal use.

HSV_DATAEXTRACT_OPT_EXTRACT_CALC

Name property: Extract Calculated

Usage: Specifies whether to extract calculated data.

Pass to CurrentValue: TRUE to extract calculated data, FALSE otherwise.

HSV_DATAEXTRACT_OPT_EXTRACT_FILE_APPEND

For internal use.

HSV_DATAEXTRACT_OPT_ICP_SUBSET

For internal use.

HSV_DATAEXTRACT_OPT_LOG_FILE_APPEND

Name property: Append to log file

Usage: Specifies whether log data is appended to or overwrites the existing log file.

Pass to CurrentValue: TRUE to append, FALSE to overwrite.

HSV_DATAEXTRACT_OPT_LOG_FILE_NAME

For internal use.

HSV_DATAEXTRACT_OPT_MAX

Usage: Points to the object that represents the extract option with the highest index in the IHsvLoadExtractOptions collection.

Pass to CurrentValue: A valid value for the option with the highest index.

Note:

There is no corresponding Name property. Calling the Name property for an IHsvLoadExtractOption object initialized with this constant returns the name of the option with the highest index.

HSV_DATAEXTRACT_OPT_MIN

Usage: Points to the object that represents the extract option with the lowest index in the IHsvLoadExtractOptions collection.

Pass to CurrentValue: A valid value for the option with the lowest index.

Note:

There is no corresponding Name property. Calling the Name property for an IHsvLoadExtractOption object initialized with this constant returns the name of the option with the lowest index.

HSV_DATAEXTRACT_OPT_PARENT_SUBSET

Name property: Parent Subset

Usage: Specifies the parent Entity dimension members for which data is being extracted.

Pass to CurrentValue: A Long array containing Entity dimension member IDs.

HSV_DATAEXTRACT_OPT_PERIOD_SUBSET

Name property: Period Subset

Usage: Specifies the Period dimension members for which data is being extracted.

Pass to CurrentValue: A Long array containing Period dimension member IDs.

HSV_DATAEXTRACT_OPT_SCENARIO_SUBSET

Name property: Scenario

Usage: Specifies the Scenario dimension member for which data is being extracted.

Pass to CurrentValue: A Long containing the Scenario dimension member ID.

HSV_DATAEXTRACT_OPT_UNICODE

For internal use.

HSV_DATAEXTRACT_OPT_VALUE_SUBSET

For internal use.

HSV_DATAEXTRACT_OPT_VIEW

Name property: View

Usage: Specifies the View dimension member for which data is being extracted.

Pass to CurrentValue: One of the following constants:

  • HSV_DATA_VIEW_PERIODIC. Data for the Periodic view will be extracted.

  • HSV_DATA_VIEW_YTD. Data for the year-to-date view will be extracted.

  • HSV_DATA_VIEW_SCENARIO. Data for the scenario’s default View dimension member will be extracted.

    Tip:

    These constants correspond to the Data View option buttons in the Extract Data workspace frame.

HSV_DATAEXTRACT_OPT_YEAR_SUBSET

Name property: Year

Usage: Specifies the Year dimension member for which data is being extracted.

Pass to CurrentValue: A Long containing the Year dimension member ID.