Audit Methods

Method Description
removeAudit Removes an audit record from the system, and writes entire audit record to audit directory specified in the web.xml file.

The user calling this method must have DeleteAuditRight or AdministratorRight and not belong to a department.

retrieveAllAudits Retrieves all audit records from the system as an array of AuditBases.

The last element of the array is null. If no Auditbases are found, an array of one element is returned with a value null. This method returns 100 audits at a time, you must keep track of the last audit ID and the last auditFT ID returned if you want to get the next 100 audits. The first time you call this method, pass an empty string for lastFileId and lastAuditFTId. If you do not want Internet Server audit records, set lastAuditId to null. If you do not want Platform Server audit records set lastAuditFTId to null.

The user calling this method must have ViewAuditRight, AdministratorRight, or HelpDeskRight.

getAudit Gets an AuditBase from the system.

If the audit Id is not found, a null is returned.

The user calling this method must have ViewAuditRight, AdministratorRight, or HelpDeskRight.

retrieveAllAuditsForUser Retrieves all audit records in which the user ID matches transfer user ID in the audit record, and returns an array of AuditBase objects.

The last element of the array is null. If no audits are found, an array of one element is returned with a value of null. This method returns 100 audits at a time, you must keep track of the last audit ID returned and the last auditFT ID returned if you want to get the next 100 audits. The first time you call this method, pass an empty string for lastAuditId and lastAuditFTId. If you do not want Internet Server audit records, set lastAuditId to null. If you do not want Platform Server audit records, set lastAuditFTId to null.

The user calling this method must have ViewAuditRight, AdministratorRight, or HelpDeskRight.

searchAudits Retrieves all audit records that match the search criteria specified in the AuditBase object.
Searches are only done on the following fields:
  • Audit Id
  • Local Transaction Id
  • Client File Name
  • Server File Name
  • Node Name
  • Transfer User Id
  • Transfer Status
  • From Date
  • To Date
  • Number Of Days
  • Department
Set the fields in the AuditBase object that you want to search on. All other fields will be ignored. You can set from one to all the fields. Use the percent sign (%) as a wildcard character. Put the From Date in the TransferStartTime member of the AuditBase object. Put the To Date in the TransferEndTime member of the AuditBase object. The results are returned as an array of AuditBase objects. The last element of the array is null. If no audits are found, an array of one element is returned with a value of null. This method returns 100 audits at a time, you must keep track of the last transfer end time returned to get the next 100 audits.

The caller of this method is responsible for setting the start time and end time. If you do not set them, all of the audit records of today will be returned. Audits are returned in order of the transfer end time with the most recent being first.

The user calling this method must have ViewAuditRight, AdministratorRight, or HelpDeskRight.

removeAuditsOlderThanDays Removes all audit records whose date created field is older than the number of days specified, and writes entire audit records to audit directory specified in the web.xml file.

The user calling this method must have DeleteAuditRight or AdministratorRight and not belong to a department.

removeAuditsOlderThanDate Removes all audit records whose date created field is older than the date specified, and writes entire audit records to audit directory specified in the web.xml file.

The user calling this method must have DeleteAuditRight or AdministratorRight and not belong to a department.