[civicrm-core.git] / xml / schema / Event / Participant.xml

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

<table>
  <base>CRM/Event</base>
  <class>Participant</class>
  <name>civicrm_participant</name>
  <description>Records of contacts' attendance and roles in events.</description>
  <add>1.7</add>
  <log>true</log>
  <icon>fa-ticket</icon>
  <component>CiviEvent</component>
  <field>
    <name>id</name>
    <uniqueName>participant_id</uniqueName>
    <title>Participant ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Participant ID</comment>
    <import>true</import>
    <headerPattern>/(^(participant(.)?)?id$)/i</headerPattern>
    <html>
      <type>Number</type>
    </html>
    <add>1.7</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>contact_id</name>
    <uniqueName>participant_contact_id</uniqueName>
    <type>int unsigned</type>
    <title>Contact ID</title>
    <headerPattern>/contact(.?id)?/i</headerPattern>
    <import>true</import>
    <required>true</required>
    <comment>FK to Contact ID</comment>
    <html>
      <label>Contact</label>
    </html>
    <add>1.7</add>
  </field>
  <foreignKey>
    <name>contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>event_id</name>
    <type>int unsigned</type>
    <title>Event ID</title>
    <import>true</import>
    <headerPattern>/event id$/i</headerPattern>
    <required>true</required>
    <comment>FK to Event ID</comment>
    <html>
      <label>Event</label>
    </html>
    <add>1.7</add>
  </field>
  <foreignKey>
    <name>event_id</name>
    <table>civicrm_event</table>
    <key>id</key>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>status_id</name>
    <uniqueName>participant_status_id</uniqueName>
    <title>Status ID</title>
    <headerPattern>/(participant.)?(status)$/i</headerPattern>
    <import>true</import>
    <type>int unsigned</type>
    <export>true</export>
    <required>true</required>
    <default>1</default>
    <comment>Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.</comment>
    <add>1.7</add>
    <pseudoconstant>
      <table>civicrm_participant_status_type</table>
      <keyColumn>id</keyColumn>
      <labelColumn>label</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
      <label>Status</label>
    </html>
  </field>
  <foreignKey>
    <name>status_id</name>
    <table>civicrm_participant_status_type</table>
    <key>id</key>
    <add>3.0</add>
  </foreignKey>
  <index>
    <name>index_status_id</name>
    <fieldName>status_id</fieldName>
    <add>1.8</add>
  </index>
  <field>
    <name>role_id</name>
    <uniqueName>participant_role_id</uniqueName>
    <title>Participant Role</title>
    <pseudoconstant>
      <optionGroupName>participant_role</optionGroupName>
    </pseudoconstant>
    <html>
      <type>Select</type>
      <multiple>1</multiple>
    </html>
    <serialize>SEPARATOR_TRIMMED</serialize>
    <headerPattern>/(participant.)?(role)$/i</headerPattern>
    <import>true</import>
    <type>varchar</type>
    <length>128</length>
    <export>true</export>
    <default>NULL</default>
    <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.</comment>
    <add>1.7</add>
  </field>
  <index>
    <name>index_role_id</name>
    <fieldName>role_id</fieldName>
    <add>1.8</add>
  </index>
  <field>
    <name>register_date</name>
    <uniqueName>participant_register_date</uniqueName>
    <title>Register date</title>
    <headerPattern>/^(r(egister\s)?date)$/i</headerPattern>
    <import>true</import>
    <type>datetime</type>
    <comment>When did contact register for event?</comment>
    <add>1.7</add>
    <html>
      <type>Select Date</type>
      <formatType>activityDateTime</formatType>
    </html>
  </field>
  <field>
    <name>source</name>
    <uniqueName>participant_source</uniqueName>
    <title>Participant Source</title>
    <headerPattern>/(participant.)?(source)$/i</headerPattern>
    <import>true</import>
    <type>varchar</type>
    <length>128</length>
    <comment>Source of this event registration.</comment>
    <html>
      <type>Text</type>
    </html>
    <add>1.7</add>
  </field>
  <field>
    <name>fee_level</name>
    <uniqueName>participant_fee_level</uniqueName>
    <title>Fee level</title>
    <headerPattern>/^(f(ee\s)?level)$/i</headerPattern>
    <type>text</type>
    <import>true</import>
    <serialize>SEPARATOR_BOOKEND</serialize>
    <comment>Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
      we store the label value and not the key</comment>
    <add>1.7</add>
  </field>
  <field>
    <name>is_test</name>
    <uniqueName>participant_is_test</uniqueName>
    <title>Test</title>
    <type>boolean</type>
    <default>0</default>
    <import>true</import>
    <add>1.7</add>
  </field>
  <field>
    <name>is_pay_later</name>
    <uniqueName>participant_is_pay_later</uniqueName>
    <title>Is Pay Later</title>
    <type>boolean</type>
    <default>0</default>
    <import>true</import>
    <headerPattern>/(is.)?(pay(.)?later)$/i</headerPattern>
    <add>2.1</add>
  </field>

  <field>
    <name>fee_amount</name>
    <uniqueName>participant_fee_amount</uniqueName>
    <title>Fee Amount</title>
    <type>decimal</type>
    <import>true</import>
    <headerPattern>/fee(.?am(ou)?nt)?/i</headerPattern>
    <dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
    <comment>actual processor fee if known - may be 0.</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>registered_by_id</name>
    <uniqueName>participant_registered_by_id</uniqueName>
    <type>int unsigned</type>
    <title>Registered By Participant ID</title>
    <import>true</import>
    <default>NULL</default>
    <comment>FK to Participant ID</comment>
    <html>
      <label>Registered By</label>
    </html>
    <add>2.1</add>
    <export>true</export>
  </field>
  <foreignKey>
    <name>registered_by_id</name>
    <table>civicrm_participant</table>
    <key>id</key>
    <add>2.1</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>discount_id</name>
    <uniqueName>participant_discount_id</uniqueName>
    <type>int unsigned</type>
    <title>Discount ID</title>
    <default>NULL</default>
    <comment>FK to Discount ID</comment>
    <html>
      <label>Discount</label>
    </html>
    <add>2.1</add>
  </field>
  <foreignKey>
    <name>discount_id</name>
    <table>civicrm_discount</table>
    <key>id</key>
    <add>2.1</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>fee_currency</name>
    <uniqueName>participant_fee_currency</uniqueName>
    <title>Fee Currency</title>
    <type>varchar</type>
    <length>3</length>
    <default>NULL</default>
    <import>true</import>
    <headerPattern>/(fee)?.?cur(rency)?/i</headerPattern>
    <dataPattern>/^[A-Z]{3}$/i</dataPattern>
    <comment>3 character string, value derived from config setting.</comment>
    <add>3.0</add>
    <pseudoconstant>
      <table>civicrm_currency</table>
      <keyColumn>name</keyColumn>
      <labelColumn>full_name</labelColumn>
      <nameColumn>name</nameColumn>
      <abbrColumn>symbol</abbrColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>campaign_id</name>
    <component>CiviCampaign</component>
    <uniqueName>participant_campaign_id</uniqueName>
    <type>int unsigned</type>
    <title>Campaign ID</title>
    <import>true</import>
    <comment>The campaign for which this participant has been registered.</comment>
    <html>
      <type>EntityRef</type>
      <label>Campaign</label>
    </html>
    <add>3.4</add>
    <pseudoconstant>
      <table>civicrm_campaign</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
      <prefetch>FALSE</prefetch>
    </pseudoconstant>
  </field>
  <foreignKey>
    <name>campaign_id</name>
    <table>civicrm_campaign</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>discount_amount</name>
    <type>int unsigned</type>
    <title>Discount Amount</title>
    <comment>Discount Amount</comment>
    <add>4.1</add>
  </field>
  <field>
    <name>cart_id</name>
    <type>int unsigned</type>
    <title>Event Cart ID</title>
    <comment>FK to civicrm_event_carts</comment>
    <html>
      <label>Event Cart</label>
    </html>
    <add>4.1</add>
  </field>
  <foreignKey>
    <name>cart_id</name>
    <table>civicrm_event_carts</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>must_wait</name>
    <type>int</type>
    <title>Must Wait on List</title>
    <comment>On Waiting List</comment>
    <add>4.1</add>
  </field>
  <field>
    <name>transferred_to_contact_id</name>
    <uniqueName>transferred_to_contact_id</uniqueName>
    <type>int unsigned</type>
    <default>NULL</default>
    <title>Transferred to Contact ID</title>
    <headerPattern>/transfer(.?id)?/i</headerPattern>
    <import>true</import>
    <comment>FK to Contact ID</comment>
    <html>
      <label>Transferred to</label>
    </html>
    <add>4.7</add>
  </field>
  <foreignKey>
    <name>transferred_to_contact_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
