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