1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
6 <name>civicrm_event
</name>
9 <icon>fa-calendar
</icon>
10 <component>CiviEvent
</component>
12 <add>civicrm/event/add?reset=
1</add>
13 <view>civicrm/event/info?reset=
1&id=[id]
</view>
17 <type>int unsigned
</type>
18 <title>Event ID
</title>
19 <required>true
</required>
20 <comment>Event
</comment>
25 <autoincrement>true
</autoincrement>
29 <uniqueName>event_title
</uniqueName>
32 <title>Event Title
</title>
33 <headerPattern>/(event.)?title$/i
</headerPattern>
35 <localizable>true
</localizable>
36 <comment>Event Title (e.g. Fall Fundraiser Dinner)
</comment>
45 <title>Event Summary
</title>
51 <localizable>true
</localizable>
52 <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>
56 <name>description
</name>
58 <uniqueName>event_description
</uniqueName>
59 <title>Event Description
</title>
61 <type>RichTextEditor
</type>
65 <localizable>true
</localizable>
66 <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
</comment>
70 <name>event_type_id
</name>
71 <type>int unsigned
</type>
72 <uniqueName>event_type_id
</uniqueName>
73 <title>Event Type
</title>
76 <optionGroupName>event_type
</optionGroupName>
81 <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
</comment>
85 <name>index_event_type_id
</name>
86 <fieldName>event_type_id
</fieldName>
90 <name>participant_listing_id
</name>
91 <type>int unsigned
</type>
92 <uniqueName>participant_listing_id
</uniqueName>
93 <title>Participant Listing
</title>
94 <default>NULL
</default>
96 <optionGroupName>participant_listing
</optionGroupName>
98 <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
</comment>
105 <name>index_participant_listing_id
</name>
106 <fieldName>participant_listing_id
</fieldName>
110 <name>is_public
</name>
112 <title>Is Event Public
</title>
114 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
117 <type>CheckBox
</type>
121 <name>start_date
</name>
122 <type>datetime
</type>
123 <uniqueName>event_start_date
</uniqueName>
124 <title>Event Start Date
</title>
125 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
126 <import>true
</import>
127 <comment>Date and time that event starts.
</comment>
130 <type>Select Date
</type>
131 <formatType>activityDateTime
</formatType>
135 <name>end_date
</name>
136 <type>datetime
</type>
137 <uniqueName>event_end_date
</uniqueName>
138 <title>Event End Date
</title>
139 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
140 <import>true
</import>
141 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
144 <type>Select Date
</type>
145 <formatType>activityDateTime
</formatType>
149 <name>is_online_registration
</name>
151 <title>Is Online Registration
</title>
153 <comment>If true, include registration link on Event Info page.
</comment>
156 <type>CheckBox
</type>
160 <name>registration_link_text
</name>
162 <title>Event Registration Link Text
</title>
164 <localizable>true
</localizable>
165 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
172 <name>registration_start_date
</name>
173 <type>datetime
</type>
174 <comment>Date and time that online registration starts.
</comment>
177 <type>Select Date
</type>
178 <formatType>activityDateTime
</formatType>
182 <name>registration_end_date
</name>
183 <type>datetime
</type>
184 <comment>Date and time that online registration ends.
</comment>
187 <type>Select Date
</type>
188 <formatType>activityDateTime
</formatType>
192 <name>max_participants
</name>
193 <type>int unsigned
</type>
194 <title>Max Participants
</title>
195 <default>NULL
</default>
196 <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>
203 <name>event_full_text
</name>
205 <title>Event Information
</title>
207 <type>TextArea
</type>
211 <localizable>true
</localizable>
212 <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>
216 <name>is_monetary
</name>
217 <title>Is this a PAID event?
</title>
220 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
223 <type>CheckBox
</type>
227 <name>financial_type_id
</name>
228 <type>int unsigned
</type>
229 <title>Financial Type
</title>
230 <default>NULL
</default>
231 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
233 <table>civicrm_financial_type
</table>
234 <keyColumn>id
</keyColumn>
235 <labelColumn>name
</labelColumn>
243 <name>payment_processor
</name>
246 <serialize>SEPARATOR_TRIMMED
</serialize>
247 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
249 <table>civicrm_payment_processor
</table>
250 <keyColumn>id
</keyColumn>
251 <labelColumn>name
</labelColumn>
260 <title>Map Enabled
</title>
263 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
266 <type>CheckBox
</type>
270 <name>is_active
</name>
271 <title>Is Active
</title>
274 <comment>Is this Event enabled or disabled/cancelled?
</comment>
277 <type>CheckBox
</type>
281 <name>fee_label
</name>
283 <import>true
</import>
284 <title>Fee Label
</title>
285 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
287 <localizable>true
</localizable>
294 <name>is_show_location
</name>
296 <title>show location
</title>
298 <comment>If true, show event location.
</comment>
301 <type>CheckBox
</type>
305 <name>loc_block_id
</name>
306 <type>int unsigned
</type>
307 <title>Location Block ID
</title>
308 <comment>FK to Location Block ID
</comment>
312 <name>loc_block_id
</name>
313 <table>civicrm_loc_block
</table>
315 <onDelete>SET NULL
</onDelete>
319 <name>default_role_id
</name>
320 <uniqueName>default_role_id
</uniqueName>
321 <title>Default Role
</title>
322 <import>true
</import>
323 <type>int unsigned
</type>
326 <optionGroupName>participant_role
</optionGroupName>
328 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
335 <name>intro_text
</name>
338 <type>RichTextEditor
</type>
342 <title>Introductory Message
</title>
343 <localizable>true
</localizable>
344 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
348 <name>footer_text
</name>
349 <title>Footer Message
</title>
352 <type>RichTextEditor
</type>
356 <localizable>true
</localizable>
357 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
361 <name>confirm_title
</name>
363 <title>Confirmation Title
</title>
365 <default>NULL
</default>
366 <localizable>true
</localizable>
367 <comment>Title for Confirmation page.
</comment>
374 <name>confirm_text
</name>
377 <type>RichTextEditor
</type>
381 <title>Confirm Text
</title>
382 <localizable>true
</localizable>
383 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
387 <name>confirm_footer_text
</name>
389 <title>Footer Text
</title>
391 <type>RichTextEditor
</type>
395 <localizable>true
</localizable>
396 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
400 <name>is_email_confirm
</name>
402 <title>Is confirm email
</title>
404 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
407 <type>CheckBox
</type>
411 <name>confirm_email_text
</name>
413 <title>Confirmation Email Text
</title>
415 <type>TextArea
</type>
419 <localizable>true
</localizable>
420 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
424 <name>confirm_from_name
</name>
426 <title>Confirm From Name
</title>
428 <localizable>true
</localizable>
429 <comment>FROM email name used for confirmation emails.
</comment>
436 <name>confirm_from_email
</name>
438 <title>Confirm From Email
</title>
440 <comment>FROM email address used for confirmation emails.
</comment>
447 <name>cc_confirm
</name>
450 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
457 <name>bcc_confirm
</name>
460 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
467 <name>default_fee_id
</name>
468 <type>int unsigned
</type>
469 <title>Default Fee ID
</title>
470 <comment>FK to civicrm_option_value.
</comment>
474 <name>default_discount_fee_id
</name>
475 <type>int unsigned
</type>
476 <title>Default Discount Fee ID
</title>
477 <comment>FK to civicrm_option_value.
</comment>
481 <name>thankyou_title
</name>
483 <title>ThankYou Title
</title>
485 <default>NULL
</default>
486 <localizable>true
</localizable>
487 <comment>Title for ThankYou page.
</comment>
494 <name>thankyou_text
</name>
497 <type>RichTextEditor
</type>
501 <title>ThankYou Text
</title>
502 <localizable>true
</localizable>
503 <comment>ThankYou Text.
</comment>
507 <name>thankyou_footer_text
</name>
509 <title>Footer Text
</title>
511 <type>RichTextEditor
</type>
515 <localizable>true
</localizable>
516 <comment>Footer message.
</comment>
520 <name>is_pay_later
</name>
521 <title>Pay Later Allowed
</title>
524 <comment>if true - allows the user to send payment directly to the org later
</comment>
527 <type>CheckBox
</type>
531 <name>pay_later_text
</name>
532 <title>Pay Later Text
</title>
534 <localizable>true
</localizable>
535 <comment>The text displayed to the user in the main form
</comment>
538 <type>RichTextEditor
</type>
542 <name>pay_later_receipt
</name>
543 <title>Pay Later Receipt Text
</title>
545 <localizable>true
</localizable>
546 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
553 <name>is_partial_payment
</name>
554 <title>Partial Payments Enabled
</title>
557 <comment>is partial payment enabled for this event
</comment>
560 <type>CheckBox
</type>
564 <name>initial_amount_label
</name>
565 <title>Initial Amount Label
</title>
568 <localizable>true
</localizable>
569 <comment>Initial amount label for partial payment
</comment>
576 <name>initial_amount_help_text
</name>
577 <title>Initial Amount Help Text
</title>
579 <localizable>true
</localizable>
580 <comment>Initial amount help text for partial payment
</comment>
587 <name>min_initial_amount
</name>
588 <title>Minimum Initial Amount
</title>
590 <comment>Minimum initial amount for partial payment
</comment>
597 <name>is_multiple_registrations
</name>
598 <title>Allow Multiple Registrations
</title>
601 <comment>if true - allows the user to register multiple participants for event
</comment>
604 <type>CheckBox
</type>
608 <name>max_additional_participants
</name>
609 <type>int unsigned
</type>
610 <title>Maximum number of additional participants per registration
</title>
612 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
616 <name>allow_same_participant_emails
</name>
618 <title>Does Event allow multiple registrations from same email address?
</title>
620 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
623 <type>CheckBox
</type>
627 <name>has_waitlist
</name>
628 <title>Waitlist Enabled
</title>
630 <comment>Whether the event has waitlist support.
</comment>
633 <type>CheckBox
</type>
637 <name>requires_approval
</name>
639 <comment>Whether participants require approval before they can finish registering.
</comment>
642 <type>CheckBox
</type>
646 <name>expiration_time
</name>
647 <type>int unsigned
</type>
648 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
655 <name>allow_selfcancelxfer
</name>
658 <title>Allow Self-service Cancellation or Transfer
</title>
659 <comment>Allow self service cancellation or transfer for event?
</comment>
662 <type>CheckBox
</type>
666 <name>selfcancelxfer_time
</name>
669 <title>Self-service Cancellation or Transfer Time
</title>
670 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
677 <name>waitlist_text
</name>
680 <type>TextArea
</type>
684 <localizable>true
</localizable>
685 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
689 <name>approval_req_text
</name>
692 <type>TextArea
</type>
696 <localizable>true
</localizable>
697 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
701 <name>is_template
</name>
702 <title>Is an Event Template
</title>
705 <required>true
</required>
706 <comment>whether the event has template
</comment>
709 <type>CheckBox
</type>
713 <name>template_title
</name>
714 <uniqueName>template_title
</uniqueName>
716 <import>true
</import>
717 <title>Event Template Title
</title>
718 <headerPattern>/(template.)?title$/i
</headerPattern>
720 <localizable>true
</localizable>
721 <comment>Event Template Title
</comment>
728 <name>created_id
</name>
729 <type>int unsigned
</type>
730 <title>Created By Contact ID
</title>
731 <comment>FK to civicrm_contact, who created this event
</comment>
735 <name>created_id
</name>
736 <table>civicrm_contact
</table>
739 <onDelete>SET NULL
</onDelete>
742 <name>created_date
</name>
743 <type>datetime
</type>
744 <title>Event Created Date
</title>
745 <comment>Date and time that event was created.
</comment>
749 <name>currency
</name>
752 <import>true
</import>
753 <headerPattern>/cur(rency)?/i
</headerPattern>
754 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
755 <comment>3 character string, value from config setting or input via user.
</comment>
758 <table>civicrm_currency
</table>
759 <keyColumn>name
</keyColumn>
760 <labelColumn>full_name
</labelColumn>
761 <nameColumn>name
</nameColumn>
762 <abbrColumn>symbol
</abbrColumn>
769 <name>campaign_id
</name>
770 <type>int unsigned
</type>
771 <title>Campaign
</title>
772 <comment>The campaign for which this event has been created.
</comment>
774 <table>civicrm_campaign
</table>
775 <keyColumn>id
</keyColumn>
776 <labelColumn>title
</labelColumn>
780 <type>EntityRef
</type>
784 <name>campaign_id
</name>
785 <table>civicrm_campaign
</table>
787 <onDelete>SET NULL
</onDelete>
790 <name>is_share
</name>
791 <title>Is shared through social media
</title>
794 <comment>Can people share the event through social media?
</comment>
797 <type>CheckBox
</type>
801 <name>is_confirm_enabled
</name>
802 <title>Is the booking confirmation screen enabled?
</title>
805 <comment>If false, the event booking confirmation screen gets skipped
</comment>
808 <type>CheckBox
</type>
812 <name>parent_event_id
</name>
813 <type>int unsigned
</type>
814 <title>Parent Event ID
</title>
815 <default>NULL
</default>
816 <comment>Implicit FK to civicrm_event: parent event
</comment>
818 <type>EntityRef
</type>
823 <name>index_parent_event_id
</name>
824 <fieldName>parent_event_id
</fieldName>
828 <name>slot_label_id
</name>
829 <type>int unsigned
</type>
830 <title>Subevent Slot Label ID
</title>
831 <default>NULL
</default>
832 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
839 <name>dedupe_rule_group_id
</name>
840 <type>int unsigned
</type>
841 <title>Dedupe Rule
</title>
842 <default>NULL
</default>
843 <comment>Rule to use when matching registrations for this event
</comment>
845 <table>civicrm_dedupe_rule_group
</table>
846 <keyColumn>id
</keyColumn>
847 <nameColumn>name
</nameColumn>
848 <labelColumn>title
</labelColumn>
856 <name>dedupe_rule_group_id
</name>
857 <table>civicrm_dedupe_rule_group
</table>
862 <name>is_billing_required
</name>
863 <title>Is billing block required
</title>
866 <comment>if true than billing block is required this event
</comment>
869 <type>CheckBox
</type>