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>
319 <values>Text, HTML, Both
</values>
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>
331 <title>Contact Hash
</title>
334 <comment>Key for validating requests related to this contact.
</comment>
337 <export>true
</export>
340 <name>index_hash
</name>
341 <fieldName>hash
</fieldName>
348 <comment>API Key for validating requests related to this contact.
</comment>
352 <name>index_api_key
</name>
353 <fieldName>api_key
</fieldName>
358 <title>Source of Contact Data
</title>
359 <uniqueName>contact_source
</uniqueName>
367 <import>true
</import>
368 <headerPattern>/(S(ource\s)?o(f\s)?C(ontact\s)?Data)$/i
</headerPattern>
369 <comment>where contact come from, e.g. import, donate module insert...
</comment>
373 <name>first_name
</name>
380 <import>true
</import>
381 <headerPattern>/^first|(f(irst\s)?name)$/i
</headerPattern>
382 <dataPattern>/^\w+$/
</dataPattern>
384 <comment>First Name.
</comment>
388 <name>index_first_name
</name>
389 <fieldName>first_name
</fieldName>
393 <name>middle_name
</name>
400 <import>true
</import>
401 <headerPattern>/^middle|(m(iddle\s)?name)$/i
</headerPattern>
402 <dataPattern>/^\w+$/
</dataPattern>
404 <comment>Middle Name.
</comment>
408 <name>last_name
</name>
415 <import>true
</import>
416 <headerPattern>/^last|(l(ast\s)?name)$/i
</headerPattern>
417 <dataPattern>/^\w+(\s\w+)?+$/
</dataPattern>
418 <comment>Last Name.
</comment>
423 <name>index_last_name
</name>
424 <fieldName>last_name
</fieldName>
431 <name>prefix_id
</name>
432 <title>Individual Prefix
</title>
433 <type>int unsigned
</type>
434 <comment>Prefix or Title for name (Ms, Mr...). FK to prefix ID
</comment>
436 <optionGroupName>individual_prefix
</optionGroupName>
441 <headerPattern>/^(prefix|title)/i
</headerPattern>
442 <dataPattern>/^(mr|ms|mrs|sir|dr)\.?$/i
</dataPattern>
443 <import>true
</import>
447 <name>UI_prefix
</name>
448 <fieldName>prefix_id
</fieldName>
452 <name>suffix_id
</name>
453 <title>Individual Suffix
</title>
454 <type>int unsigned
</type>
456 <optionGroupName>individual_suffix
</optionGroupName>
461 <import>true
</import>
462 <comment>Suffix for name (Jr, Sr...). FK to suffix ID
</comment>
463 <headerPattern>/^suffix$/i
</headerPattern>
464 <dataPattern>/^(sr|jr)\.?|i{
2,}$/
</dataPattern>
468 <name>UI_suffix
</name>
469 <fieldName>suffix_id
</fieldName>
473 <name>formal_title
</name>
476 <import>true
</import>
477 <headerPattern>/^title/i
</headerPattern>
478 <comment>Formal (academic or similar) title in front of name. (Prof., Dr. etc.)
</comment>
482 <name>communication_style_id
</name>
483 <title>Communication Style
</title>
484 <type>int unsigned
</type>
486 <optionGroupName>communication_style
</optionGroupName>
488 <export>true
</export>
489 <comment>Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.
</comment>
493 <name>index_communication_style_id
</name>
494 <fieldName>communication_style_id
</fieldName>
498 <name>greeting_type
</name>
501 <import>true
</import>
502 <comment>Preferred greeting format.
</comment>
507 <name>greeting_type_id
</name>
508 <title>Greeting Type
</title>
509 <type>int unsigned
</type>
510 <comment>FK to civicrm_option_value.id, that has to be valid, registered Greeting type.
</comment>
515 <name>custom_greeting
</name>
518 <import>true
</import>
519 <comment>Custom greeting message.
</comment>
524 <name>email_greeting_id
</name>
525 <type>int unsigned
</type>
526 <title>Email Greeting ID
</title>
527 <comment>FK to civicrm_option_value.id, that has to be valid registered Email Greeting.
</comment>
531 <name>email_greeting_custom
</name>
534 <import>true
</import>
535 <export>false
</export>
536 <comment>Custom Email Greeting.
</comment>
543 <name>email_greeting_display
</name>
544 <title>Email Greeting
</title>
547 <comment>Cache Email Greeting.
</comment>
554 <name>postal_greeting_id
</name>
555 <type>int unsigned
</type>
556 <title>Postal Greeting ID
</title>
557 <comment>FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.
</comment>
564 <name>postal_greeting_custom
</name>
567 <import>true
</import>
568 <export>false
</export>
569 <comment>Custom Postal greeting.
</comment>
576 <name>postal_greeting_display
</name>
577 <title>Postal Greeting
</title>
580 <comment>Cache Postal greeting.
</comment>
587 <name>addressee_id
</name>
588 <type>int unsigned
</type>
589 <title>Addressee ID
</title>
590 <comment>FK to civicrm_option_value.id, that has to be valid registered Addressee.
</comment>
594 <name>addressee_custom
</name>
597 <import>true
</import>
598 <export>false
</export>
599 <comment>Custom Addressee.
</comment>
606 <name>addressee_display
</name>
607 <title>Addressee
</title>
610 <comment>Cache Addressee.
</comment>
617 <name>job_title
</name>
624 <import>true
</import>
625 <headerPattern>/^job|(j(ob\s)?title)$/i
</headerPattern>
626 <dataPattern>//
</dataPattern>
627 <comment>Job Title
</comment>
631 <name>gender_id
</name>
632 <title>Gender
</title>
633 <type>int unsigned
</type>
635 <optionGroupName>gender
</optionGroupName>
640 <headerPattern>/^gender$/i
</headerPattern>
641 <comment>FK to gender ID
</comment>
642 <import>true
</import>
646 <name>UI_gender
</name>
647 <fieldName>gender_id
</fieldName>
654 <name>birth_date
</name>
656 <import>true
</import>
657 <headerPattern>/^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i
</headerPattern>
658 <dataPattern>/\d{
4}-?\d{
2}-?\d{
2}/
</dataPattern>
659 <comment>Date of birth
</comment>
662 <type>Select Date
</type>
666 <name>is_deceased
</name>
667 <title>Is Deceased
</title>
668 <import>true
</import>
669 <export>true
</export>
670 <headerPattern>/i(s\s)?d(eceased)$/i
</headerPattern>
675 <type>CheckBox
</type>
679 <name>deceased_date
</name>
681 <import>true
</import>
682 <export>true
</export>
683 <headerPattern>/^deceased|(d(eceased\s)?date)$/i
</headerPattern>
684 <comment>Date of deceased
</comment>
687 <type>Select Date
</type>
691 <name>mail_to_household_id
</name>
692 <title>Mail to Household ID
</title>
693 <type>int unsigned
</type>
694 <comment>OPTIONAL FK to civicrm_contact_household record. If NOT NULL, direct mail communications to household rather than individual location.
</comment>
695 <export>true
</export>
700 <name>mail_to_household_id
</name>
701 <table>civicrm_contact
</table>
704 <onDelete>SET NULL
</onDelete>
708 <name>household_name
</name>
715 <import>true
</import>
716 <headerPattern>/^household|(h(ousehold\s)?name)$/i
</headerPattern>
717 <dataPattern>/^\w+$/
</dataPattern>
718 <comment>Household Name.
</comment>
723 <name>index_household_name
</name>
724 <fieldName>household_name
</fieldName>
728 <name>primary_contact_id
</name>
729 <type>int unsigned
</type>
730 <title>Household Primary Contact ID
</title>
731 <comment>Optional FK to Primary Contact for this household.
</comment>
738 <name>primary_contact_id
</name>
739 <table>civicrm_contact
</table>
742 <onDelete>SET NULL
</onDelete>
745 <name>organization_name
</name>
752 <import>true
</import>
753 <headerPattern>/^organization|(o(rganization\s)?name)$/i
</headerPattern>
754 <dataPattern>/^\w+$/
</dataPattern>
755 <comment>Organization Name.
</comment>
760 <name>index_organization_name
</name>
761 <fieldName>organization_name
</fieldName>
765 <name>sic_code
</name>
768 <import>true
</import>
769 <headerPattern>/^sic|(s(ic\s)?code)$/i
</headerPattern>
770 <comment>Standard Industry Classification Code.
</comment>
777 <name>user_unique_id
</name>
779 <title>Unique ID (OpenID)
</title>
782 <import>true
</import>
783 <headerPattern>/^Open\s?ID|u(niq\w*)?\s?ID/i
</headerPattern>
784 <dataPattern>/^[\w\/\:\.]+$/
</dataPattern>
785 <comment>the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM
</comment>
792 <name>employer_id
</name>
793 <title>Current Employer ID
</title>
794 <uniqueName>current_employer_id
</uniqueName>
795 <type>int unsigned
</type>
796 <comment>OPTIONAL FK to civicrm_contact record.
</comment>
797 <export>true
</export>
800 <type>Autocomplete-Select
</type>
804 <name>employer_id
</name>
805 <table>civicrm_contact
</table>
808 <onDelete>SET NULL
</onDelete>
811 <name>is_deleted
</name>
812 <title>Contact is in Trash
</title>
813 <uniqueName>contact_is_deleted
</uniqueName>
816 <required>true
</required>
817 <export>true
</export>
820 <type>CheckBox
</type>
824 <name>index_is_deleted
</name>
825 <fieldName>is_deleted
</fieldName>
830 <name>index_is_deleted_sort_name
</name>
831 <fieldName>is_deleted
</fieldName>
832 <fieldName>sort_name
</fieldName>
833 <fieldName>id
</fieldName>
837 <name>created_date
</name>
838 <type>timestamp
</type>
839 <comment>When was the contact was created.
</comment>
840 <required>false
</required>
841 <default>NULL
</default>
845 <name>modified_date
</name>
846 <type>timestamp
</type>
847 <comment>When was the contact (or closely related entity) was created or modified or deleted.
</comment>
848 <required>false
</required>
849 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
</default>