</table>
Commit	Line	Data
3c7d2158	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
	4	<base>CRM/Event</base>
	5	<class>Participant</class>
	6	<name>civicrm_participant</name>
2562d09a	7	<description>Records of contacts' attendance and roles in events.</description>
3c7d2158	8	<add>1.7</add>
6a488035	9	<log>true</log>
449c4e6b	10	<icon>fa-ticket</icon>
d31fb4e3	11	<component>CiviEvent</component>
3c7d2158	12	<field>
8f069c03 EM	13	<name>id</name>
	14	<uniqueName>participant_id</uniqueName>
	15	<title>Participant ID</title>
	16	<type>int unsigned</type>
	17	<required>true</required>
047c5009	18	<comment>Participant ID</comment>
8f069c03 EM	19	<import>true</import>
8f069c03 EM	20	<headerPattern>/(^(participant(.)?)?id$)/i</headerPattern>
0481e12c A	21	<html>
	22	<type>Number</type>
	23	</html>
8f069c03	24	<add>1.7</add>
3c7d2158	25	</field>
3c7d2158	26	<primaryKey>
8f069c03 EM	27	<name>id</name>
8f069c03 EM	28	<autoincrement>true</autoincrement>
3c7d2158	29	</primaryKey>
3c7d2158	30	<field>
8f069c03 EM	31	<name>contact_id</name>
	32	<uniqueName>participant_contact_id</uniqueName>
	33	<type>int unsigned</type>
	34	<title>Contact ID</title>
	35	<headerPattern>/contact(.?id)?/i</headerPattern>
	36	<import>true</import>
	37	<required>true</required>
	38	<comment>FK to Contact ID</comment>
