GetJournalsDisplayData

Gets the data for the specified journals. GetJournalsDisplayData returns data only for the columns specified in the varalColumns argument.

Syntax

<HFMwManageJournals>.GetJournalsDisplayData (varasLabels, bstrScenario, bstrYear, bstrPeriod, varalColumns)

Argument	Description
varasLabels	An array containing the labels of the journals for which to return data. Tip: You can get the labels of all journals that match given criteria with ExecuteQuery. Input argument.
bstrScenario	The label of the journals’ Scenario dimension member. Input argument. String subtype.
bstrYear	The label of the journals’ Year dimension member. Input argument. String subtype.
bstrPeriod	The label of the journals’ Period dimension member. Input argument. String subtype.
varalColumns	An array of that identifies the columns for which to return data. To set this argument, use either of the following techniques: Pass the columns returned by the HFMwQueryDef method GetDefAsVariants. Construct the array by setting the array items to the desired columns. Columns are represented by the HFMConstants type library constants listed in Journal Column Display Constants. Input argument. Array items are of a Long subtype.

Return Value

Returns an array of arrays containing data for the specified journals and columns. There is one array element for each journal specified by the varasLabels argument; each element then contains an array of journal data, with the size of that array corresponding to the columns specified by the varalColumns argument.

Note:

Some journal data, such as journal type and status, are represented by HFMConstants type library constants. For more information, see Journal-Related Constants.

Example

The following function returns the labels, statuses, and types of the journals for the specified Point of View, with the journals sorted by label. The columns, filtering, and sorting options are set with various HFMwQueryDef properties; note that the For...Next loops set the filters so that journals of all statuses, types, and balance types are returned.

Function GetJournalsForPOV(sScen, sYear, sPer, sVal)
Dim cHFMManageJournals, cHFMQueryDef
Dim vaCols, vaSortOpts, vaFilters, vaLabels, vaRet
Set cHFMManageJournals = Server.CreateObject _
   ("Hyperion.HFMwManageJournals")
'g_cHFMSession is an HFMwSession object reference
cHFMManageJournals.SetWebSession(g_cHFMSession)
Set cHFMQueryDef = Server.CreateObject("Hyperion.HFMwQueryDef")
cHFMQueryDef.ResetAll
cHFMQueryDef.columnContents(0) = COLUMN_JOURNALLABEL
cHFMQueryDef.columnSortOption(0) = JOURNALREPORT_SORT_ASCENDING
cHFMQueryDef.columnContents(1) = COLUMN_JOURNALSTATUS
cHFMQueryDef.columnContents(2) = COLUMN_JOURNALTYPE
For i = 0 to WEBOM_JOURNAL_NUM_STATUS_FILTER - 1
   cHFMQueryDef.statusFilter(i) = TRUE
Next
For i = 0 to WEBOM_JOURNAL_NUM_TYPE_FILTER - 1
   cHFMQueryDef.typeFilter(i) = TRUE
Next
For i = 0 to WEBOM_JOURNAL_NUM_BALANCE_TYPE_FILTER - 1
   cHFMQueryDef.balanceTypeFilter(i) = TRUE
Next
cHFMQueryDef.GetDefAsVariants 0, vaCols, vaSortOpts, vaFilters
vaLabels= cHFMManageJournals.ExecuteQuery (0, _
   sScen, sYear, sPer, sVal, vaCols, vaSortOpts, vaFilters)
vaRet = cHFMManageJournals.GetJournalsDisplayData(vaLabels, _
   sScen, sYear, sPer, vaCols)
GetJournalsForPOV= vaRet
End Function