[civicrm-core.git] / xml / schema / Pledge / Pledge.xml

<?xml version="1.0" encoding="iso-8859-1" ?>
<table>
  <base>CRM/Pledge</base>
  <class>Pledge</class>
  <name>civicrm_pledge</name>
  <add>2.1</add>
  <log>true</log>
  <field>
    <name>id</name>
    <uniqueName>pledge_id</uniqueName>
    <title>Pledge ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Pledge ID</comment>
    <import>true</import>
    <add>2.1</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>contact_id</name>
    <uniqueName>pledge_contact_id</uniqueName>
    <title>Contact ID</title>
    <import>true</import>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Foreign key to civicrm_contact.id .</comment>
    <add>2.1</add>
    <html>
       <type>EntityRef</type>
     </html>
  </field>
  <foreignKey>
    <name>contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>2.1</add>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>contribution_type_id</name>
    <uniqueName>pledge_contribution_type_id</uniqueName>
    <export>false</export>
    <type>int unsigned</type>
    <comment>FK to Contribution Type. This is propagated to contribution record when pledge payments are made.</comment>
    <add>2.1</add>
    <drop>4.3</drop>
  </field>
  <foreignKey>
    <name>contribution_type_id</name>
    <table>civicrm_contribution_type</table>
    <key>id</key>
    <add>2.1</add>
    <drop>4.3</drop>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>financial_type_id</name>
    <title>Type</title>
    <uniqueName>pledge_financial_type_id</uniqueName>
    <type>int unsigned</type>
    <comment>FK to Financial Type</comment>
    <pseudoconstant>
      <table>civicrm_financial_type</table>
      <keyColumn>id</keyColumn>
      <labelColumn>name</labelColumn>
    </pseudoconstant>
    <add>4.3</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>financial_type_id</name>
    <table>civicrm_financial_type</table>
    <key>id</key>
    <add>4.3</add>
  </foreignKey>
  <field>
    <name>contribution_page_id</name>
    <uniqueName>pledge_contribution_page_id</uniqueName>
    <title>Pledge Contribution Page</title>
    <type>int unsigned</type>
    <comment>The Contribution Page which triggered this contribution</comment>
    <add>2.1</add>
  </field>
  <foreignKey>
    <name>contribution_page_id</name>
    <table>civicrm_contribution_page</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>amount</name>
    <uniqueName>pledge_amount</uniqueName>
    <title>Total Pledged</title>
    <type>decimal</type>
    <required>true</required>
    <import>true</import>
    <comment>Total pledged amount.</comment>
    <add>2.1</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <field>
    <name>original_installment_amount</name>
    <uniqueName>pledge_original_installment_amount</uniqueName>
    <title>Original Installment Amount</title>
    <type>decimal</type>
    <required>true</required>
    <comment>Original amount for each of the installments.</comment>
    <add>3.2</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>currency</name>
    <type>varchar</type>
    <title>Pledge Currency</title>
    <length>3</length>
    <default>NULL</default>
    <comment>3 character string, value from config setting or input via user.</comment>
    <add>3.2</add>
    <pseudoconstant>
      <table>civicrm_currency</table>
      <keyColumn>name</keyColumn>
      <labelColumn>full_name</labelColumn>
      <nameColumn>numeric_code</nameColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>frequency_unit</name>
    <uniqueName>pledge_frequency_unit</uniqueName>
    <title>Pledge Frequency Unit</title>
    <type>varchar</type>
    <length>8</length>
    <default>'month'</default>
    <comment>Time units for recurrence of pledge payments.</comment>
    <pseudoconstant>
      <optionGroupName>recur_frequency_units</optionGroupName>
      <keyColumn>name</keyColumn>
    </pseudoconstant>
    <add>2.1</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>frequency_interval</name>
    <uniqueName>pledge_frequency_interval</uniqueName>
    <title>Pledge Frequency Interval</title>
    <type>int unsigned</type>
    <required>true</required>
    <default>1</default>
    <comment>Number of time units for recurrence of pledge payments.</comment>
    <add>2.1</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>frequency_day</name>
    <type>int unsigned</type>
    <title>Pledge day</title>
    <default>3</default>
    <required>true</required>
    <comment>Day in the period when the pledge payment is due e.g. 1st of month, 15th etc. Use this to set the scheduled dates for pledge payments.</comment>
    <add>2.1</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>installments</name>
    <type>int unsigned</type>
    <title>Pledge Number of Installments</title>
    <default>1</default>
    <comment>Total number of payments to be made.</comment>
    <add>2.1</add>
    <html>
     <type>Text</type>
   </html>
  </field>
  <field>
    <name>start_date</name>
    <type>datetime</type>
    <title>Pledge Start Date</title>
    <required>true</required>
    <comment>The date the first scheduled pledge occurs.</comment>
    <add>2.1</add>
    <html>
        <type>Select Date</type>
      </html>
  </field>
  <field>
    <name>create_date</name>
    <type>datetime</type>
    <uniqueName>pledge_create_date</uniqueName>
    <title>Pledge Made</title>
    <required>true</required>
    <import>true</import>
    <comment>When this pledge record was created.</comment>
    <add>2.1</add>
    <html>
      <type>Select Date</type>
    </html>
  </field>
  <field>
    <name>acknowledge_date</name>
    <type>datetime</type>
    <title>Pledge Acknowledged</title>
    <comment>When a pledge acknowledgement message was sent to the contributor.</comment>
    <add>2.1</add>
    <html>
        <type>Select Date</type>
    </html>
  </field>
  <field>
    <name>modified_date</name>
    <type>datetime</type>
    <title>Pledge Modified Date</title>
    <comment>Last updated date for this pledge record.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>cancel_date</name>
    <type>datetime</type>
    <title>Pledge Cancelled Date</title>
    <comment>Date this pledge was cancelled by contributor.</comment>
    <add>2.1</add>
    <html>
        <type>Select Date</type>
    </html>
  </field>
  <field>
    <name>end_date</name>
    <type>datetime</type>
    <title>Pledge End Date</title>
    <comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).</comment>
    <add>2.1</add>
    <html>
        <type>Select Date</type>
    </html>
  </field>
  <field>
    <name>max_reminders</name>
    <title>Maximum Number of Reminders</title>
    <type>int unsigned</type>
    <default>1</default>
    <comment>The maximum number of payment reminders to send for any given payment.</comment>
    <html>
         <type>Text</type>
       </html>
    <add>2.1</add>
  </field>
  <field>
    <name>initial_reminder_day</name>
    <title>Initial Reminder Day</title>
    <type>int unsigned</type>
    <default>5</default>
    <comment>Send initial reminder this many days prior to the payment due date.</comment>
    <add>2.1</add>
    <html>
          <type>Select</type>
        </html>
  </field>
  <field>
    <name>additional_reminder_day</name>
    <title>Additional Reminder Days</title>
    <type>int unsigned</type>
    <default>5</default>
    <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.</comment>
    <add>2.1</add>
    <html>
         <type>Text</type>
       </html>
  </field>
  <field>
    <name>status_id</name>
    <title>Pledge Status Id</title>
    <uniqueName>pledge_status_id</uniqueName>
    <import>true</import>
    <export>false</export>
    <type>int unsigned</type>
    <pseudoconstant>
      <optionGroupName>contribution_status</optionGroupName>
    </pseudoconstant>
    <comment>Implicit foreign key to civicrm_option_values in the contribution_status option group.</comment>
    <add>2.1</add>
  </field>
  <index>
    <name>index_status</name>
    <fieldName>status_id</fieldName>
    <add>2.1</add>
  </index>
  <field>
    <name>is_test</name>
    <uniqueName>pledge_is_test</uniqueName>
    <import>true</import>
    <title>Test</title>
    <type>boolean</type>
    <default>0</default>
    <html>
     <type>CheckBox</type>
   </html>
  </field>
  <field>
    <name>campaign_id</name>
    <uniqueName>pledge_campaign_id</uniqueName>
    <type>int unsigned</type>
    <title>Campaign</title>
    <import>true</import>
    <comment>The campaign for which this pledge has been initiated.</comment>
    <pseudoconstant>
      <table>civicrm_campaign</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <add>3.4</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
