Merge pull request #1333 from eileenmcnaughton/CRM-13155
[civicrm-core.git] / xml / schema / Contact / RelationshipType.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
4 <base>CRM/Contact</base>
5 <class>RelationshipType</class>
6 <name>civicrm_relationship_type</name>
7 <comment>Relationship types s/b structured with contact_a as the 'subject/child' contact and contact_b as the 'object/parent' contact (e.g. Individual A is Employee of Org B).</comment>
8 <add>1.1</add>
9 <log>true</log>
10 <field>
11 <name>id</name>
12 <type>int unsigned</type>
13 <title>Relationship Type ID</title>
14 <required>true</required>
15 <comment>Primary key</comment>
16 <add>1.1</add>
17 </field>
18 <primaryKey>
19 <name>id</name>
20 <autoincrement>true</autoincrement>
21 </primaryKey>
22 <field>
23 <name>name_a_b</name>
24 <type>varchar</type>
25 <title>Relationship Type Name A to B</title>
26 <length>64</length>
27 <comment>name for relationship of contact_a to contact_b.</comment>
28 <add>1.1</add>
29 </field>
30 <field>
31 <name>label_a_b</name>
32 <type>varchar</type>
33 <title>Relationship Type Label A to B</title>
34 <length>64</length>
35 <comment>label for relationship of contact_a to contact_b.</comment>
36 <add>3.0</add>
37 </field>
38 <field>
39 <name>name_b_a</name>
40 <type>varchar</type>
41 <title>Relationship Type Name B to A</title>
42 <length>64</length>
43 <comment>Optional name for relationship of contact_b to contact_a.</comment>
44 <add>1.1</add>
45 </field>
46 <field>
47 <name>label_b_a</name>
48 <type>varchar</type>
49 <title>Relationship Type Label B to A</title>
50 <length>64</length>
51 <comment>Optional label for relationship of contact_b to contact_a.</comment>
52 <add>3.0</add>
53 </field>
54 <field>
55 <name>description</name>
56 <type>varchar</type>
57 <title>Relationship Description</title>
58 <length>255</length>
59 <comment>Optional verbose description of the relationship type.</comment>
60 <add>1.1</add>
61 </field>
62 <field>
63 <name>contact_type_a</name>
64 <type>enum</type>
65 <title>Contact Type for Contact A</title>
66 <values>Individual, Organization, Household</values>
67 <comment>If defined, contact_a in a relationship of this type must be a specific contact_type.</comment>
68 <add>1.1</add>
69 </field>
70 <field>
71 <name>contact_type_b</name>
72 <type>enum</type>
73 <title>Contact Type for Contact B</title>
74 <values>Individual, Organization, Household</values>
75 <comment>If defined, contact_b in a relationship of this type must be a specific contact_type.</comment>
76 <add>1.1</add>
77 </field>
78 <field>
79 <name>contact_sub_type_a</name>
80 <title>Contact Subtype A</title>
81 <type>varchar</type>
82 <length>64</length>
83 <comment>If defined, contact_sub_type_a in a relationship of this type must be a specific contact_sub_type.</comment>
84 <add>3.1</add>
85 </field>
86 <field>
87 <name>contact_sub_type_b</name>
88 <title>Contact Subtype B</title>
89 <type>varchar</type>
90 <length>64</length>
91 <comment>If defined, contact_sub_type_b in a relationship of this type must be a specific contact_sub_type.</comment>
92 <add>3.1</add>
93 </field>
94 <field>
95 <name>is_reserved</name>
96 <type>boolean</type>
97 <title>Relationship Type is Reserved</title>
98 <comment>Is this relationship type a predefined system type (can not be changed or de-activated)?</comment>
99 <add>1.1</add>
100 </field>
101 <field>
102 <name>is_active</name>
103 <title>Relationship Type is Active</title>
104 <type>boolean</type>
105 <default>1</default>
106 <comment>Is this relationship type currently active (i.e. can be used when creating or editing relationships)?</comment>
107 <add>1.1</add>
108 </field>
109 <index>
110 <name>UI_name_a_b</name>
111 <fieldName>name_a_b</fieldName>
112 <unique>true</unique>
113 <add>2.1</add>
114 </index>
115 <index>
116 <name>UI_name_b_a</name>
117 <fieldName>name_b_a</fieldName>
118 <unique>true</unique>
119 <add>2.1</add>
120 </index>
121</table>