xml/schema/Member/MembershipStatus.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Member</base>
   5   <class>MembershipStatus</class>
   6   <name>civicrm_membership_status</name>
   7   <comment>Membership Status stores admin configurable rules for assigning status to memberships.</comment>
   8   <add>1.5</add>
   9   <log>true</log>
  10   <component>CiviMember</component>
  11   <labelField>label</labelField>
  12   <field>
  13     <name>id</name>
  14     <title>Membership Status ID</title>
  15     <type>int unsigned</type>
  16     <required>true</required>
  17     <comment>Membership Id</comment>
  18     <add>1.5</add>
  19   </field>
  20   <primaryKey>
  21     <name>id</name>
  22     <autoincrement>true</autoincrement>
  23   </primaryKey>
  24   <field>
  25     <name>name</name>
  26     <uniqueName>membership_status</uniqueName>
  27     <title>Membership Status</title>
  28     <type>varchar</type>
  29     <import>true</import>
  30     <length>128</length>
  31     <comment>Name for Membership Status</comment>
  32     <add>1.5</add>
  33   </field>
  34   <field>
  35     <name>label</name>
  36     <title>Label</title>
  37     <type>varchar</type>
  38     <length>128</length>
  39     <localizable>true</localizable>
  40     <html>
  41       <type>Text</type>
  42     </html>
  43     <comment>Label for Membership Status</comment>
  44     <add>3.2</add>
  45   </field>
  46   <field>
  47     <name>start_event</name>
  48     <type>varchar</type>
  49     <length>12</length>
  50     <comment>Event when this status starts.</comment>
  51     <pseudoconstant>
  52       <callback>CRM_Core_SelectValues::eventDate</callback>
  53     </pseudoconstant>
  54     <add>1.5</add>
  55     <html>
  56       <type>Select</type>
  57     </html>
  58   </field>
  59   <field>
  60     <name>start_event_adjust_unit</name>
  61     <type>varchar</type>
  62     <length>8</length>
  63     <comment>Unit used for adjusting from start_event.</comment>
  64     <pseudoconstant>
  65       <callback>CRM_Core_SelectValues::unitList</callback>
  66     </pseudoconstant>
  67     <add>1.5</add>
  68     <html>
  69       <type>Select</type>
  70     </html>
  71   </field>
  72   <field>
  73     <name>start_event_adjust_interval</name>
  74     <type>int</type>
  75     <comment>Status range begins this many units from start_event.</comment>
  76     <add>1.5</add>
  77   </field>
  78   <field>
  79     <name>end_event</name>
  80     <type>varchar</type>
  81     <length>12</length>
  82     <comment>Event after which this status ends.</comment>
  83     <pseudoconstant>
  84       <callback>CRM_Core_SelectValues::eventDate</callback>
  85     </pseudoconstant>
  86     <add>1.5</add>
  87     <html>
  88       <type>Select</type>
  89     </html>
  90   </field>
  91   <field>
  92     <name>end_event_adjust_unit</name>
  93     <type>varchar</type>
  94     <length>8</length>
  95     <comment>Unit used for adjusting from the ending event.</comment>
  96     <pseudoconstant>
  97       <callback>CRM_Core_SelectValues::unitList</callback>
  98     </pseudoconstant>
  99     <add>1.5</add>
 100     <html>
 101       <type>Select</type>
 102     </html>
 103   </field>
 104   <field>
 105     <name>end_event_adjust_interval</name>
 106     <type>int</type>
 107     <comment>Status range ends this many units from end_event.</comment>
 108     <add>1.5</add>
 109   </field>
 110   <field>
 111     <name>is_current_member</name>
 112     <title>Current Membership?</title>
 113     <type>boolean</type>
 114     <comment>Does this status aggregate to current members (e.g. New, Renewed, Grace might all be TRUE... while Unrenewed, Lapsed, Inactive would be FALSE).</comment>
 115     <add>1.5</add>
 116   </field>
 117   <field>
 118     <name>is_admin</name>
 119     <title>Administrator Only?</title>
 120     <type>boolean</type>
 121     <comment>Is this status for admin/manual assignment only.</comment>
 122     <html>
 123       <type>CheckBox</type>
 124     </html>
 125     <add>1.5</add>
 126   </field>
 127   <field>
 128     <name>weight</name>
 129     <title>Order</title>
 130     <type>int</type>
 131     <add>1.5</add>
 132   </field>
 133   <field>
 134     <name>is_default</name>
 135     <title>Default Status?</title>
 136     <type>boolean</type>
 137     <html>
 138       <type>CheckBox</type>
 139     </html>
 140     <comment>Assign this status to a membership record if no other status match is found.</comment>
 141     <add>1.5</add>
 142   </field>
 143   <field>
 144     <name>is_active</name>
 145     <title>Is Active</title>
 146     <type>boolean</type>
 147     <default>1</default>
 148     <html>
 149       <type>CheckBox</type>
 150     </html>
 151     <comment>Is this membership_status enabled.</comment>
 152     <add>1.5</add>
 153   </field>
 154   <field>
 155     <name>is_reserved</name>
 156     <title>Is Reserved</title>
 157     <type>boolean</type>
 158     <default>0</default>
 159     <html>
 160       <type>CheckBox</type>
 161     </html>
 162     <comment>Is this membership_status reserved.</comment>
 163     <add>2.1</add>
 164   </field>
 165 </table>