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>datetime
</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>
135 <type>Select Date
</type>
136 <formatType>activityDateTime
</formatType>
140 <name>end_date
</name>
141 <type>datetime
</type>
142 <uniqueName>event_end_date
</uniqueName>
143 <title>Event End Date
</title>
144 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
145 <import>true
</import>
146 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
149 <type>Select Date
</type>
150 <formatType>activityDateTime
</formatType>
154 <name>is_online_registration
</name>
156 <title>Is Online Registration
</title>
158 <comment>If true, include registration link on Event Info page.
</comment>
161 <type>CheckBox
</type>
165 <name>registration_link_text
</name>
167 <title>Event Registration Link Text
</title>
169 <localizable>true
</localizable>
170 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
177 <name>registration_start_date
</name>
178 <type>datetime
</type>
179 <comment>Date and time that online registration starts.
</comment>
182 <type>Select Date
</type>
183 <formatType>activityDateTime
</formatType>
184 <label>Registration Start Date
</label>
188 <name>registration_end_date
</name>
189 <type>datetime
</type>
190 <comment>Date and time that online registration ends.
</comment>
193 <type>Select Date
</type>
194 <formatType>activityDateTime
</formatType>
195 <label>Registration End Date
</label>
199 <name>max_participants
</name>
200 <type>int unsigned
</type>
201 <title>Max Participants
</title>
202 <default>NULL
</default>
203 <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>
210 <name>event_full_text
</name>
212 <title>Event Information
</title>
214 <type>TextArea
</type>
218 <localizable>true
</localizable>
219 <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>
223 <name>is_monetary
</name>
224 <title>Is this a PAID event?
</title>
227 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
230 <type>CheckBox
</type>
234 <name>financial_type_id
</name>
235 <type>int unsigned
</type>
236 <title>Financial Type
</title>
237 <default>NULL
</default>
238 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
240 <table>civicrm_financial_type
</table>
241 <keyColumn>id
</keyColumn>
242 <labelColumn>name
</labelColumn>
250 <name>payment_processor
</name>
253 <serialize>SEPARATOR_TRIMMED
</serialize>
254 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
256 <table>civicrm_payment_processor
</table>
257 <keyColumn>id
</keyColumn>
258 <labelColumn>name
</labelColumn>
262 <label>Payment Processors
</label>
268 <title>Map Enabled
</title>
271 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
274 <type>CheckBox
</type>
278 <name>is_active
</name>
279 <title>Is Active
</title>
282 <comment>Is this Event enabled or disabled/cancelled?
</comment>
285 <type>CheckBox
</type>
289 <name>fee_label
</name>
291 <import>true
</import>
292 <title>Fee Label
</title>
293 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
295 <localizable>true
</localizable>
302 <name>is_show_location
</name>
304 <title>show location
</title>
306 <comment>If true, show event location.
</comment>
309 <type>CheckBox
</type>
313 <name>loc_block_id
</name>
314 <type>int unsigned
</type>
315 <title>Location Block ID
</title>
316 <comment>FK to Location Block ID
</comment>
318 <label>Location Block
</label>
323 <name>loc_block_id
</name>
324 <table>civicrm_loc_block
</table>
326 <onDelete>SET NULL
</onDelete>
330 <name>default_role_id
</name>
331 <uniqueName>default_role_id
</uniqueName>
332 <title>Default Role
</title>
333 <import>true
</import>
334 <type>int unsigned
</type>
337 <optionGroupName>participant_role
</optionGroupName>
339 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
346 <name>intro_text
</name>
349 <type>RichTextEditor
</type>
353 <title>Introductory Message
</title>
354 <localizable>true
</localizable>
355 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
359 <name>footer_text
</name>
360 <title>Footer Message
</title>
363 <type>RichTextEditor
</type>
367 <localizable>true
</localizable>
368 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
372 <name>confirm_title
</name>
374 <title>Confirmation Title
</title>
376 <default>NULL
</default>
377 <localizable>true
</localizable>
378 <comment>Title for Confirmation page.
</comment>
385 <name>confirm_text
</name>
388 <type>RichTextEditor
</type>
392 <title>Confirm Text
</title>
393 <localizable>true
</localizable>
394 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
398 <name>confirm_footer_text
</name>
400 <title>Footer Text
</title>
402 <type>RichTextEditor
</type>
406 <localizable>true
</localizable>
407 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
411 <name>is_email_confirm
</name>
413 <title>Is confirm email
</title>
415 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
418 <type>CheckBox
</type>
422 <name>confirm_email_text
</name>
424 <title>Confirmation Email Text
</title>
426 <type>TextArea
</type>
430 <localizable>true
</localizable>
431 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
435 <name>confirm_from_name
</name>
437 <title>Confirm From Name
</title>
439 <localizable>true
</localizable>
440 <comment>FROM email name used for confirmation emails.
</comment>
447 <name>confirm_from_email
</name>
449 <title>Confirm From Email
</title>
451 <comment>FROM email address used for confirmation emails.
</comment>
458 <name>cc_confirm
</name>
461 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
464 <label>CC Confirm
</label>
469 <name>bcc_confirm
</name>
472 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
475 <label>BCC Confirm
</label>
480 <name>default_fee_id
</name>
481 <type>int unsigned
</type>
482 <title>Default Fee ID
</title>
483 <comment>FK to civicrm_option_value.
</comment>
487 <name>default_discount_fee_id
</name>
488 <type>int unsigned
</type>
489 <title>Default Discount Fee ID
</title>
490 <comment>FK to civicrm_option_value.
</comment>
494 <name>thankyou_title
</name>
496 <title>ThankYou Title
</title>
498 <default>NULL
</default>
499 <localizable>true
</localizable>
500 <comment>Title for ThankYou page.
</comment>
507 <name>thankyou_text
</name>
510 <type>RichTextEditor
</type>
514 <title>ThankYou Text
</title>
515 <localizable>true
</localizable>
516 <comment>ThankYou Text.
</comment>
520 <name>thankyou_footer_text
</name>
522 <title>Footer Text
</title>
524 <type>RichTextEditor
</type>
528 <localizable>true
</localizable>
529 <comment>Footer message.
</comment>
533 <name>is_pay_later
</name>
534 <title>Pay Later Allowed
</title>
537 <comment>if true - allows the user to send payment directly to the org later
</comment>
540 <type>CheckBox
</type>
544 <name>pay_later_text
</name>
545 <title>Pay Later Text
</title>
547 <localizable>true
</localizable>
548 <comment>The text displayed to the user in the main form
</comment>
551 <type>RichTextEditor
</type>
555 <name>pay_later_receipt
</name>
556 <title>Pay Later Receipt Text
</title>
558 <localizable>true
</localizable>
559 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
566 <name>is_partial_payment
</name>
567 <title>Partial Payments Enabled
</title>
570 <comment>is partial payment enabled for this event
</comment>
573 <type>CheckBox
</type>
577 <name>initial_amount_label
</name>
578 <title>Initial Amount Label
</title>
581 <localizable>true
</localizable>
582 <comment>Initial amount label for partial payment
</comment>
589 <name>initial_amount_help_text
</name>
590 <title>Initial Amount Help Text
</title>
592 <localizable>true
</localizable>
593 <comment>Initial amount help text for partial payment
</comment>
600 <name>min_initial_amount
</name>
601 <title>Minimum Initial Amount
</title>
603 <comment>Minimum initial amount for partial payment
</comment>
610 <name>is_multiple_registrations
</name>
611 <title>Allow Multiple Registrations
</title>
614 <comment>if true - allows the user to register multiple participants for event
</comment>
617 <type>CheckBox
</type>
621 <name>max_additional_participants
</name>
622 <type>int unsigned
</type>
623 <title>Maximum number of additional participants per registration
</title>
625 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
629 <name>allow_same_participant_emails
</name>
631 <title>Does Event allow multiple registrations from same email address?
</title>
633 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
636 <type>CheckBox
</type>
640 <name>has_waitlist
</name>
641 <title>Waitlist Enabled
</title>
643 <comment>Whether the event has waitlist support.
</comment>
646 <type>CheckBox
</type>
650 <name>requires_approval
</name>
652 <comment>Whether participants require approval before they can finish registering.
</comment>
655 <type>CheckBox
</type>
656 <label>Requires Approval
</label>
660 <name>expiration_time
</name>
661 <type>int unsigned
</type>
662 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
666 <label>Expiration Time
</label>
670 <name>allow_selfcancelxfer
</name>
673 <title>Allow Self-service Cancellation or Transfer
</title>
674 <comment>Allow self service cancellation or transfer for event?
</comment>
677 <type>CheckBox
</type>
681 <name>selfcancelxfer_time
</name>
684 <title>Self-service Cancellation or Transfer Time
</title>
685 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
692 <name>waitlist_text
</name>
695 <type>TextArea
</type>
698 <label>Waitlist Text
</label>
700 <localizable>true
</localizable>
701 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
705 <name>approval_req_text
</name>
708 <type>TextArea
</type>
711 <label>Approval Required Text
</label>
713 <localizable>true
</localizable>
714 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
718 <name>is_template
</name>
719 <title>Is an Event Template
</title>
722 <required>true
</required>
723 <comment>whether the event has template
</comment>
726 <type>CheckBox
</type>
730 <name>template_title
</name>
731 <uniqueName>template_title
</uniqueName>
733 <import>true
</import>
734 <title>Event Template Title
</title>
735 <headerPattern>/(template.)?title$/i
</headerPattern>
737 <localizable>true
</localizable>
738 <comment>Event Template Title
</comment>
745 <name>created_id
</name>
746 <type>int unsigned
</type>
747 <title>Created By Contact ID
</title>
748 <comment>FK to civicrm_contact, who created this event
</comment>
750 <label>Created By
</label>
755 <name>created_id
</name>
756 <table>civicrm_contact
</table>
759 <onDelete>SET NULL
</onDelete>
762 <name>created_date
</name>
763 <type>datetime
</type>
764 <title>Event Created Date
</title>
765 <comment>Date and time that event was created.
</comment>
769 <name>currency
</name>
772 <import>true
</import>
773 <headerPattern>/cur(rency)?/i
</headerPattern>
774 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
775 <comment>3 character string, value from config setting or input via user.
</comment>
778 <table>civicrm_currency
</table>
779 <keyColumn>name
</keyColumn>
780 <labelColumn>full_name
</labelColumn>
781 <nameColumn>name
</nameColumn>
782 <abbrColumn>symbol
</abbrColumn>
786 <label>Currency
</label>
790 <name>campaign_id
</name>
791 <component>CiviCampaign
</component>
792 <type>int unsigned
</type>
793 <title>Campaign ID
</title>
794 <comment>The campaign for which this event has been created.
</comment>
797 <type>EntityRef
</type>
798 <label>Campaign
</label>
801 <table>civicrm_campaign
</table>
802 <keyColumn>id
</keyColumn>
803 <labelColumn>title
</labelColumn>
804 <prefetch>FALSE
</prefetch>
808 <name>campaign_id
</name>
809 <table>civicrm_campaign
</table>
811 <onDelete>SET NULL
</onDelete>
814 <name>is_share
</name>
815 <title>Is shared through social media
</title>
818 <comment>Can people share the event through social media?
</comment>
821 <type>CheckBox
</type>
825 <name>is_confirm_enabled
</name>
826 <title>Is the booking confirmation screen enabled?
</title>
829 <comment>If false, the event booking confirmation screen gets skipped
</comment>
832 <type>CheckBox
</type>
836 <name>parent_event_id
</name>
837 <type>int unsigned
</type>
838 <title>Parent Event ID
</title>
839 <default>NULL
</default>
840 <comment>Implicit FK to civicrm_event: parent event
</comment>
842 <type>EntityRef
</type>
847 <name>index_parent_event_id
</name>
848 <fieldName>parent_event_id
</fieldName>
852 <name>slot_label_id
</name>
853 <type>int unsigned
</type>
854 <title>Subevent Slot Label ID
</title>
855 <default>NULL
</default>
856 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
863 <name>dedupe_rule_group_id
</name>
864 <type>int unsigned
</type>
865 <title>Dedupe Rule ID
</title>
866 <default>NULL
</default>
867 <comment>Rule to use when matching registrations for this event
</comment>
869 <table>civicrm_dedupe_rule_group
</table>
870 <keyColumn>id
</keyColumn>
871 <nameColumn>name
</nameColumn>
872 <labelColumn>title
</labelColumn>
877 <label>Dedupe Rule
</label>
881 <name>dedupe_rule_group_id
</name>
882 <table>civicrm_dedupe_rule_group
</table>
887 <name>is_billing_required
</name>
888 <title>Is billing block required
</title>
891 <comment>if true than billing block is required this event
</comment>
894 <type>CheckBox
</type>