</table>
Commit	Line	Data
6a488035 TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2	<table>
	3	<base>CRM/Pledge</base>
	4	<class>Pledge</class>
	5	<name>civicrm_pledge</name>
	6	<add>2.1</add>
	7	<log>true</log>
	8	<field>
	9	<name>id</name>
	10	<uniqueName>pledge_id</uniqueName>
	11	<title>Pledge ID</title>
	12	<type>int unsigned</type>
	13	<required>true</required>
	14	<comment>Pledge ID</comment>
	15	<import>true</import>
	16	<add>2.1</add>
	17	</field>
	18	<primaryKey>
	19	<name>id</name>
	20	<autoincrement>true</autoincrement>
	21	</primaryKey>
	22	<field>
	23	<name>contact_id</name>
	24	<uniqueName>pledge_contact_id</uniqueName>
	25	<title>Contact ID</title>
	26	<import>true</import>
	27	<type>int unsigned</type>
	28	<required>true</required>
	29	<comment>Foreign key to civicrm_contact.id .</comment>
	30	<add>2.1</add>
614d72ec	31	<html>
916b6181	32	<type>EntityRef</type>
614d72ec	33	</html>
6a488035 TO	34	</field>
	35	<foreignKey>
	36	<name>contact_id</name>
	37	<table>civicrm_contact</table>
	38	<key>id</key>
	39	<add>2.1</add>
	40	<onDelete>CASCADE</onDelete>
	41	</foreignKey>
