ClearAuditTasks

Deletes the task audit history for all tasks that meet the specified criteria. Criteria include date range, application server, and user.

Note:

To delete audit information for a given task, use ClearAuditTasks2.

Syntax

<HFMwSystemInfo>.ClearAuditTasks dStartTime, dEndTime, vbAllServers, bstrServer, vbAllUsers, lActivityUserID

Argument

Description

dStartTime

The starting date and time of the date range. Pass a Double that can be cast to a Date format.

Input argument. Double subtype.

dEndTime

The ending date and time of the date range. Pass a Double that can be cast to a Date format.

Input argument. Double subtype.

vbAllServers

A flag that determines whether to delete the task audit history for all application servers. Pass TRUE for all application servers, FALSE to specify an application server with the bstrServer argument.

Input argument. Boolean subtype.

bstrServer

The name of the application server for which to delete the task audit history. This argument is used only if the vbAllServers argument is set to FALSE.

Input argument. String subtype.

vbAllUsers

A flag that determines whether to delete the task audit history for all users. Pass TRUE for all users, FALSE to specify a user with the lActivityUserID argument.

Input argument. Boolean subtype.

lActivityUserID

The activity user ID of the user for whom to delete the task audit history. This argument is used only if the vbAllUsers argument is set to FALSE.

Tip:

You can get the activity user ID of all users on the system with the HFMwManageApplications component’s EnumUsersOnSystem. method.

Input argument. Long subtype.

Example

The following subroutine deletes the audit history for a given application server.

Sub clearTaskAuditServer(sServer)
Dim cHFMSysInfo
Set cHFMSysInfo = Server.CreateObject("Hyperion.HFMwSystemInfo")
'cHFMSession is an HFMwSession object reference.
cHFMSysInfo.SetWebSession cHFMSession
cHFMSysInfo.ClearAuditTasks 0, CDbl(Now()), FALSE, sServer, _
   TRUE, 0
End Sub