57e94608 A	39	<html>
	40	<label>Contact</label>
	41	</html>
8f069c03	42	<add>1.7</add>
6a488035	43	</field>
3c7d2158	44	<foreignKey>
8f069c03 EM	45	<name>contact_id</name>
	46	<table>civicrm_contact</table>
	47	<key>id</key>
	48	<onDelete>CASCADE</onDelete>
6a488035	49	</foreignKey>
3c7d2158	50	<field>
8f069c03 EM	51	<name>event_id</name>
8f069c03 EM	52	<type>int unsigned</type>
57e94608	53	<title>Event ID</title>
8f069c03 EM	54	<import>true</import>
	55	<headerPattern>/event id$/i</headerPattern>
	56	<required>true</required>
	57	<comment>FK to Event ID</comment>
57e94608 A	58	<html>
	59	<label>Event</label>
	60	</html>
8f069c03	61	<add>1.7</add>
6a488035	62	</field>
3c7d2158	63	<foreignKey>
8f069c03 EM	64	<name>event_id</name>
	65	<table>civicrm_event</table>
	66	<key>id</key>
	67	<onDelete>CASCADE</onDelete>
6a488035	68	</foreignKey>
3c7d2158	69	<field>
8f069c03 EM	70	<name>status_id</name>
8f069c03 EM	71	<uniqueName>participant_status_id</uniqueName>
047c5009	72	<title>Status ID</title>
8f069c03 EM	73	<headerPattern>/(participant.)?(status)$/i</headerPattern>
	74	<import>true</import>
	75	<type>int unsigned</type>
