Merge branch 'getting_started' of https://github.com/cividesk/civicrm-core into civid...
[civicrm-core.git] / 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 <field>
11 <name>id</name>
12 <title>Membership Status ID</title>
13 <type>int unsigned</type>
14 <required>true</required>
15 <comment>Membership Id</comment>
16 <add>1.5</add>
17 </field>
18 <primaryKey>
19 <name>id</name>
20 <autoincrement>true</autoincrement>
21 </primaryKey>
22 <field>
23 <name>name</name>
24 <uniqueName>membership_status</uniqueName>
25 <title>Membership Status</title>
26 <type>varchar</type>
27 <import>true</import>
28 <length>128</length>
29 <comment>Name for Membership Status</comment>
30 <add>1.5</add>
31 </field>
32 <field>
33 <name>label</name>
34 <type>varchar</type>
35 <length>128</length>
36 <localizable>true</localizable>
37 <comment>Label for Membership Status</comment>
38 <add>3.2</add>
39 </field>
40 <field>
41 <name>start_event</name>
42 <type>varchar</type>
43 <length>12</length>
44 <comment>Event when this status starts.</comment>
45 <pseudoconstant>
46 <callback>CRM_Core_SelectValues::eventDate</callback>
47 </pseudoconstant>
48 <add>1.5</add>
49 <html>
50 <type>Select</type>
51 </html>
52 </field>
53 <field>
54 <name>start_event_adjust_unit</name>
55 <type>varchar</type>
56 <length>8</length>
57 <comment>Unit used for adjusting from start_event.</comment>
58 <pseudoconstant>
59 <callback>CRM_Core_SelectValues::unitList</callback>
60 </pseudoconstant>
61 <add>1.5</add>
62 <html>
63 <type>Select</type>
64 </html>
65 </field>
66 <field>
67 <name>start_event_adjust_interval</name>
68 <type>int</type>
69 <comment>Status range begins this many units from start_event.</comment>
70 <add>1.5</add>
71 </field>
72 <field>
73 <name>end_event</name>
74 <type>varchar</type>
75 <length>12</length>
76 <comment>Event after which this status ends.</comment>
77 <pseudoconstant>
78 <callback>CRM_Core_SelectValues::eventDate</callback>
79 </pseudoconstant>
80 <add>1.5</add>
81 <html>
82 <type>Select</type>
83 </html>
84 </field>
85 <field>
86 <name>end_event_adjust_unit</name>
87 <type>varchar</type>
88 <length>8</length>
89 <comment>Unit used for adjusting from the ending event.</comment>
90 <pseudoconstant>
91 <callback>CRM_Core_SelectValues::unitList</callback>
92 </pseudoconstant>
93 <add>1.5</add>
94 <html>
95 <type>Select</type>
96 </html>
97 </field>
98 <field>
99 <name>end_event_adjust_interval</name>
100 <type>int</type>
101 <comment>Status range ends this many units from end_event.</comment>
102 <add>1.5</add>
103 </field>
104 <field>
105 <name>is_current_member</name>
106 <title>Current Membership?</title>
107 <type>boolean</type>
108 <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>
109 <add>1.5</add>
110 </field>
111 <field>
112 <name>is_admin</name>
113 <title>Admin Assigned Only?</title>
114 <type>boolean</type>
115 <comment>Is this status for admin/manual assignment only.</comment>
116 <add>1.5</add>
117 </field>
118 <field>
119 <name>weight</name>
120 <title>Order</title>
121 <type>int</type>
122 <add>1.5</add>
123 </field>
124 <field>
125 <name>is_default</name>
126 <title>Default Status?</title>
127 <type>boolean</type>
128 <comment>Assign this status to a membership record if no other status match is found.</comment>
129 <add>1.5</add>
130 </field>
131 <field>
132 <name>is_active</name>
133 <title>Is Active</title>
134 <type>boolean</type>
135 <default>1</default>
136 <comment>Is this membership_status enabled.</comment>
137 <add>1.5</add>
138 </field>
139 <field>
140 <name>is_reserved</name>
141 <title>Is Reserved</title>
142 <type>boolean</type>
143 <default>0</default>
144 <comment>Is this membership_status reserved.</comment>
145 <add>2.1</add>
146 </field>
147 </table>