3c7d2158	42	<field>
3c7d2158	43	<name>contribution_type_id</name>
6a488035 TO	44	<uniqueName>pledge_contribution_type_id</uniqueName>
6a488035 TO	45	<export>false</export>
3c7d2158	46	<type>int unsigned</type>
6a488035 TO	47	<comment>FK to Contribution Type. This is propagated to contribution record when pledge payments are made.</comment>
6a488035 TO	48	<add>2.1</add>
3c7d2158	49	<drop>4.3</drop>
	50	</field>
	51	<foreignKey>
	52	<name>contribution_type_id</name>
	53	<table>civicrm_contribution_type</table>
	54	<key>id</key>
6a488035	55	<add>2.1</add>
3c7d2158	56	<drop>4.3</drop>
6a488035 TO	57	<onDelete>SET NULL</onDelete>
6a488035 TO	58	</foreignKey>
3c7d2158	59	<field>
3c7d2158	60	<name>financial_type_id</name>
6a488035 TO	61	<title>Type</title>
6a488035 TO	62	<uniqueName>pledge_financial_type_id</uniqueName>
3c7d2158	63	<type>int unsigned</type>
6a488035	64	<comment>FK to Financial Type</comment>
6cc0b7bd EM	65	<pseudoconstant>
	66	<table>civicrm_financial_type</table>
	67	<keyColumn>id</keyColumn>
	68	<labelColumn>name</labelColumn>
	69	</pseudoconstant>
3c7d2158	70	<add>4.3</add>
614d72ec	71	<html>
	72	<type>Select</type>
	73	</html>
3c7d2158	74	</field>
	75	<foreignKey>
	76	<name>financial_type_id</name>
	77	<table>civicrm_financial_type</table>
	78	<key>id</key>
	79	<add>4.3</add>
	80	</foreignKey>
	81	<field>
6a488035 TO	82	<name>contribution_page_id</name>
	83	<uniqueName>pledge_contribution_page_id</uniqueName>
	84	<title>Pledge Contribution Page</title>
3c7d2158	85	<type>int unsigned</type>
	86	<comment>The Contribution Page which triggered this contribution</comment>
	87	<add>2.1</add>
	88	</field>
	89	<foreignKey>
	90	<name>contribution_page_id</name>
	91	<table>civicrm_contribution_page</table>
	92	<key>id</key>
6a488035 TO	93	<onDelete>SET NULL</onDelete>
	94	</foreignKey>
	95	<field>
	96	<name>amount</name>
3c7d2158	97	<uniqueName>pledge_amount</uniqueName>
6a488035 TO	98	<title>Total Pledged</title>
	99	<type>decimal</type>
	100	<required>true</required>
	101	<import>true</import>
	102	<comment>Total pledged amount.</comment>
	103	<add>2.1</add>
614d72ec	104	<html>
	105	<type>Text</type>
	106	</html>
6a488035 TO	107	</field>
	108	<field>
	109	<name>original_installment_amount</name>
