1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
5 <class>Participant
</class>
6 <name>civicrm_participant
</name>
7 <description>Records of contacts' attendance and roles in events.
</description>
10 <icon>fa-ticket
</icon>
11 <component>CiviEvent
</component>
14 <uniqueName>participant_id
</uniqueName>
15 <title>Participant ID
</title>
16 <type>int unsigned
</type>
17 <required>true
</required>
18 <comment>Participant ID
</comment>
20 <headerPattern>/(^(participant(.)?)?id$)/i
</headerPattern>
28 <autoincrement>true
</autoincrement>
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>
37 <required>true
</required>
38 <comment>FK to Contact ID
</comment>
40 <label>Contact
</label>
45 <name>contact_id
</name>
46 <table>civicrm_contact
</table>
48 <onDelete>CASCADE
</onDelete>
52 <type>int unsigned
</type>
53 <title>Event ID
</title>
55 <headerPattern>/event id$/i
</headerPattern>
56 <required>true
</required>
57 <comment>FK to Event ID
</comment>
65 <table>civicrm_event
</table>
67 <onDelete>CASCADE
</onDelete>
70 <name>status_id
</name>
71 <uniqueName>participant_status_id
</uniqueName>
72 <title>Status ID
</title>
73 <headerPattern>/(participant.)?(status)$/i
</headerPattern>
75 <type>int unsigned
</type>
77 <required>true
</required>
79 <comment>Participant status ID. FK to civicrm_participant_status_type. Default of
1 should map to status = Registered.
</comment>
82 <table>civicrm_participant_status_type
</table>
83 <keyColumn>id
</keyColumn>
84 <labelColumn>label
</labelColumn>
92 <name>status_id
</name>
93 <table>civicrm_participant_status_type
</table>
98 <name>index_status_id
</name>
99 <fieldName>status_id
</fieldName>
104 <uniqueName>participant_role_id
</uniqueName>
105 <title>Participant Role ID
</title>
107 <optionGroupName>participant_role
</optionGroupName>
111 <multiple>1</multiple>
112 <label>Participant Role
</label>
114 <serialize>SEPARATOR_TRIMMED
</serialize>
115 <headerPattern>/(participant.)?(role)$/i
</headerPattern>
116 <import>true
</import>
119 <export>true
</export>
120 <default>NULL
</default>
121 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
125 <name>index_role_id
</name>
126 <fieldName>role_id
</fieldName>
130 <name>register_date
</name>
131 <uniqueName>participant_register_date
</uniqueName>
132 <title>Register date
</title>
133 <headerPattern>/^(r(egister\s)?date)$/i
</headerPattern>
134 <import>true
</import>
135 <type>datetime
</type>
136 <comment>When did contact register for event?
</comment>
139 <type>Select Date
</type>
140 <formatType>activityDateTime
</formatType>
145 <uniqueName>participant_source
</uniqueName>
146 <title>Participant Source
</title>
147 <headerPattern>/(participant.)?(source)$/i
</headerPattern>
148 <import>true
</import>
151 <comment>Source of this event registration.
</comment>
158 <name>fee_level
</name>
159 <uniqueName>participant_fee_level
</uniqueName>
160 <title>Fee level
</title>
161 <headerPattern>/^(f(ee\s)?level)$/i
</headerPattern>
163 <import>true
</import>
164 <serialize>SEPARATOR_BOOKEND
</serialize>
165 <comment>Populate with the label (text) associated with a fee level for paid events with multiple levels. Note that
166 we store the label value and not the key
</comment>
171 <uniqueName>participant_is_test
</uniqueName>
175 <required>true
</required>
176 <import>true
</import>
180 <name>is_pay_later
</name>
181 <uniqueName>participant_is_pay_later
</uniqueName>
182 <title>Is Pay Later
</title>
185 <required>true
</required>
186 <import>true
</import>
187 <headerPattern>/(is.)?(pay(.)?later)$/i
</headerPattern>
192 <name>fee_amount
</name>
193 <uniqueName>participant_fee_amount
</uniqueName>
194 <title>Fee Amount
</title>
196 <import>true
</import>
197 <headerPattern>/fee(.?am(ou)?nt)?/i
</headerPattern>
198 <dataPattern>/^\d+(\.\d{
2})?$/
</dataPattern>
199 <comment>actual processor fee if known - may be
0.
</comment>
203 <name>registered_by_id
</name>
204 <uniqueName>participant_registered_by_id
</uniqueName>
205 <type>int unsigned
</type>
206 <title>Registered By Participant ID
</title>
207 <import>true
</import>
208 <default>NULL
</default>
209 <comment>FK to Participant ID
</comment>
211 <label>Registered By
</label>
214 <export>true
</export>
217 <name>registered_by_id
</name>
218 <table>civicrm_participant
</table>
221 <onDelete>SET NULL
</onDelete>
224 <name>discount_id
</name>
225 <uniqueName>participant_discount_id
</uniqueName>
226 <type>int unsigned
</type>
227 <title>Discount ID
</title>
228 <default>NULL
</default>
229 <comment>FK to Discount ID
</comment>
231 <label>Discount
</label>
236 <name>discount_id
</name>
237 <table>civicrm_discount
</table>
240 <onDelete>SET NULL
</onDelete>
243 <name>fee_currency
</name>
244 <uniqueName>participant_fee_currency
</uniqueName>
245 <title>Fee Currency
</title>
248 <default>NULL
</default>
249 <import>true
</import>
250 <headerPattern>/(fee)?.?cur(rency)?/i
</headerPattern>
251 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
252 <comment>3 character string, value derived from config setting.
</comment>
255 <table>civicrm_currency
</table>
256 <keyColumn>name
</keyColumn>
257 <labelColumn>full_name
</labelColumn>
258 <nameColumn>name
</nameColumn>
259 <abbrColumn>symbol
</abbrColumn>
266 <name>campaign_id
</name>
267 <component>CiviCampaign
</component>
268 <uniqueName>participant_campaign_id
</uniqueName>
269 <type>int unsigned
</type>
270 <title>Campaign ID
</title>
271 <import>true
</import>
272 <comment>The campaign for which this participant has been registered.
</comment>
274 <type>EntityRef
</type>
275 <label>Campaign
</label>
279 <table>civicrm_campaign
</table>
280 <keyColumn>id
</keyColumn>
281 <labelColumn>title
</labelColumn>
282 <prefetch>FALSE
</prefetch>
286 <name>campaign_id
</name>
287 <table>civicrm_campaign
</table>
289 <onDelete>SET NULL
</onDelete>
292 <name>discount_amount
</name>
293 <type>int unsigned
</type>
294 <title>Discount Amount
</title>
295 <comment>Discount Amount
</comment>
300 <type>int unsigned
</type>
301 <title>Event Cart ID
</title>
302 <comment>FK to civicrm_event_carts
</comment>
304 <label>Event Cart
</label>
310 <table>civicrm_event_carts
</table>
312 <onDelete>SET NULL
</onDelete>
315 <name>must_wait
</name>
317 <title>Must Wait on List
</title>
318 <comment>On Waiting List
</comment>
322 <name>transferred_to_contact_id
</name>
323 <uniqueName>transferred_to_contact_id
</uniqueName>
324 <type>int unsigned
</type>
325 <default>NULL
</default>
326 <title>Transferred to Contact ID
</title>
327 <headerPattern>/transfer(.?id)?/i
</headerPattern>
328 <import>true
</import>
329 <comment>FK to Contact ID
</comment>
331 <label>Transferred to
</label>
336 <name>transferred_to_contact_id
</name>
337 <table>civicrm_contact
</table>
339 <onDelete>SET NULL
</onDelete>