xml/schema/Member/Membership.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Member</base>
   5   <class>Membership</class>
   6   <name>civicrm_membership</name>
   7   <comment>Contact Membership records.</comment>
   8   <add>1.5</add>
   9   <log>true</log>
  10   <icon>fa-id-badge</icon>
  11   <component>CiviMember</component>
  12   <paths>
  13     <add>civicrm/member/add?reset=1&amp;action=add&amp;context=standalone</add>
  14     <view>civicrm/contact/view/membership?reset=1&amp;action=view&amp;id=[id]&amp;cid=[contact_id]</view>
  15     <update>civicrm/contact/view/membership?reset=1&amp;action=update&amp;id=[id]&amp;cid=[contact_id]</update>
  16     <delete>civicrm/contact/view/membership?reset=1&amp;action=delete&amp;id=[id]&amp;cid=[contact_id]</delete>
  17   </paths>
  18   <field>
  19     <name>id</name>
  20     <uniqueName>membership_id</uniqueName>
  21     <type>int unsigned</type>
  22     <required>true</required>
  23     <import>true</import>
  24     <title>Membership ID</title>
  25     <headerPattern>/^(m(embership\s)?id)$/i</headerPattern>
  26     <comment>Membership Id</comment>
  27     <add>1.5</add>
  28     <html>
  29       <type>Number</type>
  30     </html>
  31   </field>
  32   <primaryKey>
  33     <name>id</name>
  34     <autoincrement>true</autoincrement>
  35   </primaryKey>
  36
  37   <field>
  38     <name>contact_id</name>
  39     <uniqueName>membership_contact_id</uniqueName>
  40     <type>int unsigned</type>
  41     <required>true</required>
  42     <title>Contact ID</title>
  43     <headerPattern>/contact(.?id)?/i</headerPattern>
  44     <dataPattern>/^\d+$/</dataPattern>
  45     <import>true</import>
  46     <comment>FK to Contact ID</comment>
  47     <add>1.5</add>
  48     <html>
  49       <type>EntityRef</type>
  50     </html>
  51   </field>
  52   <foreignKey>
  53     <name>contact_id</name>
  54     <table>civicrm_contact</table>
  55     <key>id</key>
  56     <add>1.5</add>
  57     <onDelete>CASCADE</onDelete>
  58   </foreignKey>
  59   <field>
  60     <name>membership_type_id</name>
  61     <type>int unsigned</type>
  62     <title>Membership Type Id</title>
  63     <import>true</import>
  64     <headerPattern>/^(m(embership\s)?type)$/i</headerPattern>
  65     <export>false</export>
  66     <required>true</required>
  67     <comment>FK to Membership Type</comment>
  68     <pseudoconstant>
  69       <table>civicrm_membership_type</table>
  70       <keyColumn>id</keyColumn>
  71       <labelColumn>name</labelColumn>
  72     </pseudoconstant>
  73     <html>
  74       <type>Select</type>
  75       <label>Membership Type</label>
  76     </html>
  77     <add>1.5</add>
  78   </field>
  79   <foreignKey>
  80     <name>membership_type_id</name>
  81     <table>civicrm_membership_type</table>
  82     <key>id</key>
  83     <add>1.5</add>
  84     <onDelete>CASCADE</onDelete>
  85   </foreignKey>
  86   <field>
  87     <name>join_date</name>
  88     <title>Member Since</title>
  89     <type>date</type>
  90     <import>true</import>
  91     <headerPattern>/^join|(j(oin\s)?date)$/i</headerPattern>
  92     <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
  93     <comment>Beginning of initial membership period (member since...).</comment>
  94     <add>1.5</add>
  95     <html>
  96       <type>Select Date</type>
  97       <formatType>activityDate</formatType>
  98     </html>
  99     <uniqueName>membership_join_date</uniqueName>
 100   </field>
 101   <field>
 102     <name>start_date</name>
 103     <uniqueName>membership_start_date</uniqueName>
 104     <title>Membership Start Date</title>
 105     <type>date</type>
 106     <import>true</import>
 107     <headerPattern>/(member(ship)?.)?start(s)?(.date$)?/i</headerPattern>
 108     <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
 109     <comment>Beginning of current uninterrupted membership period.</comment>
 110     <add>1.5</add>
 111     <html>
 112       <type>Select Date</type>
 113       <formatType>activityDate</formatType>
 114     </html>
 115   </field>
 116   <field>
 117     <name>end_date</name>
 118     <uniqueName>membership_end_date</uniqueName>
 119     <title>Membership Expiration Date</title>
 120     <type>date</type>
 121     <import>true</import>
 122     <headerPattern>/(member(ship)?.)?end(s)?(.date$)?/i</headerPattern>
 123     <dataPattern>/\d{4}-?\d{2}-?\d{2}/</dataPattern>
 124     <comment>Current membership period expire date.</comment>
 125     <add>1.5</add>
 126     <html>
 127       <type>Select Date</type>
 128       <formatType>activityDate</formatType>
 129     </html>
 130   </field>
 131   <field>
 132     <name>source</name>
 133     <uniqueName>membership_source</uniqueName>
 134     <title>Source</title>
 135     <import>true</import>
 136     <headerPattern>/^(member(ship?))?source$/i</headerPattern>
 137     <type>varchar</type>
 138     <length>128</length>
 139     <add>1.5</add>
 140     <html>
 141       <type>Text</type>
 142     </html>
 143   </field>
 144   <field>
 145     <name>status_id</name>
 146     <title>Membership Status Id</title>
 147     <import>true</import>
 148     <headerPattern>/(member(ship|).)?(status)$/i</headerPattern>
 149     <type>int unsigned</type>
 150     <export>false</export>
 151     <required>true</required>
 152     <comment>FK to Membership Status</comment>
 153     <pseudoconstant>
 154       <table>civicrm_membership_status</table>
 155       <keyColumn>id</keyColumn>
 156       <labelColumn>label</labelColumn>
 157     </pseudoconstant>
 158     <html>
 159       <type>Select</type>
 160     </html>
 161     <add>1.5</add>
 162   </field>
 163   <foreignKey>
 164     <name>status_id</name>
 165     <table>civicrm_membership_status</table>
 166     <key>id</key>
 167     <add>1.5</add>
 168     <onDelete>CASCADE</onDelete>
 169   </foreignKey>
 170   <field>
 171     <name>is_override</name>
 172     <uniqueName>member_is_override</uniqueName>
 173     <title>Status Override</title>
 174     <import>true</import>
 175     <export>true</export>
 176     <headerPattern>/override$/i</headerPattern>
 177     <type>boolean</type>
 178     <comment>Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.</comment>
 179     <html>
 180       <type>CheckBox</type>
 181     </html>
 182     <add>1.5</add>
 183   </field>
 184   <field>
 185     <name>status_override_end_date</name>
 186     <title>Status Override End Date</title>
 187     <type>date</type>
 188     <default>NULL</default>
 189     <import>true</import>
 190     <comment>Then end date of membership status override if 'Override until selected date' override type is selected.</comment>
 191     <add>4.7</add>
 192     <html>
 193       <type>Select Date</type>
 194       <formatType>activityDate</formatType>
 195     </html>
 196   </field>
 197   <field>
 198     <name>owner_membership_id</name>
 199     <type>int unsigned</type>
 200     <title>Primary Member ID</title>
 201     <comment>Optional FK to Parent Membership.</comment>
 202     <export>true</export>
 203     <add>1.7</add>
 204   </field>
 205   <foreignKey>
 206     <name>owner_membership_id</name>
 207     <table>civicrm_membership</table>
 208     <key>id</key>
 209     <add>1.7</add>
 210     <onDelete>SET NULL</onDelete>
 211   </foreignKey>
 212   <index>
 213     <name>index_owner_membership_id</name>
 214     <fieldName>owner_membership_id</fieldName>
 215     <add>1.7</add>
 216   </index>
 217   <field>
 218     <name>max_related</name>
 219     <type>int</type>
 220     <comment>Maximum number of related memberships (membership_type override).</comment>
 221     <add>4.3</add>
 222     <export>true</export>
 223     <html>
 224       <type>Text</type>
 225     </html>
 226   </field>
 227   <field>
 228     <name>is_test</name>
 229     <title>Test</title>
 230     <uniqueName>member_is_test</uniqueName>
 231     <type>boolean</type>
 232     <default>0</default>
 233     <import>true</import>
 234     <headerPattern>/(is.)?test(.member(ship)?)?/i</headerPattern>
 235     <html>
 236       <type>CheckBox</type>
 237     </html>
 238   </field>
 239   <field>
 240     <name>is_pay_later</name>
 241     <uniqueName>member_is_pay_later</uniqueName>
 242     <title>Is Pay Later</title>
 243     <type>boolean</type>
 244     <default>0</default>
 245     <import>true</import>
 246     <headerPattern>/(is.)?(pay(.)?later)$/i</headerPattern>
 247     <add>2.1</add>
 248     <html>
 249       <type>CheckBox</type>
 250     </html>
 251   </field>
 252   <field>
 253     <name>contribution_recur_id</name>
 254     <uniqueName>membership_recur_id</uniqueName>
 255     <title>Membership Recurring Contribution</title>
 256     <type>int unsigned</type>
 257     <export>true</export>
 258     <comment>Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.</comment>
 259     <add>3.3</add>
 260   </field>
 261   <foreignKey>
 262     <name>contribution_recur_id</name>
 263     <table>civicrm_contribution_recur</table>
 264     <key>id</key>
 265     <add>3.3</add>
 266     <onDelete>SET NULL</onDelete>
 267   </foreignKey>
 268   <field>
 269     <name>campaign_id</name>
 270     <uniqueName>member_campaign_id</uniqueName>
 271     <type>int unsigned</type>
 272     <title>Campaign</title>
 273     <import>true</import>
 274     <comment>The campaign for which this membership is attached.</comment>
 275     <add>3.4</add>
 276     <html>
 277       <type>Select</type>
 278     </html>
 279   </field>
 280   <foreignKey>
 281     <name>campaign_id</name>
 282     <table>civicrm_campaign</table>
 283     <key>id</key>
 284     <onDelete>SET NULL</onDelete>
 285   </foreignKey>
 286 </table>