Writing to the Carapace Audit

script	caudit.cpl
interface	Auditor
COM progId	Carapace.Auditor

Audit information is recorded in the Carapace database using the Auditor interface.

Auditor Creation

An Auditor is created by using the create function eg.

    (create Auditor db)

Auditor Methods

The Auditor interface has the following methods:

uniqueId	return a suitable uniqueId for a new audit entry
recordActivity	record the successful result of an activity
recordError	record the un-successful result of an activity
recordUserActivity	record the successful result of an action performed by a user
recordUserError	record the un-successful result of an action performed by a user
recordObjectActivity	record the successful result of an action performed on an audited object
recordObjectError	record the un-successful result of an action performed on an audited object
relateObjects	relate two audited objects together

uniqueId

Return a suitable uniqueId for a new audit entry.

Arguments: none

Return type: String

recordActivity

Record the successful result of an activity.

Arguments:

auditType	String
activity	String
description	String
...	further arguments which depend on the particular auditType

Return type: the empty List

recordError

Record the un-successful result of an activity.

Arguments:

auditType	String
activity	String
description	String
error	Error
...	further arguments which depend on the particular auditType

Return type: the empty List

recordUserActivity

Record the successful result of an action performed by a user.

Arguments:

auditType	String
activity	String
description	String
...	further arguments which depend on the particular auditType

Return type: the empty List

recordUserError

Record the un-successful result of an action performed by a user.

Arguments:

auditType	String
activity	String
description	String
error	Error
...	further arguments which depend on the particular auditType

Return type: the empty List

recordObjectActivity

Record the successful result of an action performed on an audited object.

Arguments:

objectType	String
objectId	String
auditType	String
activity	String
description	String
...	further arguments which depend on the particular auditType

Return type: the empty List

recordObjectError

Record the un-successful result of an action performed on an audited object.

Arguments:

objectType	String
objectId	String
auditType	String
activity	String
description	String
error	Error
...	further arguments which depend on the particular auditType

Return type: the empty List

relateObjects

Relate two audited objects together. Consider the example of an envelope which contains a message. If we have audited details about each of the envelope-object and the message-object, then these can be related as follows:

    (auditor.relateObjects "envelope" envelopeId "contains" "message" messageId)

Arguments:

leftObjectType	String
leftObjectId	String
relation	String
rightObjectType	String
rightObjectId	String

Return type: the empty List

Contents

Index

Current topic: audit

Related topics: databases