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