crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/drupal/modules/civicrm_member_roles/README.txt

   1 // $Id: README.txt,v 1.2.2.2.2.1 2008/09/01 04:43:43 posco Exp $
   2
   3 ============================
   4 CiviMember Roles Sync Readme
   5 ============================
   6
   7 Requirements
   8 -------------------------------
   9
  10 This module requires CiviCRM 2.1.x or greater and Drupal 6.x. In order to use this module with
  11 other versions of Drupal and CiviCRM, please see the available versions
  12 at http://drupal.org/project/civimember_roles.
  13
  14
  15 Installation Instructions
  16 -------------------------------
  17
  18 To install the CiviMember Roles Sync module, unpack the .tar.gz archive
  19 file and move the `civimember_roles` directory to your sites' `modules` directory.
  20 Then navigate to Administer > Site building > Modules and enable the CiviMember
  21 Roles Sync module.
  22
  23 Refer to the Drupal documentation for further information on how to install modules.
  24
  25
  26 How to Use
  27 -------------------------------
  28
  29 After you have installed CiviMember Roles Sync following the above instructions,
  30 navigate to Administer > Site configuration > CiviMember Roles Sync. If you do not see
  31 this link, make sure you have given yourself permission to see it in the
  32 Administer > User management > Permissions section of Drupal.
  33
  34 Here you will be able to create "association rules." These rules determine how
  35 CiviMember Roles Sync should synchronize CiviMember Membership Types
  36 to Drupal Roles. Click the "Add Association Rule" tab to add your first rule. Select
  37 the CiviMember Membership Type and Drupal Role you wish to associate and then
  38 select the CiviMember Status Rules you wish to use. Currently, CiviMember Roles
  39 Sync only knows about two different kinds of rules: "Current" and "Expired." Any
  40 CiviMember Status Rule that is assigned to "Current" will be used to determine
  41 if a CiviCRM Contact's Drupal account should be given the role. Any CiviMember
  42 Status Rule that is assigned to "Expired" will be used to determine if a CiviCRM
  43 Contact's Drupal account should have the role removed.  After you have finished
  44 filling out the form, click the "Add association rule" button to add the rule.
  45
  46 Next, click the Configure tab. This form allows you to configure how CiviMember
  47 Roles Sync should automatically synchronize Membership Types to Roles, or if
  48 it should do this automatically at all. If you choose the user login/logout method
  49 you may need to use the "Manually Synchronize" form each time you add an
  50 association rule in order to synchronize all Drupal Users initially. Otherwise,
  51 each users' roles will be updated on an individual basis each time they login or
  52 logout. If you select the Drupal cron method, all users' roles will be updated
  53 periodically each time the Drupal cron function is ran. Please refer to the Drupal
  54 documentation on how to configure Drupal cron.
  55
  56 User Import
  57 -------------------------------
  58
  59 Each CiviCRM Contact on your site will need a corresponding Drupal User account
  60 in order for CiviMember Roles Sync to synchronize Membership Types to Roles.
  61 Refer to the CiviCRM documentation:
  62
  63 http://wiki.civicrm.org/confluence/display/CRMDOC/Creating+a+Drupal+user+for+every+CiviCRM+contact
  64
  65 When a new Drupal account is created a new CiviCRM Contact will also be
  66 created. So you will only have to worry about the CiviCRM Contacts that you
  67 import into CiviCRM from a source outside of Drupal.
  68
  69
  70 Contact Information
  71 -------------------------------
  72
  73 All feedback and comments of a technical nature (including support questions)
  74 should be posted on the CiviMember Roles Sync project page at http://drupal.org/project/civimember_roles.
  75 For all other comments you can reach me at the following e-mail address. Please
  76 include "CiviMember Roles Sync" somewhere in the subject.
  77
  78 ngoodman AT wisc.edu
  79
  80
  81 License Information
  82 -------------------------------
  83
  84 Copyright (C) Neil Goodman 2010
  85 Released under GNU General Public License version 2 or later