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