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>datetime
</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>
136 <type>Select Date
</type>
137 <formatType>activityDateTime
</formatType>
141 <name>end_date
</name>
142 <type>datetime
</type>
143 <uniqueName>event_end_date
</uniqueName>
144 <title>Event End Date
</title>
145 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
146 <import>true
</import>
147 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
150 <type>Select Date
</type>
151 <formatType>activityDateTime
</formatType>
155 <name>is_online_registration
</name>
157 <required>true
</required>
158 <title>Is Online Registration
</title>
160 <comment>If true, include registration link on Event Info page.
</comment>
163 <type>CheckBox
</type>
167 <name>registration_link_text
</name>
169 <title>Event Registration Link Text
</title>
171 <localizable>true
</localizable>
172 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
179 <name>registration_start_date
</name>
180 <type>datetime
</type>
181 <comment>Date and time that online registration starts.
</comment>
184 <type>Select Date
</type>
185 <formatType>activityDateTime
</formatType>
186 <label>Registration Start Date
</label>
190 <name>registration_end_date
</name>
191 <type>datetime
</type>
192 <comment>Date and time that online registration ends.
</comment>
195 <type>Select Date
</type>
196 <formatType>activityDateTime
</formatType>
197 <label>Registration End Date
</label>
201 <name>max_participants
</name>
202 <type>int unsigned
</type>
203 <title>Max Participants
</title>
204 <default>NULL
</default>
205 <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>
212 <name>event_full_text
</name>
214 <title>Event Information
</title>
216 <type>TextArea
</type>
220 <localizable>true
</localizable>
221 <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>
225 <name>is_monetary
</name>
226 <title>Is this a PAID event?
</title>
228 <required>true
</required>
230 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
233 <type>CheckBox
</type>
237 <name>financial_type_id
</name>
238 <type>int unsigned
</type>
239 <title>Financial Type
</title>
240 <default>NULL
</default>
241 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
243 <table>civicrm_financial_type
</table>
244 <keyColumn>id
</keyColumn>
245 <labelColumn>name
</labelColumn>
253 <name>payment_processor
</name>
256 <serialize>SEPARATOR_TRIMMED
</serialize>
257 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
259 <table>civicrm_payment_processor
</table>
260 <keyColumn>id
</keyColumn>
261 <labelColumn>name
</labelColumn>
265 <label>Payment Processors
</label>
271 <title>Map Enabled
</title>
273 <required>true
</required>
275 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
278 <type>CheckBox
</type>
282 <name>is_active
</name>
283 <title>Is Active
</title>
285 <required>true
</required>
287 <comment>Is this Event enabled or disabled/cancelled?
</comment>
290 <type>CheckBox
</type>
294 <name>fee_label
</name>
296 <import>true
</import>
297 <title>Fee Label
</title>
298 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
300 <localizable>true
</localizable>
307 <name>is_show_location
</name>
309 <required>true
</required>
310 <title>show location
</title>
312 <comment>If true, show event location.
</comment>
315 <type>CheckBox
</type>
319 <name>loc_block_id
</name>
320 <type>int unsigned
</type>
321 <title>Location Block ID
</title>
322 <comment>FK to Location Block ID
</comment>
324 <label>Location Block
</label>
329 <name>loc_block_id
</name>
330 <table>civicrm_loc_block
</table>
332 <onDelete>SET NULL
</onDelete>
336 <name>default_role_id
</name>
337 <uniqueName>default_role_id
</uniqueName>
338 <title>Default Role
</title>
339 <import>true
</import>
340 <type>int unsigned
</type>
343 <optionGroupName>participant_role
</optionGroupName>
345 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
352 <name>intro_text
</name>
355 <type>RichTextEditor
</type>
359 <title>Introductory Message
</title>
360 <localizable>true
</localizable>
361 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
365 <name>footer_text
</name>
366 <title>Footer Message
</title>
369 <type>RichTextEditor
</type>
373 <localizable>true
</localizable>
374 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
378 <name>confirm_title
</name>
380 <title>Confirmation Title
</title>
382 <default>NULL
</default>
383 <localizable>true
</localizable>
384 <comment>Title for Confirmation page.
</comment>
391 <name>confirm_text
</name>
394 <type>RichTextEditor
</type>
398 <title>Confirm Text
</title>
399 <localizable>true
</localizable>
400 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
404 <name>confirm_footer_text
</name>
406 <title>Footer Text
</title>
408 <type>RichTextEditor
</type>
412 <localizable>true
</localizable>
413 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
417 <name>is_email_confirm
</name>
419 <required>true
</required>
420 <title>Is confirm email
</title>
422 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
425 <type>CheckBox
</type>
429 <name>confirm_email_text
</name>
431 <title>Confirmation Email Text
</title>
433 <type>TextArea
</type>
437 <localizable>true
</localizable>
438 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
442 <name>confirm_from_name
</name>
444 <title>Confirm From Name
</title>
446 <localizable>true
</localizable>
447 <comment>FROM email name used for confirmation emails.
</comment>
454 <name>confirm_from_email
</name>
456 <title>Confirm From Email
</title>
458 <comment>FROM email address used for confirmation emails.
</comment>
465 <name>cc_confirm
</name>
468 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
471 <label>CC Confirm
</label>
476 <name>bcc_confirm
</name>
479 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
482 <label>BCC Confirm
</label>
487 <name>default_fee_id
</name>
488 <type>int unsigned
</type>
489 <title>Default Fee ID
</title>
490 <comment>FK to civicrm_option_value.
</comment>
494 <name>default_discount_fee_id
</name>
495 <type>int unsigned
</type>
496 <title>Default Discount Fee ID
</title>
497 <comment>FK to civicrm_option_value.
</comment>
501 <name>thankyou_title
</name>
503 <title>ThankYou Title
</title>
505 <default>NULL
</default>
506 <localizable>true
</localizable>
507 <comment>Title for ThankYou page.
</comment>
514 <name>thankyou_text
</name>
517 <type>RichTextEditor
</type>
521 <title>ThankYou Text
</title>
522 <localizable>true
</localizable>
523 <comment>ThankYou Text.
</comment>
527 <name>thankyou_footer_text
</name>
529 <title>Footer Text
</title>
531 <type>RichTextEditor
</type>
535 <localizable>true
</localizable>
536 <comment>Footer message.
</comment>
540 <name>is_pay_later
</name>
541 <title>Pay Later Allowed
</title>
543 <required>true
</required>
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>
577 <required>true
</required>
579 <comment>is partial payment enabled for this event
</comment>
582 <type>CheckBox
</type>
586 <name>initial_amount_label
</name>
587 <title>Initial Amount Label
</title>
590 <localizable>true
</localizable>
591 <comment>Initial amount label for partial payment
</comment>
598 <name>initial_amount_help_text
</name>
599 <title>Initial Amount Help Text
</title>
601 <localizable>true
</localizable>
602 <comment>Initial amount help text for partial payment
</comment>
609 <name>min_initial_amount
</name>
610 <title>Minimum Initial Amount
</title>
612 <comment>Minimum initial amount for partial payment
</comment>
619 <name>is_multiple_registrations
</name>
620 <title>Allow Multiple Registrations
</title>
622 <required>true
</required>
624 <comment>if true - allows the user to register multiple participants for event
</comment>
627 <type>CheckBox
</type>
631 <name>max_additional_participants
</name>
632 <type>int unsigned
</type>
633 <title>Maximum number of additional participants per registration
</title>
635 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
639 <name>allow_same_participant_emails
</name>
641 <required>true
</required>
642 <title>Does Event allow multiple registrations from same email address?
</title>
644 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
647 <type>CheckBox
</type>
651 <name>has_waitlist
</name>
652 <title>Waitlist Enabled
</title>
654 <required>true
</required>
656 <comment>Whether the event has waitlist support.
</comment>
659 <type>CheckBox
</type>
663 <name>requires_approval
</name>
665 <required>true
</required>
667 <comment>Whether participants require approval before they can finish registering.
</comment>
670 <type>CheckBox
</type>
671 <label>Requires Approval
</label>
675 <name>expiration_time
</name>
676 <type>int unsigned
</type>
677 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
681 <label>Expiration Time
</label>
685 <name>allow_selfcancelxfer
</name>
687 <required>true
</required>
689 <title>Allow Self-service Cancellation or Transfer
</title>
690 <comment>Allow self service cancellation or transfer for event?
</comment>
693 <type>CheckBox
</type>
697 <name>selfcancelxfer_time
</name>
700 <title>Self-service Cancellation or Transfer Time
</title>
701 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
708 <name>waitlist_text
</name>
711 <type>TextArea
</type>
714 <label>Waitlist Text
</label>
716 <localizable>true
</localizable>
717 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
721 <name>approval_req_text
</name>
724 <type>TextArea
</type>
727 <label>Approval Required Text
</label>
729 <localizable>true
</localizable>
730 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
734 <name>is_template
</name>
735 <title>Is an Event Template
</title>
737 <required>true
</required>
739 <required>true
</required>
740 <comment>whether the event has template
</comment>
743 <type>CheckBox
</type>
747 <name>template_title
</name>
748 <uniqueName>template_title
</uniqueName>
750 <import>true
</import>
751 <title>Event Template Title
</title>
752 <headerPattern>/(template.)?title$/i
</headerPattern>
754 <localizable>true
</localizable>
755 <comment>Event Template Title
</comment>
762 <name>created_id
</name>
763 <type>int unsigned
</type>
764 <title>Created By Contact ID
</title>
765 <comment>FK to civicrm_contact, who created this event
</comment>
767 <label>Created By
</label>
772 <name>created_id
</name>
773 <table>civicrm_contact
</table>
776 <onDelete>SET NULL
</onDelete>
779 <name>created_date
</name>
780 <type>datetime
</type>
781 <title>Event Created Date
</title>
782 <comment>Date and time that event was created.
</comment>
786 <name>currency
</name>
789 <import>true
</import>
790 <headerPattern>/cur(rency)?/i
</headerPattern>
791 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
792 <comment>3 character string, value from config setting or input via user.
</comment>
795 <table>civicrm_currency
</table>
796 <keyColumn>name
</keyColumn>
797 <labelColumn>full_name
</labelColumn>
798 <nameColumn>name
</nameColumn>
799 <abbrColumn>symbol
</abbrColumn>
803 <label>Currency
</label>
807 <name>campaign_id
</name>
808 <component>CiviCampaign
</component>
809 <type>int unsigned
</type>
810 <title>Campaign ID
</title>
811 <comment>The campaign for which this event has been created.
</comment>
814 <type>EntityRef
</type>
815 <label>Campaign
</label>
818 <table>civicrm_campaign
</table>
819 <keyColumn>id
</keyColumn>
820 <labelColumn>title
</labelColumn>
821 <prefetch>FALSE
</prefetch>
825 <name>campaign_id
</name>
826 <table>civicrm_campaign
</table>
828 <onDelete>SET NULL
</onDelete>
831 <name>is_share
</name>
832 <title>Is shared through social media
</title>
834 <required>true
</required>
836 <comment>Can people share the event through social media?
</comment>
839 <type>CheckBox
</type>
843 <name>is_confirm_enabled
</name>
844 <title>Is the booking confirmation screen enabled?
</title>
846 <required>true
</required>
848 <comment>If false, the event booking confirmation screen gets skipped
</comment>
851 <type>CheckBox
</type>
855 <name>parent_event_id
</name>
856 <type>int unsigned
</type>
857 <title>Parent Event ID
</title>
858 <default>NULL
</default>
859 <comment>Implicit FK to civicrm_event: parent event
</comment>
861 <type>EntityRef
</type>
866 <name>index_parent_event_id
</name>
867 <fieldName>parent_event_id
</fieldName>
871 <name>slot_label_id
</name>
872 <type>int unsigned
</type>
873 <title>Subevent Slot Label ID
</title>
874 <default>NULL
</default>
875 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
882 <name>dedupe_rule_group_id
</name>
883 <type>int unsigned
</type>
884 <title>Dedupe Rule ID
</title>
885 <default>NULL
</default>
886 <comment>Rule to use when matching registrations for this event
</comment>
888 <table>civicrm_dedupe_rule_group
</table>
889 <keyColumn>id
</keyColumn>
890 <nameColumn>name
</nameColumn>
891 <labelColumn>title
</labelColumn>
896 <label>Dedupe Rule
</label>
900 <name>dedupe_rule_group_id
</name>
901 <table>civicrm_dedupe_rule_group
</table>
906 <name>is_billing_required
</name>
907 <title>Is billing block required
</title>
909 <required>true
</required>
911 <comment>if true than billing block is required this event
</comment>
914 <type>CheckBox
</type>