Journal Extract Options (Filtered)

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

Caution!

Use these options only with the ExtractOptionsEx property.

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 83. Journal Extract Options (Filtered)

Constant	Extract Option Information
HSV_JOURNALEXTRACT_EX_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_EX_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_EX_OPT_PERIOD	Name property: Period Usage: Specifies the Period dimension members for which journals are being extracted. Pass to CurrentValue: A Long array that contains the IDs of the Period dimension members.
HSV_JOURNALEXTRACT_EX_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_EX_OPT_ENTITIES	Name property: Entity Usage: Specifies the child Entity dimension members for which journals are being extracted. Pass to CurrentValue: A Long array that contains the IDs of the child Entity dimension members.
HSV_JOURNALEXTRACT_EX_OPT_PARENTS	Name property: Parent Usage: Specifies the parent Entity dimension members for which journals are being extracted. Pass to CurrentValue: A Long array that contains the IDs of the parent Entity dimension members. This array must have a one-to-one correspondence with the array for the child Entity dimension members.
HSV_JOURNALEXTRACT_EX_OPT_VALUES	Name property: Value Usage: Specifies the Value dimension members for which journals are being extracted. Pass to CurrentValue: A Long array that contains the IDs of the Value dimension members.
HSV_JOURNALEXTRACT_EX_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_EX_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_EX_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_EX_OPT_FILTER_BALANCE	Name property: Balance Type Usage: Specifies the balance type filter for the extraction. Pass to CurrentValue: A Long array containing the balance types to use as filtering criteria. Valid values are represented by the HFMConstants type library constants listed in Balance Type Constants.
HSV_JOURNALEXTRACT_EX_OPT_FILTER_GROUP	Name property: Group Usage: Specifies the journal group filter for the extraction. Pass to CurrentValue: A String array containing the journal group filtering criteria. You can use the pound character ( # ) as a wildcard.
HSV_JOURNALEXTRACT_EX_OPT_FILTER_LABEL	Name property: Label Usage: Specifies the journal label filter for the extraction. Pass to CurrentValue: A String array containing the journal label filtering criteria. You can use the pound character ( # ) as a wildcard.
HSV_JOURNALEXTRACT_EX_OPT_FILTER_STATUS	Name property: Status Usage: Specifies the journal status filter for the extraction. Pass to CurrentValue: A Long array containing the status filtering criteria. Valid values are represented by the HFMConstants type library constants listed in Journal Status Constants.
HSV_JOURNALEXTRACT_EX_OPT_FILTER_TYPE	Name property: Type Usage: Specifies the journal type filter for the extraction. Pass to CurrentValue: A Long array containing the journal type filtering criteria. Valid values are represented by the HFMConstants type library constants listed in Journal Type Constants.
HSV_JOURNALEXTRACT_EX_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_EX_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.