xml/schema/Contact/RelationshipType.xml

   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     <html>
  37       <type>Text</type>
  38     </html>
  39     <add>3.0</add>
  40     <localizable>true</localizable>
  41   </field>
  42   <field>
  43     <name>name_b_a</name>
  44     <type>varchar</type>
  45     <title>Relationship Type Name B to A</title>
  46     <length>64</length>
  47     <comment>Optional name for relationship of contact_b to contact_a.</comment>
  48     <add>1.1</add>
  49   </field>
  50   <field>
  51     <name>label_b_a</name>
  52     <type>varchar</type>
  53     <title>Relationship Type Label B to A</title>
  54     <length>64</length>
  55     <comment>Optional label for relationship of contact_b to contact_a.</comment>
  56     <html>
  57       <type>Text</type>
  58     </html>
  59     <add>3.0</add>
  60     <localizable>true</localizable>
  61   </field>
  62   <field>
  63     <name>description</name>
  64     <type>varchar</type>
  65     <title>Relationship Description</title>
  66     <length>255</length>
  67     <comment>Optional verbose description of the relationship type.</comment>
  68     <add>1.1</add>
  69     <html>
  70       <type>Text</type>
  71     </html>
  72     <localizable>true</localizable>
  73   </field>
  74   <field>
  75     <name>contact_type_a</name>
  76     <title>Contact Type for Contact A</title>
  77     <type>varchar</type>
  78     <length>12</length>
  79     <comment>If defined, contact_a in a relationship of this type must be a specific contact_type.</comment>
  80     <pseudoconstant>
  81       <table>civicrm_contact_type</table>
  82       <keyColumn>name</keyColumn>
  83       <labelColumn>label</labelColumn>
  84       <condition>parent_id IS NULL</condition>
  85     </pseudoconstant>
  86     <add>1.1</add>
  87     <html>
  88       <type>Select</type>
  89     </html>
  90   </field>
  91   <field>
  92     <name>contact_type_b</name>
  93     <title>Contact Type for Contact B</title>
  94     <type>varchar</type>
  95     <length>12</length>
  96     <comment>If defined, contact_b in a relationship of this type must be a specific contact_type.</comment>
  97     <pseudoconstant>
  98       <table>civicrm_contact_type</table>
  99       <keyColumn>name</keyColumn>
 100       <labelColumn>label</labelColumn>
 101       <condition>parent_id IS NULL</condition>
 102     </pseudoconstant>
 103     <add>1.1</add>
 104     <html>
 105       <type>Select</type>
 106     </html>
 107   </field>
 108   <field>
 109     <name>contact_sub_type_a</name>
 110     <title>Contact Subtype A</title>
 111     <type>varchar</type>
 112     <length>64</length>
 113     <comment>If defined, contact_sub_type_a in a relationship of this type must be a specific contact_sub_type.</comment>
 114     <add>3.1</add>
 115     <html>
 116       <type>Select</type>
 117     </html>
 118     <pseudoconstant>
 119       <table>civicrm_contact_type</table>
 120       <keyColumn>name</keyColumn>
 121       <labelColumn>label</labelColumn>
 122       <condition>parent_id IS NOT NULL</condition>
 123     </pseudoconstant>
 124   </field>
 125   <field>
 126     <name>contact_sub_type_b</name>
 127     <title>Contact Subtype B</title>
 128     <type>varchar</type>
 129     <length>64</length>
 130     <comment>If defined, contact_sub_type_b in a relationship of this type must be a specific contact_sub_type.</comment>
 131     <add>3.1</add>
 132     <html>
 133       <type>Select</type>
 134     </html>
 135     <pseudoconstant>
 136       <table>civicrm_contact_type</table>
 137       <keyColumn>name</keyColumn>
 138       <labelColumn>label</labelColumn>
 139       <condition>parent_id IS NOT NULL</condition>
 140     </pseudoconstant>
 141   </field>
 142   <field>
 143     <name>is_reserved</name>
 144     <type>boolean</type>
 145     <title>Relationship Type is Reserved</title>
 146     <comment>Is this relationship type a predefined system type (can not be changed or de-activated)?</comment>
 147     <html>
 148       <type>CheckBox</type>
 149     </html>
 150     <add>1.1</add>
 151   </field>
 152   <field>
 153     <name>is_active</name>
 154     <title>Relationship Type is Active</title>
 155     <type>boolean</type>
 156     <default>1</default>
 157     <comment>Is this relationship type currently active (i.e. can be used when creating or editing relationships)?</comment>
 158     <html>
 159       <type>CheckBox</type>
 160     </html>
 161     <add>1.1</add>
 162   </field>
 163   <index>
 164     <name>UI_name_a_b</name>
 165     <fieldName>name_a_b</fieldName>
 166     <unique>true</unique>
 167     <add>2.1</add>
 168   </index>
 169   <index>
 170     <name>UI_name_b_a</name>
 171     <fieldName>name_b_a</fieldName>
 172     <unique>true</unique>
 173     <add>2.1</add>
 174   </index>
 175 </table>