xml/schema/Contribute/Product.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Contribute</base>
   5   <class>Product</class>
   6   <comment>able - stores "product info" for premiums and can be used for non-incentive products </comment>
   7   <name>civicrm_product</name>
   8   <add>1.4</add>
   9   <log>true</log>
  10   <field>
  11       <name>id</name>
  12       <type>int unsigned</type>
  13       <required>true</required>
  14       <add>1.4</add>
  15   </field>
  16   <primaryKey>
  17        <name>id</name>
  18        <autoincrement>true</autoincrement>
  19   </primaryKey>
  20   <field>
  21        <name>name</name>
  22        <uniqueName>product_name</uniqueName>
  23        <title>Product Name</title>
  24        <type>varchar</type>
  25        <length>255</length>
  26        <required>true</required>
  27        <export>true</export>
  28        <localizable>true</localizable>
  29        <comment>Required product/premium name</comment>
  30        <add>1.4</add>
  31   </field>
  32   <field>
  33       <name>description</name>
  34       <title>Description</title>
  35       <type>text</type>
  36       <localizable>true</localizable>
  37       <comment>Optional description of the product/premium.</comment>
  38       <add>1.4</add>
  39   </field>
  40   <field>
  41       <name>sku</name>
  42       <title>SKU</title>
  43       <type>varchar</type>
  44       <length>50</length>
  45       <export>true</export>
  46       <comment>Optional product sku or code.</comment>
  47       <add>1.4</add>
  48   </field>
  49   <field>
  50       <name>options</name>
  51       <title>Options</title>
  52       <type>text</type>
  53       <localizable>true</localizable>
  54       <comment>Store comma-delimited list of color, size, etc. options for the product.</comment>
  55       <add>1.4</add>
  56   </field>
  57   <field>
  58       <name>image</name>
  59       <title>Image</title>
  60       <type>varchar</type>
  61       <length>255</length>
  62       <comment>Full or relative URL to uploaded image - fullsize.</comment>
  63       <add>1.4</add>
  64   </field>
  65    <field>
  66       <name>thumbnail</name>
  67       <title>Thumbnail</title>
  68       <type>varchar</type>
  69       <length>255</length>
  70       <comment>Full or relative URL to image thumbnail.</comment>
  71       <add>1.4</add>
  72   </field>
  73   <field>
  74       <name>price</name>
  75       <title>Price</title>
  76       <type>decimal</type>
  77       <comment>Sell price or market value for premiums. For tax-deductible contributions, this will be stored as non_deductible_amount in the contribution record.</comment>
  78       <add>1.4</add>
  79   </field>
  80   <field>
  81       <name>currency</name>
  82       <type>varchar</type>
  83       <length>3</length>
  84       <default>NULL</default>
  85       <comment>3 character string, value from config setting or input via user.</comment>
  86       <add>3.2</add>
  87       <pseudoconstant>
  88         <table>civicrm_currency</table>
  89         <keyColumn>name</keyColumn>
  90         <labelColumn>symbol</labelColumn>
  91       </pseudoconstant>
  92   </field>
  93   <field>
  94       <name>financial_type_id</name>
  95       <title>Financial Type</title>
  96       <type>int unsigned</type>
  97       <default>NULL</default>
  98       <comment>FK to Financial Type.</comment>
  99       <add>4.3</add>
 100   </field>
 101   <foreignKey>
 102        <name>financial_type_id</name>
 103        <table>civicrm_financial_type</table>
 104        <key>id</key>
 105        <onDelete>SET NULL</onDelete>
 106        <add>4.3</add>
 107   </foreignKey>
 108
 109   <field>
 110       <name>min_contribution</name>
 111       <title>Minimum Contribution</title>
 112       <type>decimal</type>
 113       <comment>Minimum contribution required to be eligible to select this premium.</comment>
 114       <add>1.4</add>
 115   </field>
 116   <field>
 117       <name>cost</name>
 118       <title>Cost</title>
 119       <type>decimal</type>
 120       <comment>Actual cost of this product. Useful to determine net return from sale or using this as an incentive.</comment>
 121       <add>1.4</add>
 122   </field>
 123   <field>
 124       <name>is_active</name>
 125       <title>Is Active</title>
 126       <type>boolean</type>
 127       <required>true</required>
 128       <comment>Disabling premium removes it from the premiums_premium join table below.</comment>
 129       <add>1.4</add>
 130   </field>
 131   <field>
 132       <name>period_type</name>
 133       <title>Period Type</title>
 134       <type>enum</type>
 135       <values>rolling,fixed</values>
 136       <default>'rolling'</default>
 137       <comment>Rolling means we set start/end based on current day, fixed means we set start/end for current year or month
 138 (e.g. 1 year + fixed -> we would set start/end for 1/1/06 thru 12/31/06 for any premium chosen in 2006) </comment>
 139       <add>1.4</add>
 140   </field>
 141   <field>
 142       <name>fixed_period_start_day</name>
 143       <title>Fixed Period Start Day</title>
 144       <type>int</type>
 145       <default>0101</default>
 146       <comment>Month and day (MMDD) that fixed period type subscription or membership starts.</comment>
 147       <add>1.4</add>
 148   </field>
 149   <field>
 150       <name>duration_unit</name>
 151       <title>Duration Unit</title>
 152       <type>enum</type>
 153       <values>day,month,week,year</values>
 154       <default>'year'</default>
 155       <add>1.4</add>
 156   </field>
 157   <field>
 158       <name>duration_interval</name>
 159       <title>Duration Interval</title>
 160       <type>int</type>
 161       <comment>Number of units for total duration of subscription, service, membership (e.g. 12 Months).</comment>
 162       <add>1.4</add>
 163   </field>
 164   <field>
 165       <name>frequency_unit</name>
 166       <title>Frequency Unit</title>
 167       <type>enum</type>
 168       <values>day,month,week,year</values>
 169       <default>'month'</default>
 170       <comment>Frequency unit and interval allow option to store actual delivery frequency for a subscription or service.</comment>
 171       <add>1.4</add>
 172   </field>
 173   <field>
 174       <name>frequency_interval</name>
 175       <title>Frequency Interval</title>
 176       <type>int</type>
 177       <comment>Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months).</comment>
 178       <add>1.4</add>
 179   </field>
 180 </table>