Commit b26e3c7d authored by Michael Haggerty's avatar Michael Haggerty

by techsoldaten: adding README and CHANGELOG files

parent 753fab96
CRM Core 7.x-0.92 (03-May-2013)
===================================
New features:
- Improvements for contacts
- implemented match method on CRMCoreContactEntity
- implemented primary fields for email, phone and address on contacts, for use in feature
development
- added hook_entity_delete for contact records
- added support for relationship deletion
- Improvments for activities
- activities can now be created without first selecting a contact
- modified logic for activity participants, removed dependency on original contact
- modified filters for activity displays, can now filter by all activity types
- Improvements for relationships
- relationships can now be created without first selecting a contact
- Improvements for CRM Core User Sync
- removed dependency on rules configuration for contact to user management
- New module: CRM Core Match
- implements matching engines and logic for identifying duplicate contacts
- implements interface for selecting default matching rules for contacts
- New module: CRM Core Default Matching Engine
- creates matching engine and interface for configuring matching logic
Other commits:
- Corrected several permissions issues affecting the display of contact information
- Corrected path issues for links coming from various views
- Improved breadcrumb support for CRM Core Reports
- Modified filters on various views to support resetting filter criteria
- Implemented logical operators for contact matching in CRM Core Default Matching Engine
- Implemented field hanlders for supporting logical operations in CRM Core Default Matching Engine
- Implemented support for selecting matching engines in CRM Core Match
- Implemented support for multiple contact types in CRM Core Match
- Implemented test cases for evaluating contacts in CRM Core Match
- Implemented security around CRM Core Match test cases
- Implemented objects for creating custom matching engines and API around them
- Implemented several relationships in views to account for matches and duplicates
- Improved documentation in various areas of the code
CRM Core 7.x-0.91 (22-Mar-2013)
===================================
New features:
- Addition of settings screen, with options for controlling the theme, primary links, and contact info for
linked user accounts.
- Addition of user matching screen, for linking user accounts to contacts.
- Addition of inactive relationships screen.
- Addition of navigational menu for CRM Core, and creation of CRM Core Admin menu.
- Addition of CRM Core Report.
- Implementation of theming functions and code hinting for all CRM Core entities.
- Removed from this release:
Removals:
The following modules, which exist in previous development releases, were removed from this release:
- CRM OG Sync
- CRM Core Case
- CRM Core Match
- CRM Core Default Matching Engine
These modules still exist in development versions, they are just not considered stable. These modules will be
supported in future official releases of CRM Core. You can find them the --development branch.
Other commits:
- Implemented consistent path schemes for all CRM Core entities.
- Implemented consistent breadcrumb structure for all CRM Core entities.
- Removed the default image field for contacts.
- Removed default contact fields from the user edit form.
- Corrected bugs with bi-directional relationships.
- Modified appearance of various screens for adding CRM Core entities to ensure there is a uniform appearance.
- Modified various page titles for compliance with Drupal standards.
- Modified no results text on contacts, activities and relationship pages.
- Added action links for adding CRM Core entities.
- Added operations columns to screens for displaying CRM Core entities.
- Modified links for adding new contacts.
- Added reset buttons and other UI controls for various filters throughout the system.
- Improved UI for user synchronization.
- Enhanced user synchronization options - system now allows for weighted rules matching.
- Enhanced user synchronization options - system now allows for batch processing of user accounts.
- Enhanced sync form to only display users / contacts with no match.
- Improved dashboard handling - removed default text.
- Improved dashboard handling - added UI for configuring dashboard.
- Improved dashboard handling - added controls to remove links to dashboard when it is not present in the system.
- Removed unnecessary CSS throughout system.
- Adjusted paths for adding entities within the dashboard.
- Business logic - CRM Core now allows contacts to be removed from activities.
- Business logic - CRM Core now allows multiple contacts to be added to activities.
- Business logic - UI now displays information about contacts when viewing an activity.
- Business logic - UI now displays participant names as links to contact records.
- Business logic - streamlined process for deleting relationships.
- Dependencies - removed unnecessary dependencies.
- Template files - removed duplicate template files, added theme hinting.
\ No newline at end of file
-- SUMMARY --
CRM Core is a set of modules that provide contact management functionality within Drupal
web sites. The module supports contacts, relationships and activities, and provides various UI
elements can can (optionally) be used for maintaining these entities. It also provides support
for identifying duplicate contacts, linking contact records to user accounts, and generating
reports.
-- REQUIREMENTS --
A number of modules ship with CRM Core. They require the following modules to operate
properly, in addition to some interdependencies between the modules themselves:
* Entity API
* Field UI
* Field
* Field SQL storage
* Views
* Chaos tools
* Fieldgroup
* Name Field
* Entity Reference
* Date API
* Date
-- INSTALLATION --
CRM Core can be installed like any other Drupal module.
1) Download CRM Core to the modules directory for your site.
2) Go to the admin/modules page and enable CRM Core.
From here, select the options most appropriate for your site:
- if you want to use activity management in CRM Core, enable CRM Core Activity. You will probably also
want to enable CRM Core Activity UI, but this is not required.
- if you want to use relationship management, enable CRM Core Relationship. You will probably also want to
enable CRM Core Relationship UI, but this is not required.
- if you want to provide a UI for viewing reports defined by CRM Core features, enable CRM Core Report.
Please note, CRM Core does not ship with reports of it's own. This page will be blank until you define
reports.
- if you want to link contact records to user accounts, enable CRM Core User Sync.
- if you want to use matching engines to identify duplicate contacts, enable CRM Core Match.
- if you want to use the default matching engine that ships with CRM Core, enable CRM Core Default Matching
Engine.
-- UPGRADING --
Any time you upgrade the CRM Core modules, run update.php on your Drupal website.
-- RELATED MODULES --
* CRM Core Profile
A form builder for CRM Core. Allows administrators to dynamically create forms for interacting
with contact information.
http://drupal.org/project/crm_core_profile
-- CONFIGURATION --
There are a number of options for how to configure CRM Core. Please see the project documentation at
http://drupal.org/node/1856906 for more details on the configuration and setup process.
-- CONTACT --
Current maintainers:
* techsoldaten. - http://drupal.org/user/16339
If you are interested in participating in CRM Core development or help configuring your CRM Core instance,
please contact me directly through this form.
Development sponsored by Trellon.
-- SUMMARY --
CRM Core Match is a tool for implementing matching engines in CRM Core. Matching engines are used to
identify contacts and enhance the information they contain. Most frequently, this will be used to identify
contact records in CRM Core, either as duplicates or as the 'right' contact in a given situation.
CRM Core Match can support an unlimited number of matching engines, and this module provides users with a
framework for implementing them in a consistent way.
-- REQUIREMENTS --
The following modules are required by CRM Core Match:
* CRM Core
* CRM Core Contact
* Entity API
* Field UI
* Field
* Field SQL storage
* Views
* Chaos tools
* Fieldgroup
* Name Field
It is highly recommended that you enable CRM Core Default Matching Engine along with CRM Core Match.
Unless you have a custom matching engine already installed, CRM Core Match will not do anything without
this matching engine enabled.
-- INSTALLATION --
CRM Core can be installed like any other Drupal module.
1) Download CRM Core to the modules directory for your site.
2) Go to the admin/modules page and enable CRM Core.
From here, select the options most appropriate for your site:
- if you want to use activity management in CRM Core, enable CRM Core Activity. You will probably also
want to enable CRM Core Activity UI, but this is not required.
- if you want to use relationship management, enable CRM Core Relationship. You will probably also want to
enable CRM Core Relationship UI, but this is not required.
- if you want to provide a UI for viewing reports defined by CRM Core features, enable CRM Core Report.
Please note, CRM Core does not ship with reports of it's own. This page will be blank until you define
reports.
- if you want to link contact records to user accounts, enable CRM Core User Sync.
- if you want to use matching engines to identify duplicate contacts, enable CRM Core Match.
- if you want to use the default matching engine that ships with CRM Core, enable CRM Core Default Matching
Engine.
-- RELATED MODULES --
* CRM Core Profile
A form builder for CRM Core. CRMCP integrates directly with CRM Core Match to identify duplicate contacts
when contact matching is turned on. The module includes some excellent examples for developers looking to
implement their own custom matching interfaces.
http://drupal.org/project/crm_core_profile
-- CONFIGURATION --
1) Go to admin/config/crm-core/match and enable a matching engine.
2) Use the matching engine's configuration page to configure contact matching.
-- MATCHING ENGINES --
If you don't like the way CRM Core identifies matches, feel free to write your own engine. It can be as simple
or as complex as you like, and you can enable any number of matching engines within CRM Core Match.
There are many reasons why you might want to buld your own matching engine. CRM Core Default Matching Engine
operates via entity field queries, which are appropriate in the majority of cases CRM Core will ever be used.
But some organizations might benefit from having a matching tool that:
- sorts matches according to some unqiue criteria that is hard to enforce through logical operators
and weighted scores
- refines matches using Soundex / Levenshtein / Metaphone / etc.
- finds matches from an external source using a web service
- carries out more complex operations using Solr
- does something new or unanticipated with how matches are identified
CRM Core Match was built to support these kinds of cases.
A few things to be aware of when creating your own matching engine:
1) Matching engines should implement CrmCoreMatchEngine.
2) Matching engines identify themselves to CRM Core Match using hook_crm_core_match_engine_register. The code for
this can be found in the includes folder.
3) Matching engines always receive a list of contact ids that represent potential matches when they are run,
which are generated by whatever matching engines ran before the current one. It is the responsibility of
each matching engine to sort / segment / filter / drill down / do whatever to that list.
4) Most modules that work with CRM Core will accept the top contact returned by a matching engine as the
correct 'match.' Always sort matches so that the one you intend to have used is the top result.
5) Matching engines are capable of injecting information into a contact record as part of the matching process.
This is useful especially in cases where contact information is being matched against sources external to
CRM Core. For instance: if you needed to identify a match in an external system, you might want to store
an external identifier in the case where a match is made.
-- CONTACT --
Current maintainers:
* techsoldaten. - http://drupal.org/user/16339
If you are interested in participating in CRM Core development or help configuring your CRM Core instance,
please contact me directly through this form.
Development sponsored by Trellon.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment