1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
6 <name>civicrm_event
</name>
9 <icon>fa-calendar
</icon>
12 <type>int unsigned
</type>
13 <title>Event ID
</title>
14 <required>true
</required>
15 <comment>Event
</comment>
20 <autoincrement>true
</autoincrement>
24 <uniqueName>event_title
</uniqueName>
27 <title>Event Title
</title>
28 <headerPattern>/(event.)?title$/i
</headerPattern>
30 <localizable>true
</localizable>
31 <comment>Event Title (e.g. Fall Fundraiser Dinner)
</comment>
40 <title>Event Summary
</title>
46 <localizable>true
</localizable>
47 <comment>Brief summary of event. Text and html allowed. Displayed on Event Registration form and can be used on other CMS pages which need an event summary.
</comment>
51 <name>description
</name>
53 <uniqueName>event_description
</uniqueName>
54 <title>Event Description
</title>
56 <type>RichTextEditor
</type>
60 <localizable>true
</localizable>
61 <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
</comment>
65 <name>event_type_id
</name>
66 <type>int unsigned
</type>
67 <uniqueName>event_type_id
</uniqueName>
68 <title>Event Type
</title>
71 <optionGroupName>event_type
</optionGroupName>
76 <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
</comment>
80 <name>index_event_type_id
</name>
81 <fieldName>event_type_id
</fieldName>
85 <name>participant_listing_id
</name>
86 <type>int unsigned
</type>
87 <uniqueName>participant_listing_id
</uniqueName>
88 <title>Participant Listing
</title>
89 <default>NULL
</default>
91 <optionGroupName>participant_listing
</optionGroupName>
93 <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
</comment>
100 <name>index_participant_listing_id
</name>
101 <fieldName>participant_listing_id
</fieldName>
105 <name>is_public
</name>
107 <title>Is Event Public
</title>
109 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
112 <type>CheckBox
</type>
116 <name>start_date
</name>
117 <type>datetime
</type>
118 <uniqueName>event_start_date
</uniqueName>
119 <title>Event Start Date
</title>
120 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
121 <import>true
</import>
122 <comment>Date and time that event starts.
</comment>
125 <type>Select Date
</type>
126 <formatType>activityDateTime
</formatType>
130 <name>end_date
</name>
131 <type>datetime
</type>
132 <uniqueName>event_end_date
</uniqueName>
133 <title>Event End Date
</title>
134 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
135 <import>true
</import>
136 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
139 <type>Select Date
</type>
140 <formatType>activityDateTime
</formatType>
144 <name>is_online_registration
</name>
146 <title>Is Online Registration
</title>
148 <comment>If true, include registration link on Event Info page.
</comment>
151 <type>CheckBox
</type>
155 <name>registration_link_text
</name>
157 <title>Event Registration Link Text
</title>
159 <localizable>true
</localizable>
160 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
167 <name>registration_start_date
</name>
168 <type>datetime
</type>
169 <comment>Date and time that online registration starts.
</comment>
172 <type>Select Date
</type>
173 <formatType>activityDateTime
</formatType>
177 <name>registration_end_date
</name>
178 <type>datetime
</type>
179 <comment>Date and time that online registration ends.
</comment>
182 <type>Select Date
</type>
183 <formatType>activityDateTime
</formatType>
187 <name>max_participants
</name>
188 <type>int unsigned
</type>
189 <title>Max Participants
</title>
190 <default>NULL
</default>
191 <comment>Maximum number of registered participants to allow. After max is reached, a custom Event Full message is displayed. If NULL, allow unlimited number of participants.
</comment>
198 <name>event_full_text
</name>
200 <title>Event Information
</title>
202 <type>TextArea
</type>
206 <localizable>true
</localizable>
207 <comment>Message to display on Event Information page and INSTEAD OF Event Registration form if maximum participants are signed up. Can include email address/info about getting on a waiting list, etc. Text and html allowed.
</comment>
211 <name>is_monetary
</name>
212 <title>Is this a PAID event?
</title>
215 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
218 <type>CheckBox
</type>
222 <name>financial_type_id
</name>
223 <type>int unsigned
</type>
224 <title>Financial Type
</title>
225 <default>NULL
</default>
226 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
228 <table>civicrm_financial_type
</table>
229 <keyColumn>id
</keyColumn>
230 <labelColumn>name
</labelColumn>
238 <name>payment_processor
</name>
241 <serialize>SEPARATOR_TRIMMED
</serialize>
242 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
244 <table>civicrm_payment_processor
</table>
245 <keyColumn>id
</keyColumn>
246 <labelColumn>name
</labelColumn>
255 <title>Map Enabled
</title>
258 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
261 <type>CheckBox
</type>
265 <name>is_active
</name>
266 <title>Is Active
</title>
269 <comment>Is this Event enabled or disabled/cancelled?
</comment>
272 <type>CheckBox
</type>
276 <name>fee_label
</name>
278 <import>true
</import>
279 <title>Fee Label
</title>
280 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
282 <localizable>true
</localizable>
289 <name>is_show_location
</name>
291 <title>show location
</title>
293 <comment>If true, show event location.
</comment>
296 <type>CheckBox
</type>
300 <name>loc_block_id
</name>
301 <type>int unsigned
</type>
302 <title>Location Block ID
</title>
303 <comment>FK to Location Block ID
</comment>
307 <name>loc_block_id
</name>
308 <table>civicrm_loc_block
</table>
310 <onDelete>SET NULL
</onDelete>
314 <name>default_role_id
</name>
315 <uniqueName>default_role_id
</uniqueName>
316 <title>Default Role
</title>
317 <import>true
</import>
318 <type>int unsigned
</type>
321 <optionGroupName>participant_role
</optionGroupName>
323 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
330 <name>intro_text
</name>
333 <type>RichTextEditor
</type>
337 <title>Introductory Message
</title>
338 <localizable>true
</localizable>
339 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
343 <name>footer_text
</name>
344 <title>Footer Message
</title>
347 <type>RichTextEditor
</type>
351 <localizable>true
</localizable>
352 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
356 <name>confirm_title
</name>
358 <title>Confirmation Title
</title>
360 <default>NULL
</default>
361 <localizable>true
</localizable>
362 <comment>Title for Confirmation page.
</comment>
369 <name>confirm_text
</name>
372 <type>RichTextEditor
</type>
376 <title>Confirm Text
</title>
377 <localizable>true
</localizable>
378 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
382 <name>confirm_footer_text
</name>
384 <title>Footer Text
</title>
386 <type>RichTextEditor
</type>
390 <localizable>true
</localizable>
391 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
395 <name>is_email_confirm
</name>
397 <title>Is confirm email
</title>
399 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
402 <type>CheckBox
</type>
406 <name>confirm_email_text
</name>
408 <title>Confirmation Email Text
</title>
410 <type>TextArea
</type>
414 <localizable>true
</localizable>
415 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
419 <name>confirm_from_name
</name>
421 <title>Confirm From Name
</title>
423 <localizable>true
</localizable>
424 <comment>FROM email name used for confirmation emails.
</comment>
431 <name>confirm_from_email
</name>
433 <title>Confirm From Email
</title>
435 <comment>FROM email address used for confirmation emails.
</comment>
442 <name>cc_confirm
</name>
445 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
452 <name>bcc_confirm
</name>
455 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
462 <name>default_fee_id
</name>
463 <type>int unsigned
</type>
464 <title>Default Fee ID
</title>
465 <comment>FK to civicrm_option_value.
</comment>
469 <name>default_discount_fee_id
</name>
470 <type>int unsigned
</type>
471 <title>Default Discount Fee ID
</title>
472 <comment>FK to civicrm_option_value.
</comment>
476 <name>thankyou_title
</name>
478 <title>ThankYou Title
</title>
480 <default>NULL
</default>
481 <localizable>true
</localizable>
482 <comment>Title for ThankYou page.
</comment>
489 <name>thankyou_text
</name>
492 <type>RichTextEditor
</type>
496 <title>ThankYou Text
</title>
497 <localizable>true
</localizable>
498 <comment>ThankYou Text.
</comment>
502 <name>thankyou_footer_text
</name>
504 <title>Footer Text
</title>
506 <type>RichTextEditor
</type>
510 <localizable>true
</localizable>
511 <comment>Footer message.
</comment>
515 <name>is_pay_later
</name>
516 <title>Pay Later Allowed
</title>
519 <comment>if true - allows the user to send payment directly to the org later
</comment>
522 <type>CheckBox
</type>
526 <name>pay_later_text
</name>
527 <title>Pay Later Text
</title>
529 <localizable>true
</localizable>
530 <comment>The text displayed to the user in the main form
</comment>
533 <type>RichTextEditor
</type>
537 <name>pay_later_receipt
</name>
538 <title>Pay Later Receipt Text
</title>
540 <localizable>true
</localizable>
541 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
548 <name>is_partial_payment
</name>
549 <title>Partial Payments Enabled
</title>
552 <comment>is partial payment enabled for this event
</comment>
555 <type>CheckBox
</type>
559 <name>initial_amount_label
</name>
560 <title>Initial Amount Label
</title>
563 <localizable>true
</localizable>
564 <comment>Initial amount label for partial payment
</comment>
571 <name>initial_amount_help_text
</name>
572 <title>Initial Amount Help Text
</title>
574 <localizable>true
</localizable>
575 <comment>Initial amount help text for partial payment
</comment>
582 <name>min_initial_amount
</name>
583 <title>Minimum Initial Amount
</title>
585 <comment>Minimum initial amount for partial payment
</comment>
592 <name>is_multiple_registrations
</name>
593 <title>Allow Multiple Registrations
</title>
596 <comment>if true - allows the user to register multiple participants for event
</comment>
599 <type>CheckBox
</type>
603 <name>max_additional_participants
</name>
604 <type>int unsigned
</type>
605 <title>Maximum number of additional participants per registration
</title>
607 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
611 <name>allow_same_participant_emails
</name>
613 <title>Does Event allow multiple registrations from same email address?
</title>
615 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
618 <type>CheckBox
</type>
622 <name>has_waitlist
</name>
623 <title>Waitlist Enabled
</title>
625 <comment>Whether the event has waitlist support.
</comment>
628 <type>CheckBox
</type>
632 <name>requires_approval
</name>
634 <comment>Whether participants require approval before they can finish registering.
</comment>
637 <type>CheckBox
</type>
641 <name>expiration_time
</name>
642 <type>int unsigned
</type>
643 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
650 <name>allow_selfcancelxfer
</name>
653 <title>Allow Self-service Cancellation or Transfer
</title>
654 <comment>Allow self service cancellation or transfer for event?
</comment>
657 <type>CheckBox
</type>
661 <name>selfcancelxfer_time
</name>
664 <title>Self-service Cancellation or Transfer Time
</title>
665 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
672 <name>waitlist_text
</name>
675 <type>TextArea
</type>
679 <localizable>true
</localizable>
680 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
684 <name>approval_req_text
</name>
687 <type>TextArea
</type>
691 <localizable>true
</localizable>
692 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
696 <name>is_template
</name>
697 <title>Is an Event Template
</title>
700 <required>true
</required>
701 <comment>whether the event has template
</comment>
704 <type>CheckBox
</type>
708 <name>template_title
</name>
709 <uniqueName>template_title
</uniqueName>
711 <import>true
</import>
712 <title>Event Template Title
</title>
713 <headerPattern>/(template.)?title$/i
</headerPattern>
715 <localizable>true
</localizable>
716 <comment>Event Template Title
</comment>
723 <name>created_id
</name>
724 <type>int unsigned
</type>
725 <title>Created By Contact ID
</title>
726 <comment>FK to civicrm_contact, who created this event
</comment>
730 <name>created_id
</name>
731 <table>civicrm_contact
</table>
734 <onDelete>SET NULL
</onDelete>
737 <name>created_date
</name>
738 <type>datetime
</type>
739 <title>Event Created Date
</title>
740 <comment>Date and time that event was created.
</comment>
744 <name>currency
</name>
747 <import>true
</import>
748 <headerPattern>/cur(rency)?/i
</headerPattern>
749 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
750 <comment>3 character string, value from config setting or input via user.
</comment>
753 <table>civicrm_currency
</table>
754 <keyColumn>name
</keyColumn>
755 <labelColumn>full_name
</labelColumn>
756 <nameColumn>name
</nameColumn>
757 <abbrColumn>symbol
</abbrColumn>
764 <name>campaign_id
</name>
765 <type>int unsigned
</type>
766 <title>Campaign
</title>
767 <comment>The campaign for which this event has been created.
</comment>
769 <table>civicrm_campaign
</table>
770 <keyColumn>id
</keyColumn>
771 <labelColumn>title
</labelColumn>
775 <type>EntityRef
</type>
779 <name>campaign_id
</name>
780 <table>civicrm_campaign
</table>
782 <onDelete>SET NULL
</onDelete>
785 <name>is_share
</name>
786 <title>Is shared through social media
</title>
789 <comment>Can people share the event through social media?
</comment>
792 <type>CheckBox
</type>
796 <name>is_confirm_enabled
</name>
797 <title>Is the booking confirmation screen enabled?
</title>
800 <comment>If false, the event booking confirmation screen gets skipped
</comment>
803 <type>CheckBox
</type>
807 <name>parent_event_id
</name>
808 <type>int unsigned
</type>
809 <title>Parent Event ID
</title>
810 <default>NULL
</default>
811 <comment>Implicit FK to civicrm_event: parent event
</comment>
813 <type>EntityRef
</type>
818 <name>index_parent_event_id
</name>
819 <fieldName>parent_event_id
</fieldName>
823 <name>slot_label_id
</name>
824 <type>int unsigned
</type>
825 <title>Subevent Slot Label ID
</title>
826 <default>NULL
</default>
827 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
834 <name>dedupe_rule_group_id
</name>
835 <type>int unsigned
</type>
836 <title>Dedupe Rule
</title>
837 <default>NULL
</default>
838 <comment>Rule to use when matching registrations for this event
</comment>
840 <table>civicrm_dedupe_rule_group
</table>
841 <keyColumn>id
</keyColumn>
842 <nameColumn>name
</nameColumn>
843 <labelColumn>title
</labelColumn>
851 <name>dedupe_rule_group_id
</name>
852 <table>civicrm_dedupe_rule_group
</table>
857 <name>is_billing_required
</name>
858 <title>Is billing block required
</title>
861 <comment>if true than billing block is required this event
</comment>
864 <type>CheckBox
</type>