[civicrm-core.git] / xml / schema / Member / MembershipType.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Member</base>
  <class>MembershipType</class>
  <name>civicrm_membership_type</name>
  <comment>Sites can configure multiple types of memberships. They encode the owner organization, fee, and the rules needed to set start and end (expire) dates when a member signs up for that type.</comment>
  <add>1.5</add>
  <log>true</log>
  <component>CiviMember</component>
  <labelField>name</labelField>
  <field>
    <name>id</name>
    <title>Membership Type ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Membership Id</comment>
    <add>1.5</add>
    <html>
      <type>Number</type>
    </html>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>domain_id</name>
    <title>Membership Type Domain</title>
    <type>int unsigned</type>
    <required>true</required>
    <pseudoconstant>
      <table>civicrm_domain</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <comment>Which Domain is this match entry for</comment>
    <add>3.0</add>
  </field>
  <foreignKey>
    <name>domain_id</name>
    <table>civicrm_domain</table>
    <key>id</key>
    <add>3.0</add>
  </foreignKey>
  <field>
    <name>name</name>
    <uniqueName>membership_type</uniqueName>
    <title>Membership Type</title>
    <type>varchar</type>
    <required>true</required>
    <import>true</import>
    <length>128</length>
    <localizable>true</localizable>
    <comment>Name of Membership Type</comment>
    <html>
      <type>Text</type>
      <label>Name</label>
    </html>
    <add>1.5</add>
  </field>
  <field>
    <name>description</name>
    <title>Membership Type Description</title>
    <type>varchar</type>
    <html>
      <type>TextArea</type>
      <rows>6</rows>
      <cols>50</cols>
      <label>Description</label>
    </html>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Description of Membership Type</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>member_of_contact_id</name>
    <title>Membership Type Organization</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Owner organization for this membership type. FK to Contact ID</comment>
    <add>1.5</add>
  </field>
  <foreignKey>
    <name>member_of_contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>1.5</add>
    <onDelete>RESTRICT</onDelete>
  </foreignKey>
  <field>
    <name>financial_type_id</name>
    <title>Membership Financial Type</title>
    <type>int unsigned</type>
    <required>true</required>
    <pseudoconstant>
      <table>civicrm_financial_type</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <comment>If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id</comment>
    <add>4.3</add>
  </field>
  <foreignKey>
    <name>financial_type_id</name>
    <table>civicrm_financial_type</table>
    <key>id</key>
    <add>4.3</add>
  </foreignKey>
  <field>
    <name>minimum_fee</name>
    <title>Membership Type Minimum Fee</title>
    <type>decimal</type>
    <length>18,9</length>
    <comment>Minimum fee for this membership (0 for free/complimentary memberships).</comment>
    <default>0</default>
    <html>
      <type>Text</type>
      <label>Minimum Fee</label>
    </html>
    <add>1.5</add>
  </field>
  <field>
    <name>duration_unit</name>
    <title>Membership Type Duration Unit</title>
    <type>varchar</type>
    <length>8</length>
    <comment>Unit in which membership period is expressed.</comment>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::membershipTypeUnitList</callback>
    </pseudoconstant>
    <add>1.5</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>duration_interval</name>
    <title>Membership Type Duration Interval</title>
    <type>int</type>
    <html>
      <type>Text</type>
    </html>
    <comment>Number of duration units in membership period (e.g. 1 year, 12 months).</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>period_type</name>
    <title>Membership Type Plan</title>
    <type>varchar</type>
    <length>8</length>
    <required>true</required>
    <comment>Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.</comment>
    <html>
      <type>Select</type>
    </html>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::periodType</callback>
    </pseudoconstant>
    <add>1.5</add>
  </field>
  <field>
    <name>fixed_period_start_day</name>
    <title>Fixed Period Start Day</title>
    <type>int</type>
    <comment>For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>fixed_period_rollover_day</name>
    <title>Fixed Period Rollover Day</title>
    <type>int</type>
    <comment>For fixed period memberships, signups after this day (mmdd) rollover to next period.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>relationship_type_id</name>
    <title>Membership Type Relationship</title>
    <type>varchar</type>
    <length>64</length>
    <comment>FK to Relationship Type ID</comment>
    <add>1.5</add>
    <serialize>SEPARATOR_TRIMMED</serialize>
  </field>
  <index>
    <name>index_relationship_type_id</name>
    <fieldName>relationship_type_id</fieldName>
    <add>3.3</add>
  </index>
  <field>
    <name>relationship_direction</name>
    <type>varchar</type>
    <length>128</length>
    <add>1.7</add>
    <serialize>SEPARATOR_TRIMMED</serialize>
  </field>
  <field>
    <name>max_related</name>
    <title>Max Related Members for Type</title>
    <type>int</type>
    <comment>Maximum number of related memberships.</comment>
    <add>4.3</add>
    <html>
      <type>Text</type>
      <label>Max Related</label>
    </html>
  </field>
  <field>
    <name>visibility</name>
    <title>Visible</title>
    <type>varchar</type>
    <length>64</length>
    <add>1.5</add>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::memberVisibility</callback>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>weight</name>
    <title>Order</title>
    <type>int</type>
    <html>
      <type>Text</type>
    </html>
    <add>1.5</add>
  </field>
  <field>
    <name>receipt_text_signup</name>
    <title>Membership Type Receipt Text</title>
    <type>varchar</type>
    <html>
      <type>TextArea</type>
      <rows>6</rows>
      <cols>50</cols>
    </html>
    <length>255</length>
    <comment>Receipt Text for membership signup</comment>
    <add>2.0</add>
  </field>
  <field>
    <name>receipt_text_renewal</name>
    <title>Membership Type Renewal Text</title>
    <type>varchar</type>
    <html>
      <type>TextArea</type>
      <rows>6</rows>
      <cols>50</cols>
    </html>
    <length>255</length>
    <comment>Receipt Text for membership renewal</comment>
    <add>2.0</add>
  </field>
  <field>
    <name>auto_renew</name>
    <type>boolean</type>
    <default>0</default>
    <html>
      <type>Radio</type>
    </html>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::memberAutoRenew</callback>
    </pseudoconstant>
    <comment>0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;</comment>
    <add>3.3</add>
  </field>
  <field>
    <name>is_active</name>
    <title>Is Active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this membership_type enabled</comment>
    <add>1.5</add>
    <html>
      <type>CheckBox</type>
      <label>Enabled?</label>
    </html>
  </field>
