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 <title>Is Event Public
</title>
119 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
122 <type>CheckBox
</type>
126 <name>start_date
</name>
127 <type>timestamp
</type>
128 <uniqueName>event_start_date
</uniqueName>
129 <title>Event Start Date
</title>
130 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
131 <import>true
</import>
132 <comment>Date and time that event starts.
</comment>
134 <required>false
</required>
135 <default>NULL
</default>
137 <type>Select Date
</type>
138 <formatType>activityDateTime
</formatType>
142 <name>end_date
</name>
143 <type>timestamp
</type>
144 <uniqueName>event_end_date
</uniqueName>
145 <title>Event End Date
</title>
146 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
147 <import>true
</import>
148 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
150 <required>false
</required>
151 <default>NULL
</default>
153 <type>Select Date
</type>
154 <formatType>activityDateTime
</formatType>
158 <name>is_online_registration
</name>
160 <title>Is Online Registration
</title>
162 <comment>If true, include registration link on Event Info page.
</comment>
165 <type>CheckBox
</type>
169 <name>registration_link_text
</name>
171 <title>Event Registration Link Text
</title>
173 <localizable>true
</localizable>
174 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
181 <name>registration_start_date
</name>
182 <type>timestamp
</type>
183 <comment>Date and time that online registration starts.
</comment>
185 <required>false
</required>
186 <default>NULL
</default>
188 <type>Select Date
</type>
189 <formatType>activityDateTime
</formatType>
190 <label>Registration Start Date
</label>
194 <name>registration_end_date
</name>
195 <type>timestamp
</type>
196 <comment>Date and time that online registration ends.
</comment>
198 <required>false
</required>
199 <default>NULL
</default>
201 <type>Select Date
</type>
202 <formatType>activityDateTime
</formatType>
203 <label>Registration End Date
</label>
207 <name>max_participants
</name>
208 <type>int unsigned
</type>
209 <title>Max Participants
</title>
210 <default>NULL
</default>
211 <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>
218 <name>event_full_text
</name>
220 <title>Event Information
</title>
222 <type>TextArea
</type>
226 <localizable>true
</localizable>
227 <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>
231 <name>is_monetary
</name>
232 <title>Is this a PAID event?
</title>
235 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
238 <type>CheckBox
</type>
242 <name>financial_type_id
</name>
243 <type>int unsigned
</type>
244 <title>Financial Type
</title>
245 <default>NULL
</default>
246 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
248 <table>civicrm_financial_type
</table>
249 <keyColumn>id
</keyColumn>
250 <labelColumn>name
</labelColumn>
258 <name>payment_processor
</name>
261 <serialize>SEPARATOR_TRIMMED
</serialize>
262 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
264 <table>civicrm_payment_processor
</table>
265 <keyColumn>id
</keyColumn>
266 <labelColumn>name
</labelColumn>
270 <label>Payment Processors
</label>
276 <title>Map Enabled
</title>
279 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
282 <type>CheckBox
</type>
286 <name>is_active
</name>
287 <title>Is Active
</title>
290 <comment>Is this Event enabled or disabled/cancelled?
</comment>
293 <type>CheckBox
</type>
297 <name>fee_label
</name>
299 <import>true
</import>
300 <title>Fee Label
</title>
301 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
303 <localizable>true
</localizable>
310 <name>is_show_location
</name>
312 <title>show location
</title>
314 <comment>If true, show event location.
</comment>
317 <type>CheckBox
</type>
321 <name>loc_block_id
</name>
322 <type>int unsigned
</type>
323 <title>Location Block ID
</title>
324 <comment>FK to Location Block ID
</comment>
326 <label>Location Block
</label>
331 <name>loc_block_id
</name>
332 <table>civicrm_loc_block
</table>
334 <onDelete>SET NULL
</onDelete>
338 <name>default_role_id
</name>
339 <uniqueName>default_role_id
</uniqueName>
340 <title>Default Role
</title>
341 <import>true
</import>
342 <type>int unsigned
</type>
345 <optionGroupName>participant_role
</optionGroupName>
347 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
354 <name>intro_text
</name>
357 <type>RichTextEditor
</type>
361 <title>Introductory Message
</title>
362 <localizable>true
</localizable>
363 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
367 <name>footer_text
</name>
368 <title>Footer Message
</title>
371 <type>RichTextEditor
</type>
375 <localizable>true
</localizable>
376 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
380 <name>confirm_title
</name>
382 <title>Confirmation Title
</title>
384 <default>NULL
</default>
385 <localizable>true
</localizable>
386 <comment>Title for Confirmation page.
</comment>
393 <name>confirm_text
</name>
396 <type>RichTextEditor
</type>
400 <title>Confirm Text
</title>
401 <localizable>true
</localizable>
402 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
406 <name>confirm_footer_text
</name>
408 <title>Footer Text
</title>
410 <type>RichTextEditor
</type>
414 <localizable>true
</localizable>
415 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
419 <name>is_email_confirm
</name>
421 <title>Is confirm email
</title>
423 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
426 <type>CheckBox
</type>
430 <name>confirm_email_text
</name>
432 <title>Confirmation Email Text
</title>
434 <type>TextArea
</type>
438 <localizable>true
</localizable>
439 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
443 <name>confirm_from_name
</name>
445 <title>Confirm From Name
</title>
447 <localizable>true
</localizable>
448 <comment>FROM email name used for confirmation emails.
</comment>
455 <name>confirm_from_email
</name>
457 <title>Confirm From Email
</title>
459 <comment>FROM email address used for confirmation emails.
</comment>
466 <name>cc_confirm
</name>
469 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
472 <label>CC Confirm
</label>
477 <name>bcc_confirm
</name>
480 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
483 <label>BCC Confirm
</label>
488 <name>default_fee_id
</name>
489 <type>int unsigned
</type>
490 <title>Default Fee ID
</title>
491 <comment>FK to civicrm_option_value.
</comment>
495 <name>default_discount_fee_id
</name>
496 <type>int unsigned
</type>
497 <title>Default Discount Fee ID
</title>
498 <comment>FK to civicrm_option_value.
</comment>
502 <name>thankyou_title
</name>
504 <title>ThankYou Title
</title>
506 <default>NULL
</default>
507 <localizable>true
</localizable>
508 <comment>Title for ThankYou page.
</comment>
515 <name>thankyou_text
</name>
518 <type>RichTextEditor
</type>
522 <title>ThankYou Text
</title>
523 <localizable>true
</localizable>
524 <comment>ThankYou Text.
</comment>
528 <name>thankyou_footer_text
</name>
530 <title>Footer Text
</title>
532 <type>RichTextEditor
</type>
536 <localizable>true
</localizable>
537 <comment>Footer message.
</comment>
541 <name>is_pay_later
</name>
542 <title>Pay Later Allowed
</title>
545 <comment>if true - allows the user to send payment directly to the org later
</comment>
548 <type>CheckBox
</type>
552 <name>pay_later_text
</name>
553 <title>Pay Later Text
</title>
555 <localizable>true
</localizable>
556 <comment>The text displayed to the user in the main form
</comment>
559 <type>RichTextEditor
</type>
563 <name>pay_later_receipt
</name>
564 <title>Pay Later Receipt Text
</title>
566 <localizable>true
</localizable>
567 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
574 <name>is_partial_payment
</name>
575 <title>Partial Payments Enabled
</title>
578 <comment>is partial payment enabled for this event
</comment>
581 <type>CheckBox
</type>
585 <name>initial_amount_label
</name>
586 <title>Initial Amount Label
</title>
589 <localizable>true
</localizable>
590 <comment>Initial amount label for partial payment
</comment>
597 <name>initial_amount_help_text
</name>
598 <title>Initial Amount Help Text
</title>
600 <localizable>true
</localizable>
601 <comment>Initial amount help text for partial payment
</comment>
608 <name>min_initial_amount
</name>
609 <title>Minimum Initial Amount
</title>
611 <comment>Minimum initial amount for partial payment
</comment>
618 <name>is_multiple_registrations
</name>
619 <title>Allow Multiple Registrations
</title>
622 <comment>if true - allows the user to register multiple participants for event
</comment>
625 <type>CheckBox
</type>
629 <name>max_additional_participants
</name>
630 <type>int unsigned
</type>
631 <title>Maximum number of additional participants per registration
</title>
633 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
637 <name>allow_same_participant_emails
</name>
639 <title>Does Event allow multiple registrations from same email address?
</title>
641 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
644 <type>CheckBox
</type>
648 <name>has_waitlist
</name>
649 <title>Waitlist Enabled
</title>
651 <comment>Whether the event has waitlist support.
</comment>
654 <type>CheckBox
</type>
658 <name>requires_approval
</name>
660 <comment>Whether participants require approval before they can finish registering.
</comment>
663 <type>CheckBox
</type>
664 <label>Requires Approval
</label>
668 <name>expiration_time
</name>
669 <type>int unsigned
</type>
670 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
674 <label>Expiration Time
</label>
678 <name>allow_selfcancelxfer
</name>
681 <title>Allow Self-service Cancellation or Transfer
</title>
682 <comment>Allow self service cancellation or transfer for event?
</comment>
685 <type>CheckBox
</type>
689 <name>selfcancelxfer_time
</name>
692 <title>Self-service Cancellation or Transfer Time
</title>
693 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
700 <name>waitlist_text
</name>
703 <type>TextArea
</type>
706 <label>Waitlist Text
</label>
708 <localizable>true
</localizable>
709 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
713 <name>approval_req_text
</name>
716 <type>TextArea
</type>
719 <label>Approval Required Text
</label>
721 <localizable>true
</localizable>
722 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
726 <name>is_template
</name>
727 <title>Is an Event Template
</title>
730 <required>true
</required>
731 <comment>whether the event has template
</comment>
734 <type>CheckBox
</type>
738 <name>template_title
</name>
739 <uniqueName>template_title
</uniqueName>
741 <import>true
</import>
742 <title>Event Template Title
</title>
743 <headerPattern>/(template.)?title$/i
</headerPattern>
745 <localizable>true
</localizable>
746 <comment>Event Template Title
</comment>
753 <name>created_id
</name>
754 <type>int unsigned
</type>
755 <title>Created By Contact ID
</title>
756 <comment>FK to civicrm_contact, who created this event
</comment>
758 <label>Created By
</label>
763 <name>created_id
</name>
764 <table>civicrm_contact
</table>
767 <onDelete>SET NULL
</onDelete>
770 <name>created_date
</name>
771 <type>datetime
</type>
772 <title>Event Created Date
</title>
773 <comment>Date and time that event was created.
</comment>
777 <name>currency
</name>
780 <import>true
</import>
781 <headerPattern>/cur(rency)?/i
</headerPattern>
782 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
783 <comment>3 character string, value from config setting or input via user.
</comment>
786 <table>civicrm_currency
</table>
787 <keyColumn>name
</keyColumn>
788 <labelColumn>full_name
</labelColumn>
789 <nameColumn>name
</nameColumn>
790 <abbrColumn>symbol
</abbrColumn>
794 <label>Currency
</label>
798 <name>campaign_id
</name>
799 <component>CiviCampaign
</component>
800 <type>int unsigned
</type>
801 <title>Campaign ID
</title>
802 <comment>The campaign for which this event has been created.
</comment>
805 <type>EntityRef
</type>
806 <label>Campaign
</label>
809 <table>civicrm_campaign
</table>
810 <keyColumn>id
</keyColumn>
811 <labelColumn>title
</labelColumn>
812 <prefetch>FALSE
</prefetch>
816 <name>campaign_id
</name>
817 <table>civicrm_campaign
</table>
819 <onDelete>SET NULL
</onDelete>
822 <name>is_share
</name>
823 <title>Is shared through social media
</title>
826 <comment>Can people share the event through social media?
</comment>
829 <type>CheckBox
</type>
833 <name>is_confirm_enabled
</name>
834 <title>Is the booking confirmation screen enabled?
</title>
837 <comment>If false, the event booking confirmation screen gets skipped
</comment>
840 <type>CheckBox
</type>
844 <name>parent_event_id
</name>
845 <type>int unsigned
</type>
846 <title>Parent Event ID
</title>
847 <default>NULL
</default>
848 <comment>Implicit FK to civicrm_event: parent event
</comment>
850 <type>EntityRef
</type>
855 <name>index_parent_event_id
</name>
856 <fieldName>parent_event_id
</fieldName>
860 <name>slot_label_id
</name>
861 <type>int unsigned
</type>
862 <title>Subevent Slot Label ID
</title>
863 <default>NULL
</default>
864 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
871 <name>dedupe_rule_group_id
</name>
872 <type>int unsigned
</type>
873 <title>Dedupe Rule ID
</title>
874 <default>NULL
</default>
875 <comment>Rule to use when matching registrations for this event
</comment>
877 <table>civicrm_dedupe_rule_group
</table>
878 <keyColumn>id
</keyColumn>
879 <nameColumn>name
</nameColumn>
880 <labelColumn>title
</labelColumn>
885 <label>Dedupe Rule
</label>
889 <name>dedupe_rule_group_id
</name>
890 <table>civicrm_dedupe_rule_group
</table>
895 <name>is_billing_required
</name>
896 <title>Is billing block required
</title>
899 <comment>if true than billing block is required this event
</comment>
902 <type>CheckBox
</type>
906 <name>event_tz
</name>
908 <uniqueName>event_tz
</uniqueName>
909 <title>Event Time Zone
</title>
910 <import>true
</import>
911 <comment>Event's native time zone
</comment>
913 <default>NULL
</default>
918 <callback>CRM_Core_SelectValues::timezone
</callback>