Report Data Array Structures

The following tables describe structures of arrays used by GetReportData and GetReportData2. These are the arrays for journal report filters and display columns.

Journal Report Filter Array Elements

The following table lists the index numbers, corresponding display columns, and descriptions of the supported elements in the array that specifies a report’s journal filters.

Note:

The array passed to the vararvFilters argument is a 32-element array. Indexes for this array that are not listed in the following table are reserved for future use.

Table 66. Journal Report Filter Array Elements

Index

Display Column

Description

0

Label

A String containing the desired label. You can use the percentage sign ( % ) as a wildcard character.

1

Status

An array of Longs containing the journal statuses to be applied. These statuses are represented by the HFMConstants type library constants listed in Journal Status Constants.

2

Type

An array of Longs containing the journal types to be applied. These balance types are represented by the HFMConstants type library constants listed in Journal Type Constants.

3

Balance Type

An array of Longs containing the balance types to be applied. These balance types are represented by the HFMConstants type library constants listed in Balance Type Constants.

4

Group

A String containing the name of the desired journal group. You can use the percentage sign ( % ) as a wildcard character.

5

Description

A String containing the name of the desired description. You can use the percentage sign ( % ) as a wildcard character.

14

Entity

The member ID (Long) of the entity by which to filter.

15

Parent

The member ID (Long) of the parent entity by which to filter.

16

Account

The member ID (Long) of the account by which to filter.

Journal Report Display Columns

The journal report methods take an array that specifies the report data to return. The following table lists the constants that identify and the type of data returned for the columns.

Table 67. Report Column Display Constants

Constant

Column

Return Value (Subtype and Description)

0

Label

String. The journal label.

1

Status

Integer. The journal status. The valid return values are represented by the HFMConstants type library constants listed in Journal Status Constants

2

Type

Integer. The journal type. The valid return values are represented by the HFMConstants type library constants listed in Journal Type Constants

3

Balance Type

Integer. The balance type. The valid return values are represented by the HFMConstants type library constants listed in Balance Type Constants.

4

Group

String. The name of the journal group.

5

Description

String. The journal description.

6

Short Description

String. The truncated version of the journal description.

7

Created By

String. The fully qualified username of the journal creator.

8

Date Created

Double. The time and date on which the journal was created. This is returned as a Double that you can cast to a Date format.

9

Approved By

String. The fully qualified username of the journal approver.

If a journal has not been approved, a blank String is returned.

10

Approved On

Double. The time and date on which the journal was approved. This is returned as a Double that you can cast to a Date format.

If a journal has not been approved, 0 is returned.

11

Posted By

String. The fully qualified username of the journal poster.

If a journal has not been posted, a blank String is returned.

12

Date Posted

Double. The time and date on which the journal was posted. This is returned as a Double that you can cast to a Date format.

If a journal has not been posted, 0 is returned.

13

Security Class

Long. The ID number of the journal’s security class.

14

Entity

Long. The member ID of the journal’s entity.

15

Parent

Long. The member ID of the journal’s parent entity.

16

Account

Long. The member ID of the journal’s account.

17

ICP

Long. The member ID of the journal’s Intercompany Partner dimension member.

18

Custom1

Long. The member ID of the journal’s Custom 1 dimension member.

19

Custom2

Long. The member ID of the journal’s Custom 2 dimension member.

20

Custom3

Long. The member ID of the journal’s Custom 3 dimension member.

21

Custom4

Long. The member ID of the journal’s Custom 4 dimension member.