[civicrm-core.git] / xml / schema / Contribute / Product.xml

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

<table>
  <base>CRM/Contribute</base>
  <class>Product</class>
  <comment>able - stores "product info" for premiums and can be used for non-incentive products </comment>
  <name>civicrm_product</name>
  <add>1.4</add>
  <log>true</log>
  <field>
      <name>id</name>
      <type>int unsigned</type>
      <required>true</required>
      <add>1.4</add>
  </field>
  <primaryKey>
       <name>id</name>
       <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
       <name>name</name>
       <uniqueName>product_name</uniqueName>
       <title>Product Name</title>
       <type>varchar</type>
       <length>255</length>
       <required>true</required>
       <export>true</export>
       <localizable>true</localizable>
       <comment>Required product/premium name</comment>
       <add>1.4</add>
  </field>
  <field>
      <name>description</name>
      <title>Description</title>
      <type>text</type>
      <localizable>true</localizable>
      <comment>Optional description of the product/premium.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>sku</name>
      <title>SKU</title>
      <type>varchar</type>
      <length>50</length>
      <export>true</export>
      <comment>Optional product sku or code.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>options</name>
      <title>Options</title>
      <type>text</type>
      <localizable>true</localizable>
      <comment>Store comma-delimited list of color, size, etc. options for the product.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>image</name>
      <title>Image</title>
      <type>varchar</type>
      <length>255</length>
      <comment>Full or relative URL to uploaded image - fullsize.</comment>
      <add>1.4</add>
  </field>
   <field>
      <name>thumbnail</name>
      <title>Thumbnail</title>
      <type>varchar</type>
      <length>255</length>
      <comment>Full or relative URL to image thumbnail.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>price</name>
      <title>Price</title>
      <type>decimal</type>
      <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>
      <add>1.4</add>
  </field>
  <field>
      <name>currency</name>
      <type>varchar</type>
      <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>financial_type_id</name>
      <title>Financial Type</title>
      <type>int unsigned</type>
      <default>NULL</default>
      <comment>FK to Financial Type.</comment>
      <add>4.3</add>
  </field>
  <foreignKey>
       <name>financial_type_id</name>
       <table>civicrm_financial_type</table>
       <key>id</key>
       <onDelete>SET NULL</onDelete>
       <add>4.3</add>
  </foreignKey>

  <field>
      <name>min_contribution</name>
      <title>Minimum Contribution</title>
      <type>decimal</type>
      <comment>Minimum contribution required to be eligible to select this premium.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>cost</name>
      <title>Cost</title>
      <type>decimal</type>
      <comment>Actual cost of this product. Useful to determine net return from sale or using this as an incentive.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>is_active</name>
      <title>Is Active</title>
      <type>boolean</type>
      <required>true</required>
      <comment>Disabling premium removes it from the premiums_premium join table below.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>period_type</name>
      <title>Period Type</title>
      <type>enum</type>
      <values>rolling,fixed</values>
      <default>'rolling'</default>
      <comment>Rolling means we set start/end based on current day, fixed means we set start/end for current year or month
(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>
      <add>1.4</add>
      <html>
        <type>Select</type>
      </html>
  </field>
  <field>
      <name>fixed_period_start_day</name>
      <title>Fixed Period Start Day</title>
      <type>int</type>
      <default>0101</default>
      <comment>Month and day (MMDD) that fixed period type subscription or membership starts.</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>duration_unit</name>
      <title>Duration Unit</title>
      <type>enum</type>
      <values>day,month,week,year</values>
      <default>'year'</default>
      <add>1.4</add>
      <html>
        <type>Select</type>
      </html>
  </field>
  <field>
      <name>duration_interval</name>
      <title>Duration Interval</title>
      <type>int</type>
      <comment>Number of units for total duration of subscription, service, membership (e.g. 12 Months).</comment>
      <add>1.4</add>
  </field>
  <field>
      <name>frequency_unit</name>
      <title>Frequency Unit</title>
      <type>enum</type>
      <values>day,month,week,year</values>
      <default>'month'</default>
      <comment>Frequency unit and interval allow option to store actual delivery frequency for a subscription or service.</comment>
      <add>1.4</add>
      <html>
        <type>Select</type>
      </html>
  </field>
  <field>
      <name>frequency_interval</name>
      <title>Frequency Interval</title>
      <type>int</type>
      <comment>Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months).</comment>
      <add>1.4</add>
  </field>
</table>
Commit	Line	Data
3c7d2158	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
	4	<base>CRM/Contribute</base>
6a488035 TO	5	<class>Product</class>
6a488035 TO	6	<comment>able - stores "product info" for premiums and can be used for non-incentive products </comment>
3c7d2158	7	<name>civicrm_product</name>
3c7d2158	8	<add>1.4</add>
6a488035	9	<log>true</log>
3c7d2158	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>
6a488035 TO	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>
3c7d2158	40	<field>
3c7d2158	41	<name>sku</name>
6a488035 TO	42	<title>SKU</title>
	43	<type>varchar</type>
	44	<length>50</length>
3c7d2158	45	<export>true</export>
6a488035	46	<comment>Optional product sku or code.</comment>
3c7d2158	47	<add>1.4</add>
	48	</field>
	49	<field>
	50	<name>options</name>
6a488035 TO	51	<title>Options</title>
	52	<type>text</type>
	53	<localizable>true</localizable>
3c7d2158	54	<comment>Store comma-delimited list of color, size, etc. options for the product.</comment>
	55	<add>1.4</add>
	56	</field>
	57	<field>
