Difference between revisions of "CiviCRM"

From Freephile Wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
[[File:Applications-education.svg|thumb|link=http://civiteacher.com|Go to CiviTeacher.com to learn about using CiviCRM|200px]]
 
[[File:Applications-education.svg|thumb|link=http://civiteacher.com|Go to CiviTeacher.com to learn about using CiviCRM|200px]]
 
[http://civiteacher.com CiviTeacher.com] is a place for high quality videos on CiviCRM
 
[http://civiteacher.com CiviTeacher.com] is a place for high quality videos on CiviCRM
 +
 +
== Help ==
 +
There is help in the '[http://forum.civicrm.org/ forums]'
 +
But the CiviCRM Community Forums have now been deprecated by a new StackExchange https://civicrm.stackexchange.com/
  
 
== Installation ==
 
== Installation ==
Line 47: Line 51:
 
== API ==
 
== API ==
 
<ol>
 
<ol>
<li>{{@todo}} Learn the Civi API (<code>/civicrm/api</code>) http://wiki.civicrm.org/confluence/display/CRMDOC/API+Examples
+
<li> Learn the Civi API (Go to <code>/civicrm/api</code> in your installation)
 +
<li> Use the [https://equality-tech.com/civicrm/api/doc#explorer 'API Explorer'] and the [https://equality-tech.com/civicrm/api/doc#docs 'API Docs'] interface that is available in your installation
 +
<li> http://wiki.civicrm.org/confluence/display/CRMDOC40/CiviCRM+Public+APIs
 +
 
 +
<li> http://wiki.civicrm.org/confluence/display/CRMDOC/API+Examples
 +
<li> http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 +
<li> http://wiki.civicrm.org/confluence/display/CRMDOC/API+Reference
 +
<li> <span style="color:red;">Warning</span> old, probably incorrect: http://wiki.civicrm.org/confluence/display/CRMDOC32/Using+CiviCRM+APIs+-+Code+Snippets
 
</ol>
 
</ol>
  

Revision as of 23:28, 17 June 2015

Learn[edit | edit source]

Go to CiviTeacher.com to learn about using CiviCRM

CiviTeacher.com is a place for high quality videos on CiviCRM

Help[edit | edit source]

There is help in the 'forums' But the CiviCRM Community Forums have now been deprecated by a new StackExchange https://civicrm.stackexchange.com/

Installation[edit | edit source]

CiviCRM sits on top of a CMS: either Drupal, WordPress, or Joomla!.

The CiviCRM User and Administrator Book and also the wiki (see https://civicrm.org/go/books) are invaluable in getting setup.

When installing on top of Drupal, if you have the HTMLPurifier module enabled, you will run into a conflict that you can resolve by disabling the module in Drupal proper, or else modifying the bootstrap code in civicrm [1]

Also, the default theme (and most other themes?) don't work well for CiviCRM - especially the admin side. So, drush dl civi_bartik and enable it for the admin side.

After installation, there is a checklist that you should complete (e.g. http://example.org/civicrm/admin/configtask)

Some of the things needed for a first-time setup:

  1. Enable the CiviBartik theme, for Civi admin, and then immediately configure various blocks to NOT appear in that theme (remove everything from column two, so that you get a wide display)
  2. enable the components
  3. check/enable permissions (Drupal)
  4. set the headers and footers for mailings
  5. set the message template for mailings
  6. setup custom fieldsets and data fields. Before you do this, learn about Option Groups
  7. map import data to fields, groups, tags. Also do a large amount of data wrangling (normalization; and ETL) to get source data in a format suitable for use with CiviCRM. The data that I have is "composite" because it has individuals embedded inside organization records. So I needed to extract and flatten out contact records from their organization records; plus create and maintain a simple "external ID" system to relate them after import. This means parsing, slicing and dicing, string manipulation and making corrections or formatting data a particular way. I almost installed Pentaho Data Integration (kettle) because that tool is (supposedly) built for this job. [2]
  8. Be sure to tag each import with some unique tag. You can always remove those tags later (easily). When you inevitably run into problems during import, the proper way to delete records is to search by tag, and delete.
  9. Option Groups. There are many things in CiviCRM that are already configured as "Option Groups". "Website" is one example. When adding an Organization or Contact, and you want to enter data about their website, it could be one of many types: main, work, personal, facebook, twitter, pinterest, github etc. These are defined in the option group for "website". You can modify these to suit your data and your needs. As another example, "Campaign Type" comes defined as 'Direct Mail', 'Referral Program', and 'Customer Engangement'. I added 'Marketing' so that I can do a generic (email/web) marketing campaign.
  10. If you plan to use the CiviCase component to manage the common constituent "projects" or "workflows" and their associated timelines, then you'll need to create your own "Case Types". Look at the existing "Case Types" for reference.
  11. Gedit.svg todo review docs and setup cron to do things like geocoding
  12. Test and set your SPF record for your domain so that you can use Mailer, and review the docs for email system configuration


Interestingly, CiviCRM optionally uses wkhtmltopdf to convert HTML to PDF

Todo[edit | edit source]

  • Gedit.svg todo Install, and use overrides for DEV/PROD and make sure you can use the installation on multiple hosts [3]

Extensions[edit | edit source]


Developing Extensions[edit | edit source]

API[edit | edit source]

  1. Learn the Civi API (Go to /civicrm/api in your installation)
  2. Use the 'API Explorer' and the 'API Docs' interface that is available in your installation
  3. http://wiki.civicrm.org/confluence/display/CRMDOC40/CiviCRM+Public+APIs
  4. http://wiki.civicrm.org/confluence/display/CRMDOC/API+Examples
  5. http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  6. http://wiki.civicrm.org/confluence/display/CRMDOC/API+Reference
  7. Warning old, probably incorrect: http://wiki.civicrm.org/confluence/display/CRMDOC32/Using+CiviCRM+APIs+-+Code+Snippets


Notes[edit | edit source]

"Views" in Drupal (in core as of Drupal 8 [4]) is a good way to get reports from your data. If you want to use "Views" for your CiviCRM instance, you have to manually integrate it http://wiki.civicrm.org/confluence/display/CRMDOC/Views3+Integration Admin = civicrm/admin/setting/uf

References[edit source]

  1. http://forum.civicrm.org/index.php?topic=28429.0
  2. But like since version 3, Pentaho still doesn't work even at 5. The install docs are missing. The thing failed to even load, with no error.
  3. http://wiki.civicrm.org/confluence/display/CRMDOC/Moving+an+Existing+Installation+to+a+New+Server+or+Location
  4. https://www.drupal.org/project/views