Enabling User Group Synchronizers


User Group Synchronizers provide a way to integrate existing user stores with Cartella. By default, a new Cartella instance contains User Group Synchronizers for Salesforce (a customer-relations management platform) and for an LDAP directory. However, developers can create additional synchronizers for connecting to any kind of user store.

Essentially, setting up a User Group Synchronizer is a two-step process:

  1. Set the attribute values on <UserGroupSynchronizers>.
  2. Set up the appropriate synchronizer (i.e., Salesforce, LDAP, custom synchronizer) in an <add> element.
Tip
Alternatively, you can configure synchronizers within the Cartella application itself by navigating to Settings > Configuration Management. See User Group Sync Configuration Tool for details.
To enable the User Group Synchronizers feature:
  1. Navigate to [Site_Root].
  2. Open Cartella.config in a text editor.
  3. Locate the <UserGroupSynchronizers> element:
    <UserGroupSynchronizers adminLoginName="testAdmin" enabled="false" delay="60">
        
        <!-- SALESFORCE -->
        <!-- <add/> -->
    
        <!-- LDAP -->
        <!-- <add/> -->
    
        <!-- CUSTOM GROUP -->
        <!-- <add/> -->
        
    </UserGroupSynchronizers>
  4. Set the appropriate attribute values on <UserGroupSynchronizers>.
    AttributeDescription
    @adminLoginNameThe login name of the Cartella administrator account. This account is recorded as the creator of all groups and users.
    @adminPasswordThe password for the Cartella administrator account.
    @enabledTurns user group synchronization on or off. A value of "true" turns the feature on, and a value of "false" turns it off.
    @delaySpecifies the length of time to wait before running another synchronization. After a synchronization is complete, Cartella delays for a specified time period before performing another synchronization. The delay period is not usually an issue for LDAP synchronization. However, a Salesforce API may only allow a limited number of connections per day. If this is the case, you may need to adjust the delay accordingly.
  5. Depending on your needs, choose the setup procedure from the following:
  6. Save Cartella.config.