</table>
Commit	Line	Data
6a488035 TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
	4	<base>CRM/Member</base>
	5	<class>MembershipType</class>
	6	<name>civicrm_membership_type</name>
	7	<comment>Sites can configure multiple types of memberships. They encode the owner organization, fee, and the rules needed to set start and end (expire) dates when a member signs up for that type.</comment>
	8	<add>1.5</add>
	9	<log>true</log>
d31fb4e3	10	<component>CiviMember</component>
8ab43c93	11	<labelField>name</labelField>
6a488035 TO	12	<field>
6a488035 TO	13	<name>id</name>
0d94665e	14	<title>Membership Type ID</title>
6a488035 TO	15	<type>int unsigned</type>
	16	<required>true</required>
	17	<comment>Membership Id</comment>
	18	<add>1.5</add>
0481e12c A	19	<html>
	20	<type>Number</type>
	21	</html>
6a488035 TO	22	</field>
	23	<primaryKey>
	24	<name>id</name>
	25	<autoincrement>true</autoincrement>
	26	</primaryKey>
	27	<field>
	28	<name>domain_id</name>
0d94665e	29	<title>Membership Type Domain</title>
6a488035 TO	30	<type>int unsigned</type>
6a488035 TO	31	<required>true</required>
c2b4755a EM	32	<pseudoconstant>
	33	<table>civicrm_domain</table>
	34	<keyColumn>id</keyColumn>
	35	<labelColumn>name</labelColumn>
	36	</pseudoconstant>
6a488035 TO	37	<comment>Which Domain is this match entry for</comment>
	38	<add>3.0</add>
	39	</field>
	40	<foreignKey>
	41	<name>domain_id</name>
	42	<table>civicrm_domain</table>
	43	<key>id</key>
	44	<add>3.0</add>
3c7d2158	45	</foreignKey>
6a488035 TO	46	<field>
6a488035 TO	47	<name>name</name>
3c7d2158	48	<uniqueName>membership_type</uniqueName>
6a488035 TO	49	<title>Membership Type</title>
6a488035 TO	50	<type>varchar</type>
dec137c7	51	<required>true</required>
6a488035 TO	52	<import>true</import>
	53	<length>128</length>
	54	<localizable>true</localizable>
	55	<comment>Name of Membership Type</comment>
6f85d058	56	<html>
6f85d058	57	<type>Text</type>
80a96508	58	<label>Name</label>
6f85d058	59	</html>
6a488035 TO	60	<add>1.5</add>
	61	</field>
	62	<field>
	63	<name>description</name>