e51b7372	76	<export>true</export>
8f069c03 EM	77	<required>true</required>
8f069c03 EM	78	<default>1</default>
bd7d6a3d	79	<comment>Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.</comment>
8f069c03 EM	80	<add>1.7</add>
	81	<pseudoconstant>
	82	<table>civicrm_participant_status_type</table>
	83	<keyColumn>id</keyColumn>
	84	<labelColumn>label</labelColumn>
	85	</pseudoconstant>
	86	<html>
	87	<type>Select</type>
047c5009	88	<label>Status</label>
8f069c03	89	</html>
6a488035 TO	90	</field>
	91	<foreignKey>
	92	<name>status_id</name>
	93	<table>civicrm_participant_status_type</table>
	94	<key>id</key>
	95	<add>3.0</add>
	96	</foreignKey>
	97	<index>
	98	<name>index_status_id</name>
	99	<fieldName>status_id</fieldName>
	100	<add>1.8</add>
	101	</index>
3c7d2158	102	<field>
8f069c03 EM	103	<name>role_id</name>
8f069c03 EM	104	<uniqueName>participant_role_id</uniqueName>
bd7d6a3d	105	<title>Participant Role</title>
8f069c03 EM	106	<pseudoconstant>
	107	<optionGroupName>participant_role</optionGroupName>
	108	</pseudoconstant>
	109	<html>
	110	<type>Select</type>
2a5c9b4d	111	<multiple>1</multiple>
8f069c03	112	</html>
2a5c9b4d	113	<serialize>SEPARATOR_TRIMMED</serialize>
8f069c03 EM	114	<headerPattern>/(participant.)?(role)$/i</headerPattern>
	115	<import>true</import>
	116	<type>varchar</type>
	117	<length>128</length>
f5d67b2a	118	<export>true</export>
8f069c03 EM	119	<default>NULL</default>
	120	<comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.</comment>
	121	<add>1.7</add>
6a488035 TO	122	</field>
	123	<index>
	124	<name>index_role_id</name>
	125	<fieldName>role_id</fieldName>
	126	<add>1.8</add>
	127	</index>
3c7d2158	128	<field>
8f069c03 EM	129	<name>register_date</name>
	130	<uniqueName>participant_register_date</uniqueName>
	131	<title>Register date</title>
	132	<headerPattern>/^(r(egister\s)?date)$/i</headerPattern>
	133	<import>true</import>
	134	<type>datetime</type>
	135	<comment>When did contact register for event?</comment>
	136	<add>1.7</add>
3cef3c00	137	<html>
3cef3c00	138	<type>Select Date</type>
24317d89	139	<formatType>activityDateTime</formatType>
3cef3c00	140	</html>
6a488035 TO	141	</field>
6a488035 TO	142	<field>
8f069c03 EM	143	<name>source</name>
	144	<uniqueName>participant_source</uniqueName>
	145	<title>Participant Source</title>
	146	<headerPattern>/(participant.)?(source)$/i</headerPattern>
	147	<import>true</import>
	148	<type>varchar</type>
	149	<length>128</length>
	150	<comment>Source of this event registration.</comment>
c1a6d6ac SL	151	<html>
	152	<type>Text</type>
	153	</html>
8f069c03	154	<add>1.7</add>
3c7d2158	155	</field>
3c7d2158	156	<field>
8f069c03 EM	157	<name>fee_level</name>
	158	<uniqueName>participant_fee_level</uniqueName>
	159	<title>Fee level</title>
	160	<headerPattern>/^(f(ee\s)?level)$/i</headerPattern>
	161	<type>text</type>
	162	<import>true</import>
