Merge pull request #22680 from mattwire/paymentstatushelpers
[civicrm-core.git] / xml / schema / Contact / Contact.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
4 <base>CRM/Contact</base>
5 <class>Contact</class>
6 <name>civicrm_contact</name>
7 <comment>Contact objects are defined by a civicrm_contact record plus a related civicrm_contact_type record.</comment>
2562d09a 8 <description>Individuals, organizations, households, etc.</description>
6a488035
TO
9 <add>1.1</add>
10 <log>true</log>
449c4e6b 11 <icon>fa-address-book-o</icon>
8ab43c93 12 <labelField>display_name</labelField>
a7bd99ff 13 <paths>
5c385299 14 <add>civicrm/contact/add?reset=1&amp;ct=[contact_type]</add>
a7bd99ff 15 <view>civicrm/contact/view?reset=1&amp;cid=[id]</view>
5c385299 16 <update>civicrm/contact/add?reset=1&amp;action=update&amp;cid=[id]</update>
a7bd99ff
CW
17 <delete>civicrm/contact/view/delete?reset=1&amp;delete=1&amp;cid=[id]</delete>
18 </paths>
8f069c03
EM
19 <field>
20 <name>id</name>
21 <type>int unsigned</type>
d79be26c 22 <title>Contact ID</title>
8f069c03
EM
23 <import>true</import>
24 <headerPattern>/internal|contact?|id$/i</headerPattern>
25 <required>true</required>
26 <comment>Unique Contact ID</comment>
0481e12c
A
27 <html>
28 <type>Number</type>
29 </html>
8f069c03 30 <add>1.1</add>
6a488035
TO
31 </field>
32 <primaryKey>
8f069c03
EM
33 <name>id</name>
34 <autoincrement>true</autoincrement>
6a488035
TO
35 </primaryKey>
36 <field>
8f069c03
EM
37 <name>contact_type</name>
38 <title>Contact Type</title>
39 <type>varchar</type>
40 <length>64</length>
41 <comment>Type of Contact.</comment>
42 <export>true</export>
43 <pseudoconstant>
44 <table>civicrm_contact_type</table>
45 <keyColumn>name</keyColumn>
46 <labelColumn>label</labelColumn>
47 <condition>parent_id IS NULL</condition>
48 </pseudoconstant>
49 <html>
50 <type>Select</type>
51 </html>
34745448 52 <readonly>true</readonly>
8f069c03
EM
53 <add>1.1</add>
54 <change>3.1</change>
f5c0f096 55 <contactType>null</contactType>
6a488035
TO
56 </field>
57 <index>
8f069c03
EM
58 <name>index_contact_type</name>
59 <fieldName>contact_type</fieldName>
60 <add>2.1</add>
6a488035
TO
61 </index>
62 <field>
8f069c03
EM
63 <name>contact_sub_type</name>
64 <title>Contact Subtype</title>
65 <type>varchar</type>
66 <length>255</length>
67 <export>true</export>
68 <import>true</import>
69 <headerPattern>/C(ontact )?(subtype|sub-type|sub type)/i</headerPattern>
70 <comment>May be used to over-ride contact view and edit templates.</comment>
71 <pseudoconstant>
72 <table>civicrm_contact_type</table>
73 <keyColumn>name</keyColumn>
74 <labelColumn>label</labelColumn>
75 <condition>parent_id IS NOT NULL</condition>
76 </pseudoconstant>
77 <html>
916b6181
CW
78 <type>Select</type>
79 <multiple>1</multiple>
8f069c03 80 </html>
2a5c9b4d 81 <serialize>SEPARATOR_BOOKEND</serialize>
8f069c03 82 <add>1.5</add>
6a488035
TO
83 </field>
84 <index>
8f069c03
EM
85 <name>index_contact_sub_type</name>
86 <fieldName>contact_sub_type</fieldName>
8f069c03 87 <add>2.1</add>
6a488035
TO
88 </index>
89 <field>
8f069c03
EM
90 <name>do_not_email</name>
91 <type>boolean</type>
92 <import>true</import>
93 <headerPattern>/d(o )?(not )?(email)/i</headerPattern>
94 <dataPattern>/^\d{1,}$/</dataPattern>
95 <default>0</default>
96 <html>
97 <type>CheckBox</type>
fd735f54 98 <label>Do Not Email</label>
8f069c03
EM
99 </html>
100 <add>1.1</add>
101 </field>
102 <field>
103 <name>do_not_phone</name>
104 <type>boolean</type>
105 <default>0</default>
106 <import>true</import>
107 <headerPattern>/d(o )?(not )?(call|phone)/i</headerPattern>
108 <dataPattern>/^\d{1,}$/</dataPattern>
109 <add>1.1</add>
110 <html>
111 <type>CheckBox</type>
fd735f54 112 <label>Do Not Phone</label>
8f069c03
EM
113 </html>
114 </field>
115 <field>
116 <name>do_not_mail</name>
117 <type>boolean</type>
118 <import>true</import>
119 <headerPattern>/^(d(o\s)?n(ot\s)?mail)|(\w*)?bulk\s?(\w*)$/i</headerPattern>
120 <dataPattern>/^\d{1,}$/</dataPattern>
121 <default>0</default>
122 <add>1.1</add>
123 <html>
124 <type>CheckBox</type>
fd735f54 125 <label>Do Not Mail</label>
8f069c03
EM
126 </html>
127 </field>
128 <field>
129 <name>do_not_sms</name>
130 <type>boolean</type>
131 <import>true</import>
132 <headerPattern>/d(o )?(not )?(sms)/i</headerPattern>
133 <dataPattern>/^\d{1,}$/</dataPattern>
134 <default>0</default>
135 <add>3.0</add>
136 <html>
137 <type>CheckBox</type>
fd735f54 138 <label>Do Not Sms</label>
8f069c03
EM
139 </html>
140 </field>
141 <field>
142 <name>do_not_trade</name>
143 <type>boolean</type>
144 <import>true</import>
145 <headerPattern>/d(o )?(not )?(trade)/i</headerPattern>
146 <dataPattern>/^\d{1,}$/</dataPattern>
147 <default>0</default>
148 <add>1.1</add>
149 <html>
150 <type>CheckBox</type>
fd735f54 151 <label>Do Not Trade</label>
8f069c03 152 </html>
6a488035
TO
153 </field>
154 <field>
155 <name>is_opt_out</name>
156 <type>boolean</type>
157 <title>No Bulk Emails (User Opt Out)</title>
158 <default>0</default>
159 <import>true</import>
160 <required>true</required>
161 <comment>Has the contact opted out from receiving all bulk email from the organization or site domain?</comment>
162 <add>1.1</add>
614d72ec 163 <html>
8f069c03 164 <type>CheckBox</type>
fd735f54 165 <label>Is Opt Out</label>
8f069c03 166 </html>
6a488035
TO
167 </field>
168 <field>
8f069c03
EM
169 <name>legal_identifier</name>
170 <type>varchar</type>
171 <length>32</length>
172 <import>true</import>
173 <headerPattern>/legal\s?id/i</headerPattern>
174 <dataPattern>/\w+?\d{5,}/</dataPattern>
fb607354 175 <comment>May be used for SSN, EIN/TIN, Household ID (census) or other applicable unique legal/government ID.</comment>
8f069c03
EM
176 <add>1.1</add>
177 <html>
178 <type>Text</type>
fd735f54 179 <label>Legal Identifier</label>
8f069c03 180 </html>
6a488035
TO
181 </field>
182 <field>
8f069c03
EM
183 <name>external_identifier</name>
184 <type>varchar</type>
b5618f69 185 <length>64</length>
8f069c03
EM
186 <html>
187 <type>Text</type>
54f5e87f 188 <size>8</size>
fd735f54 189 <label>External Identifier</label>
8f069c03 190 </html>
614d72ec 191
8f069c03
EM
192 <import>true</import>
193 <headerPattern>/external\s?id/i</headerPattern>
194 <dataPattern>/^\d{11,}$/</dataPattern>
a005e91a 195 <comment>Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.</comment>
8f069c03 196 <add>1.1</add>
6a488035
TO
197 </field>
198 <index>
8f069c03
EM
199 <name>UI_external_identifier</name>
200 <unique>true</unique>
201 <fieldName>external_identifier</fieldName>
202 <add>1.7</add>
6a488035
TO
203 </index>
204 <field>
8f069c03
EM
205 <name>sort_name</name>
206 <title>Sort Name</title>
207 <type>varchar</type>
208 <length>128</length>
209 <html>
210 <type>Text</type>
54f5e87f 211 <size>30</size>
8f069c03 212 </html>
34745448 213 <readonly>true</readonly>
8f069c03
EM
214 <export>true</export>
215 <comment>Name used for sorting different contact types</comment>
216 <add>1.1</add>
6a488035
TO
217 </field>
218 <index>
8f069c03
EM
219 <name>index_sort_name</name>
220 <fieldName>sort_name</fieldName>
221 <add>2.1</add>
6a488035
TO
222 </index>
223 <field>
8f069c03
EM
224 <name>display_name</name>
225 <title>Display Name</title>
226 <type>varchar</type>
227 <length>128</length>
228 <html>
229 <type>Text</type>
54f5e87f 230 <size>30</size>
8f069c03 231 </html>
34745448 232 <readonly>true</readonly>
8f069c03
EM
233 <export>true</export>
234 <comment>Formatted name representing preferred format for display/print/other output.</comment>
235 <add>1.1</add>
236 </field>
237 <field>
238 <name>nick_name</name>
239 <title>Nickname</title>
240 <type>varchar</type>
241 <length>128</length>
242 <html>
243 <type>Text</type>
54f5e87f 244 <size>30</size>
8f069c03 245 </html>
614d72ec 246
8f069c03
EM
247 <import>true</import>
248 <headerPattern>/n(ick\s)name|nick$/i</headerPattern>
249 <dataPattern>/^\w+$/</dataPattern>
250 <comment>Nickname.</comment>
251 <fulltext/>
252 <add>1.1</add>
253 </field>
254 <field>
255 <name>legal_name</name>
256 <type>varchar</type>
257 <length>128</length>
258 <html>
259 <type>Text</type>
54f5e87f 260 <size>30</size>
fd735f54 261 <label>Legal Name</label>
8f069c03 262 </html>
b383d043 263 <contactType>Organization</contactType>
8f069c03
EM
264 <import>true</import>
265 <headerPattern>/^legal|(l(egal\s)?name)$/i</headerPattern>
266 <comment>Legal Name.</comment>
267 <fulltext/>
268 <add>1.1</add>
269 </field>
8f069c03
EM
270 <field>
271 <name>image_URL</name>
8e2e96a5 272 <type>text</type>
8f069c03
EM
273 <import>true</import>
274 <comment>optional URL for preferred image (photo, logo, etc.) to display for this contact.</comment>
275 <add>1.1</add>
276 <html>
51479855 277 <type>File</type>
54f5e87f 278 <size>30</size>
fd735f54 279 <label>Image URL</label>
8f069c03
EM
280 </html>
281 </field>
282 <field>
283 <name>preferred_communication_method</name>
284 <title>Preferred Communication Method</title>
285 <type>varchar</type>
286 <length>255</length>
287 <import>true</import>
288 <headerPattern>/^p(ref\w*\s)?c(omm\w*)|( meth\w*)$/i</headerPattern>
289 <dataPattern>/^\w+$/</dataPattern>
290 <comment>What is the preferred mode of communication.</comment>
291 <add>1.1</add>
292 <pseudoconstant>
293 <optionGroupName>preferred_communication_method</optionGroupName>
294 </pseudoconstant>
295 <html>
296 <type>Select</type>
2a5c9b4d 297 <multiple>1</multiple>
8f069c03 298 </html>
2a5c9b4d 299 <serialize>SEPARATOR_BOOKEND</serialize>
6a488035
TO
300 </field>
301 <index>
8f069c03
EM
302 <name>index_preferred_communication_method</name>
303 <fieldName>preferred_communication_method</fieldName>
304 <add>1.6</add>
6a488035
TO
305 </index>
306 <field>
8f069c03
EM
307 <name>preferred_language</name>
308 <title>Preferred Language</title>
309 <type>varchar</type>
310 <length>5</length>
311 <comment>Which language is preferred for communication. FK to languages in civicrm_option_value.</comment>
312 <headerPattern>/^lang/i</headerPattern>
313 <import>true</import>
314 <pseudoconstant>
315 <optionGroupName>languages</optionGroupName>
316 <keyColumn>name</keyColumn>
317 </pseudoconstant>
318 <html>
319 <type>Select</type>
320 </html>
321 <add>3.2</add>
322 </field>
323 <field>
324 <name>preferred_mail_format</name>
325 <type>varchar</type>
326 <length>8</length>
327 <default>"Both"</default>
328 <import>true</import>
329 <headerPattern>/^p(ref\w*\s)?m(ail\s)?f(orm\w*)$/i</headerPattern>
330 <comment>What is the preferred mode of sending an email.</comment>
331 <add>1.1</add>
332 <pseudoconstant>
333 <callback>CRM_Core_SelectValues::pmf</callback>
334 </pseudoconstant>
335 <html>
336 <type>Select</type>
fd735f54 337 <label>Preferred Mail Format</label>
8f069c03
EM
338 </html>
339 </field>
340 <field>
341 <name>hash</name>
342 <title>Contact Hash</title>
343 <type>varchar</type>
344 <length>32</length>
345 <comment>Key for validating requests related to this contact.</comment>
346 <add>1.1</add>
347 <change>1.5</change>
348 <export>true</export>
34745448 349 <readonly>true</readonly>
6a488035
TO
350 </field>
351 <index>
8f069c03
EM
352 <name>index_hash</name>
353 <fieldName>hash</fieldName>
354 <add>2.1</add>
6a488035
TO
355 </index>
356 <field>
8f069c03
EM
357 <name>api_key</name>
358 <type>varchar</type>
359 <length>32</length>
360 <comment>API Key for validating requests related to this contact.</comment>
1662d426
A
361 <html>
362 <label>API KEY</label>
363 </html>
8f069c03 364 <add>2.2</add>
58b0bf5a 365 <readonly>true</readonly>
1713a0ec
CW
366 <permission>
367 <or>administer CiviCRM, edit api keys</or>
368 </permission>
6a488035
TO
369 </field>
370 <index>
8f069c03
EM
371 <name>index_api_key</name>
372 <fieldName>api_key</fieldName>
373 <add>2.1</add>
6a488035
TO
374 </index>
375 <field>
8f069c03 376 <name>source</name>
d79be26c 377 <title>Contact Source</title>
8f069c03
EM
378 <uniqueName>contact_source</uniqueName>
379 <type>varchar</type>
380 <length>255</length>
381 <html>
382 <type>Text</type>
54f5e87f 383 <size>30</size>
8f069c03 384 </html>
614d72ec 385
8f069c03 386 <import>true</import>
d79be26c 387 <headerPattern>/(C(ontact\s)?Source)$/i</headerPattern>
8f069c03
EM
388 <comment>where contact come from, e.g. import, donate module insert...</comment>
389 <add>1.1</add>
390 </field>
391 <field>
392 <name>first_name</name>
393 <type>varchar</type>
394 <length>64</length>
395 <html>
396 <type>Text</type>
54f5e87f 397 <size>30</size>
fd735f54 398 <label>First Name</label>
8f069c03
EM
399 </html>
400 <import>true</import>
401 <headerPattern>/^first|(f(irst\s)?name)$/i</headerPattern>
402 <dataPattern>/^\w+$/</dataPattern>
403 <fulltext/>
404 <comment>First Name.</comment>
405 <add>1.1</add>
f5c0f096 406 <contactType>Individual</contactType>
6a488035
TO
407 </field>
408 <index>
8f069c03
EM
409 <name>index_first_name</name>
410 <fieldName>first_name</fieldName>
411 <add>1.8</add>
6a488035
TO
412 </index>
413 <field>
8f069c03
EM
414 <name>middle_name</name>
415 <type>varchar</type>
416 <length>64</length>
417 <html>
418 <type>Text</type>
54f5e87f 419 <size>30</size>
fd735f54 420 <label>Middle Name</label>
8f069c03
EM
421 </html>
422 <import>true</import>
423 <headerPattern>/^middle|(m(iddle\s)?name)$/i</headerPattern>
424 <dataPattern>/^\w+$/</dataPattern>
425 <fulltext/>
426 <comment>Middle Name.</comment>
427 <add>1.1</add>
f5c0f096 428 <contactType>Individual</contactType>
8f069c03
EM
429 </field>
430 <field>
431 <name>last_name</name>
432 <type>varchar</type>
433 <length>64</length>
434 <html>
435 <type>Text</type>
54f5e87f 436 <size>30</size>
fd735f54 437 <label>Last Name</label>
8f069c03
EM
438 </html>
439 <import>true</import>
440 <headerPattern>/^last|(l(ast\s)?name)$/i</headerPattern>
441 <dataPattern>/^\w+(\s\w+)?+$/</dataPattern>
442 <comment>Last Name.</comment>
443 <fulltext/>
444 <add>1.1</add>
f5c0f096 445 <contactType>Individual</contactType>
6a488035
TO
446 </field>
447 <index>
8f069c03
EM
448 <name>index_last_name</name>
449 <fieldName>last_name</fieldName>
450 <add>1.8</add>
6a488035
TO
451 </index>
452 <field>
8f069c03
EM
453 <name>prefix_id</name>
454 <title>Individual Prefix</title>
455 <type>int unsigned</type>
456 <comment>Prefix or Title for name (Ms, Mr...). FK to prefix ID</comment>
457 <pseudoconstant>
458 <optionGroupName>individual_prefix</optionGroupName>
459 </pseudoconstant>
460 <html>
461 <type>Select</type>
462 </html>
463 <headerPattern>/^(prefix|title)/i</headerPattern>
464 <dataPattern>/^(mr|ms|mrs|sir|dr)\.?$/i</dataPattern>
465 <import>true</import>
466 <add>1.2</add>
f5c0f096 467 <contactType>Individual</contactType>
6a488035
TO
468 </field>
469 <index>
8f069c03
EM
470 <name>UI_prefix</name>
471 <fieldName>prefix_id</fieldName>
472 <add>1.6</add>
6a488035
TO
473 </index>
474 <field>
8f069c03
EM
475 <name>suffix_id</name>
476 <title>Individual Suffix</title>
477 <type>int unsigned</type>
478 <pseudoconstant>
479 <optionGroupName>individual_suffix</optionGroupName>
480 </pseudoconstant>
481 <html>
482 <type>Select</type>
483 </html>
484 <import>true</import>
485 <comment>Suffix for name (Jr, Sr...). FK to suffix ID</comment>
486 <headerPattern>/^suffix$/i</headerPattern>
487 <dataPattern>/^(sr|jr)\.?|i{2,}$/</dataPattern>
488 <add>1.2</add>
f5c0f096 489 <contactType>Individual</contactType>
6a488035
TO
490 </field>
491 <index>
8f069c03
EM
492 <name>UI_suffix</name>
493 <fieldName>suffix_id</fieldName>
494 <add>1.6</add>
6a488035 495 </index>
e171748b 496 <field>
8f069c03
EM
497 <name>formal_title</name>
498 <type>varchar</type>
499 <length>64</length>
500 <import>true</import>
0c4b273e 501 <html>
502 <type>Text</type>
fd735f54 503 <label>Formal Title</label>
0c4b273e 504 </html>
8f069c03
EM
505 <headerPattern>/^title/i</headerPattern>
506 <comment>Formal (academic or similar) title in front of name. (Prof., Dr. etc.)</comment>
507 <add>4.5</add>
f5c0f096 508 <contactType>Individual</contactType>
8f069c03
EM
509 </field>
510 <field>
511 <name>communication_style_id</name>
512 <title>Communication Style</title>
513 <type>int unsigned</type>
514 <pseudoconstant>
515 <optionGroupName>communication_style</optionGroupName>
516 </pseudoconstant>
517 <export>true</export>
1a18ea39
CW
518 <import>true</import>
519 <headerPattern>/style/i</headerPattern>
a005e91a 520 <comment>Communication style (e.g. formal vs. familiar) to use with this contact. FK to communication styles in civicrm_option_value.</comment>
8f069c03 521 <add>4.4</add>
dd4706ef
TM
522 <html>
523 <type>Select</type>
524 </html>
aa62b355
OB
525 </field>
526 <index>
8f069c03
EM
527 <name>index_communication_style_id</name>
528 <fieldName>communication_style_id</fieldName>
529 <add>4.4</add>
aa62b355 530 </index>
8f069c03
EM
531 <field>
532 <name>email_greeting_id</name>
533 <type>int unsigned</type>
534 <title>Email Greeting ID</title>
54e389ac 535 <export>true</export>
8f069c03
EM
536 <comment>FK to civicrm_option_value.id, that has to be valid registered Email Greeting.</comment>
537 <add>3.0</add>
3542118f
CW
538 <html>
539 <type>Select</type>
540 </html>
f4a9693e
SL
541 <pseudoconstant>
542 <optionGroupName>email_greeting</optionGroupName>
543 </pseudoconstant>
8f069c03
EM
544 </field>
545 <field>
546 <name>email_greeting_custom</name>
547 <type>varchar</type>
548 <length>128</length>
549 <import>true</import>
550 <export>false</export>
551 <comment>Custom Email Greeting.</comment>
552 <add>3.0</add>
553 <html>
554 <type>Text</type>
fd735f54 555 <label>Email Greeting Custom</label>
8f069c03
EM
556 </html>
557 </field>
558 <field>
559 <name>email_greeting_display</name>
560 <title>Email Greeting</title>
561 <type>varchar</type>
562 <length>255</length>
563 <comment>Cache Email Greeting.</comment>
a0e733f3 564 <readonly>true</readonly>
8f069c03 565 <add>3.0</add>
8f069c03
EM
566 </field>
567 <field>
568 <name>postal_greeting_id</name>
569 <type>int unsigned</type>
570 <title>Postal Greeting ID</title>
54e389ac 571 <export>true</export>
8f069c03
EM
572 <comment>FK to civicrm_option_value.id, that has to be valid registered Postal Greeting.</comment>
573 <add>3.0</add>
574 <html>
3542118f 575 <type>Select</type>
8f069c03 576 </html>
f4a9693e
SL
577 <pseudoconstant>
578 <optionGroupName>postal_greeting</optionGroupName>
579 </pseudoconstant>
8f069c03
EM
580 </field>
581 <field>
582 <name>postal_greeting_custom</name>
583 <type>varchar</type>
584 <length>128</length>
585 <import>true</import>
586 <export>false</export>
587 <comment>Custom Postal greeting.</comment>
588 <add>3.0</add>
589 <html>
590 <type>Text</type>
fd735f54 591 <label>Postal Greeting Custom</label>
8f069c03
EM
592 </html>
593 </field>
594 <field>
595 <name>postal_greeting_display</name>
596 <title>Postal Greeting</title>
597 <type>varchar</type>
598 <length>255</length>
599 <comment>Cache Postal greeting.</comment>
a0e733f3 600 <readonly>true</readonly>
8f069c03 601 <add>3.0</add>
8f069c03
EM
602 </field>
603 <field>
604 <name>addressee_id</name>
605 <type>int unsigned</type>
606 <title>Addressee ID</title>
607 <comment>FK to civicrm_option_value.id, that has to be valid registered Addressee.</comment>
608 <add>3.0</add>
54e389ac 609 <export>true</export>
3542118f
CW
610 <html>
611 <type>Select</type>
612 </html>
a28e9198 613 <pseudoconstant>
614 <optionGroupName>addressee</optionGroupName>
615 </pseudoconstant>
8f069c03
EM
616 </field>
617 <field>
618 <name>addressee_custom</name>
619 <type>varchar</type>
620 <length>128</length>
621 <import>true</import>
622 <export>false</export>
623 <comment>Custom Addressee.</comment>
624 <add>3.0</add>
625 <html>
626 <type>Text</type>
fd735f54 627 <label>Addressee Custom</label>
8f069c03
EM
628 </html>
629 </field>
630 <field>
631 <name>addressee_display</name>
632 <title>Addressee</title>
633 <type>varchar</type>
634 <length>255</length>
635 <comment>Cache Addressee.</comment>
a0e733f3 636 <readonly>true</readonly>
8f069c03 637 <add>3.0</add>
8f069c03
EM
638 </field>
639 <field>
640 <name>job_title</name>
641 <type>varchar</type>
642 <length>255</length>
643 <html>
644 <type>Text</type>
54f5e87f 645 <size>30</size>
fd735f54 646 <label>Job Title</label>
8f069c03
EM
647 </html>
648 <import>true</import>
649 <headerPattern>/^job|(j(ob\s)?title)$/i</headerPattern>
650 <dataPattern>//</dataPattern>
651 <comment>Job Title</comment>
652 <add>1.1</add>
f5c0f096 653 <contactType>Individual</contactType>
8f069c03
EM
654 </field>
655 <field>
656 <name>gender_id</name>
9ac33d0f 657 <title>Gender ID</title>
8f069c03
EM
658 <type>int unsigned</type>
659 <pseudoconstant>
660 <optionGroupName>gender</optionGroupName>
661 </pseudoconstant>
662 <html>
663 <type>Select</type>
9ac33d0f 664 <label>Gender</label>
8f069c03
EM
665 </html>
666 <headerPattern>/^gender$/i</headerPattern>
667 <comment>FK to gender ID</comment>
668 <import>true</import>
669 <add>1.2</add>
f5c0f096 670 <contactType>Individual</contactType>
6a488035
TO
671 </field>
672 <index>
8f069c03
EM
673 <name>UI_gender</name>
674 <fieldName>gender_id</fieldName>
675 <add>1.6</add>
6a488035
TO
676 </index>
677 <field>
8f069c03
EM
678 <name>birth_date</name>
679 <type>date</type>
680 <import>true</import>
681 <headerPattern>/^birth|(b(irth\s)?date)|D(\W*)O(\W*)B(\W*)$/i</headerPattern>
682 <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
683 <comment>Date of birth</comment>
684 <add>1.1</add>
685 <html>
686 <type>Select Date</type>
24317d89 687 <formatType>birth</formatType>
fd735f54 688 <label>Birth Date</label>
8f069c03 689 </html>
f5c0f096 690 <contactType>Individual</contactType>
8f069c03
EM
691 </field>
692 <field>
693 <name>is_deceased</name>
945ddec3 694 <title>Deceased</title>
8f069c03
EM
695 <import>true</import>
696 <export>true</export>
697 <headerPattern>/i(s\s)?d(eceased)$/i</headerPattern>
698 <type>boolean</type>
699 <default>0</default>
700 <add>1.1</add>
2cd5d411 701 <required>true</required>
8f069c03
EM
702 <html>
703 <type>CheckBox</type>
fd735f54 704 <label>Is Deceased</label>
8f069c03 705 </html>
f5c0f096 706 <contactType>Individual</contactType>
8f069c03 707 </field>
27633545
SL
708 <index>
709 <name>index_is_deceased</name>
710 <fieldName>is_deceased</fieldName>
711 <add>4.7</add>
712 </index>
8f069c03
EM
713 <field>
714 <name>deceased_date</name>
715 <type>date</type>
716 <import>true</import>
717 <export>true</export>
718 <headerPattern>/^deceased|(d(eceased\s)?date)$/i</headerPattern>
719 <comment>Date of deceased</comment>
720 <add>1.5</add>
721 <html>
722 <type>Select Date</type>
24317d89 723 <formatType>birth</formatType>
fd735f54 724 <label>Deceased Date</label>
8f069c03 725 </html>
f5c0f096 726 <contactType>Individual</contactType>
8f069c03 727 </field>
6a488035 728 <field>
8f069c03
EM
729 <name>household_name</name>
730 <type>varchar</type>
731 <length>128</length>
732 <html>
733 <type>Text</type>
54f5e87f 734 <size>30</size>
fd735f54 735 <label>Household Name</label>
8f069c03
EM
736 </html>
737 <import>true</import>
738 <headerPattern>/^household|(h(ousehold\s)?name)$/i</headerPattern>
739 <dataPattern>/^\w+$/</dataPattern>
740 <comment>Household Name.</comment>
741 <fulltext/>
742 <add>1.1</add>
f5c0f096 743 <contactType>Household</contactType>
6a488035
TO
744 </field>
745 <index>
8f069c03
EM
746 <name>index_household_name</name>
747 <fieldName>household_name</fieldName>
748 <add>1.8</add>
6a488035
TO
749 </index>
750 <field>
8f069c03
EM
751 <name>primary_contact_id</name>
752 <type>int unsigned</type>
753 <title>Household Primary Contact ID</title>
754 <comment>Optional FK to Primary Contact for this household.</comment>
57e94608
A
755 <html>
756 <label>Household Primary Contact</label>
757 </html>
8f069c03 758 <add>1.1</add>
f5c0f096 759 <contactType>Household</contactType>
a0e733f3 760 <readonly>true</readonly>
6a488035
TO
761 </field>
762 <foreignKey>
8f069c03
EM
763 <name>primary_contact_id</name>
764 <table>civicrm_contact</table>
765 <key>id</key>
766 <add>1.1</add>
767 <onDelete>SET NULL</onDelete>
6a488035
TO
768 </foreignKey>
769 <field>
8f069c03
EM
770 <name>organization_name</name>
771 <type>varchar</type>
772 <length>128</length>
773 <html>
774 <type>Text</type>
54f5e87f 775 <size>30</size>
fd735f54 776 <label>Organization Name</label>
8f069c03
EM
777 </html>
778 <import>true</import>
779 <headerPattern>/^organization|(o(rganization\s)?name)$/i</headerPattern>
780 <dataPattern>/^\w+$/</dataPattern>
781 <comment>Organization Name.</comment>
782 <fulltext/>
783 <add>1.1</add>
f5c0f096 784 <contactType>Organization</contactType>
6a488035
TO
785 </field>
786 <index>
8f069c03
EM
787 <name>index_organization_name</name>
788 <fieldName>organization_name</fieldName>
789 <add>1.8</add>
6a488035
TO
790 </index>
791 <field>
8f069c03
EM
792 <name>sic_code</name>
793 <type>varchar</type>
794 <length>8</length>
795 <import>true</import>
796 <headerPattern>/^sic|(s(ic\s)?code)$/i</headerPattern>
797 <comment>Standard Industry Classification Code.</comment>
798 <add>1.1</add>
799 <html>
800 <type>Text</type>
fd735f54 801 <label>SIC Code</label>
8f069c03 802 </html>
f5c0f096 803 <contactType>Organization</contactType>
8f069c03
EM
804 </field>
805 <field>
806 <name>user_unique_id</name>
807 <rule>url</rule>
808 <title>Unique ID (OpenID)</title>
809 <type>varchar</type>
810 <length>255</length>
811 <import>true</import>
812 <headerPattern>/^Open\s?ID|u(niq\w*)?\s?ID/i</headerPattern>
813 <dataPattern>/^[\w\/\:\.]+$/</dataPattern>
a005e91a 814 <comment>the OpenID (or OpenID-style http://username.domain/) unique identifier for this contact mainly used for logging in to CiviCRM</comment>
8f069c03
EM
815 <add>2.0</add>
816 <html>
817 <type>Text</type>
818 </html>
819 </field>
820 <field>
821 <name>employer_id</name>
a1d226d6 822 <title>Current Employer ID</title>
8f069c03
EM
823 <uniqueName>current_employer_id</uniqueName>
824 <type>int unsigned</type>
825 <comment>OPTIONAL FK to civicrm_contact record.</comment>
826 <export>true</export>
827 <add>2.1</add>
828 <html>
916b6181 829 <type>EntityRef</type>
a1d226d6 830 <label>Current Employer</label>
8f069c03 831 </html>
f5c0f096 832 <contactType>Individual</contactType>
6a488035
TO
833 </field>
834 <foreignKey>
8f069c03
EM
835 <name>employer_id</name>
836 <table>civicrm_contact</table>
837 <key>id</key>
838 <add>2.1</add>
839 <onDelete>SET NULL</onDelete>
6a488035
TO
840 </foreignKey>
841 <field>
842 <name>is_deleted</name>
843 <title>Contact is in Trash</title>
844 <uniqueName>contact_is_deleted</uniqueName>
845 <type>boolean</type>
846 <default>0</default>
847 <required>true</required>
848 <export>true</export>
849 <add>3.2</add>
614d72ec 850 <html>
851 <type>CheckBox</type>
852 </html>
6a488035 853 </field>
e7d940b2
DL
854 <index>
855 <name>index_is_deleted_sort_name</name>
856 <fieldName>is_deleted</fieldName>
857 <fieldName>sort_name</fieldName>
858 <fieldName>id</fieldName>
859 <add>4.4</add>
6a488035
TO
860 </index>
861 <field>
862 <name>created_date</name>
863 <type>timestamp</type>
864 <comment>When was the contact was created.</comment>
865 <required>false</required>
0fd2fe32 866 <export>true</export>
6a488035 867 <default>NULL</default>
1662d426
A
868 <html>
869 <label>Created Date</label>
870 </html>
6a488035
TO
871 <add>4.3</add>
872 </field>
11e5567f 873 <index>
874 <name>index_created_date</name>
875 <fieldName>created_date</fieldName>
876 <add>5.18</add>
877 </index>
6a488035
TO
878 <field>
879 <name>modified_date</name>
880 <type>timestamp</type>
881 <comment>When was the contact (or closely related entity) was created or modified or deleted.</comment>
882 <required>false</required>
0fd2fe32 883 <export>true</export>
6a488035 884 <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP</default>
1662d426
A
885 <html>
886 <label>Modified Date</label>
887 </html>
34745448 888 <readonly>true</readonly>
6a488035
TO
889 <add>4.3</add>
890 </field>
11e5567f 891 <index>
892 <name>index_modified_date</name>
893 <fieldName>modified_date</fieldName>
894 <add>5.18</add>
895 </index>
6a488035 896</table>