Data Load Options

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

Table 79. Data Load Options

Constant	Load Option Information
HSV_DATALOAD_OPT_ACCUMULATE_WITHIN_FILE	Name property: Accumulate within file Usage: Specifies whether multiple values for the same cell within the load file should be accumulated or allowed to overwrite each other. If the load file does not contain multiple values for the same cell, then this option has no effect. In addition, this load option applies to line items and values, but not to descriptions — multiple descriptions always overwrite. Note: Data for system accounts never gets accumulated. Pass to CurrentValue: TRUE to accumulate, FALSE to overwrite.
HSV_DATALOAD_OPT_DELIMITER_CHAR	Name property: Delimiter Usage: Specifies a load file’s delimiter. Pass to CurrentValue: String — a valid delimiter character. The ValidationList property returns the valid delimiters.
HSV_DATALOAD_OPT_DUPLICATES	Name property: Duplicates Usage: Sets the data load mode to replace, merge, or accumulate. Tip: This option corresponds to the Lode Mode option buttons in Financial Management’s Load Data workspace frame. For details on the load modes, see the Oracle Hyperion Financial Management, Fusion Edition User's Guide. Pass to CurrentValue: One of the following constants: HSV_DATALOAD_MERGE. Merge mode. HSV_DATALOAD_REPLACE. Replace mode. HSV_DATALOAD_ACCUMULATE. Accumulate mode. HSV_DATALOAD_REPLACEWITHSECURITY. Replace with Security mode. Note: For descriptions of these modes, see the description of the HsvData type library’s corresponding constants in Update Mode Constants. You should be especially aware of the security-related differences between the Replace and Replace with Security modes.
HSV_DATALOAD_OPT_FILE_CONTAINS_SHARES	Name property: Does the file contain shares data Usage: Specifies whether the load file contains shares data such as “shares outstanding” or “voting outstanding” or “owned.” Pass to CurrentValue: TRUE if the file contains shares data, FALSE otherwise.
HSV_DATALOAD_OPT_FILE_FORMAT	Name property: FileFormat Usage: Specifies the load file format. In this release, only the native file format is supported. Pass to CurrentValue: The following constant, which represents the only supported option: HSV_DATALOAD_FILE_FORMAT_NATIVE
HSV_DATALOAD_OPT_LOAD_CALC	For internal use.
HSV_DATALOAD_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: Boolean — TRUE to append, FALSE to overwrite.
HSV_DATALOAD_OPT_FILE_CONTAINS_ SUBMISSIONPHASE	Name property: Does the file contain submission phase data Usage: Specifies whether the load file contains data for phased submissions. Pass to CurrentValue: Boolean — TRUE if phased submissions data is being loaded.
10	Name property: DecimalChar Note: This option is not represented by a constant; 10 is the option's index in the array of data load options. Usage: Specifies the decimal character used in the load file. By default this option is set to an empty string, which indicates the load operation will use the decimal character set as the user's preference. Tip: To get the user preferences for the decimal and thousands separator characters, use the HsvSystemInfo method GetNumberFormattingUserParameters. Pass to CurrentValue: String — if the load file's decimal character differs from that specified as the user's preference, specify the load file's decimal character.
11	Name property: ThousandsChar Note: This option is not represented by a constant; 11 is the option's index in the array of data load options. Usage: Specifies the thousands separator character used in the load file. By default this option is set to an empty string, which indicates the load operation will use the thousands separator character set as the user's preference. Pass to CurrentValue: String — if the load file's thousands separator differs from that specified as the user's preference, specify the load file's thousands separator.
HSV_DATALOAD_OPT_MAX	Usage: Points to the object that represents the load 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_DATALOAD_OPT_MIN	Usage: Points to the object that represents the load 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_DATALOAD_OPT_MODE	Name property: Mode Usage: Specifies whether the data file is loaded or is merely scanned when Load is called. Pass to CurrentValue: One of the following constants: HSV_DATALOAD_LOAD. Data will be loaded. HSV_DATALOAD_SCAN. Data will be scanned but not loaded. The Mode option defaults to scanning, so you must set the option to HSV_DATALOAD_LOAD in order to load data.