2a5c9b4d	163	<serialize>SEPARATOR_BOOKEND</serialize>
8f069c03	164	<comment>Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
fb607354	165	we store the label value and not the key</comment>
8f069c03	166	<add>1.7</add>
3c7d2158	167	</field>
3c7d2158	168	<field>
8f069c03 EM	169	<name>is_test</name>
	170	<uniqueName>participant_is_test</uniqueName>
	171	<title>Test</title>
	172	<type>boolean</type>
	173	<default>0</default>
	174	<import>true</import>
	175	<add>1.7</add>
6a488035	176	</field>
3c7d2158	177	<field>
8f069c03 EM	178	<name>is_pay_later</name>
	179	<uniqueName>participant_is_pay_later</uniqueName>
	180	<title>Is Pay Later</title>
	181	<type>boolean</type>
	182	<default>0</default>
	183	<import>true</import>
	184	<headerPattern>/(is.)?(pay(.)?later)$/i</headerPattern>
	185	<add>2.1</add>
6a488035	186	</field>
3c7d2158	187
3c7d2158	188	<field>
8f069c03 EM	189	<name>fee_amount</name>
	190	<uniqueName>participant_fee_amount</uniqueName>
	191	<title>Fee Amount</title>
	192	<type>decimal</type>
	193	<import>true</import>
	194	<headerPattern>/fee(.?am(ou)?nt)?/i</headerPattern>
	195	<dataPattern>/^\d+(\.\d{2})?$/</dataPattern>
	196	<comment>actual processor fee if known - may be 0.</comment>
	197	<add>2.1</add>
3c7d2158	198	</field>
3c7d2158	199	<field>
8f069c03 EM	200	<name>registered_by_id</name>
	201	<uniqueName>participant_registered_by_id</uniqueName>
	202	<type>int unsigned</type>
57e94608	203	<title>Registered By Participant ID</title>
8f069c03 EM	204	<import>true</import>
	205	<default>NULL</default>
	206	<comment>FK to Participant ID</comment>
57e94608 A	207	<html>
	208	<label>Registered By</label>
	209	</html>
8f069c03 EM	210	<add>2.1</add>
8f069c03 EM	211	<export>true</export>
6a488035	212	</field>
3c7d2158	213	<foreignKey>
8f069c03 EM	214	<name>registered_by_id</name>
	215	<table>civicrm_participant</table>
	216	<key>id</key>
	217	<add>2.1</add>
	218	<onDelete>SET NULL</onDelete>
3c7d2158	219	</foreignKey>
3c7d2158	220	<field>
8f069c03 EM	221	<name>discount_id</name>
	222	<uniqueName>participant_discount_id</uniqueName>
	223	<type>int unsigned</type>
	224	<title>Discount ID</title>
	225	<default>NULL</default>
	226	<comment>FK to Discount ID</comment>
57e94608 A	227	<html>
	228	<label>Discount</label>
	229	</html>
8f069c03	230	<add>2.1</add>
6a488035	231	</field>
3c7d2158	232	<foreignKey>
8f069c03 EM	233	<name>discount_id</name>
	234	<table>civicrm_discount</table>
	235	<key>id</key>
	236	<add>2.1</add>
	237	<onDelete>SET NULL</onDelete>
3c7d2158	238	</foreignKey>
3c7d2158	239	<field>
8f069c03 EM	240	<name>fee_currency</name>
	241	<uniqueName>participant_fee_currency</uniqueName>
	242	<title>Fee Currency</title>
	243	<type>varchar</type>
	244	<length>3</length>
	245	<default>NULL</default>
	246	<import>true</import>
	247	<headerPattern>/(fee)?.?cur(rency)?/i</headerPattern>
	248	<dataPattern>/^[A-Z]{3}$/i</dataPattern>
	249	<comment>3 character string, value derived from config setting.</comment>
	250	<add>3.0</add>
	251	<pseudoconstant>
	252	<table>civicrm_currency</table>
	253	<keyColumn>name</keyColumn>
	254	<labelColumn>full_name</labelColumn>
