X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=xml%2Fschema%2FContact%2FContact.xml;h=9b21b6e0d1e77f14c7860c88296387e4420a7faa;hb=493c757190d33b6818048dae6053d22ef153acc9;hp=374fa6a61da3e3dde5a2440365016b927a5e8f65;hpb=c90a093af5607c80a76a7af50f76d2c1d5bf4f37;p=civicrm-core.git diff --git a/xml/schema/Contact/Contact.xml b/xml/schema/Contact/Contact.xml index 374fa6a61d..9b21b6e0d1 100644 --- a/xml/schema/Contact/Contact.xml +++ b/xml/schema/Contact/Contact.xml @@ -7,131 +7,131 @@ Contact objects are defined by a civicrm_contact record plus a related civicrm_contact_type record. 1.1 true - - id - int unsigned - Internal Contact ID - true - /internal|contact?|id$/i - true - Unique Contact ID - 1.1 + + id + int unsigned + Internal Contact ID + true + /internal|contact?|id$/i + true + Unique Contact ID + 1.1 - id - true + id + true - contact_type - Contact Type - varchar - 64 - Type of Contact. - true - - civicrm_contact_type
- name - label - parent_id IS NULL - - - Select - - 1.1 - 3.1 + contact_type + Contact Type + varchar + 64 + Type of Contact. + true + + civicrm_contact_type
+ name + label + parent_id IS NULL + + + Select + + 1.1 + 3.1 - index_contact_type - contact_type - 2.1 + index_contact_type + contact_type + 2.1 - contact_sub_type - Contact Subtype - varchar - 255 - true - true - /C(ontact )?(subtype|sub-type|sub type)/i - May be used to over-ride contact view and edit templates. - - civicrm_contact_type
- name - label - parent_id IS NOT NULL - - - Multi-Select - - 1.5 + contact_sub_type + Contact Subtype + varchar + 255 + true + true + /C(ontact )?(subtype|sub-type|sub type)/i + May be used to over-ride contact view and edit templates. + + civicrm_contact_type
+ name + label + parent_id IS NOT NULL + + + Multi-Select + + 1.5 - index_contact_sub_type - contact_sub_type - - Multi-Select - - 2.1 + index_contact_sub_type + contact_sub_type + + Multi-Select + + 2.1 - do_not_email - boolean - true - /d(o )?(not )?(email)/i - /^\d{1,}$/ - 0 - - CheckBox - - 1.1 - - - do_not_phone - boolean - 0 - true - /d(o )?(not )?(call|phone)/i - /^\d{1,}$/ - 1.1 - - CheckBox - - - - do_not_mail - boolean - true - /^(d(o\s)?n(ot\s)?mail)|(\w*)?bulk\s?(\w*)$/i - /^\d{1,}$/ - 0 - 1.1 - - CheckBox - - - - do_not_sms - boolean - true - /d(o )?(not )?(sms)/i - /^\d{1,}$/ - 0 - 3.0 - - CheckBox - - - - do_not_trade - boolean - true - /d(o )?(not )?(trade)/i - /^\d{1,}$/ - 0 - 1.1 - - CheckBox - + do_not_email + boolean + true + /d(o )?(not )?(email)/i + /^\d{1,}$/ + 0 + + CheckBox + + 1.1 + + + do_not_phone + boolean + 0 + true + /d(o )?(not )?(call|phone)/i + /^\d{1,}$/ + 1.1 + + CheckBox + + + + do_not_mail + boolean + true + /^(d(o\s)?n(ot\s)?mail)|(\w*)?bulk\s?(\w*)$/i + /^\d{1,}$/ + 0 + 1.1 + + CheckBox + + + + do_not_sms + boolean + true + /d(o )?(not )?(sms)/i + /^\d{1,}$/ + 0 + 3.0 + + CheckBox + + + + do_not_trade + boolean + true + /d(o )?(not )?(trade)/i + /^\d{1,}$/ + 0 + 1.1 + + CheckBox + is_opt_out @@ -143,672 +143,673 @@ Has the contact opted out from receiving all bulk email from the organization or site domain? 1.1 - CheckBox - + CheckBox + - legal_identifier - varchar - 32 - true - /legal\s?id/i - /\w+?\d{5,}/ - May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID. - 1.1 - - Text - + legal_identifier + varchar + 32 + true + /legal\s?id/i + /\w+?\d{5,}/ + May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID. + + 1.1 + + Text + - external_identifier - varchar - 32 - - Text - EIGHT - + external_identifier + varchar + 32 + + Text + EIGHT + - true - /external\s?id/i - /^\d{11,}$/ - Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations. - 1.1 + true + /external\s?id/i + /^\d{11,}$/ + Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations. + 1.1 - UI_external_identifier - true - external_identifier - 1.7 + UI_external_identifier + true + external_identifier + 1.7 - sort_name - Sort Name - varchar - 128 - - Text - BIG - + sort_name + Sort Name + varchar + 128 + + Text + BIG + - true - Name used for sorting different contact types - 1.1 + true + Name used for sorting different contact types + 1.1 - index_sort_name - sort_name - 2.1 + index_sort_name + sort_name + 2.1 - display_name - Display Name - varchar - 128 - - Text - BIG - + display_name + Display Name + varchar + 128 + + Text + BIG + - true - Formatted name representing preferred format for display/print/other output. - 1.1 - - - nick_name - Nickname - varchar - 128 - - Text - BIG - + true + Formatted name representing preferred format for display/print/other output. + 1.1 + + + nick_name + Nickname + varchar + 128 + + Text + BIG + - true - /n(ick\s)name|nick$/i - /^\w+$/ - Nickname. - - 1.1 - - - legal_name - varchar - 128 - - Text - BIG - + true + /n(ick\s)name|nick$/i + /^\w+$/ + Nickname. + + 1.1 + + + legal_name + varchar + 128 + + Text + BIG + - true - /^legal|(l(egal\s)?name)$/i - Legal Name. - - 1.1 - - - home_URL - url - Website - varchar - 128 - - Text - BIG - + true + /^legal|(l(egal\s)?name)$/i + Legal Name. + + 1.1 + + + home_URL + url + Website + varchar + 128 + + Text + BIG + - true - /^(home\sURL)|URL|web|site/i - /^[\w\/\:\.]+$/ - optional "home page" URL for this contact. - 1.1 - 3.2 - - - image_URL - varchar - 255 - true - optional URL for preferred image (photo, logo, etc.) to display for this contact. - 1.1 - - Text - - - - preferred_communication_method - Preferred Communication Method - varchar - 255 - true - /^p(ref\w*\s)?c(omm\w*)|( meth\w*)$/i - /^\w+$/ - What is the preferred mode of communication. - 1.1 - - preferred_communication_method - - - Select - + true + /^(home\sURL)|URL|web|site/i + /^[\w\/\:\.]+$/ + optional "home page" URL for this contact. + 1.1 + 3.2 + + + image_URL + varchar + 255 + true + optional URL for preferred image (photo, logo, etc.) to display for this contact. + 1.1 + + Text + + + + preferred_communication_method + Preferred Communication Method + varchar + 255 + true + /^p(ref\w*\s)?c(omm\w*)|( meth\w*)$/i + /^\w+$/ + What is the preferred mode of communication. + 1.1 + + preferred_communication_method + + + Select + - index_preferred_communication_method - preferred_communication_method - 1.6 + index_preferred_communication_method + preferred_communication_method + 1.6 - preferred_language - Preferred Language - varchar - 5 - Which language is preferred for communication. FK to languages in civicrm_option_value. - /^lang/i - true - - languages - name - - - Select - - 3.2 - - - preferred_mail_format - varchar - 8 - "Both" - true - /^p(ref\w*\s)?m(ail\s)?f(orm\w*)$/i - What is the preferred mode of sending an email. - 1.1 - - CRM_Core_SelectValues::pmf - - - Select - - - - hash - Contact Hash - varchar - 32 - Key for validating requests related to this contact. - 1.1 - 1.5 - true + preferred_language + Preferred Language + varchar + 5 + Which language is preferred for communication. FK to languages in civicrm_option_value. + /^lang/i + true + + languages + name + + + Select + + 3.2 + + + preferred_mail_format + varchar + 8 + "Both" + true + /^p(ref\w*\s)?m(ail\s)?f(orm\w*)$/i + What is the preferred mode of sending an email. + 1.1 + + CRM_Core_SelectValues::pmf + + + Select + + + + hash + Contact Hash + varchar + 32 + Key for validating requests related to this contact. + 1.1 + 1.5 + true - index_hash - hash - 2.1 + index_hash + hash + 2.1 - api_key - varchar - 32 - API Key for validating requests related to this contact. - 2.2 + api_key + varchar + 32 + API Key for validating requests related to this contact. + 2.2 - index_api_key - api_key - 2.1 + index_api_key + api_key + 2.1 - source - Source of Contact Data - contact_source - varchar - 255 - - Text - BIG - + source + Source of Contact Data + contact_source + varchar + 255 + + Text + BIG + - true - /(S(ource\s)?o(f\s)?C(ontact\s)?Data)$/i - where contact come from, e.g. import, donate module insert... - 1.1 - - - first_name - varchar - 64 - - Text - BIG - - true - /^first|(f(irst\s)?name)$/i - /^\w+$/ - - First Name. - 1.1 + true + /(S(ource\s)?o(f\s)?C(ontact\s)?Data)$/i + where contact come from, e.g. import, donate module insert... + 1.1 + + + first_name + varchar + 64 + + Text + BIG + + true + /^first|(f(irst\s)?name)$/i + /^\w+$/ + + First Name. + 1.1 - index_first_name - first_name - 1.8 + index_first_name + first_name + 1.8 - middle_name - varchar - 64 - - Text - MEDIUM - - true - /^middle|(m(iddle\s)?name)$/i - /^\w+$/ - - Middle Name. - 1.1 - - - last_name - varchar - 64 - - Text - BIG - - true - /^last|(l(ast\s)?name)$/i - /^\w+(\s\w+)?+$/ - Last Name. - - 1.1 + middle_name + varchar + 64 + + Text + MEDIUM + + true + /^middle|(m(iddle\s)?name)$/i + /^\w+$/ + + Middle Name. + 1.1 + + + last_name + varchar + 64 + + Text + BIG + + true + /^last|(l(ast\s)?name)$/i + /^\w+(\s\w+)?+$/ + Last Name. + + 1.1 - index_last_name - last_name - 1.8 - - Text - + index_last_name + last_name + 1.8 + + Text + - prefix_id - Individual Prefix - int unsigned - Prefix or Title for name (Ms, Mr...). FK to prefix ID - - individual_prefix - - - Select - - /^(prefix|title)/i - /^(mr|ms|mrs|sir|dr)\.?$/i - true - 1.2 + prefix_id + Individual Prefix + int unsigned + Prefix or Title for name (Ms, Mr...). FK to prefix ID + + individual_prefix + + + Select + + /^(prefix|title)/i + /^(mr|ms|mrs|sir|dr)\.?$/i + true + 1.2 - UI_prefix - prefix_id - 1.6 + UI_prefix + prefix_id + 1.6 - suffix_id - Individual Suffix - int unsigned - - individual_suffix - - - Select - - true - Suffix for name (Jr, Sr...). FK to suffix ID - /^suffix$/i - /^(sr|jr)\.?|i{2,}$/ - 1.2 + suffix_id + Individual Suffix + int unsigned + + individual_suffix + + + Select + + true + Suffix for name (Jr, Sr...). FK to suffix ID + /^suffix$/i + /^(sr|jr)\.?|i{2,}$/ + 1.2 - UI_suffix - suffix_id - 1.6 + UI_suffix + suffix_id + 1.6 - formal_title - varchar - 64 - true - /^title/i - Formal (academic or similar) title in front of name. (Prof., Dr. etc.) - 4.5 - - - communication_style_id - Communication Style - int unsigned - - communication_style - - true - Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value. - 4.4 + formal_title + varchar + 64 + true + /^title/i + Formal (academic or similar) title in front of name. (Prof., Dr. etc.) + 4.5 + + + communication_style_id + Communication Style + int unsigned + + communication_style + + true + Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value. + 4.4 - index_communication_style_id - communication_style_id - 4.4 + index_communication_style_id + communication_style_id + 4.4 - greeting_type - varchar - 128 - true - Preferred greeting format. - 1.1 - 2.2 - - - greeting_type_id - Greeting Type - int unsigned - FK to civicrm_option_value.id, that has to be valid, registered Greeting type. - 2.2 - 3.0 - - - custom_greeting - varchar - 128 - true - Custom greeting message. - 1.1 - 3.0 - - - email_greeting_id - int unsigned - Email Greeting ID - FK to civicrm_option_value.id, that has to be valid registered Email Greeting. - 3.0 - - - email_greeting_custom - varchar - 128 - true - false - Custom Email Greeting. - 3.0 - - Text - - - - email_greeting_display - Email Greeting - varchar - 255 - Cache Email Greeting. - 3.0 - - Text - - - - postal_greeting_id - int unsigned - Postal Greeting ID - FK to civicrm_option_value.id, that has to be valid registered Postal Greeting. - 3.0 - - Text - - - - postal_greeting_custom - varchar - 128 - true - false - Custom Postal greeting. - 3.0 - - Text - - - - postal_greeting_display - Postal Greeting - varchar - 255 - Cache Postal greeting. - 3.0 - - Text - - - - addressee_id - int unsigned - Addressee ID - FK to civicrm_option_value.id, that has to be valid registered Addressee. - 3.0 - - - addressee_custom - varchar - 128 - true - false - Custom Addressee. - 3.0 - - Text - - - - addressee_display - Addressee - varchar - 255 - Cache Addressee. - 3.0 - - Text - - - - job_title - varchar - 255 - - Text - MEDIUM - - true - /^job|(j(ob\s)?title)$/i - // - Job Title - 1.1 - - - gender_id - Gender - int unsigned - - gender - - - Select - - /^gender$/i - FK to gender ID - true - 1.2 + greeting_type + varchar + 128 + true + Preferred greeting format. + 1.1 + 2.2 + + + greeting_type_id + Greeting Type + int unsigned + FK to civicrm_option_value.id, that has to be valid, registered Greeting type. + 2.2 + 3.0 + + + custom_greeting + varchar + 128 + true + Custom greeting message. + 1.1 + 3.0 + + + email_greeting_id + int unsigned + Email Greeting ID + FK to civicrm_option_value.id, that has to be valid registered Email Greeting. + 3.0 + + + email_greeting_custom + varchar + 128 + true + false + Custom Email Greeting. + 3.0 + + Text + + + + email_greeting_display + Email Greeting + varchar + 255 + Cache Email Greeting. + 3.0 + + Text + + + + postal_greeting_id + int unsigned + Postal Greeting ID + FK to civicrm_option_value.id, that has to be valid registered Postal Greeting. + 3.0 + + Text + + + + postal_greeting_custom + varchar + 128 + true + false + Custom Postal greeting. + 3.0 + + Text + + + + postal_greeting_display + Postal Greeting + varchar + 255 + Cache Postal greeting. + 3.0 + + Text + + + + addressee_id + int unsigned + Addressee ID + FK to civicrm_option_value.id, that has to be valid registered Addressee. + 3.0 + + + addressee_custom + varchar + 128 + true + false + Custom Addressee. + 3.0 + + Text + + + + addressee_display + Addressee + varchar + 255 + Cache Addressee. + 3.0 + + Text + + + + job_title + varchar + 255 + + Text + MEDIUM + + true + /^job|(j(ob\s)?title)$/i + // + Job Title + 1.1 + + + gender_id + Gender + int unsigned + + gender + + + Select + + /^gender$/i + FK to gender ID + true + 1.2 - UI_gender - gender_id - 1.6 - - Select - + UI_gender + gender_id + 1.6 + + Select + - birth_date - date - true - /^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i - /\d{4}-?\d{2}-?\d{2}/ - Date of birth - 1.1 - - Select Date - - - - is_deceased - Is Deceased - true - true - /i(s\s)?d(eceased)$/i - boolean - 0 - 1.1 - - CheckBox - - - - deceased_date - date - true - true - /^deceased|(d(eceased\s)?date)$/i - Date of deceased - 1.5 - - Select Date - - - - mail_to_household_id - Mail to Household ID - int unsigned - OPTIONAL FK to civicrm_contact_household record. If NOT NULL, direct mail communications to household rather than individual location. - true - 1.1 - 3.3 + birth_date + date + true + /^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i + /\d{4}-?\d{2}-?\d{2}/ + Date of birth + 1.1 + + Select Date + + + + is_deceased + Is Deceased + true + true + /i(s\s)?d(eceased)$/i + boolean + 0 + 1.1 + + CheckBox + + + + deceased_date + date + true + true + /^deceased|(d(eceased\s)?date)$/i + Date of deceased + 1.5 + + Select Date + + + + mail_to_household_id + Mail to Household ID + int unsigned + OPTIONAL FK to civicrm_contact_household record. If NOT NULL, direct mail communications to household rather than individual location. + true + 1.1 + 3.3 - mail_to_household_id - civicrm_contact
- id - 2.1 - SET NULL - 3.3 + mail_to_household_id + civicrm_contact
+ id + 2.1 + SET NULL + 3.3 - household_name - varchar - 128 - - Text - BIG - - true - /^household|(h(ousehold\s)?name)$/i - /^\w+$/ - Household Name. - - 1.1 + household_name + varchar + 128 + + Text + BIG + + true + /^household|(h(ousehold\s)?name)$/i + /^\w+$/ + Household Name. + + 1.1 - index_household_name - household_name - 1.8 + index_household_name + household_name + 1.8 - primary_contact_id - int unsigned - Household Primary Contact ID - Optional FK to Primary Contact for this household. - 1.1 - - Select - + primary_contact_id + int unsigned + Household Primary Contact ID + Optional FK to Primary Contact for this household. + 1.1 + + Select + - primary_contact_id - civicrm_contact
- id - 1.1 - SET NULL + primary_contact_id + civicrm_contact
+ id + 1.1 + SET NULL - organization_name - varchar - 128 - - Text - BIG - - true - /^organization|(o(rganization\s)?name)$/i - /^\w+$/ - Organization Name. - - 1.1 + organization_name + varchar + 128 + + Text + BIG + + true + /^organization|(o(rganization\s)?name)$/i + /^\w+$/ + Organization Name. + + 1.1 - index_organization_name - organization_name - 1.8 + index_organization_name + organization_name + 1.8 - sic_code - varchar - 8 - true - /^sic|(s(ic\s)?code)$/i - Standard Industry Classification Code. - 1.1 - - Text - - - - user_unique_id - url - Unique ID (OpenID) - varchar - 255 - true - /^Open\s?ID|u(niq\w*)?\s?ID/i - /^[\w\/\:\.]+$/ - the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM - 2.0 - - Text - - - - employer_id - Current Employer ID - current_employer_id - int unsigned - OPTIONAL FK to civicrm_contact record. - true - 2.1 - - Autocomplete-Select - + sic_code + varchar + 8 + true + /^sic|(s(ic\s)?code)$/i + Standard Industry Classification Code. + 1.1 + + Text + + + + user_unique_id + url + Unique ID (OpenID) + varchar + 255 + true + /^Open\s?ID|u(niq\w*)?\s?ID/i + /^[\w\/\:\.]+$/ + the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM + 2.0 + + Text + + + + employer_id + Current Employer ID + current_employer_id + int unsigned + OPTIONAL FK to civicrm_contact record. + true + 2.1 + + Autocomplete-Select + - employer_id - civicrm_contact
- id - 2.1 - SET NULL + employer_id + civicrm_contact
+ id + 2.1 + SET NULL is_deleted @@ -841,6 +842,7 @@ timestamp When was the contact was created. false + true NULL 4.3 @@ -849,6 +851,7 @@ timestamp When was the contact (or closely related entity) was created or modified or deleted. false + true CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP 4.3