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