3c7d2158	110	<uniqueName>pledge_original_installment_amount</uniqueName>
6a488035 TO	111	<title>Original Installment Amount</title>
	112	<type>decimal</type>
	113	<required>true</required>
	114	<comment>Original amount for each of the installments.</comment>
	115	<add>3.2</add>
614d72ec	116	<html>
	117	<type>Text</type>
	118	</html>
6a488035 TO	119	</field>
	120	<field>
	121	<name>currency</name>
	122	<type>varchar</type>
	123	<title>Pledge Currency</title>
	124	<length>3</length>
	125	<default>NULL</default>
	126	<comment>3 character string, value from config setting or input via user.</comment>
	127	<add>3.2</add>
bd44e0df AS	128	<pseudoconstant>
	129	<table>civicrm_currency</table>
	130	<keyColumn>name</keyColumn>
a38a89fc CW	131	<labelColumn>full_name</labelColumn>
a38a89fc CW	132	<nameColumn>numeric_code</nameColumn>
bd44e0df	133	</pseudoconstant>
614d72ec	134	<html>
e0991796	135	<type>Select</type>
614d72ec	136	</html>
6a488035 TO	137	</field>
	138	<field>
	139	<name>frequency_unit</name>
	140	<uniqueName>pledge_frequency_unit</uniqueName>
	141	<title>Pledge Frequency Unit</title>
be622aca	142	<type>varchar</type>
be622aca	143	<length>8</length>
6a488035 TO	144	<default>'month'</default>
6a488035 TO	145	<comment>Time units for recurrence of pledge payments.</comment>
71a707c3	146	<pseudoconstant>
	147	<optionGroupName>recur_frequency_units</optionGroupName>
	148	<keyColumn>name</keyColumn>
	149	</pseudoconstant>
6a488035	150	<add>2.1</add>
614d72ec	151	<html>
	152	<type>Select</type>
	153	</html>
6a488035 TO	154	</field>
	155	<field>
	156	<name>frequency_interval</name>
	157	<uniqueName>pledge_frequency_interval</uniqueName>
	158	<title>Pledge Frequency Interval</title>
	159	<type>int unsigned</type>
	160	<required>true</required>
	161	<default>1</default>
	162	<comment>Number of time units for recurrence of pledge payments.</comment>
	163	<add>2.1</add>
614d72ec	164	<html>
	165	<type>Text</type>
	166	</html>
6a488035 TO	167	</field>
	168	<field>
	169	<name>frequency_day</name>
	170	<type>int unsigned</type>
	171	<title>Pledge day</title>
	172	<default>3</default>
	173	<required>true</required>
	174	<comment>Day in the period when the pledge payment is due e.g. 1st of month, 15th etc. Use this to set the scheduled dates for pledge payments.</comment>
	175	<add>2.1</add>
614d72ec	176	<html>
	177	<type>Select</type>
	178	</html>
6a488035 TO	179	</field>
	180	<field>
	181	<name>installments</name>
	182	<type>int unsigned</type>
	183	<title>Pledge Number of Installments</title>
	184	<default>1</default>
	185	<comment>Total number of payments to be made.</comment>
	186	<add>2.1</add>
614d72ec	187	<html>
	188	<type>Text</type>
	189	</html>
6a488035 TO	190	</field>
	191	<field>
	192	<name>start_date</name>
	193	<type>datetime</type>
	194	<title>Pledge Start Date</title>
	195	<required>true</required>
	196	<comment>The date the first scheduled pledge occurs.</comment>
	197	<add>2.1</add>
614d72ec	198	<html>
	199	<type>Select Date</type>
	200	</html>
6a488035 TO	201	</field>
	202	<field>
	203	<name>create_date</name>
	204	<type>datetime</type>
	205	<uniqueName>pledge_create_date</uniqueName>
	206	<title>Pledge Made</title>
	207	<required>true</required>
	208	<import>true</import>
	209	<comment>When this pledge record was created.</comment>
	210	<add>2.1</add>
614d72ec	211	<html>
	212	<type>Select Date</type>
	213	</html>
6a488035 TO	214	</field>
	215	<field>
	216	<name>acknowledge_date</name>
	217	<type>datetime</type>
	218	<title>Pledge Acknowledged</title>
	219	<comment>When a pledge acknowledgement message was sent to the contributor.</comment>
	220	<add>2.1</add>
614d72ec	221	<html>
	222	<type>Select Date</type>
	223	</html>
