EnumDataAuditItems

Returns data audit information from a given range of audit records that meet the specified filtering criteria. The filtering criteria include date range, application server, and username. Audit information is returned in several arrays that have a one-to-one correspondence.

The lStartRecord and lEndRecord arguments specify the starting and ending indexes of the range of records, and the plTotalNumRecords argument returns the total number of records that match the filtering criteria. To iterate through all the matching records, in the first call to EnumDataAuditItems pass 0 to lStartRecord, then use the count returned by plTotalNumRecords to loop through the remaining records.

Note:

The number of matching records can change after you call EnumDataAuditItems. For example, a user might delete some or all of the audit records.

To get the history of a given cell, use GetCellHistory.

Note:

An application stores audit histories only if the audit-related application settings have been turned on. For more information, see the Oracle Hyperion Financial Management, Fusion Edition Administrator's Guide.

Syntax

<HsvData>.EnumDataAuditItems dStartTime, dEndTime, vbAllServers, bstrServer, vbAllUsers, bstrUserName, lStartRecord, lEndRecord, pvaralScenarios, pvaralYear, pvaralPeriod, pvaralEntity, pvaralParent, pvaralValue, pvaralICP, pvaralAccount, pvaralCustom1, pvaralCustom2, pvaralCustom3, pvaralCustom4, pvarabstrServers, pvarabstrUserNames, pvaradTimeModified, pvaralActivityCode, pvaradValues, pvaralNoData, plTotalNumRecords

Argument

Description

dStartTime

Double (ByVal). The timestamp of the date range’s starting time and date. The timestamp must be expressed as a Double that can be cast into a valid date.

dEndTime

Double (ByVal). The timestamp of the date range’s closing time and date. The timestamp must be expressed as a Double that can be cast into a valid date.

vbAllServers

Boolean (ByVal). A flag that determines whether to return data audit information for all application servers. Pass TRUE for all servers, FALSE to filter by a specific application server.

If you pass FALSE, use the bstrServer argument to specify the application server by which to filter.

bstrServer

String (ByVal). The name of the application server by which to filter. This argument is used only if the vbAllServers argument is set to FALSE.

vbAllUsers

Boolean (ByVal). A flag that determines whether to return data audit information for all users. Pass TRUE for all users, FALSE to filter by a specific username.

If you pass FALSE, use the bstrUserName argument to specify the username by which to filter.

bstrUserName

String (ByVal). The user name of the user by which to filter. This argument is used only if the vbAllUsers argument is set to FALSE.

lStartRecord

Long (ByVal). The index of the first record in the range of records to retrieve. This is a zero-based index.

lEndRecord

Long (ByVal). The index of the last record in the range of records to retrieve. This is a zero-based index.

pvaralScenarios

Variant array. Returns the member IDs of the Scenario dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralYear

Variant array. Returns the member IDs of the Year dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralPeriod

Variant array. Returns the member IDs of the Period dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralEntity

Variant array. Returns the member IDs of the Entity dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralParent

Variant array. Returns the member IDs of the parents of the Entity dimension members returned by the pvaralEntity argument.

The array items are returned as a Long subtype.

pvaralValue

Variant array. Returns the member IDs of the Value dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralICP

Variant array. Returns the member IDs of the Intercompany Partner dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralAccount

Variant array. Returns the member IDs of the Account dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralCustom1

Variant array. Returns the member IDs of the Custom 1 dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralCustom2

Variant array. Returns the member IDs of the Custom 2 dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralCustom3

Variant array. Returns the member IDs of the Custom 3 dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvaralCustom4

Variant array. Returns the member IDs of the Custom 4 dimension members for the data changes’ cells.

The array items are returned as a Long subtype.

pvarabstrServers

Variant array. Returns the names of the application servers on which the data changes were made.

The array items are returned as a String subtype.

pvarabstrUserNames

Variant array. Returns the usernames of the users who made the data changes.

The array items are returned as a String subtype.

pvaradTimeModified

Variant array. Returns the timestamps of the data changes. These are returned as Double values that can be cast to the Date format.

The array items are returned as a Double subtype.

pvaralActivityCode

Variant array. Returns the IDs of the user activities that caused the data changes. Valid values are represented by the HFMConstants type library constants listed in User Activity Constants.

The array items are returned as a Long subtype.

pvaradValues

Variant array. Returns the cell values that the data changes resulted in.

The array items are returned as a Double subtype.

pvaralNoData

Variant array. Indicates whether cells contain data or no data. Valid values are as follows:

  • 0 - The cell contains data.

  • 1 - The cell contains no data.

The array items are returned as a Long subtype.

plTotalNumRecords

Long. Returns the total number of audit records in the database that meet the filtering criteria.