Reading from the Carapace Audit

script	caudit.cpl
interface	Audit
COM progId	Carapace.Audit

Audit information is read from the Carapace database using the Audit interface.

Audit Creation

An Audit is created by using the create function eg.

    (create Audit db)

Audit Methods

The Audit interface has the following methods:

auditTypes	return the complete list of available audit types
filterHeadings	return the attributes which can be used to filter the supplied audit type
displayHeadings	return the headings for audited information held by the suppied audit type
orderHeadings	put the audit headings in the 'standard' order
timeString	put the integer epoch time into a string suitable for entry into the database
select	select information from the supplied extension table
filter	filter the information contained within the audit according to the supplied details
activities	list the set of activities available for the supplied audit type
enumerate	enumerate the values allowed for the supplied extension attribute
objectAudit	get the custom audit object for the supplied object type
storedObjectType	get the custom audit object for the supplied object type
fetchObject	fetch the identified audited object
filterPage	return the name of the HTML template used to provide object-specific filtering for the supplied object type
detailsPage	return the name of the HTML template used to display an audited object
relatedToThis	list the identifiers and relations of all audited objects related to the supplied one
thisRelatedTo	list the identifiers and relations of all audited objects which relate to the supplied one

auditTypes

Return the list of audit types within the Carapac database.

Arguments: none

Return type: List

filterHeadings

Return the list of the headings used for filtering the given audit type.

Arguments:

auditType

String

Return type: List

displayHeadings

Return the list of the headings which can be displayed for the given audit type.

Arguments:

auditType

String

Return type: List

orderHeadings

Put the audit headings in the 'standard' order.

Arguments:

headings

List

Return type: List

timeString

Convert the integer epoch time into a string suitable for entry into the database.

Arguments:

epoch

Integer

Return type: String

select

Select the supplied headings from from the given extension table where the records match the given filter. The filter is an attribute/value list of heading/value pairs.

Arguments:

extensionTable	String
filter	List
headings	List

Return type: List

filter

Apply the supplied filter to the audit and return the identified records. The filter is an attribute/value list of heading/value pairs.

Arguments:

auditType	String
filter	List
headings	List

Return type: List

activities

Return the list of activities for the supplied audit type.

Arguments:

auditType

String

Return type: List

enumerate

Return the list of values for the supplied extension attribute.

Arguments:

extensionTbl	String
attribute	String

Return type: List

objectAudit

Get the custom audit object for the supplied object type. Click here for information about object extensions to the Carapace audit.

Arguments:

objectType

String

Return type: Object

storedObjectType

Get the type of object stored for a given audit type -- a value of "" (the empty String) is returned if no object type is stored.

Click here for information about object extensions to the Carapace audit.

Arguments:

auditType

String

Return type: String

fetchObject

Fetch the identified audited object.

Arguments:

objectType	String
objectId	String

Return type: Object

filterPage

Return the name of the HTML template used to provide object-specific filtering for the supplied object type. The empty string "" is returned if no such page is recorded.

Arguments:

objectType

String

Return type: String

detailsPage

Return the name of the HTML template used to display an audited object. The empty string "" is returned if no such page is recorded.

Arguments:

objectType

String

Return type: String

relatedToThis

List the identifiers and relations of all audited objects related to the supplied one. The returned list contains triplets of strings showing the following:

1. relationship name
2. type of the related object
3. identifier for the related object

Arguments:

objectId

String

Return type: List

thisRelatedTo

List the identifiers and relations of all audited objects which relate to the supplied one. The returned list contains triplets of strings showing the following:

1. relationship name
2. type of the related object
3. identifier for the related object

Arguments:

objectId

String

Return type: List

Contents

Index

Current topic: audit

Related topics: databases