1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
6 <name>civicrm_event
</name>
7 <description>Scheduled in-person or online events which contacts can register for and attend.
</description>
10 <icon>fa-calendar
</icon>
11 <labelField>title
</labelField>
12 <component>CiviEvent
</component>
14 <add>civicrm/event/add?reset=
1</add>
15 <view>civicrm/event/info?reset=
1&id=[id]
</view>
19 <type>int unsigned
</type>
20 <title>Event ID
</title>
21 <required>true
</required>
22 <comment>Event
</comment>
30 <autoincrement>true
</autoincrement>
34 <uniqueName>event_title
</uniqueName>
37 <title>Event Title
</title>
38 <headerPattern>/(event.)?title$/i
</headerPattern>
40 <localizable>true
</localizable>
41 <comment>Event Title (e.g. Fall Fundraiser Dinner)
</comment>
50 <title>Event Summary
</title>
56 <localizable>true
</localizable>
57 <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>
61 <name>description
</name>
63 <uniqueName>event_description
</uniqueName>
64 <title>Event Description
</title>
66 <type>RichTextEditor
</type>
70 <localizable>true
</localizable>
71 <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
</comment>
75 <name>event_type_id
</name>
76 <type>int unsigned
</type>
77 <uniqueName>event_type_id
</uniqueName>
78 <title>Event Type
</title>
81 <optionGroupName>event_type
</optionGroupName>
86 <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
</comment>
90 <name>index_event_type_id
</name>
91 <fieldName>event_type_id
</fieldName>
95 <name>participant_listing_id
</name>
96 <type>int unsigned
</type>
97 <uniqueName>participant_listing_id
</uniqueName>
98 <title>Participant Listing
</title>
99 <default>NULL
</default>
101 <optionGroupName>participant_listing
</optionGroupName>
103 <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
</comment>
110 <name>index_participant_listing_id
</name>
111 <fieldName>participant_listing_id
</fieldName>
115 <name>is_public
</name>
117 <required>true
</required>
118 <title>Is Event Public
</title>
120 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
123 <type>CheckBox
</type>
127 <name>start_date
</name>
128 <type>timestamp
</type>
129 <uniqueName>event_start_date
</uniqueName>
130 <title>Event Start Date
</title>
131 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
132 <import>true
</import>
133 <comment>Date and time that event starts.
</comment>
135 <required>false
</required>
136 <default>NULL
</default>
138 <type>Select Date
</type>
139 <formatType>activityDateTime
</formatType>
143 <name>end_date
</name>
144 <type>timestamp
</type>
145 <uniqueName>event_end_date
</uniqueName>
146 <title>Event End Date
</title>
147 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
148 <import>true
</import>
149 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
151 <required>false
</required>
152 <default>NULL
</default>
154 <type>Select Date
</type>
155 <formatType>activityDateTime
</formatType>
159 <name>is_online_registration
</name>
161 <required>true
</required>
162 <title>Is Online Registration
</title>
164 <comment>If true, include registration link on Event Info page.
</comment>
167 <type>CheckBox
</type>
171 <name>registration_link_text
</name>
173 <title>Event Registration Link Text
</title>
175 <localizable>true
</localizable>
176 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
183 <name>registration_start_date
</name>
184 <type>timestamp
</type>
185 <comment>Date and time that online registration starts.
</comment>
187 <required>false
</required>
188 <default>NULL
</default>
190 <type>Select Date
</type>
191 <formatType>activityDateTime
</formatType>
192 <label>Registration Start Date
</label>
196 <name>registration_end_date
</name>
197 <type>timestamp
</type>
198 <comment>Date and time that online registration ends.
</comment>
200 <required>false
</required>
201 <default>NULL
</default>
203 <type>Select Date
</type>
204 <formatType>activityDateTime
</formatType>
205 <label>Registration End Date
</label>
209 <name>max_participants
</name>
210 <type>int unsigned
</type>
211 <title>Max Participants
</title>
212 <default>NULL
</default>
213 <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>
220 <name>event_full_text
</name>
222 <title>Event Information
</title>
224 <type>TextArea
</type>
228 <localizable>true
</localizable>
229 <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>
233 <name>is_monetary
</name>
234 <title>Is this a PAID event?
</title>
236 <required>true
</required>
238 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
241 <type>CheckBox
</type>
245 <name>financial_type_id
</name>
246 <type>int unsigned
</type>
247 <title>Financial Type
</title>
248 <default>NULL
</default>
249 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
251 <table>civicrm_financial_type
</table>
252 <keyColumn>id
</keyColumn>
253 <labelColumn>name
</labelColumn>
261 <name>payment_processor
</name>
264 <serialize>SEPARATOR_TRIMMED
</serialize>
265 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
267 <table>civicrm_payment_processor
</table>
268 <keyColumn>id
</keyColumn>
269 <labelColumn>name
</labelColumn>
273 <label>Payment Processors
</label>
279 <title>Map Enabled
</title>
281 <required>true
</required>
283 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
286 <type>CheckBox
</type>
290 <name>is_active
</name>
291 <title>Is Active
</title>
293 <required>true
</required>
295 <comment>Is this Event enabled or disabled/cancelled?
</comment>
298 <type>CheckBox
</type>
302 <name>fee_label
</name>
304 <import>true
</import>
305 <title>Fee Label
</title>
306 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
308 <localizable>true
</localizable>
315 <name>is_show_location
</name>
317 <required>true
</required>
318 <title>show location
</title>
320 <comment>If true, show event location.
</comment>
323 <type>CheckBox
</type>
327 <name>loc_block_id
</name>
328 <type>int unsigned
</type>
329 <title>Location Block ID
</title>
330 <comment>FK to Location Block ID
</comment>
332 <label>Location Block
</label>
337 <name>loc_block_id
</name>
338 <table>civicrm_loc_block
</table>
340 <onDelete>SET NULL
</onDelete>
344 <name>default_role_id
</name>
345 <uniqueName>default_role_id
</uniqueName>
346 <title>Default Role
</title>
347 <import>true
</import>
348 <type>int unsigned
</type>
351 <optionGroupName>participant_role
</optionGroupName>
353 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
360 <name>intro_text
</name>
363 <type>RichTextEditor
</type>
367 <title>Introductory Message
</title>
368 <localizable>true
</localizable>
369 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
373 <name>footer_text
</name>
374 <title>Footer Message
</title>
377 <type>RichTextEditor
</type>
381 <localizable>true
</localizable>
382 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
386 <name>confirm_title
</name>
388 <title>Confirmation Title
</title>
390 <default>NULL
</default>
391 <localizable>true
</localizable>
392 <comment>Title for Confirmation page.
</comment>
399 <name>confirm_text
</name>
402 <type>RichTextEditor
</type>
406 <title>Confirm Text
</title>
407 <localizable>true
</localizable>
408 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
412 <name>confirm_footer_text
</name>
414 <title>Footer Text
</title>
416 <type>RichTextEditor
</type>
420 <localizable>true
</localizable>
421 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
425 <name>is_email_confirm
</name>
427 <required>true
</required>
428 <title>Is confirm email
</title>
430 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
433 <type>CheckBox
</type>
437 <name>confirm_email_text
</name>
439 <title>Confirmation Email Text
</title>
441 <type>TextArea
</type>
445 <localizable>true
</localizable>
446 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
450 <name>confirm_from_name
</name>
452 <title>Confirm From Name
</title>
454 <localizable>true
</localizable>
455 <comment>FROM email name used for confirmation emails.
</comment>
462 <name>confirm_from_email
</name>
464 <title>Confirm From Email
</title>
466 <comment>FROM email address used for confirmation emails.
</comment>
473 <name>cc_confirm
</name>
476 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
479 <label>CC Confirm
</label>
484 <name>bcc_confirm
</name>
487 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
490 <label>BCC Confirm
</label>
495 <name>default_fee_id
</name>
496 <type>int unsigned
</type>
497 <title>Default Fee ID
</title>
498 <comment>FK to civicrm_option_value.
</comment>
502 <name>default_discount_fee_id
</name>
503 <type>int unsigned
</type>
504 <title>Default Discount Fee ID
</title>
505 <comment>FK to civicrm_option_value.
</comment>
509 <name>thankyou_title
</name>
511 <title>ThankYou Title
</title>
513 <default>NULL
</default>
514 <localizable>true
</localizable>
515 <comment>Title for ThankYou page.
</comment>
522 <name>thankyou_text
</name>
525 <type>RichTextEditor
</type>
529 <title>ThankYou Text
</title>
530 <localizable>true
</localizable>
531 <comment>ThankYou Text.
</comment>
535 <name>thankyou_footer_text
</name>
537 <title>Footer Text
</title>
539 <type>RichTextEditor
</type>
543 <localizable>true
</localizable>
544 <comment>Footer message.
</comment>
548 <name>is_pay_later
</name>
549 <title>Pay Later Allowed
</title>
551 <required>true
</required>
553 <comment>if true - allows the user to send payment directly to the org later
</comment>
556 <type>CheckBox
</type>
560 <name>pay_later_text
</name>
561 <title>Pay Later Text
</title>
563 <localizable>true
</localizable>
564 <comment>The text displayed to the user in the main form
</comment>
567 <type>RichTextEditor
</type>
571 <name>pay_later_receipt
</name>
572 <title>Pay Later Receipt Text
</title>
574 <localizable>true
</localizable>
575 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
582 <name>is_partial_payment
</name>
583 <title>Partial Payments Enabled
</title>
585 <required>true
</required>
587 <comment>is partial payment enabled for this event
</comment>
590 <type>CheckBox
</type>
594 <name>initial_amount_label
</name>
595 <title>Initial Amount Label
</title>
598 <localizable>true
</localizable>
599 <comment>Initial amount label for partial payment
</comment>
606 <name>initial_amount_help_text
</name>
607 <title>Initial Amount Help Text
</title>
609 <localizable>true
</localizable>
610 <comment>Initial amount help text for partial payment
</comment>
617 <name>min_initial_amount
</name>
618 <title>Minimum Initial Amount
</title>
620 <comment>Minimum initial amount for partial payment
</comment>
627 <name>is_multiple_registrations
</name>
628 <title>Allow Multiple Registrations
</title>
630 <required>true
</required>
632 <comment>if true - allows the user to register multiple participants for event
</comment>
635 <type>CheckBox
</type>
639 <name>max_additional_participants
</name>
640 <type>int unsigned
</type>
641 <title>Maximum number of additional participants per registration
</title>
643 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
647 <name>allow_same_participant_emails
</name>
649 <required>true
</required>
650 <title>Does Event allow multiple registrations from same email address?
</title>
652 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
655 <type>CheckBox
</type>
659 <name>has_waitlist
</name>
660 <title>Waitlist Enabled
</title>
662 <required>true
</required>
664 <comment>Whether the event has waitlist support.
</comment>
667 <type>CheckBox
</type>
671 <name>requires_approval
</name>
673 <required>true
</required>
675 <comment>Whether participants require approval before they can finish registering.
</comment>
678 <type>CheckBox
</type>
679 <label>Requires Approval
</label>
683 <name>expiration_time
</name>
684 <type>int unsigned
</type>
685 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
689 <label>Expiration Time
</label>
693 <name>allow_selfcancelxfer
</name>
695 <required>true
</required>
697 <title>Allow Self-service Cancellation or Transfer
</title>
698 <comment>Allow self service cancellation or transfer for event?
</comment>
701 <type>CheckBox
</type>
705 <name>selfcancelxfer_time
</name>
708 <title>Self-service Cancellation or Transfer Time
</title>
709 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
716 <name>waitlist_text
</name>
719 <type>TextArea
</type>
722 <label>Waitlist Text
</label>
724 <localizable>true
</localizable>
725 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
729 <name>approval_req_text
</name>
732 <type>TextArea
</type>
735 <label>Approval Required Text
</label>
737 <localizable>true
</localizable>
738 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
742 <name>is_template
</name>
743 <title>Is an Event Template
</title>
745 <required>true
</required>
747 <required>true
</required>
748 <comment>whether the event has template
</comment>
751 <type>CheckBox
</type>
755 <name>template_title
</name>
756 <uniqueName>template_title
</uniqueName>
758 <import>true
</import>
759 <title>Event Template Title
</title>
760 <headerPattern>/(template.)?title$/i
</headerPattern>
762 <localizable>true
</localizable>
763 <comment>Event Template Title
</comment>
770 <name>created_id
</name>
771 <type>int unsigned
</type>
772 <title>Created By Contact ID
</title>
773 <comment>FK to civicrm_contact, who created this event
</comment>
775 <label>Created By
</label>
780 <name>created_id
</name>
781 <table>civicrm_contact
</table>
784 <onDelete>SET NULL
</onDelete>
787 <name>created_date
</name>
788 <type>datetime
</type>
789 <title>Event Created Date
</title>
790 <comment>Date and time that event was created.
</comment>
794 <name>currency
</name>
797 <import>true
</import>
798 <headerPattern>/cur(rency)?/i
</headerPattern>
799 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
800 <comment>3 character string, value from config setting or input via user.
</comment>
803 <table>civicrm_currency
</table>
804 <keyColumn>name
</keyColumn>
805 <labelColumn>full_name
</labelColumn>
806 <nameColumn>name
</nameColumn>
807 <abbrColumn>symbol
</abbrColumn>
811 <label>Currency
</label>
815 <name>campaign_id
</name>
816 <component>CiviCampaign
</component>
817 <type>int unsigned
</type>
818 <title>Campaign ID
</title>
819 <comment>The campaign for which this event has been created.
</comment>
822 <type>EntityRef
</type>
823 <label>Campaign
</label>
826 <table>civicrm_campaign
</table>
827 <keyColumn>id
</keyColumn>
828 <labelColumn>title
</labelColumn>
829 <prefetch>FALSE
</prefetch>
833 <name>campaign_id
</name>
834 <table>civicrm_campaign
</table>
836 <onDelete>SET NULL
</onDelete>
839 <name>is_share
</name>
840 <title>Is shared through social media
</title>
842 <required>true
</required>
844 <comment>Can people share the event through social media?
</comment>
847 <type>CheckBox
</type>
851 <name>is_confirm_enabled
</name>
852 <title>Is the booking confirmation screen enabled?
</title>
854 <required>true
</required>
856 <comment>If false, the event booking confirmation screen gets skipped
</comment>
859 <type>CheckBox
</type>
863 <name>parent_event_id
</name>
864 <type>int unsigned
</type>
865 <title>Parent Event ID
</title>
866 <default>NULL
</default>
867 <comment>Implicit FK to civicrm_event: parent event
</comment>
869 <type>EntityRef
</type>
874 <name>index_parent_event_id
</name>
875 <fieldName>parent_event_id
</fieldName>
879 <name>slot_label_id
</name>
880 <type>int unsigned
</type>
881 <title>Subevent Slot Label ID
</title>
882 <default>NULL
</default>
883 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
890 <name>dedupe_rule_group_id
</name>
891 <type>int unsigned
</type>
892 <title>Dedupe Rule ID
</title>
893 <default>NULL
</default>
894 <comment>Rule to use when matching registrations for this event
</comment>
896 <table>civicrm_dedupe_rule_group
</table>
897 <keyColumn>id
</keyColumn>
898 <nameColumn>name
</nameColumn>
899 <labelColumn>title
</labelColumn>
904 <label>Dedupe Rule
</label>
908 <name>dedupe_rule_group_id
</name>
909 <table>civicrm_dedupe_rule_group
</table>
914 <name>is_billing_required
</name>
915 <title>Is billing block required
</title>
917 <required>true
</required>
919 <comment>if true than billing block is required this event
</comment>
922 <type>CheckBox
</type>
926 <name>event_tz
</name>
928 <uniqueName>event_tz
</uniqueName>
929 <title>Event Time Zone
</title>
930 <import>true
</import>
931 <comment>Event's native time zone
</comment>
933 <default>NULL
</default>
938 <callback>CRM_Core_SelectValues::timezone
</callback>