SOLR Integration

SOLR XML definition

For solar integration, the following integration points need to be implemented:

• SOLR shall be able to search contacts and cases, including all relevant data
• SOLR shall be automatically updated automatically when entities change in CiviCRM (insert/update/delete)
• on contact insert/update, send request to SOLR to reindex the submitted XML document
• on contact delete, send request to SOLR to remove the document from the index

• a function that can be called to update a set of records (for example after a bulk import)
• an update function shall allow a set of IDs to be passed in for indexing.

function solrUpdate($type, $aIDs) {}

type: [contact,case]
aIDs: list of IDs to index for the type of record
returns an XML document that can be passed in to SOLR

• a delete function that allows a set of IDs to be passed in for deletion.

function solrDelete($type, $aIDs) {}

type: [contact,case]
aIDs: list of IDs to index for the type of record
returns true/false

• XML definitions
• Contacts: all data relevant to a contact should be included in the XML:
• primary contact fields
• user that created/update the record
• date/time for created/updated
• addresses
• contact records (phone/email etc.)
• non-case activities (field name "activity")
• notes
• case activities (field name "caseActivity")
• any custom fields created for contacts

• Cases: all data relevant to a case should be included in the XML:
• primary case fields
• person who created the case
• date/time for created/updated
• case activities (field name "caseActivity")
• any custom fields created for cases

• search interfaces:
• ajax contact search shall be replaced with the SOLR search (to allow for wildcard searches on large datasets) via config switch.
• contact search and advanced search shall be replaced with SOLR via config switch.

• once uploaded documents can be attached to contacts (pdf, word, text files) they shall also be searchable via SOLR