CiviSync CMS Component

published on Wednesday, 04 May 2011 15:00

CiviSync CMS allows the administrators to manage the Site Key of CiviCRM and API Keys for the users from an easy to use interface within your Content Management System (CMS). CiviSync CMS is available for both Joomla and Drupal. It has been tested for

  • Joomla 1.5.23 with CiviCRM 3.2.x
  • Joomla 1.6+ with CiviCRM 3.4.x
  • Drupal 6 with CiviCRM 3.2.x
  • Drupal 7 with CiviCRM 4.0

Login/Register and download the files from the left hand side panel.

What is a Site Key?

You are required to pass authentication information at runtime to prevent any scripts in CiviCRM from being invoked by an unauthorized agent. CiviCRM uses a Site Key in addition to a valid username and password. The site key is a 16-32 bit alphanumeric/punctuation key value. Also, the site key should not contain any reserved or unsafe URL characters.

What is API Key?

In order to use the REST API a user is required to have an API Key stored in the database. This API Key is to be passed with each transaction together with the username and password of the user.

How to Setup CiviSync CMS?

Joomla 1.5

  1. Make sure that you have CiviCRM version 3.2.x installed.
  2. Download the relevant zip from the left hand side panel. (You will have to login/register to access the links)
  3. Login to your Joomla administration and go to Extensions > Install/Uninstall
  4. Click Browse and locate the zip that you downloaded.
  5. Click Upload file & Install to install the component. CiviSync should now be available in component menu.

Drupal 6

  1. Make sure that you have CiviCRM version 3.2.x installed. Current version of CiviSync CMS has the limitation that CiviCRM database should be same as Drupal database.
  2. Download the zip from the left hand side menu. (Don't forget to login/register to access the download links)
  3. Unzip & Upload the folder CiviSync to your Drupal Root > Sites > Default > Modules folder
  4. Login as administrator to your Drupal site and go to Site Building > Modules
  5. Enable the Module and you are all set to go.

Drupal 7

  • Navigate to the install page. Navigate to Modules > List (tab), or http://example.com/admin/moduleshttp://example.com/admin/modules, and click the link 'Install new module.'
  • Follow the prompts. You will be prompted to provide either the URL to the download, or to upload the CiviSync_CMS_Drupal7.zip file from your local computer. Click 'Install', and the Update manager will copy the files into your sites/all/modules folder. (See Update manager for more information about what that core module can do.) The next screen gives you two links. Click 'Enable newly added modules' and skip down to the 'Enable and configure' section.