c3de5c5a	255	<nameColumn>name</nameColumn>
a8fdb24e	256	<abbrColumn>symbol</abbrColumn>
8f069c03 EM	257	</pseudoconstant>
	258	<html>
	259	<type>Select</type>
	260	</html>
6a488035	261	</field>
3c7d2158	262	<field>
8f069c03	263	<name>campaign_id</name>
88c31c05	264	<component>CiviCampaign</component>
8f069c03 EM	265	<uniqueName>participant_campaign_id</uniqueName>
8f069c03 EM	266	<type>int unsigned</type>
57e94608	267	<title>Campaign ID</title>
8f069c03 EM	268	<import>true</import>
8f069c03 EM	269	<comment>The campaign for which this participant has been registered.</comment>
57e94608	270	<html>
8813f972	271	<type>EntityRef</type>
57e94608 A	272	<label>Campaign</label>
57e94608 A	273	</html>
8f069c03	274	<add>3.4</add>
25ad69f2 CW	275	<pseudoconstant>
	276	<table>civicrm_campaign</table>
	277	<keyColumn>id</keyColumn>
	278	<labelColumn>title</labelColumn>
	279	<prefetch>FALSE</prefetch>
	280	</pseudoconstant>
3c7d2158	281	</field>
3c7d2158	282	<foreignKey>
8f069c03 EM	283	<name>campaign_id</name>
	284	<table>civicrm_campaign</table>
	285	<key>id</key>
	286	<onDelete>SET NULL</onDelete>
6a488035 TO	287	</foreignKey>
6a488035 TO	288	<field>
8f069c03 EM	289	<name>discount_amount</name>
	290	<type>int unsigned</type>
	291	<title>Discount Amount</title>
	292	<comment>Discount Amount</comment>
	293	<add>4.1</add>
6a488035 TO	294	</field>
6a488035 TO	295	<field>
8f069c03 EM	296	<name>cart_id</name>
	297	<type>int unsigned</type>
	298	<title>Event Cart ID</title>
	299	<comment>FK to civicrm_event_carts</comment>
57e94608 A	300	<html>
	301	<label>Event Cart</label>
	302	</html>
8f069c03	303	<add>4.1</add>
6a488035 TO	304	</field>
6a488035 TO	305	<foreignKey>
8f069c03 EM	306	<name>cart_id</name>
	307	<table>civicrm_event_carts</table>
	308	<key>id</key>
	309	<onDelete>SET NULL</onDelete>
6a488035 TO	310	</foreignKey>
6a488035 TO	311	<field>
8f069c03 EM	312	<name>must_wait</name>
	313	<type>int</type>
	314	<title>Must Wait on List</title>
	315	<comment>On Waiting List</comment>
	316	<add>4.1</add>
6a488035	317	</field>
7dbb67ae DG	318	<field>
	319	<name>transferred_to_contact_id</name>
	320	<uniqueName>transferred_to_contact_id</uniqueName>
	321	<type>int unsigned</type>
	322	<default>NULL</default>
	323	<title>Transferred to Contact ID</title>
	324	<headerPattern>/transfer(.?id)?/i</headerPattern>
	325	<import>true</import>
	326	<comment>FK to Contact ID</comment>
57e94608 A	327	<html>
	328	<label>Transferred to</label>
	329	</html>
7dbb67ae DG	330	<add>4.7</add>
	331	</field>
	332	<foreignKey>
	333	<name>transferred_to_contact_id</name>
	334	<table>civicrm_contact</table>
	335	<key>id</key>
	336	<onDelete>SET NULL</onDelete>
	337	</foreignKey>
6a488035	338	</table>