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

Contact Template

unlinkCatItem()

Disassociates an entity (Community OU or individual) with a catalogue Item.

Syntax

number = rb.contact.unlinkCatItem(target, node)

Parameters

The 'unlinkCatItem' method takes 2 parameters:

Name Type/Value Range/Length Description
targetnumberinteger, valid ID Required. The ID of the OU or individual to be attached to a new parent (higher up the organisational heirarchy)
nodenumber  Required. The Catalogue Item ID to be associated with the target contact.

Results

The 'unlinkCatItem' method returns number:

Type/Value Range/Length Description
number  ID of the Item, or -1 if the unlink failed

Remarks

link() is used to associate individuals with both parent OUs or communities.

Allowable combinations are:

  • An individual may be linked to a parent OU (in which case it inherits membership of that OU, its parents and community memberships).
  • An individual may be linked directly to a community
  • An OU may be linked to a parent OU (in which case all direct and indirect children become indirect members of the parent OU, its parents and any communities of which it is a member).
  • An OU may be linked to a community (in which case all direct and indirect children become members of the community by inheritance as long as they remain linked to the OU)

Whitebeam release 1.3.36
(loadtime : 202ms)