6a488035 TO	58	<name>image</name>
6a488035 TO	59	<title>Image</title>
3c7d2158	60	<type>varchar</type>
6a488035	61	<length>255</length>
3c7d2158	62	<comment>Full or relative URL to uploaded image - fullsize.</comment>
	63	<add>1.4</add>
	64	</field>
	65	<field>
6a488035 TO	66	<name>thumbnail</name>
6a488035 TO	67	<title>Thumbnail</title>
3c7d2158	68	<type>varchar</type>
6a488035	69	<length>255</length>
3c7d2158	70	<comment>Full or relative URL to image thumbnail.</comment>
	71	<add>1.4</add>
	72	</field>
	73	<field>
	74	<name>price</name>
6a488035	75	<title>Price</title>
3c7d2158	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>
6a488035 TO	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>
bd44e0df AS	87	<pseudoconstant>
	88	<table>civicrm_currency</table>
	89	<keyColumn>name</keyColumn>
a38a89fc CW	90	<labelColumn>full_name</labelColumn>
a38a89fc CW	91	<nameColumn>numeric_code</nameColumn>
bd44e0df	92	</pseudoconstant>
614d72ec	93	<html>
	94	<type>Select></type>
	95	</html>
6a488035	96	</field>
3c7d2158	97	<field>
3c7d2158	98	<name>financial_type_id</name>
6a488035	99	<title>Financial Type</title>
3c7d2158	100	<type>int unsigned</type>
6a488035 TO	101	<default>NULL</default>
6a488035 TO	102	<comment>FK to Financial Type.</comment>
3c7d2158	103	<add>4.3</add>
	104	</field>
	105	<foreignKey>
	106	<name>financial_type_id</name>
	107	<table>civicrm_financial_type</table>
	108	<key>id</key>
6a488035 TO	109	<onDelete>SET NULL</onDelete>
6a488035 TO	110	<add>4.3</add>
3c7d2158	111	</foreignKey>
	112
	113	<field>
6a488035 TO	114	<name>min_contribution</name>
	115	<title>Minimum Contribution</title>
	116	<type>decimal</type>
3c7d2158	117	<comment>Minimum contribution required to be eligible to select this premium.</comment>
3c7d2158	118	<add>1.4</add>
6a488035	119	</field>
3c7d2158	120	<field>
6a488035 TO	121	<name>cost</name>
6a488035 TO	122	<title>Cost</title>
3c7d2158	123	<type>decimal</type>
	124	<comment>Actual cost of this product. Useful to determine net return from sale or using this as an incentive.</comment>
	125	<add>1.4</add>
6a488035	126	</field>
3c7d2158	127	<field>
6a488035 TO	128	<name>is_active</name>
6a488035 TO	129	<title>Is Active</title>
3c7d2158	130	<type>boolean</type>
	131	<required>true</required>
	132	<comment>Disabling premium removes it from the premiums_premium join table below.</comment>
	133	<add>1.4</add>
6a488035	134	</field>
3c7d2158	135	<field>
6a488035 TO	136	<name>period_type</name>
	137	<title>Period Type</title>
	138	<type>enum</type>
	139	<values>rolling,fixed</values>
	140	<default>'rolling'</default>
	141	<comment>Rolling means we set start/end based on current day, fixed means we set start/end for current year or month
3c7d2158	142	(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>
3c7d2158	143	<add>1.4</add>
614d72ec	144	<html>
	145	<type>Select</type>
	146	</html>
6a488035	147	</field>
3c7d2158	148	<field>
6a488035 TO	149	<name>fixed_period_start_day</name>
	150	<title>Fixed Period Start Day</title>
	151	<type>int</type>
	152	<default>0101</default>
3c7d2158	153	<comment>Month and day (MMDD) that fixed period type subscription or membership starts.</comment>
3c7d2158	154	<add>1.4</add>
6a488035	155	</field>
3c7d2158	156	<field>
6a488035 TO	157	<name>duration_unit</name>
	158	<title>Duration Unit</title>
	159	<type>enum</type>
	160	<values>day,month,week,year</values>
	161	<default>'year'</default>
3c7d2158	162	<add>1.4</add>
614d72ec	163	<html>
	164	<type>Select</type>
	165	</html>
6a488035	166	</field>
3c7d2158	167	<field>
6a488035 TO	168	<name>duration_interval</name>
	169	<title>Duration Interval</title>
	170	<type>int</type>
3c7d2158	171	<comment>Number of units for total duration of subscription, service, membership (e.g. 12 Months).</comment>
3c7d2158	172	<add>1.4</add>
6a488035	173	</field>
3c7d2158	174	<field>
6a488035 TO	175	<name>frequency_unit</name>
	176	<title>Frequency Unit</title>
	177	<type>enum</type>
	178	<values>day,month,week,year</values>
	179	<default>'month'</default>
	180	<comment>Frequency unit and interval allow option to store actual delivery frequency for a subscription or service.</comment>
3c7d2158	181	<add>1.4</add>
614d72ec	182	<html>
	183	<type>Select</type>
	184	</html>
6a488035	185	</field>
3c7d2158	186	<field>
6a488035 TO	187	<name>frequency_interval</name>
	188	<title>Frequency Interval</title>
	189	<type>int</type>
3c7d2158	190	<comment>Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months).</comment>
3c7d2158	191	<add>1.4</add>
6a488035 TO	192	</field>
6a488035 TO	193	</table>