ExtractDataAuditItems

Extracts to a file the data audit information that meets the specified filtering criteria. The filtering criteria include dimension members, date range, application server, and username.

Syntax

<HsvData>.ExtractDataAuditItems bstrServerFileName, bstrLogFileName, bstrDelimitChar, dStartTime, dEndTime, varabstrMemberFilter, vbAllServers, bstrServer, vbAllUsers, bstrUserName

Argument

Description

bstrServerFileName

String (ByVal). The name and path of the file into which to extract audit information.

bstrLogFileName

String (ByVal). The name and path of the log file for the extraction.

bstrDelimitChar

String (ByVal). The delimiter character for the extract file.

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.

varabstrMemberFilter

String array (ByVal). An array that contains the dimension member names by which to filter cells. The array contains 12 items–one item for each dimension–and is indexed by the HFMConstants type library constants listed in Dimension ID Constants.

Caution!

Do not use the constant that represents parent Entity members as an index, because parents cannot be used as filters.

If you do not want to filter by a given dimension, pass an empty string as the corresponding array item. For example, the following array filters by only the Scenario and Account dimensions:

vaFilter(DIMENSIONACCOUNT) = "Sales"
vaFilter(DIMENSIONCUSTOM1) = ""
vaFilter(DIMENSIONCUSTOM2) = ""
vaFilter(DIMENSIONCUSTOM3) = ""
vaFilter(DIMENSIONCUSTOM4) = ""
vaFilter(DIMENSIONENTITY) = ""
vaFilter(DIMENSIONICP) = ""
vaFilter(DIMENSIONPERIOD) = ""
vaFilter(DIMENSIONSCENARIO) = "Actual"
vaFilter(DIMENSIONVALUE) = ""
vaFilter(DIMENSIONVIEW) = ""
vaFilter(DIMENSIONYEAR) = ""

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 username by which to filter. This argument is used only if the vbAllUsers argument is set to FALSE.