0d94665e	64	<title>Membership Type Description</title>
6a488035	65	<type>varchar</type>
7deea513	66	<html>
7deea513	67	<type>TextArea</type>
817807ab	68	<rows>6</rows>
817807ab	69	<cols>50</cols>
80a96508	70	<label>Description</label>
7deea513	71	</html>
6a488035 TO	72	<length>255</length>
	73	<localizable>true</localizable>
	74	<comment>Description of Membership Type</comment>
	75	<add>1.5</add>
	76	</field>
	77	<field>
	78	<name>member_of_contact_id</name>
0d94665e	79	<title>Membership Type Organization</title>
6a488035 TO	80	<type>int unsigned</type>
	81	<required>true</required>
	82	<comment>Owner organization for this membership type. FK to Contact ID</comment>
	83	<add>1.5</add>
	84	</field>
3c7d2158	85	<foreignKey>
	86	<name>member_of_contact_id</name>
	87	<table>civicrm_contact</table>
6a488035 TO	88	<key>id</key>
	89	<add>1.5</add>
	90	<onDelete>RESTRICT</onDelete>
	91	</foreignKey>
6a488035 TO	92	<field>
6a488035 TO	93	<name>financial_type_id</name>
0d94665e	94	<title>Membership Financial Type</title>
6a488035 TO	95	<type>int unsigned</type>
6a488035 TO	96	<required>true</required>
6cc0b7bd EM	97	<pseudoconstant>
	98	<table>civicrm_financial_type</table>
	99	<keyColumn>id</keyColumn>
	100	<labelColumn>name</labelColumn>
	101	</pseudoconstant>
6a488035 TO	102	<comment>If membership is paid by a contribution - what financial type should be used. FK to civicrm_financial_type.id</comment>
	103	<add>4.3</add>
	104	</field>
3c7d2158	105	<foreignKey>
	106	<name>financial_type_id</name>
	107	<table>civicrm_financial_type</table>
	108	<key>id</key>
6a488035 TO	109	<add>4.3</add>
6a488035 TO	110	</foreignKey>
3c7d2158	111	<field>
3c7d2158	112	<name>minimum_fee</name>
6f85d058	113	<title>Membership Type Minimum Fee</title>
3c7d2158	114	<type>decimal</type>
25e0f950	115	<length>18,9</length>
3c7d2158	116	<comment>Minimum fee for this membership (0 for free/complimentary memberships).</comment>
6a488035	117	<default>0</default>
6f85d058	118	<html>
6f85d058	119	<type>Text</type>
80a96508	120	<label>Minimum Fee</label>
6f85d058	121	</html>
3c7d2158	122	<add>1.5</add>
	123	</field>
	124	<field>
	125	<name>duration_unit</name>
0d94665e	126	<title>Membership Type Duration Unit</title>
be622aca	127	<type>varchar</type>
be622aca	128	<length>8</length>
3c7d2158	129	<comment>Unit in which membership period is expressed.</comment>
71a707c3	130	<pseudoconstant>
93bfa565	131	<callback>CRM_Core_SelectValues::membershipTypeUnitList</callback>
71a707c3	132	</pseudoconstant>
3c7d2158	133	<add>1.5</add>
614d72ec	134	<html>
	135	<type>Select</type>
	136	</html>
3c7d2158	137	</field>
3c7d2158	138	<field>
6a488035	139	<name>duration_interval</name>
0d94665e	140	<title>Membership Type Duration Interval</title>
6a488035	141	<type>int</type>
6f85d058	142	<html>
	143	<type>Text</type>
	144	</html>
3c7d2158	145	<comment>Number of duration units in membership period (e.g. 1 year, 12 months).</comment>
	146	<add>1.5</add>
	147	</field>
	148	<field>
	149	<name>period_type</name>
0d94665e	150	<title>Membership Type Plan</title>
be622aca	151	<type>varchar</type>
be622aca	152	<length>8</length>
0524826d	153	<required>true</required>
3c7d2158	154	<comment>Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day.</comment>
6f85d058	155	<html>
	156	<type>Select</type>
	157	</html>
71a707c3	158	<pseudoconstant>
93bfa565	159	<callback>CRM_Core_SelectValues::periodType</callback>
71a707c3	160	</pseudoconstant>
3c7d2158	161	<add>1.5</add>
	162	</field>
	163	<field>
	164	<name>fixed_period_start_day</name>
0d94665e	165	<title>Fixed Period Start Day</title>
6a488035	166	<type>int</type>
3c7d2158	167	<comment>For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day.</comment>
	168	<add>1.5</add>
	169	</field>
	170	<field>
	171	<name>fixed_period_rollover_day</name>
