The CiviCase component is available starting with the 2.2 release of CiviCRM and is included in the general release download files. This document provides instructions for setting up CiviCase with the sample configuration so you can try out CiviCase features prior to configuring CiviCase for your specific organizations needs.

Review the planning section of the configuration guide for an overview of concepts and terms. You can also review Physician Health Program's user documentation to get acquainted with a specific installed configuration of CiviCase from the user perspective.

Configuring Sample Data


In order to configure CiviCase with sample data you will need:

Otherwise, you can explore the sample CiviCase configuration on our public demo:

What's Included?

The sample configuration provides examples of case types which might be used in a community-based human services organization:

It does not include configured custom fields for these activities - although you can add these yourself once the configuration is loaded from Administer CiviCRM » Custom Data. Select Activities in the Used For field and then select the activity type you want to add custom fields for.


Configuration tasks are:

  1. Create the configuration directory.
  2. Copy sample configuration files.
  3. Load the sample mysql file.
  4. Enable the CiviCase component.
  5. Verify permissions.

1. Create configuration directory

$ cd <civicrm_root>/CRM/Case/xml
$ mkdir configuration

2. Copy the sample CiviCase XML files to the configuration directory

$ cp  <civicrm_root>/CRM/Case/xml/configuration.sample/*.xml <civicrm_root>/CRM/Case/xml/configuration

3. Load the sample mysql file

Using phpMyAdmin:

Using MySQL command line:

$ cd <civicrm_root>/CRM/Case/xml/configuration.sample
$ mysql -u DB_USERNAME -pDB_PASSWORD DB_NAME < SampleConfig.mysql

4. Enable the CiviCase component

The CiviCase component is included in CiviCRM downloads starting with version 2.2 However it is NOT enabled by default. To enable the component:

5. Verify Permissions

You will need to create a contact record for each staff member or service provider who will be trying out / using CiviCase. These individuals will also need to have a user account (Drupal and Joomla installs). If you are new to CiviCRM, please review the Access Control section before continuing.

You should also add contact records for service providers who will be assigned case roles but will not be accessing the CiviCase system. CiviCase will allow your staff to easily send emails to these providers with pertinent case and client information, as well as record case-related interactions reported by them. Click New Individual from the CiviCRM Shortcuts block to begin adding contact records.