6a488035 TO	224	</field>
	225	<field>
	226	<name>modified_date</name>
	227	<type>datetime</type>
	228	<title>Pledge Modified Date</title>
	229	<comment>Last updated date for this pledge record.</comment>
	230	<add>2.1</add>
	231	</field>
	232	<field>
	233	<name>cancel_date</name>
	234	<type>datetime</type>
	235	<title>Pledge Cancelled Date</title>
	236	<comment>Date this pledge was cancelled by contributor.</comment>
	237	<add>2.1</add>
614d72ec	238	<html>
	239	<type>Select Date</type>
	240	</html>
6a488035 TO	241	</field>
	242	<field>
	243	<name>end_date</name>
	244	<type>datetime</type>
	245	<title>Pledge End Date</title>
	246	<comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).</comment>
	247	<add>2.1</add>
614d72ec	248	<html>
	249	<type>Select Date</type>
	250	</html>
6a488035	251	</field>
6a488035 TO	252	<field>
	253	<name>max_reminders</name>
	254	<title>Maximum Number of Reminders</title>
	255	<type>int unsigned</type>
	256	<default>1</default>
	257	<comment>The maximum number of payment reminders to send for any given payment.</comment>
614d72ec	258	<html>
	259	<type>Text</type>
	260	</html>
6a488035 TO	261	<add>2.1</add>
	262	</field>
	263	<field>
	264	<name>initial_reminder_day</name>
	265	<title>Initial Reminder Day</title>
	266	<type>int unsigned</type>
	267	<default>5</default>
	268	<comment>Send initial reminder this many days prior to the payment due date.</comment>
	269	<add>2.1</add>
614d72ec	270	<html>
	271	<type>Select</type>
	272	</html>
6a488035 TO	273	</field>
	274	<field>
	275	<name>additional_reminder_day</name>
	276	<title>Additional Reminder Days</title>
	277	<type>int unsigned</type>
	278	<default>5</default>
	279	<comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.</comment>
	280	<add>2.1</add>
614d72ec	281	<html>
	282	<type>Text</type>
	283	</html>
6a488035 TO	284	</field>
	285	<field>
	286	<name>status_id</name>
	287	<title>Pledge Status Id</title>
	288	<uniqueName>pledge_status_id</uniqueName>
	289	<import>true</import>
	290	<export>false</export>
	291	<type>int unsigned</type>
294cc627	292	<pseudoconstant>
	293	<optionGroupName>contribution_status</optionGroupName>
	294	</pseudoconstant>
6a488035 TO	295	<comment>Implicit foreign key to civicrm_option_values in the contribution_status option group.</comment>
	296	<add>2.1</add>
	297	</field>
	298	<index>
	299	<name>index_status</name>
	300	<fieldName>status_id</fieldName>
	301	<add>2.1</add>
	302	</index>
3c7d2158	303	<field>
	304	<name>is_test</name>
	305	<uniqueName>pledge_is_test</uniqueName>
6a488035 TO	306	<import>true</import>
	307	<title>Test</title>
	308	<type>boolean</type>
	309	<default>0</default>
614d72ec	310	<html>
	311	<type>CheckBox</type>
	312	</html>
6a488035	313	</field>
3c7d2158	314	<field>
3c7d2158	315	<name>campaign_id</name>
6a488035	316	<uniqueName>pledge_campaign_id</uniqueName>
3c7d2158	317	<type>int unsigned</type>
e1ab2e91	318	<title>Campaign</title>
3c7d2158	319	<import>true</import>
3c7d2158	320	<comment>The campaign for which this pledge has been initiated.</comment>
3e3eacd0 CW	321	<pseudoconstant>
	322	<table>civicrm_campaign</table>
	323	<keyColumn>id</keyColumn>
	324	<labelColumn>title</labelColumn>
3e3eacd0	325	</pseudoconstant>
3c7d2158	326	<add>3.4</add>
614d72ec	327	<html>
	328	<type>Select</type>
	329	</html>
3c7d2158	330	</field>
	331	<foreignKey>
	332	<name>campaign_id</name>
	333	<table>civicrm_campaign</table>
	334	<key>id</key>
6a488035 TO	335	<onDelete>SET NULL</onDelete>
	336	</foreignKey>
	337	</table>