CiviCRM is a web-based, open source, Constituent Relationship Management (CRM) software geared toward meeting the needs of non-profit and other civic-sector organizations.

collective.civicrm is a package aimed to provide basic integration between Plone and CiviCRM.

To enable this package in a buildout-based installation:

1. Edit your buildout.cfg and add add the following to it:

   [buildout]
   ...
   eggs =
       collective.civicrm

After updating the configuration you need to run ''bin/buildout'', which will take care of updating your system.

Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.

Check the box next to collective.civicrm and click the 'Activate' button.

To use the CiviCRM integration you need the following information:

• REST interface URL
• Site key
• Every user that will interact with CiviCRM needs an API key

See CiviCRM REST interface documentation for more information on this.

After installing CiviCRM integration, go to the control panel configlet and set up the REST interface URL and site key.

Set up the API key for all users that will use the CiviCRM integration.

Go to the @@civicrm-find-contacts view at the site root and start making searches. You can search for contacts by name or email, and you can filter the results by contact type, group and tag.

You can select any contact from the results to see his details. After a few seconds you will also see the relationships of the contact.

You can also select any contact from the relationships list for more details.