CiviCRM installation process

Pre-requisites: Ubuntu packages: php5-ldap php5-sybase. Restart apache afterwards.

Install drupal 7 (currently 7.15)

Install and configure the drupal-ldap module.

Install drush 5.7

Install civicrm 4.2 (currently 4.2.2)

Add localisation, to allow for English (UK) language: relevant l10n file for civi version.

Then follow additional localisation instructions at: ​http://wiki.civicrm.org/confluence/display/CRMDOC40/CiviCRM+Localisation

Log in as the site administrator account, and go to /sites/all/modules/civicrm/install/index.php

Provide details of civicrm database connection and other pre-install configuration.

Full details of the installation step here: ​http://wiki.civicrm.org/confluence/display/CRMDOC42/Drupal+Installation+Guide+for+CiviCRM+4.2+-+Drupal+7

Run 'Synchronize contacts to users' to ensure that cid=1 is set to the site admin user.

Then use the configuration checklist within the CiviCRM module.

In 'Address settings', in both the address format boxes, shift the supplemental_address_1 field ABOVE the street_address field. Change 'contact.state_province' to 'contact.state_province_name'. In the 'address editing' section, turn off 'post code suffix', 'county', latitude, longitude, street address parsing.

In 'Display Preferences', under 'editing contacts', untick IM, OpenID and Website. Also untick 'Notify activity assignees'. In the 'contact dashboard' section, tick 'Assigned activities'.

In 'Outbound Mail' set the mail type to SMTP and the server to smtp.xuhl-tr.nhs.uk port 25. Authentication is not required.

in Administer >> System Settings >> Enable Components, disable CiviContribute, CiviMail, CiviMember, CiviPledge, CiviEvent, CiviGrant and CiviCampaign. Enable CiviCase and CiviReport only.

Change date and time representations to UK format using Administer >> Localization >> Date Formats.

In Administer >> Settings - Directories set the 'templates directory' to the drupal base path + "sites/all/civicrm_templates" - this is essential for the CiviCase XML files to be read.

In Administer >> Customize Data >> Word Replacements set "CiviCase" -> "Study Management", "Case Types" -> "Research Studies", "Case Type" -> "Study", "Open Case" -> "Enrol into study", "Case Subject" -> "Enrolment Label", "Case Statuses" -> "Enrolment Statuses", "Case" -> "Study Enrolment", "case" -> "study enrolment", "Client" -> "Participant".

Finally, install the lcbru module to configure the GENVASC case sructure and other customisations specific to the LCBRU, the GENVASC label printing module and the ICE messaging module. Also enable the 'CiviGroup Roles Sync' module.

Configure Civi Cases

The definition XML files for the CiciCRM Cases for each Study is attached to the Study TRAC page.

1. Ensure that all the Activity Types used in the Study Definition XML file is defined within CiviCRM (Administer >> Customise Data and Screens >> Activity Types) against the CiviCase component.
2. Copy the Study Definition file into the following directory: Drupal civicrm_templates/CRM/Case/xml/configuration
3. Create the Case Types in Administer > Study Management > Research Studies. Complete the form using the exact same text for the Label as you entered for the CaseType <name> element in your case configuration files.

Issues

CiviCRM Documentation

Configuration of CiviCase: ​http://wiki.civicrm.org/confluence/display/CRMDOC41/CiviCase+Configuration#CiviCaseConfiguration-ConfiguringCiviCase

Notes on Drupal and LDAP configuration - used to create user accounts, and associate the user accounts to the 'LCBRU staff' group.

PDF generation

Better performance in PDF generation is offered with the wkhtmltopdf library - which SHOULD NOT be installed on Ubuntu using apt-get, but by downloading and installing the pre-compiled version from the website, which includes an internal X server for use on headless machines. Copy the resulting executable to /usr/bin/wkhtmltopdf and then in the CiviCRM admin menu you can point to the executable, and CiviCRM will use that.

Mail merging, tokens, etc

The {contact.state_province_name} token works in the display screens but not in the mail merges. There's a replacement token supplied using hooks in the LCBRU module, along with other tokens useful for various purposes, in the civicrm_hooks.php file.

Upgrades

Remember that drupal upgrades require dependent modules to be disabled during the upgrade process. This can take a little while, as you have to disable them in order of dependency.

Upgrade from 4.2.x to 4.3.5 worked smoothly on localhost test machine. However before this could be repeated on live, 4.4.0 was released. This did not upgrade smoothly on the test server - the new word_replacements code imposes a case-insensitive uniqueness constraint which does not work well with our data. There is a patch, and 4.4.1 will be OK. The test system was restored to full functionality with the word replacements being entered manually, but for the live system, we should patch the upgrade before applying it. The patch was installed manually, and the upgrade reported completed successfully.