1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
6 <name>civicrm_event
</name>
11 <type>int unsigned
</type>
12 <title>Event ID
</title>
13 <required>true
</required>
14 <comment>Event
</comment>
19 <autoincrement>true
</autoincrement>
23 <uniqueName>event_title
</uniqueName>
26 <title>Event Title
</title>
27 <headerPattern>/(event.)?title$/i
</headerPattern>
29 <localizable>true
</localizable>
30 <comment>Event Title (e.g. Fall Fundraiser Dinner)
</comment>
39 <title>Event Summary
</title>
45 <localizable>true
</localizable>
46 <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>
50 <name>description
</name>
52 <uniqueName>event_description
</uniqueName>
53 <title>Event Description
</title>
59 <localizable>true
</localizable>
60 <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.
</comment>
64 <name>event_type_id
</name>
65 <type>int unsigned
</type>
66 <uniqueName>event_type_id
</uniqueName>
67 <title>Event Type
</title>
70 <optionGroupName>event_type
</optionGroupName>
75 <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.
</comment>
79 <name>index_event_type_id
</name>
80 <fieldName>event_type_id
</fieldName>
84 <name>participant_listing_id
</name>
85 <type>int unsigned
</type>
86 <uniqueName>participant_listing_id
</uniqueName>
87 <title>Participant Listing
</title>
90 <optionGroupName>participant_listing
</optionGroupName>
92 <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.
</comment>
99 <name>index_participant_listing_id
</name>
100 <fieldName>participant_listing_id
</fieldName>
104 <name>is_public
</name>
106 <title>Is Event Public
</title>
108 <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.
</comment>
111 <type>CheckBox
</type>
115 <name>start_date
</name>
116 <type>datetime
</type>
117 <uniqueName>event_start_date
</uniqueName>
118 <title>Event Start Date
</title>
119 <headerPattern>/^start|(s(tart\s)?date)$/i
</headerPattern>
120 <import>true
</import>
121 <comment>Date and time that event starts.
</comment>
124 <type>Select Date
</type>
128 <name>end_date
</name>
129 <type>datetime
</type>
130 <uniqueName>event_end_date
</uniqueName>
131 <title>Event End Date
</title>
132 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
133 <import>true
</import>
134 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
137 <type>Select Date
</type>
141 <name>is_online_registration
</name>
143 <title>Is Online Registration
</title>
145 <comment>If true, include registration link on Event Info page.
</comment>
148 <type>CheckBox
</type>
152 <name>registration_link_text
</name>
154 <title>Event Registration Link Text
</title>
156 <localizable>true
</localizable>
157 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
164 <name>registration_start_date
</name>
165 <type>datetime
</type>
166 <comment>Date and time that online registration starts.
</comment>
169 <type>Select Date
</type>
173 <name>registration_end_date
</name>
174 <type>datetime
</type>
175 <comment>Date and time that online registration ends.
</comment>
178 <type>Select Date
</type>
182 <name>max_participants
</name>
183 <type>int unsigned
</type>
184 <title>Max Participants
</title>
185 <default>NULL
</default>
186 <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>
193 <name>event_full_text
</name>
195 <title>Event Information
</title>
197 <type>TextArea
</type>
201 <localizable>true
</localizable>
202 <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>
206 <name>is_monetary
</name>
207 <title>Is this a PAID event?
</title>
210 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
213 <type>CheckBox
</type>
217 <name>contribution_type_id
</name>
218 <type>int unsigned
</type>
220 <comment>Contribution type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
225 <name>financial_type_id
</name>
226 <type>int unsigned
</type>
227 <title>Financial Type
</title>
228 <default>NULL
</default>
229 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
231 <table>civicrm_financial_type
</table>
232 <keyColumn>id
</keyColumn>
233 <labelColumn>name
</labelColumn>
241 <name>payment_processor
</name>
244 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
246 <table>civicrm_payment_processor
</table>
247 <keyColumn>id
</keyColumn>
248 <labelColumn>name
</labelColumn>
257 <title>Map Enabled
</title>
260 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
263 <type>CheckBox
</type>
267 <name>is_active
</name>
268 <title>Is Active
</title>
271 <comment>Is this Event enabled or disabled/cancelled?
</comment>
274 <type>CheckBox
</type>
278 <name>fee_label
</name>
280 <import>true
</import>
281 <title>Fee Label
</title>
282 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
284 <localizable>true
</localizable>
291 <name>is_show_location
</name>
293 <title>show location
</title>
295 <comment>If true, show event location.
</comment>
298 <type>CheckBox
</type>
302 <name>loc_block_id
</name>
303 <type>int unsigned
</type>
304 <title>Location Block ID
</title>
305 <comment>FK to Location Block ID
</comment>
309 <name>loc_block_id
</name>
310 <table>civicrm_loc_block
</table>
312 <onDelete>SET NULL
</onDelete>
316 <name>receipt_text
</name>
319 <type>TextArea
</type>
324 <comment>Receipt Text for off-line event participation
</comment>
329 <name>default_role_id
</name>
330 <uniqueName>default_role_id
</uniqueName>
331 <title>Default Role
</title>
332 <import>true
</import>
333 <type>int unsigned
</type>
336 <optionGroupName>participant_role
</optionGroupName>
338 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
345 <name>intro_text
</name>
348 <type>TextArea
</type>
352 <title>Introductory Message
</title>
353 <localizable>true
</localizable>
354 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
358 <name>footer_text
</name>
359 <title>Footer Message
</title>
362 <type>TextArea
</type>
366 <localizable>true
</localizable>
367 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
371 <name>confirm_title
</name>
373 <title>Confirmation Title
</title>
375 <default>NULL
</default>
376 <localizable>true
</localizable>
377 <comment>Title for Confirmation page.
</comment>
384 <name>confirm_text
</name>
387 <type>TextArea
</type>
391 <title>Confirm Text
</title>
392 <localizable>true
</localizable>
393 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
397 <name>confirm_footer_text
</name>
399 <title>Footer Text
</title>
401 <type>TextArea
</type>
405 <localizable>true
</localizable>
406 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
410 <name>is_email_confirm
</name>
412 <title>Is confirm email
</title>
414 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
417 <type>CheckBox
</type>
421 <name>confirm_email_text
</name>
423 <title>Confirmation Email Text
</title>
425 <type>TextArea
</type>
429 <localizable>true
</localizable>
430 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
434 <name>confirm_from_name
</name>
436 <title>Confirm From Name
</title>
438 <localizable>true
</localizable>
439 <comment>FROM email name used for confirmation emails.
</comment>
446 <name>confirm_from_email
</name>
448 <title>Confirm From Email
</title>
450 <comment>FROM email address used for confirmation emails.
</comment>
457 <name>cc_confirm
</name>
460 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
467 <name>bcc_confirm
</name>
470 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
477 <name>default_fee_id
</name>
478 <type>int unsigned
</type>
479 <title>Default Fee ID
</title>
480 <comment>FK to civicrm_option_value.
</comment>
484 <name>default_discount_fee_id
</name>
485 <type>int unsigned
</type>
486 <title>Default Discount Fee ID
</title>
487 <comment>FK to civicrm_option_value.
</comment>
491 <name>thankyou_title
</name>
493 <title>ThankYou Title
</title>
495 <default>NULL
</default>
496 <localizable>true
</localizable>
497 <comment>Title for ThankYou page.
</comment>
504 <name>thankyou_text
</name>
507 <type>TextArea
</type>
511 <title>ThankYou Text
</title>
512 <localizable>true
</localizable>
513 <comment>ThankYou Text.
</comment>
517 <name>thankyou_footer_text
</name>
519 <title>Footer Text
</title>
521 <type>TextArea
</type>
525 <localizable>true
</localizable>
526 <comment>Footer message.
</comment>
530 <name>is_pay_later
</name>
531 <title>Pay Later Allowed
</title>
534 <comment>if true - allows the user to send payment directly to the org later
</comment>
537 <type>CheckBox
</type>
541 <name>pay_later_text
</name>
542 <title>Pay Later Text
</title>
544 <localizable>true
</localizable>
545 <comment>The text displayed to the user in the main form
</comment>
552 <name>pay_later_receipt
</name>
553 <title>Pay Later Receipt Text
</title>
555 <localizable>true
</localizable>
556 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
563 <name>is_partial_payment
</name>
564 <title>Partial Payments Enabled
</title>
567 <comment>is partial payment enabled for this event
</comment>
570 <type>CheckBox
</type>
574 <name>initial_amount_label
</name>
575 <title>Initial Amount Label
</title>
578 <localizable>true
</localizable>
579 <comment>Initial amount label for partial payment
</comment>
586 <name>initial_amount_help_text
</name>
587 <title>Initial Amount Help Text
</title>
589 <localizable>true
</localizable>
590 <comment>Initial amount help text for partial payment
</comment>
597 <name>min_initial_amount
</name>
598 <title>Minimum Initial Amount
</title>
600 <comment>Minimum initial amount for partial payment
</comment>
607 <name>is_multiple_registrations
</name>
608 <title>Allow Multiple Registrations
</title>
611 <comment>if true - allows the user to register multiple participants for event
</comment>
614 <type>CheckBox
</type>
618 <name>max_additional_participants
</name>
619 <type>int unsigned
</type>
620 <title>Maximum number of additional participants per registration
</title>
622 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
626 <name>allow_same_participant_emails
</name>
628 <title>Does Event allow multiple registrations from same email address?
</title>
630 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
633 <type>CheckBox
</type>
637 <name>has_waitlist
</name>
638 <title>Waitlist Enabled
</title>
640 <comment>Whether the event has waitlist support.
</comment>
643 <type>CheckBox
</type>
647 <name>requires_approval
</name>
649 <comment>Whether participants require approval before they can finish registering.
</comment>
652 <type>CheckBox
</type>
656 <name>expiration_time
</name>
657 <type>int unsigned
</type>
658 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
665 <name>allow_selfcancelxfer
</name>
668 <title>Allow Self-service Cancellation or Transfer
</title>
669 <comment>Allow self service cancellation or transfer for event?
</comment>
672 <type>CheckBox
</type>
676 <name>selfcancelxfer_time
</name>
677 <type>int unsigned
</type>
679 <title>Self-service Cancellation or Transfer Time
</title>
680 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
687 <name>waitlist_text
</name>
690 <type>TextArea
</type>
694 <localizable>true
</localizable>
695 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
699 <name>approval_req_text
</name>
702 <type>TextArea
</type>
706 <localizable>true
</localizable>
707 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
711 <name>is_template
</name>
712 <title>Is an Event Template
</title>
715 <required>true
</required>
716 <comment>whether the event has template
</comment>
719 <type>CheckBox
</type>
723 <name>template_title
</name>
724 <uniqueName>template_title
</uniqueName>
726 <import>true
</import>
727 <title>Event Template Title
</title>
728 <headerPattern>/(template.)?title$/i
</headerPattern>
730 <localizable>true
</localizable>
731 <comment>Event Template Title
</comment>
738 <name>created_id
</name>
739 <type>int unsigned
</type>
740 <title>Created By Contact ID
</title>
741 <comment>FK to civicrm_contact, who created this event
</comment>
745 <name>created_id
</name>
746 <table>civicrm_contact
</table>
749 <onDelete>SET NULL
</onDelete>
752 <name>created_date
</name>
753 <type>datetime
</type>
754 <title>Event Created Date
</title>
755 <comment>Date and time that event was created.
</comment>
759 <name>currency
</name>
762 <import>true
</import>
763 <headerPattern>/cur(rency)?/i
</headerPattern>
764 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
765 <comment>3 character string, value from config setting or input via user.
</comment>
768 <table>civicrm_currency
</table>
769 <keyColumn>name
</keyColumn>
770 <labelColumn>full_name
</labelColumn>
771 <nameColumn>name
</nameColumn>
778 <name>campaign_id
</name>
779 <type>int unsigned
</type>
780 <title>Campaign
</title>
781 <comment>The campaign for which this event has been created.
</comment>
783 <table>civicrm_campaign
</table>
784 <keyColumn>id
</keyColumn>
785 <labelColumn>title
</labelColumn>
789 <type>EntityRef
</type>
793 <name>campaign_id
</name>
794 <table>civicrm_campaign
</table>
796 <onDelete>SET NULL
</onDelete>
799 <name>is_share
</name>
800 <title>Is shared through social media
</title>
803 <comment>Can people share the event through social media?
</comment>
806 <type>CheckBox
</type>
810 <name>is_confirm_enabled
</name>
811 <title>Is the booking confirmation screen enabled?
</title>
814 <comment>If false, the event booking confirmation screen gets skipped
</comment>
817 <type>CheckBox
</type>
821 <name>parent_event_id
</name>
822 <type>int unsigned
</type>
823 <title>Parent Event ID
</title>
824 <default>NULL
</default>
825 <comment>Implicit FK to civicrm_event: parent event
</comment>
827 <type>EntityRef
</type>
832 <name>index_parent_event_id
</name>
833 <fieldName>parent_event_id
</fieldName>
837 <name>slot_label_id
</name>
838 <type>int unsigned
</type>
839 <title>Subevent Slot Label ID
</title>
840 <default>NULL
</default>
841 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
848 <name>dedupe_rule_group_id
</name>
849 <type>int unsigned
</type>
850 <title>Dedupe Rule
</title>
851 <default>NULL
</default>
852 <comment>Rule to use when matching registrations for this event
</comment>
854 <table>civicrm_dedupe_rule_group
</table>
855 <keyColumn>id
</keyColumn>
856 <nameColumn>name
</nameColumn>
857 <labelColumn>title
</labelColumn>
865 <name>dedupe_rule_group_id
</name>
866 <table>civicrm_dedupe_rule_group
</table>
871 <name>is_billing_required
</name>
872 <title>Is billing block required
</title>
875 <comment>if true than billing block is required this event
</comment>
878 <type>CheckBox
</type>