1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Contact
</base>
6 <name>civicrm_contact
</name>
7 <comment>Contact objects are defined by a civicrm_contact record plus a related civicrm_contact_type record.
</comment>
12 <type>int unsigned
</type>
13 <title>Internal Contact ID
</title>
15 <headerPattern>/internal|contact?|id$/i
</headerPattern>
16 <required>true
</required>
17 <comment>Unique Contact ID
</comment>
22 <autoincrement>true
</autoincrement>
25 <name>contact_type
</name>
26 <title>Contact Type
</title>
29 <comment>Type of Contact.
</comment>
32 <table>civicrm_contact_type
</table>
33 <keyColumn>name
</keyColumn>
34 <labelColumn>label
</labelColumn>
35 <condition>parent_id IS NULL
</condition>
44 <name>index_contact_type
</name>
45 <fieldName>contact_type
</fieldName>
49 <name>contact_sub_type
</name>
50 <title>Contact Subtype
</title>
55 <headerPattern>/C(ontact )?(subtype|sub-type|sub type)/i
</headerPattern>
56 <comment>May be used to over-ride contact view and edit templates.
</comment>
58 <table>civicrm_contact_type
</table>
59 <keyColumn>name
</keyColumn>
60 <labelColumn>label
</labelColumn>
61 <condition>parent_id IS NOT NULL
</condition>
64 <type>Multi-Select
</type>
69 <name>index_contact_sub_type
</name>
70 <fieldName>contact_sub_type
</fieldName>
72 <type>Multi-Select
</type>
77 <name>do_not_email
</name>
80 <headerPattern>/d(o )?(not )?(email)/i
</headerPattern>
81 <dataPattern>/^\d{
1,}$/
</dataPattern>
89 <name>do_not_phone
</name>
93 <headerPattern>/d(o )?(not )?(call|phone)/i
</headerPattern>
94 <dataPattern>/^\d{
1,}$/
</dataPattern>
101 <name>do_not_mail
</name>
103 <import>true
</import>
104 <headerPattern>/^(d(o\s)?n(ot\s)?mail)|(\w*)?bulk\s?(\w*)$/i
</headerPattern>
105 <dataPattern>/^\d{
1,}$/
</dataPattern>
109 <type>CheckBox
</type>
113 <name>do_not_sms
</name>
115 <import>true
</import>
116 <headerPattern>/d(o )?(not )?(sms)/i
</headerPattern>
117 <dataPattern>/^\d{
1,}$/
</dataPattern>
121 <type>CheckBox
</type>
125 <name>do_not_trade
</name>
127 <import>true
</import>
128 <headerPattern>/d(o )?(not )?(trade)/i
</headerPattern>
129 <dataPattern>/^\d{
1,}$/
</dataPattern>
133 <type>CheckBox
</type>
137 <name>is_opt_out
</name>
139 <title>No Bulk Emails (User Opt Out)
</title>
141 <import>true
</import>
142 <required>true
</required>
143 <comment>Has the contact opted out from receiving all bulk email from the organization or site domain?
</comment>
146 <type>CheckBox
</type>
150 <name>legal_identifier
</name>
153 <import>true
</import>
154 <headerPattern>/legal\s?id/i
</headerPattern>
155 <dataPattern>/\w+?\d{
5,}/
</dataPattern>
156 <comment>May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.
</comment>
163 <name>external_identifier
</name>
171 <import>true
</import>
172 <headerPattern>/external\s?id/i
</headerPattern>
173 <dataPattern>/^\d{
11,}$/
</dataPattern>
174 <comment>Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.
</comment>
178 <name>UI_external_identifier
</name>
179 <unique>true
</unique>
180 <fieldName>external_identifier
</fieldName>
184 <name>sort_name
</name>
185 <title>Sort Name
</title>
193 <export>true
</export>
194 <comment>Name used for sorting different contact types
</comment>
198 <name>index_sort_name
</name>
199 <fieldName>sort_name
</fieldName>
203 <name>display_name
</name>
204 <title>Display Name
</title>
212 <export>true
</export>
213 <comment>Formatted name representing preferred format for display/print/other output.
</comment>
217 <name>nick_name
</name>
218 <title>Nickname
</title>
226 <import>true
</import>
227 <headerPattern>/n(ick\s)name|nick$/i
</headerPattern>
228 <dataPattern>/^\w+$/
</dataPattern>
229 <comment>Nickname.
</comment>
234 <name>legal_name
</name>
242 <import>true
</import>
243 <headerPattern>/^legal|(l(egal\s)?name)$/i
</headerPattern>
244 <comment>Legal Name.
</comment>
249 <name>home_URL
</name>
251 <title>Website
</title>
259 <import>true
</import>
260 <headerPattern>/^(home\sURL)|URL|web|site/i
</headerPattern>
261 <dataPattern>/^[\w\/\:\.]+$/
</dataPattern>
262 <comment>optional
"home page" URL for this contact.
</comment>
267 <name>image_URL
</name>
270 <import>true
</import>
271 <comment>optional URL for preferred image (photo, logo, etc.) to display for this contact.
</comment>
278 <name>preferred_communication_method
</name>
279 <title>Preferred Communication Method
</title>
282 <import>true
</import>
283 <headerPattern>/^p(ref\w*\s)?c(omm\w*)|( meth\w*)$/i
</headerPattern>
284 <dataPattern>/^\w+$/
</dataPattern>
285 <comment>What is the preferred mode of communication.
</comment>
288 <optionGroupName>preferred_communication_method
</optionGroupName>
295 <name>index_preferred_communication_method
</name>
296 <fieldName>preferred_communication_method
</fieldName>
300 <name>preferred_language
</name>
301 <title>Preferred Language
</title>
304 <comment>Which language is preferred for communication. FK to languages in civicrm_option_value.
</comment>
305 <headerPattern>/^lang/i
</headerPattern>
306 <import>true
</import>
308 <optionGroupName>languages
</optionGroupName>
309 <keyColumn>name
</keyColumn>
317 <name>preferred_mail_format
</name>
320 <default>"Both"</default>
321 <import>true
</import>
322 <headerPattern>/^p(ref\w*\s)?m(ail\s)?f(orm\w*)$/i
</headerPattern>
323 <comment>What is the preferred mode of sending an email.
</comment>
326 <callback>CRM_Core_SelectValues::pmf
</callback>
334 <title>Contact Hash
</title>
337 <comment>Key for validating requests related to this contact.
</comment>
340 <export>true
</export>
343 <name>index_hash
</name>
344 <fieldName>hash
</fieldName>
351 <comment>API Key for validating requests related to this contact.
</comment>
355 <name>index_api_key
</name>
356 <fieldName>api_key
</fieldName>
361 <title>Source of Contact Data
</title>
362 <uniqueName>contact_source
</uniqueName>
370 <import>true
</import>
371 <headerPattern>/(S(ource\s)?o(f\s)?C(ontact\s)?Data)$/i
</headerPattern>
372 <comment>where contact come from, e.g. import, donate module insert...
</comment>
376 <name>first_name
</name>
383 <import>true
</import>
384 <headerPattern>/^first|(f(irst\s)?name)$/i
</headerPattern>
385 <dataPattern>/^\w+$/
</dataPattern>
387 <comment>First Name.
</comment>
391 <name>index_first_name
</name>
392 <fieldName>first_name
</fieldName>
396 <name>middle_name
</name>
403 <import>true
</import>
404 <headerPattern>/^middle|(m(iddle\s)?name)$/i
</headerPattern>
405 <dataPattern>/^\w+$/
</dataPattern>
407 <comment>Middle Name.
</comment>
411 <name>last_name
</name>
418 <import>true
</import>
419 <headerPattern>/^last|(l(ast\s)?name)$/i
</headerPattern>
420 <dataPattern>/^\w+(\s\w+)?+$/
</dataPattern>
421 <comment>Last Name.
</comment>
426 <name>index_last_name
</name>
427 <fieldName>last_name
</fieldName>
434 <name>prefix_id
</name>
435 <title>Individual Prefix
</title>
436 <type>int unsigned
</type>
437 <comment>Prefix or Title for name (Ms, Mr...). FK to prefix ID
</comment>
439 <optionGroupName>individual_prefix
</optionGroupName>
444 <headerPattern>/^(prefix|title)/i
</headerPattern>
445 <dataPattern>/^(mr|ms|mrs|sir|dr)\.?$/i
</dataPattern>
446 <import>true
</import>
450 <name>UI_prefix
</name>
451 <fieldName>prefix_id
</fieldName>
455 <name>suffix_id
</name>
456 <title>Individual Suffix
</title>
457 <type>int unsigned
</type>
459 <optionGroupName>individual_suffix
</optionGroupName>
464 <import>true
</import>
465 <comment>Suffix for name (Jr, Sr...). FK to suffix ID
</comment>
466 <headerPattern>/^suffix$/i
</headerPattern>
467 <dataPattern>/^(sr|jr)\.?|i{
2,}$/
</dataPattern>
471 <name>UI_suffix
</name>
472 <fieldName>suffix_id
</fieldName>
476 <name>formal_title
</name>
479 <import>true
</import>
480 <headerPattern>/^title/i
</headerPattern>
481 <comment>Formal (academic or similar) title in front of name. (Prof., Dr. etc.)
</comment>
485 <name>communication_style_id
</name>
486 <title>Communication Style
</title>
487 <type>int unsigned
</type>
489 <optionGroupName>communication_style
</optionGroupName>
491 <export>true
</export>
492 <comment>Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.
</comment>
496 <name>index_communication_style_id
</name>
497 <fieldName>communication_style_id
</fieldName>
501 <name>greeting_type
</name>
504 <import>true
</import>
505 <comment>Preferred greeting format.
</comment>
510 <name>greeting_type_id
</name>
511 <title>Greeting Type
</title>
512 <type>int unsigned
</type>
513 <comment>FK to civicrm_option_value.id, that has to be valid, registered Greeting type.
</comment>
518 <name>custom_greeting
</name>
521 <import>true
</import>
522 <comment>Custom greeting message.
</comment>
527 <name>email_greeting_id
</name>
528 <type>int unsigned
</type>
529 <title>Email Greeting ID
</title>
530 <comment>FK to civicrm_option_value.id, that has to be valid registered Email Greeting.
</comment>
534 <name>email_greeting_custom
</name>
537 <import>true
</import>
538 <export>false
</export>
539 <comment>Custom Email Greeting.
</comment>
546 <name>email_greeting_display
</name>
547 <title>Email Greeting
</title>
550 <comment>Cache Email Greeting.
</comment>
557 <name>postal_greeting_id
</name>
558 <type>int unsigned
</type>
559 <title>Postal Greeting ID
</title>
560 <comment>FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.
</comment>
567 <name>postal_greeting_custom
</name>
570 <import>true
</import>
571 <export>false
</export>
572 <comment>Custom Postal greeting.
</comment>
579 <name>postal_greeting_display
</name>
580 <title>Postal Greeting
</title>
583 <comment>Cache Postal greeting.
</comment>
590 <name>addressee_id
</name>
591 <type>int unsigned
</type>
592 <title>Addressee ID
</title>
593 <comment>FK to civicrm_option_value.id, that has to be valid registered Addressee.
</comment>
597 <name>addressee_custom
</name>
600 <import>true
</import>
601 <export>false
</export>
602 <comment>Custom Addressee.
</comment>
609 <name>addressee_display
</name>
610 <title>Addressee
</title>
613 <comment>Cache Addressee.
</comment>
620 <name>job_title
</name>
627 <import>true
</import>
628 <headerPattern>/^job|(j(ob\s)?title)$/i
</headerPattern>
629 <dataPattern>//
</dataPattern>
630 <comment>Job Title
</comment>
634 <name>gender_id
</name>
635 <title>Gender
</title>
636 <type>int unsigned
</type>
638 <optionGroupName>gender
</optionGroupName>
643 <headerPattern>/^gender$/i
</headerPattern>
644 <comment>FK to gender ID
</comment>
645 <import>true
</import>
649 <name>UI_gender
</name>
650 <fieldName>gender_id
</fieldName>
657 <name>birth_date
</name>
659 <import>true
</import>
660 <headerPattern>/^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i
</headerPattern>
661 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
662 <comment>Date of birth
</comment>
665 <type>Select Date
</type>
669 <name>is_deceased
</name>
670 <title>Is Deceased
</title>
671 <import>true
</import>
672 <export>true
</export>
673 <headerPattern>/i(s\s)?d(eceased)$/i
</headerPattern>
678 <type>CheckBox
</type>
682 <name>deceased_date
</name>
684 <import>true
</import>
685 <export>true
</export>
686 <headerPattern>/^deceased|(d(eceased\s)?date)$/i
</headerPattern>
687 <comment>Date of deceased
</comment>
690 <type>Select Date
</type>
694 <name>mail_to_household_id
</name>
695 <title>Mail to Household ID
</title>
696 <type>int unsigned
</type>
697 <comment>OPTIONAL FK to civicrm_contact_household record. If NOT NULL, direct mail communications to household rather than individual location.
</comment>
698 <export>true
</export>
703 <name>mail_to_household_id
</name>
704 <table>civicrm_contact
</table>
707 <onDelete>SET NULL
</onDelete>
711 <name>household_name
</name>
718 <import>true
</import>
719 <headerPattern>/^household|(h(ousehold\s)?name)$/i
</headerPattern>
720 <dataPattern>/^\w+$/
</dataPattern>
721 <comment>Household Name.
</comment>
726 <name>index_household_name
</name>
727 <fieldName>household_name
</fieldName>
731 <name>primary_contact_id
</name>
732 <type>int unsigned
</type>
733 <title>Household Primary Contact ID
</title>
734 <comment>Optional FK to Primary Contact for this household.
</comment>
741 <name>primary_contact_id
</name>
742 <table>civicrm_contact
</table>
745 <onDelete>SET NULL
</onDelete>
748 <name>organization_name
</name>
755 <import>true
</import>
756 <headerPattern>/^organization|(o(rganization\s)?name)$/i
</headerPattern>
757 <dataPattern>/^\w+$/
</dataPattern>
758 <comment>Organization Name.
</comment>
763 <name>index_organization_name
</name>
764 <fieldName>organization_name
</fieldName>
768 <name>sic_code
</name>
771 <import>true
</import>
772 <headerPattern>/^sic|(s(ic\s)?code)$/i
</headerPattern>
773 <comment>Standard Industry Classification Code.
</comment>
780 <name>user_unique_id
</name>
782 <title>Unique ID (OpenID)
</title>
785 <import>true
</import>
786 <headerPattern>/^Open\s?ID|u(niq\w*)?\s?ID/i
</headerPattern>
787 <dataPattern>/^[\w\/\:\.]+$/
</dataPattern>
788 <comment>the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM
</comment>
795 <name>employer_id
</name>
796 <title>Current Employer ID
</title>
797 <uniqueName>current_employer_id
</uniqueName>
798 <type>int unsigned
</type>
799 <comment>OPTIONAL FK to civicrm_contact record.
</comment>
800 <export>true
</export>
803 <type>Autocomplete-Select
</type>
807 <name>employer_id
</name>
808 <table>civicrm_contact
</table>
811 <onDelete>SET NULL
</onDelete>
814 <name>is_deleted
</name>
815 <title>Contact is in Trash
</title>
816 <uniqueName>contact_is_deleted
</uniqueName>
819 <required>true
</required>
820 <export>true
</export>
823 <type>CheckBox
</type>
827 <name>index_is_deleted
</name>
828 <fieldName>is_deleted
</fieldName>
833 <name>index_is_deleted_sort_name
</name>
834 <fieldName>is_deleted
</fieldName>
835 <fieldName>sort_name
</fieldName>
836 <fieldName>id
</fieldName>
840 <name>created_date
</name>
841 <type>timestamp
</type>
842 <comment>When was the contact was created.
</comment>
843 <required>false
</required>
844 <export>true
</export>
845 <default>NULL
</default>
849 <name>modified_date
</name>
850 <type>timestamp
</type>
851 <comment>When was the contact (or closely related entity) was created or modified or deleted.
</comment>
852 <required>false
</required>
853 <export>true
</export>
854 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>