Merge pull request #23195 from eileenmcnaughton/ds3
[civicrm-core.git] / xml / schema / Pledge / PledgeBlock.xml
1 <?xml version="1.0" encoding="iso-8859-1" ?>
2 <table>
3 <base>CRM/Pledge</base>
4 <class>PledgeBlock</class>
5 <name>civicrm_pledge_block</name>
6 <add>2.1</add>
7 <log>true</log>
8 <component>CiviPledge</component>
9 <field>
10 <name>id</name>
11 <title>Pledge Block ID</title>
12 <type>int unsigned</type>
13 <required>true</required>
14 <comment>Pledge ID</comment>
15 <add>2.1</add>
16 <html>
17 <type>Number</type>
18 </html>
19 </field>
20 <primaryKey>
21 <name>id</name>
22 <autoincrement>true</autoincrement>
23 </primaryKey>
24 <field>
25 <name>entity_table</name>
26 <title>Entity Table</title>
27 <type>varchar</type>
28 <length>64</length>
29 <comment>physical tablename for entity being joined to pledge, e.g. civicrm_contact</comment>
30 <add>2.1</add>
31 </field>
32 <field>
33 <name>entity_id</name>
34 <title>Entity ID</title>
35 <type>int unsigned</type>
36 <required>true</required>
37 <comment>FK to entity table specified in entity_table column.</comment>
38 <add>2.1</add>
39 </field>
40 <dynamicForeignKey>
41 <idColumn>entity_id</idColumn>
42 <typeColumn>entity_table</typeColumn>
43 <add>2.1</add>
44 </dynamicForeignKey>
45 <index>
46 <name>index_entity</name>
47 <fieldName>entity_table</fieldName>
48 <fieldName>entity_id</fieldName>
49 <add>2.1</add>
50 </index>
51 <field>
52 <name>pledge_frequency_unit</name>
53 <title>Pledge Frequency Unit</title>
54 <type>varchar</type>
55 <length>128</length>
56 <comment>Delimited list of supported frequency units</comment>
57 <serialize>SEPARATOR_TRIMMED</serialize>
58 <add>2.1</add>
59 </field>
60 <field>
61 <name>is_pledge_interval</name>
62 <title>Expose Frequency Interval?</title>
63 <type>boolean</type>
64 <default>0</default>
65 <required>true</required>
66 <comment>Is frequency interval exposed on the contribution form.</comment>
67 <add>2.1</add>
68 </field>
69 <field>
70 <name>max_reminders</name>
71 <title>Maximum Number of Reminders</title>
72 <type>int unsigned</type>
73 <default>1</default>
74 <comment>The maximum number of payment reminders to send for any given payment.</comment>
75 <add>2.1</add>
76 </field>
77 <field>
78 <name>initial_reminder_day</name>
79 <title>Initial Reminder Day</title>
80 <type>int unsigned</type>
81 <default>5</default>
82 <comment>Send initial reminder this many days prior to the payment due date.</comment>
83 <add>2.1</add>
84 </field>
85 <field>
86 <name>additional_reminder_day</name>
87 <title>Additional Reminder Days</title>
88 <type>int unsigned</type>
89 <default>5</default>
90 <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.</comment>
91 <add>2.1</add>
92 </field>
93 <field>
94 <name>pledge_start_date</name>
95 <type>varchar</type>
96 <length>64</length>
97 <title>Pledge Start Date</title>
98 <comment>The date the first scheduled pledge occurs.</comment>
99 <add>4.7</add>
100 </field>
101 <field>
102 <name>is_pledge_start_date_visible</name>
103 <type>boolean</type>
104 <title>Show Recurring Donation Start Date?</title>
105 <default>0</default>
106 <required>true</required>
107 <comment>If true - recurring start date is shown.</comment>
108 <add>4.7</add>
109 </field>
110 <field>
111 <name>is_pledge_start_date_editable</name>
112 <type>boolean</type>
113 <title>Allow Edits to Recurring Donation Start Date?</title>
114 <default>0</default>
115 <required>true</required>
116 <comment>If true - recurring start date is editable.</comment>
117 <add>4.7</add>
118 </field>
119 </table>