0d94665e	172	<title>Fixed Period Rollover Day</title>
3c7d2158	173	<type>int</type>
	174	<comment>For fixed period memberships, signups after this day (mmdd) rollover to next period.</comment>
	175	<add>1.5</add>
	176	</field>
6a488035 TO	177	<field>
6a488035 TO	178	<name>relationship_type_id</name>
0d94665e	179	<title>Membership Type Relationship</title>
6a488035 TO	180	<type>varchar</type>
	181	<length>64</length>
	182	<comment>FK to Relationship Type ID</comment>
	183	<add>1.5</add>
96c40ac7	184	<serialize>SEPARATOR_TRIMMED</serialize>
6a488035	185	</field>
6a488035 TO	186	<index>
	187	<name>index_relationship_type_id</name>
	188	<fieldName>relationship_type_id</fieldName>
	189	<add>3.3</add>
	190	</index>
3c7d2158	191	<field>
	192	<name>relationship_direction</name>
	193	<type>varchar</type>
	194	<length>128</length>
	195	<add>1.7</add>
96c40ac7	196	<serialize>SEPARATOR_TRIMMED</serialize>
6a488035 TO	197	</field>
	198	<field>
	199	<name>max_related</name>
0d94665e	200	<title>Max Related Members for Type</title>
6a488035 TO	201	<type>int</type>
	202	<comment>Maximum number of related memberships.</comment>
	203	<add>4.3</add>
6f85d058	204	<html>
6f85d058	205	<type>Text</type>
80a96508	206	<label>Max Related</label>
6f85d058	207	</html>
6a488035 TO	208	</field>
6a488035 TO	209	<field>
3c7d2158	210	<name>visibility</name>
6a488035 TO	211	<title>Visible</title>
	212	<type>varchar</type>
	213	<length>64</length>
4080e473 AS	214	<add>1.5</add>
4080e473 AS	215	<pseudoconstant>
eacf220c	216	<callback>CRM_Core_SelectValues::memberVisibility</callback>
4080e473	217	</pseudoconstant>
614d72ec	218	<html>
e0991796	219	<type>Select</type>
614d72ec	220	</html>
6a488035	221	</field>
3c7d2158	222	<field>
3c7d2158	223	<name>weight</name>
7ecddde4	224	<title>Order</title>
6a488035	225	<type>int</type>
6f85d058	226	<html>
	227	<type>Text</type>
	228	</html>
3c7d2158	229	<add>1.5</add>
6a488035 TO	230	</field>
	231	<field>
	232	<name>receipt_text_signup</name>
0d94665e	233	<title>Membership Type Receipt Text</title>
6a488035	234	<type>varchar</type>
7deea513	235	<html>
7deea513	236	<type>TextArea</type>
817807ab	237	<rows>6</rows>
817807ab	238	<cols>50</cols>
7deea513	239	</html>
6a488035 TO	240	<length>255</length>
	241	<comment>Receipt Text for membership signup</comment>
	242	<add>2.0</add>
	243	</field>
	244	<field>
	245	<name>receipt_text_renewal</name>
0d94665e	246	<title>Membership Type Renewal Text</title>
6a488035	247	<type>varchar</type>
7deea513	248	<html>
7deea513	249	<type>TextArea</type>
817807ab	250	<rows>6</rows>
817807ab	251	<cols>50</cols>
7deea513	252	</html>
6a488035 TO	253	<length>255</length>
	254	<comment>Receipt Text for membership renewal</comment>
	255	<add>2.0</add>
	256	</field>
3c7d2158	257	<field>
3c7d2158	258	<name>auto_renew</name>
6a488035 TO	259	<type>boolean</type>
6a488035 TO	260	<default>0</default>
fc093e40	261	<html>
	262	<type>Radio</type>
	263	</html>
dbd82592 CW	264	<pseudoconstant>
	265	<callback>CRM_Core_SelectValues::memberAutoRenew</callback>
	266	</pseudoconstant>
3c7d2158	267	<comment>0 = No auto-renew option; 1 = Give option, but not required; 2 = Auto-renew required;</comment>
	268	<add>3.3</add>
	269	</field>
	270	<field>
	271	<name>is_active</name>
6a488035 TO	272	<title>Is Active</title>
	273	<type>boolean</type>
	274	<default>1</default>
3c7d2158	275	<comment>Is this membership_type enabled</comment>
3c7d2158	276	<add>1.5</add>
6f85d058	277	<html>
6f85d058	278	<type>CheckBox</type>
80a96508	279	<label>Enabled?</label>
6f85d058	280	</html>
3c7d2158	281	</field>
6a488035	282	</table>