Journal Extract Options (Unfiltered)

For each unfiltered journal 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 Item. The table also describes each option and the type of information to be passed to CurrentValue.

By default, journals are extracted, and standard and recurring templates are not extracted. Use the Regular, Standard, and Recurring extract options to override these defaults.

Table 82. Journal Extract Options (Unfiltered)

Constant

Extract Option Information

HSV_JOURNALEXTRACT_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_JOURNALEXTRACT_OPT_SCENARIO

Name property: Scenario

Usage: Specifies the Scenario dimension member for which journals are being extracted.

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

HSV_JOURNALEXTRACT_OPT_PERIOD

Name property: Period

Usage: Specifies the Period dimension member for which journals are being extracted.

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

HSV_JOURNALEXTRACT_OPT_YEAR

Name property: Year

Usage: Specifies the Year dimension member for which journals are being extracted.

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

HSV_JOURNALEXTRACT_OPT_REGULAR

Name property: Regular

Usage: Specifies whether journals are being extracted.

Pass to CurrentValue: Boolean - TRUE to extract journals, otherwise FALSE. This option defaults to TRUE.

HSV_JOURNALEXTRACT_OPT_STANDARD

Name property: Standard

Usage: Specifies whether standard templates are being extracted.

Pass to CurrentValue: Boolean - TRUE to extract standard templates, otherwise FALSE. This option defaults to FALSE.

HSV_JOURNALEXTRACT_OPT_RECURRING

Name property: Recurring

Usage: Specifies whether recurring templates are being extracted.

Pass to CurrentValue: Boolean - TRUE to extract recurring templates, otherwise FALSE. This option defaults to FALSE.

HSV_JOURNALEXTRACT_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.

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_JOURNALEXTRACT_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.

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.