IHsvJournalsEx Interface Overview

The IHsvJournalsEx interface is used to create and process journals and to create templates. The IHsvJournalsEx methods also return the information that journals and templates contain.

The IHsvJournalsEx interface is a child of the HsvSession object. Use HsvSession’s Journals property to assign IHsvJournalsEx object references as shown in the following example:

  Dim cIHsvJournalsEx As IHsvJournalsEx
  Set cIHsvJournalsEx = cHsvSession.Journals

The following table lists the methods of the IHsvJournalsEx interface.

Table 24. IHsvJournalsEx Interface Methods

Method

Description

AddJournalGroup

Creates a journal group.

ApproveJournals

Approves one or more journals.

DeleteJournals

Deletes one or more journals.

DeleteTemplates

Deletes one or more templates.

EnumJournalGroups

Returns the names and descriptions of an application’s journal groups.

EnumJournalGroupsForScenarioYear

Returns the names and descriptions of the journal groups assigned to journals for a given scenario and year.

EnumJournalIDsForExtractFilter

Returns the IDs of journals and templates that match the specified filtering criteria.

GenerateRecurring

Generates a journal from a recurring template.

GetEntityJournals

Returns journal entry information for all journals that match the specified Point of View.

GetEntityJournals2

Returns journal entry information for all journals, including journal IDs, that match the specified Point of View.

GetJournal

Returns a variety of information for a journal. Line item amounts are returned in a Double array.

GetJournal2

Returns a variety of information for a journal. This is the same as GetJournal except with the addition of the VARIANT_BOOL vbScaleAmounts flag which is used to determine whether the textual representation of the amounts are scaled or not.

GetJournalDisplayData

Returns various types of information for journals. The types of information returned correspond to the display columns in the Columns tab of the Filters And Sorting dialog box in the Process Journals workspace frame.

GetJournalLabelsForIDs

Returns the labels of the journals that contain the specified Scenario and Year dimension members and that correspond to a given set of journal IDs.

GetJournalQueryDefinitionIDs

Returns IDs of one or more journals. You can return IDs of all journals or return only those IDs that meet filtering criteria that you specify.

GetTemplate

Returns a variety of information for a template. Line item amounts are returned in a Double array.

GetTemplateDisplayData

Returns various types of information for templates. The types of information returned correspond to the display columns in the Columns tab of the Filters And Sorting dialog box in the Set Up Journals workspace frame.

GetTemplateLabelsForIDs

Returns the labels of the journal templates for a given set of journal template IDs.

GetTemplateQueryDefinitionIDs

Returns IDs of one or more templates. You can return IDs of all templates or return only those IDs that meet the filtering criteria you specify.

GetTextJournal

Returns a variety of information for a journal. Line item amounts are returned in a String array.

GetTextTemplate

Returns a variety of information for a template. Line item amounts are returned in a String array.

GetVariance

Returns a journal’s total debit and credit amounts and the difference between these amounts.

PostJournals

Posts one or more journals.

RejectJournals

Rejects one or more journals.

RemoveAllJournalGroups

Removes all journal groups from an application.

RemoveJournalGroup

Removes the specified journal group.

SaveJournal

Creates a new journal, or saves changes to an existing journal that has a Working or Submitted status. Line item amounts are passed in a Double array.

Tip:

To create a journal from a template, pass the values returned by GetTemplate to SaveJournal.

SaveTemplate

Creates a new journal template, or updates an existing journal template. Line item amounts are passed in a Double array.

SaveTextJournal

Creates a new journal, or saves changes to an existing journal that has a Working or Submitted status. Line item amounts are passed in a String array.

Tip:

To create a journal from a template, pass the values returned by GetTextTemplate to SaveTextJournal.

SaveTextTemplate

Creates a new journal template, or updates an existing journal template. Line item amounts are passed in a String array.

SubmitJournals

Submits one or more journals.

UnpostJournals

Unposts one or more journals.

UnsubmitJournals

Unsubmits one or more journals.

ValidateLineItems

Validates whether the values passed would define a valid journal.

ValidateValue

Indicates whether a String resolves to a Double that Financial Management would then allow to be inserted as a journal amount. To evaluate as valid, the String must not represent a negative Double, as Financial Management does not allow the entry of negative amounts in journals.

For detailed descriptions of these methods, see IHsvJournalsEx Interface Methods.