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

Audit Template

move()

Move records for one contact ID to another contact ID

Syntax

number = rb.audit.move(fromContactID, toContactID, type)

Parameters

The 'move' method takes 3 parameters:

Name Type/Value Range/Length Description
fromContactIDnumber  Required. The ID of the contact from which all audit records are to be moved
toContactIDnumber  Required. The ID of the contact to which matching audit records are to be moved
typestring  Optional. If specified then this is a SIMILAR TO (SQL) filter string applied to the audit record 'type' field. Only records that match this string will be moved from the old to the new contact ID.

Results

The 'move' method returns number:

Type/Value Range/Length Description
number   Number or records from from the source to the destination contact

Remarks

This method allows all the audit records assigned to one contact ID to be moved to another contact ID. The most common use case for this method is the merging of two contact records into one (i.e. a de-duplication process).

None of the existing records assigned to the target contact are changed or deleted as a result of this method

This method returns the number of audit records moved from the source to the target contact.

Whitebeam release 1.3.36
(loadtime : 61ms)