Reference¶
Browse this Diátaxis content type by functional area and component.
48 page(s) in this section.
Appendices¶
Communication — Campaigns¶
- Reports and analysis Find the campaign search filters and reporting options available in CiviCRM. CiviCRM latest Updated 2026-10-06
Communication — Mailings¶
- Reports and analysis Understand individual mailing reports, bounce information, click-through statistics, and CiviReport mailing reports. CiviCRM latest Updated 2026-10-06
- Variables and tokens in workflow message templates Identify tokens and Smarty variables described for contribution workflow message templates. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Configuration¶
- Configure CiviCRM Review the configuration checklist and the settings available for an installed CiviCRM site. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Custom data¶
- Creating custom fields Learn how to scope and configure custom field sets and fields, and when to use groups or tags instead. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Installation¶
- Installation requirements Check the server, software, and database requirements before installing or upgrading CiviCRM. CiviCRM latest Updated 2026-08-20
- Troubleshooting CiviCRM installation Find diagnostic steps and possible solutions for CiviCRM installation and upgrade problems. CiviCRM latest Updated 2026-08-20
Configure, automate and extend — Permissions¶
- CMS permissions Find CMS permission settings, assign roles and review permissions for common access needs. CiviCRM latest Updated 2026-10-06
- Permissions Understand how SearchKit display settings and FormBuilder form settings affect permissions. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — System administration¶
- Payment processors Compare payment processors and find the configuration guidance provided for accepting payments through CiviCRM pages. CiviCRM latest Updated 2026-07-02
- Switching CMS platforms Find the guide for moving a CiviCRM installation from one CMS to another. CiviCRM latest Updated 2026-07-02
- Multisite components and functional separation Look up how multisite functionality is delivered and which entities are separated by domain. CiviCRM latest Updated 2026-07-02
- Secret keys Find how to configure, generate, and manage CiviCRM secret keys. CiviCRM latest Updated 2026-07-02
- Configuring PayPal API Certificate credentials Preserve the documented API Certificate procedure and its stated support limitation. CiviCRM latest Updated 2026-07-02
- Setup Understand the CiviCRM System Status screen and where to find help for reported issues. CiviCRM latest Updated 2026-07-02
- Version-specific upgrade tasks Find additional tasks and changes to check when an upgrade crosses specific CiviCRM versions. CiviCRM 4.7.3, 4.7.31, 5.27.0, 5.29.0 Updated 2026-07-02
- Webform CiviCRM integration Learn how the Webform CiviCRM module connects Backdrop webforms with CiviCRM data and what to consider when configuring forms. CiviCRM latest Updated 2026-07-02
- WordPress integration Find CiviCRM extensions, WordPress plugins, and widgets that support integration between CiviCRM and WordPress. CiviCRM latest Updated 2026-07-02
- Integrating with WordPress CiviCRM integrates with WordPress as a plugin starting with WordPress version 3.3.1 (those using earlier versions of WordPress will need to upgrade prior to installing CiviCRM). CiviCRM latest Updated 2026-07-02
Contacts and data — Activities¶
- Activities Understand activity records, repeating activities, and the options for administering activity types and statuses. CiviCRM latest Updated 2026-10-06
- Import requirements for activities, contributions, memberships, participants and tags Find the CSV fields and import options described for activities, contributions, memberships, participants and tags. CiviCRM latest Updated 2026-10-06
Contacts and data — Contacts¶
- Contacts Understand contact types, core fields, and the information available on each contact tab. CiviCRM latest Updated 2026-10-06
Contacts and data — Data management¶
- Tokens and mail merge Find tokens for mail merge and look up checksum links, date formatting, click-tracking rules, and available tokens. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Cases¶
- CiviCase permissions Review the contact and account requirements and the permissions that control access to CiviCase. CiviCRM latest Updated 2026-10-06
- Reports and analysis Find the available ways to review, report on, search, and export casework data. CiviCRM latest Updated 2026-10-06
- Relationship type status warnings Identify situations that can cause CiviCase status warnings related to Relationship Types. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Contributions¶
- Viewing the CiviContribute dashboard See where to review contribution summaries and choose a dashboard layout. CiviCRM latest Updated 2026-10-06
- Reports and analysis Find the standard contribution reports and other ways to analyse contributions. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Events¶
- Keeping track of events and participants Use the CiviEvent Dashboard and event listing to find events and participant information. CiviCRM latest Updated 2026-10-06
- Reports Compare ways to analyse event and participant data, and learn how to display an event report on the home dashboard. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Memberships¶
- Membership status rules Understand membership dates, status rules, overrides, and how membership statuses are kept up to date. CiviCRM latest Updated 2026-10-06
- Membership reports Find out what the membership dashboard and built-in membership reports show. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Pledges¶
- Pledge reports and analysis Identify the available pledge reports and templates for analysing pledges. CiviCRM latest Updated 2026-10-06
Initial set up¶
- Dates Find the settings for date display, date input, calendar conventions, and date-field ranges. CiviCRM latest Updated 2026-10-06
- Scheduled jobs Learn how scheduled jobs are initiated and configured, and look up the available jobs and their parameters. CiviCRM latest Updated 2026-10-06
Search and reporting — Forms¶
- Types of forms Learn what the Submission Forms, Search Forms, and Field Blocks tabs on the main FormBuilder page are for. CiviCRM latest Updated 2026-10-06
Search and reporting — Reporting¶
- Navigation menu Find CiviCRM features through the navigation menu and learn how menu items can be changed. CiviCRM latest Updated 2026-10-06
Search and reporting — Search¶
- Search displays Learn how to add a SearchKit display, choose a display type, and configure how results appear. CiviCRM latest Updated 2026-10-06
- Search result actions Look up the actions available for contact, contribution, participant, activity, and member search results. CiviCRM latest Updated 2026-10-06
- Relative date filters Look up the relative date filters that ship with CiviCRM and the date boundaries they define. CiviCRM latest Updated 2026-10-06
- Search button Learn when to use the search button to preview or refresh search results. CiviCRM latest Updated 2026-10-06
- Field transformations Learn what field transformations do and which categories are available in Search Kit. CiviCRM latest Updated 2026-10-06
- URL filter support in searches Look up supported search URL parameters and the date formats used in their values. CiviCRM latest Updated 2026-10-06
Search and reporting — SearchKit¶
- Query info View the API and SQL code behind a SearchKit search. CiviCRM latest Updated 2026-10-06
- Search For Identify the primary entities available in Search For and the optional ways to modify or group a search. CiviCRM latest Updated 2026-10-06
- Where Understand how Where filters SearchKit results and how its comparison operators behave. CiviCRM latest Updated 2026-10-06