Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

rb.audit Object Description
(audit Template)

The rb.audit object provides a store for 'audit trail' information. Audit trails are a simple collection of records associated with some other 'thing' (contact, category, item). The intention is to provide a simple place to store opaque data intended primarily for audit trail purposes (this thing happened at this time). How it is actually used may be more general than this - allowing arbitrary serialised JavaScript objects to be stored against other database elements without bloating the core tables.

Note that it is expected that any applications using this component will create potentially large numbers of audit records per reported entity and that access to that data is likely to be infrequent. This makes storage in, for example, catalogue items inappropriate as the item structures could become slow and bloated.

Methods

rb.audit.create() Create a new audit record
rb.audit.createMany() Create a number of audit records as an atomic unit
rb.audit.modify() Modify an existing audit record
rb.audit.remove() Permanently remove an audit record
rb.audit.get() Iterate over audit records
rb.audit.count() Count matching audit records
rb.audit.countType() Count grouped by audit record type
rb.audit.bulkRemove() Bulk remove records using a search spec
rb.audit.move() Move records for one contact ID to another contact ID

Aggregate Types

rb.audit.auditRecord An audit record
rb.audit.auditCount undefined
rb.audit.auditQueryData Flags used in 'rb.audit.get'
Whitebeam release 1.3.36
(loadtime : 64ms)