1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
6 <name>civicrm_event
</name>
9 <icon>fa-calendar
</icon>
11 <add>civicrm/event/add?reset=
1</add>
12 <view>civicrm/event/info?reset=
1&id=[id]
</view>
16 <type>int unsigned
</type>
17 <title>Event ID
</title>
18 <required>true
</required>
19 <comment>Event
</comment>
24 <autoincrement>true
</autoincrement>
28 <uniqueName>event_title
</uniqueName>
31 <title>Event Title
</title>
32 <headerPattern>/(event.)?title$/i
</headerPattern>
34 <localizable>true
</localizable>
35 <comment>Event Title (e.g. Fall Fundraiser Dinner)
</comment>
44 <title>Event Summary
</title>
50 <localizable>true
</localizable>
51 <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>
55 <name>description
</name>
57 <uniqueName>event_description
</uniqueName>
58 <title>Event Description
</title>
60 <type>RichTextEditor
</type>
64 <localizable>true
</localizable>
65 <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
</comment>
69 <name>event_type_id
</name>
70 <type>int unsigned
</type>
71 <uniqueName>event_type_id
</uniqueName>
72 <title>Event Type
</title>
75 <optionGroupName>event_type
</optionGroupName>
80 <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
</comment>
84 <name>index_event_type_id
</name>
85 <fieldName>event_type_id
</fieldName>
89 <name>participant_listing_id
</name>
90 <type>int unsigned
</type>
91 <uniqueName>participant_listing_id
</uniqueName>
92 <title>Participant Listing
</title>
93 <default>NULL
</default>
95 <optionGroupName>participant_listing
</optionGroupName>
97 <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
</comment>
104 <name>index_participant_listing_id
</name>
105 <fieldName>participant_listing_id
</fieldName>
109 <name>is_public
</name>
111 <title>Is Event Public
</title>
113 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
116 <type>CheckBox
</type>
120 <name>start_date
</name>
121 <type>datetime
</type>
122 <uniqueName>event_start_date
</uniqueName>
123 <title>Event Start Date
</title>
124 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
125 <import>true
</import>
126 <comment>Date and time that event starts.
</comment>
129 <type>Select Date
</type>
130 <formatType>activityDateTime
</formatType>
134 <name>end_date
</name>
135 <type>datetime
</type>
136 <uniqueName>event_end_date
</uniqueName>
137 <title>Event End Date
</title>
138 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
139 <import>true
</import>
140 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
143 <type>Select Date
</type>
144 <formatType>activityDateTime
</formatType>
148 <name>is_online_registration
</name>
150 <title>Is Online Registration
</title>
152 <comment>If true, include registration link on Event Info page.
</comment>
155 <type>CheckBox
</type>
159 <name>registration_link_text
</name>
161 <title>Event Registration Link Text
</title>
163 <localizable>true
</localizable>
164 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
171 <name>registration_start_date
</name>
172 <type>datetime
</type>
173 <comment>Date and time that online registration starts.
</comment>
176 <type>Select Date
</type>
177 <formatType>activityDateTime
</formatType>
181 <name>registration_end_date
</name>
182 <type>datetime
</type>
183 <comment>Date and time that online registration ends.
</comment>
186 <type>Select Date
</type>
187 <formatType>activityDateTime
</formatType>
191 <name>max_participants
</name>
192 <type>int unsigned
</type>
193 <title>Max Participants
</title>
194 <default>NULL
</default>
195 <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>
202 <name>event_full_text
</name>
204 <title>Event Information
</title>
206 <type>TextArea
</type>
210 <localizable>true
</localizable>
211 <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>
215 <name>is_monetary
</name>
216 <title>Is this a PAID event?
</title>
219 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
222 <type>CheckBox
</type>
226 <name>financial_type_id
</name>
227 <type>int unsigned
</type>
228 <title>Financial Type
</title>
229 <default>NULL
</default>
230 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
232 <table>civicrm_financial_type
</table>
233 <keyColumn>id
</keyColumn>
234 <labelColumn>name
</labelColumn>
242 <name>payment_processor
</name>
245 <serialize>SEPARATOR_TRIMMED
</serialize>
246 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
248 <table>civicrm_payment_processor
</table>
249 <keyColumn>id
</keyColumn>
250 <labelColumn>name
</labelColumn>
259 <title>Map Enabled
</title>
262 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
265 <type>CheckBox
</type>
269 <name>is_active
</name>
270 <title>Is Active
</title>
273 <comment>Is this Event enabled or disabled/cancelled?
</comment>
276 <type>CheckBox
</type>
280 <name>fee_label
</name>
282 <import>true
</import>
283 <title>Fee Label
</title>
284 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
286 <localizable>true
</localizable>
293 <name>is_show_location
</name>
295 <title>show location
</title>
297 <comment>If true, show event location.
</comment>
300 <type>CheckBox
</type>
304 <name>loc_block_id
</name>
305 <type>int unsigned
</type>
306 <title>Location Block ID
</title>
307 <comment>FK to Location Block ID
</comment>
311 <name>loc_block_id
</name>
312 <table>civicrm_loc_block
</table>
314 <onDelete>SET NULL
</onDelete>
318 <name>default_role_id
</name>
319 <uniqueName>default_role_id
</uniqueName>
320 <title>Default Role
</title>
321 <import>true
</import>
322 <type>int unsigned
</type>
325 <optionGroupName>participant_role
</optionGroupName>
327 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
334 <name>intro_text
</name>
337 <type>RichTextEditor
</type>
341 <title>Introductory Message
</title>
342 <localizable>true
</localizable>
343 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
347 <name>footer_text
</name>
348 <title>Footer Message
</title>
351 <type>RichTextEditor
</type>
355 <localizable>true
</localizable>
356 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
360 <name>confirm_title
</name>
362 <title>Confirmation Title
</title>
364 <default>NULL
</default>
365 <localizable>true
</localizable>
366 <comment>Title for Confirmation page.
</comment>
373 <name>confirm_text
</name>
376 <type>RichTextEditor
</type>
380 <title>Confirm Text
</title>
381 <localizable>true
</localizable>
382 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
386 <name>confirm_footer_text
</name>
388 <title>Footer Text
</title>
390 <type>RichTextEditor
</type>
394 <localizable>true
</localizable>
395 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
399 <name>is_email_confirm
</name>
401 <title>Is confirm email
</title>
403 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
406 <type>CheckBox
</type>
410 <name>confirm_email_text
</name>
412 <title>Confirmation Email Text
</title>
414 <type>TextArea
</type>
418 <localizable>true
</localizable>
419 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
423 <name>confirm_from_name
</name>
425 <title>Confirm From Name
</title>
427 <localizable>true
</localizable>
428 <comment>FROM email name used for confirmation emails.
</comment>
435 <name>confirm_from_email
</name>
437 <title>Confirm From Email
</title>
439 <comment>FROM email address used for confirmation emails.
</comment>
446 <name>cc_confirm
</name>
449 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
456 <name>bcc_confirm
</name>
459 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
466 <name>default_fee_id
</name>
467 <type>int unsigned
</type>
468 <title>Default Fee ID
</title>
469 <comment>FK to civicrm_option_value.
</comment>
473 <name>default_discount_fee_id
</name>
474 <type>int unsigned
</type>
475 <title>Default Discount Fee ID
</title>
476 <comment>FK to civicrm_option_value.
</comment>
480 <name>thankyou_title
</name>
482 <title>ThankYou Title
</title>
484 <default>NULL
</default>
485 <localizable>true
</localizable>
486 <comment>Title for ThankYou page.
</comment>
493 <name>thankyou_text
</name>
496 <type>RichTextEditor
</type>
500 <title>ThankYou Text
</title>
501 <localizable>true
</localizable>
502 <comment>ThankYou Text.
</comment>
506 <name>thankyou_footer_text
</name>
508 <title>Footer Text
</title>
510 <type>RichTextEditor
</type>
514 <localizable>true
</localizable>
515 <comment>Footer message.
</comment>
519 <name>is_pay_later
</name>
520 <title>Pay Later Allowed
</title>
523 <comment>if true - allows the user to send payment directly to the org later
</comment>
526 <type>CheckBox
</type>
530 <name>pay_later_text
</name>
531 <title>Pay Later Text
</title>
533 <localizable>true
</localizable>
534 <comment>The text displayed to the user in the main form
</comment>
537 <type>RichTextEditor
</type>
541 <name>pay_later_receipt
</name>
542 <title>Pay Later Receipt Text
</title>
544 <localizable>true
</localizable>
545 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
552 <name>is_partial_payment
</name>
553 <title>Partial Payments Enabled
</title>
556 <comment>is partial payment enabled for this event
</comment>
559 <type>CheckBox
</type>
563 <name>initial_amount_label
</name>
564 <title>Initial Amount Label
</title>
567 <localizable>true
</localizable>
568 <comment>Initial amount label for partial payment
</comment>
575 <name>initial_amount_help_text
</name>
576 <title>Initial Amount Help Text
</title>
578 <localizable>true
</localizable>
579 <comment>Initial amount help text for partial payment
</comment>
586 <name>min_initial_amount
</name>
587 <title>Minimum Initial Amount
</title>
589 <comment>Minimum initial amount for partial payment
</comment>
596 <name>is_multiple_registrations
</name>
597 <title>Allow Multiple Registrations
</title>
600 <comment>if true - allows the user to register multiple participants for event
</comment>
603 <type>CheckBox
</type>
607 <name>max_additional_participants
</name>
608 <type>int unsigned
</type>
609 <title>Maximum number of additional participants per registration
</title>
611 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
615 <name>allow_same_participant_emails
</name>
617 <title>Does Event allow multiple registrations from same email address?
</title>
619 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
622 <type>CheckBox
</type>
626 <name>has_waitlist
</name>
627 <title>Waitlist Enabled
</title>
629 <comment>Whether the event has waitlist support.
</comment>
632 <type>CheckBox
</type>
636 <name>requires_approval
</name>
638 <comment>Whether participants require approval before they can finish registering.
</comment>
641 <type>CheckBox
</type>
645 <name>expiration_time
</name>
646 <type>int unsigned
</type>
647 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
654 <name>allow_selfcancelxfer
</name>
657 <title>Allow Self-service Cancellation or Transfer
</title>
658 <comment>Allow self service cancellation or transfer for event?
</comment>
661 <type>CheckBox
</type>
665 <name>selfcancelxfer_time
</name>
668 <title>Self-service Cancellation or Transfer Time
</title>
669 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
676 <name>waitlist_text
</name>
679 <type>TextArea
</type>
683 <localizable>true
</localizable>
684 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
688 <name>approval_req_text
</name>
691 <type>TextArea
</type>
695 <localizable>true
</localizable>
696 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
700 <name>is_template
</name>
701 <title>Is an Event Template
</title>
704 <required>true
</required>
705 <comment>whether the event has template
</comment>
708 <type>CheckBox
</type>
712 <name>template_title
</name>
713 <uniqueName>template_title
</uniqueName>
715 <import>true
</import>
716 <title>Event Template Title
</title>
717 <headerPattern>/(template.)?title$/i
</headerPattern>
719 <localizable>true
</localizable>
720 <comment>Event Template Title
</comment>
727 <name>created_id
</name>
728 <type>int unsigned
</type>
729 <title>Created By Contact ID
</title>
730 <comment>FK to civicrm_contact, who created this event
</comment>
734 <name>created_id
</name>
735 <table>civicrm_contact
</table>
738 <onDelete>SET NULL
</onDelete>
741 <name>created_date
</name>
742 <type>datetime
</type>
743 <title>Event Created Date
</title>
744 <comment>Date and time that event was created.
</comment>
748 <name>currency
</name>
751 <import>true
</import>
752 <headerPattern>/cur(rency)?/i
</headerPattern>
753 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
754 <comment>3 character string, value from config setting or input via user.
</comment>
757 <table>civicrm_currency
</table>
758 <keyColumn>name
</keyColumn>
759 <labelColumn>full_name
</labelColumn>
760 <nameColumn>name
</nameColumn>
761 <abbrColumn>symbol
</abbrColumn>
768 <name>campaign_id
</name>
769 <type>int unsigned
</type>
770 <title>Campaign
</title>
771 <comment>The campaign for which this event has been created.
</comment>
773 <table>civicrm_campaign
</table>
774 <keyColumn>id
</keyColumn>
775 <labelColumn>title
</labelColumn>
779 <type>EntityRef
</type>
783 <name>campaign_id
</name>
784 <table>civicrm_campaign
</table>
786 <onDelete>SET NULL
</onDelete>
789 <name>is_share
</name>
790 <title>Is shared through social media
</title>
793 <comment>Can people share the event through social media?
</comment>
796 <type>CheckBox
</type>
800 <name>is_confirm_enabled
</name>
801 <title>Is the booking confirmation screen enabled?
</title>
804 <comment>If false, the event booking confirmation screen gets skipped
</comment>
807 <type>CheckBox
</type>
811 <name>parent_event_id
</name>
812 <type>int unsigned
</type>
813 <title>Parent Event ID
</title>
814 <default>NULL
</default>
815 <comment>Implicit FK to civicrm_event: parent event
</comment>
817 <type>EntityRef
</type>
822 <name>index_parent_event_id
</name>
823 <fieldName>parent_event_id
</fieldName>
827 <name>slot_label_id
</name>
828 <type>int unsigned
</type>
829 <title>Subevent Slot Label ID
</title>
830 <default>NULL
</default>
831 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
838 <name>dedupe_rule_group_id
</name>
839 <type>int unsigned
</type>
840 <title>Dedupe Rule
</title>
841 <default>NULL
</default>
842 <comment>Rule to use when matching registrations for this event
</comment>
844 <table>civicrm_dedupe_rule_group
</table>
845 <keyColumn>id
</keyColumn>
846 <nameColumn>name
</nameColumn>
847 <labelColumn>title
</labelColumn>
855 <name>dedupe_rule_group_id
</name>
856 <table>civicrm_dedupe_rule_group
</table>
861 <name>is_billing_required
</name>
862 <title>Is billing block required
</title>
865 <comment>if true than billing block is required this event
</comment>
868 <type>CheckBox
</type>