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>
125 <formatType>activityDateTime
</formatType>
129 <name>end_date
</name>
130 <type>datetime
</type>
131 <uniqueName>event_end_date
</uniqueName>
132 <title>Event End Date
</title>
133 <headerPattern>/^end|(e(nd\s)?date)$/i
</headerPattern>
134 <import>true
</import>
135 <comment>Date and time that event ends. May be NULL if no defined end date/time
</comment>
138 <type>Select Date
</type>
139 <formatType>activityDateTime
</formatType>
143 <name>is_online_registration
</name>
145 <title>Is Online Registration
</title>
147 <comment>If true, include registration link on Event Info page.
</comment>
150 <type>CheckBox
</type>
154 <name>registration_link_text
</name>
156 <title>Event Registration Link Text
</title>
158 <localizable>true
</localizable>
159 <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.
</comment>
166 <name>registration_start_date
</name>
167 <type>datetime
</type>
168 <comment>Date and time that online registration starts.
</comment>
171 <type>Select Date
</type>
172 <formatType>activityDateTime
</formatType>
176 <name>registration_end_date
</name>
177 <type>datetime
</type>
178 <comment>Date and time that online registration ends.
</comment>
181 <type>Select Date
</type>
182 <formatType>activityDateTime
</formatType>
186 <name>max_participants
</name>
187 <type>int unsigned
</type>
188 <title>Max Participants
</title>
189 <default>NULL
</default>
190 <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>
197 <name>event_full_text
</name>
199 <title>Event Information
</title>
201 <type>TextArea
</type>
205 <localizable>true
</localizable>
206 <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>
210 <name>is_monetary
</name>
211 <title>Is this a PAID event?
</title>
214 <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.
</comment>
217 <type>CheckBox
</type>
221 <name>contribution_type_id
</name>
222 <type>int unsigned
</type>
224 <comment>Contribution type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
229 <name>financial_type_id
</name>
230 <type>int unsigned
</type>
231 <title>Financial Type
</title>
232 <default>NULL
</default>
233 <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.
</comment>
235 <table>civicrm_financial_type
</table>
236 <keyColumn>id
</keyColumn>
237 <labelColumn>name
</labelColumn>
245 <name>payment_processor
</name>
248 <comment>Payment Processors configured for this Event (if is_monetary is true)
</comment>
250 <table>civicrm_payment_processor
</table>
251 <keyColumn>id
</keyColumn>
252 <labelColumn>name
</labelColumn>
261 <title>Map Enabled
</title>
264 <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?
</comment>
267 <type>CheckBox
</type>
271 <name>is_active
</name>
272 <title>Is Active
</title>
275 <comment>Is this Event enabled or disabled/cancelled?
</comment>
278 <type>CheckBox
</type>
282 <name>fee_label
</name>
284 <import>true
</import>
285 <title>Fee Label
</title>
286 <headerPattern>/^fee|(f(ee\s)?label)$/i
</headerPattern>
288 <localizable>true
</localizable>
295 <name>is_show_location
</name>
297 <title>show location
</title>
299 <comment>If true, show event location.
</comment>
302 <type>CheckBox
</type>
306 <name>loc_block_id
</name>
307 <type>int unsigned
</type>
308 <title>Location Block ID
</title>
309 <comment>FK to Location Block ID
</comment>
313 <name>loc_block_id
</name>
314 <table>civicrm_loc_block
</table>
316 <onDelete>SET NULL
</onDelete>
320 <name>receipt_text
</name>
323 <type>TextArea
</type>
328 <comment>Receipt Text for off-line event participation
</comment>
333 <name>default_role_id
</name>
334 <uniqueName>default_role_id
</uniqueName>
335 <title>Default Role
</title>
336 <import>true
</import>
337 <type>int unsigned
</type>
340 <optionGroupName>participant_role
</optionGroupName>
342 <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.
</comment>
349 <name>intro_text
</name>
352 <type>TextArea
</type>
356 <title>Introductory Message
</title>
357 <localizable>true
</localizable>
358 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
362 <name>footer_text
</name>
363 <title>Footer Message
</title>
366 <type>TextArea
</type>
370 <localizable>true
</localizable>
371 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
375 <name>confirm_title
</name>
377 <title>Confirmation Title
</title>
379 <default>NULL
</default>
380 <localizable>true
</localizable>
381 <comment>Title for Confirmation page.
</comment>
388 <name>confirm_text
</name>
391 <type>TextArea
</type>
395 <title>Confirm Text
</title>
396 <localizable>true
</localizable>
397 <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.
</comment>
401 <name>confirm_footer_text
</name>
403 <title>Footer Text
</title>
405 <type>TextArea
</type>
409 <localizable>true
</localizable>
410 <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.
</comment>
414 <name>is_email_confirm
</name>
416 <title>Is confirm email
</title>
418 <comment>If true, confirmation is automatically emailed to contact on successful registration.
</comment>
421 <type>CheckBox
</type>
425 <name>confirm_email_text
</name>
427 <title>Confirmation Email Text
</title>
429 <type>TextArea
</type>
433 <localizable>true
</localizable>
434 <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now
</comment>
438 <name>confirm_from_name
</name>
440 <title>Confirm From Name
</title>
442 <localizable>true
</localizable>
443 <comment>FROM email name used for confirmation emails.
</comment>
450 <name>confirm_from_email
</name>
452 <title>Confirm From Email
</title>
454 <comment>FROM email address used for confirmation emails.
</comment>
461 <name>cc_confirm
</name>
464 <comment>comma-separated list of email addresses to cc each time a confirmation is sent
</comment>
471 <name>bcc_confirm
</name>
474 <comment>comma-separated list of email addresses to bcc each time a confirmation is sent
</comment>
481 <name>default_fee_id
</name>
482 <type>int unsigned
</type>
483 <title>Default Fee ID
</title>
484 <comment>FK to civicrm_option_value.
</comment>
488 <name>default_discount_fee_id
</name>
489 <type>int unsigned
</type>
490 <title>Default Discount Fee ID
</title>
491 <comment>FK to civicrm_option_value.
</comment>
495 <name>thankyou_title
</name>
497 <title>ThankYou Title
</title>
499 <default>NULL
</default>
500 <localizable>true
</localizable>
501 <comment>Title for ThankYou page.
</comment>
508 <name>thankyou_text
</name>
511 <type>TextArea
</type>
515 <title>ThankYou Text
</title>
516 <localizable>true
</localizable>
517 <comment>ThankYou Text.
</comment>
521 <name>thankyou_footer_text
</name>
523 <title>Footer Text
</title>
525 <type>TextArea
</type>
529 <localizable>true
</localizable>
530 <comment>Footer message.
</comment>
534 <name>is_pay_later
</name>
535 <title>Pay Later Allowed
</title>
538 <comment>if true - allows the user to send payment directly to the org later
</comment>
541 <type>CheckBox
</type>
545 <name>pay_later_text
</name>
546 <title>Pay Later Text
</title>
548 <localizable>true
</localizable>
549 <comment>The text displayed to the user in the main form
</comment>
556 <name>pay_later_receipt
</name>
557 <title>Pay Later Receipt Text
</title>
559 <localizable>true
</localizable>
560 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
567 <name>is_partial_payment
</name>
568 <title>Partial Payments Enabled
</title>
571 <comment>is partial payment enabled for this event
</comment>
574 <type>CheckBox
</type>
578 <name>initial_amount_label
</name>
579 <title>Initial Amount Label
</title>
582 <localizable>true
</localizable>
583 <comment>Initial amount label for partial payment
</comment>
590 <name>initial_amount_help_text
</name>
591 <title>Initial Amount Help Text
</title>
593 <localizable>true
</localizable>
594 <comment>Initial amount help text for partial payment
</comment>
601 <name>min_initial_amount
</name>
602 <title>Minimum Initial Amount
</title>
604 <comment>Minimum initial amount for partial payment
</comment>
611 <name>is_multiple_registrations
</name>
612 <title>Allow Multiple Registrations
</title>
615 <comment>if true - allows the user to register multiple participants for event
</comment>
618 <type>CheckBox
</type>
622 <name>max_additional_participants
</name>
623 <type>int unsigned
</type>
624 <title>Maximum number of additional participants per registration
</title>
626 <comment>Maximum number of additional participants that can be registered on a single booking
</comment>
630 <name>allow_same_participant_emails
</name>
632 <title>Does Event allow multiple registrations from same email address?
</title>
634 <comment>if true - allows the user to register multiple registrations from same email address.
</comment>
637 <type>CheckBox
</type>
641 <name>has_waitlist
</name>
642 <title>Waitlist Enabled
</title>
644 <comment>Whether the event has waitlist support.
</comment>
647 <type>CheckBox
</type>
651 <name>requires_approval
</name>
653 <comment>Whether participants require approval before they can finish registering.
</comment>
656 <type>CheckBox
</type>
660 <name>expiration_time
</name>
661 <type>int unsigned
</type>
662 <comment>Expire pending but unconfirmed registrations after this many hours.
</comment>
669 <name>allow_selfcancelxfer
</name>
672 <title>Allow Self-service Cancellation or Transfer
</title>
673 <comment>Allow self service cancellation or transfer for event?
</comment>
676 <type>CheckBox
</type>
680 <name>selfcancelxfer_time
</name>
681 <type>int unsigned
</type>
683 <title>Self-service Cancellation or Transfer Time
</title>
684 <comment>Number of hours prior to event start date to allow self-service cancellation or transfer.
</comment>
691 <name>waitlist_text
</name>
694 <type>TextArea
</type>
698 <localizable>true
</localizable>
699 <comment>Text to display when the event is full, but participants can signup for a waitlist.
</comment>
703 <name>approval_req_text
</name>
706 <type>TextArea
</type>
710 <localizable>true
</localizable>
711 <comment>Text to display when the approval is required to complete registration for an event.
</comment>
715 <name>is_template
</name>
716 <title>Is an Event Template
</title>
719 <required>true
</required>
720 <comment>whether the event has template
</comment>
723 <type>CheckBox
</type>
727 <name>template_title
</name>
728 <uniqueName>template_title
</uniqueName>
730 <import>true
</import>
731 <title>Event Template Title
</title>
732 <headerPattern>/(template.)?title$/i
</headerPattern>
734 <localizable>true
</localizable>
735 <comment>Event Template Title
</comment>
742 <name>created_id
</name>
743 <type>int unsigned
</type>
744 <title>Created By Contact ID
</title>
745 <comment>FK to civicrm_contact, who created this event
</comment>
749 <name>created_id
</name>
750 <table>civicrm_contact
</table>
753 <onDelete>SET NULL
</onDelete>
756 <name>created_date
</name>
757 <type>datetime
</type>
758 <title>Event Created Date
</title>
759 <comment>Date and time that event was created.
</comment>
763 <name>currency
</name>
766 <import>true
</import>
767 <headerPattern>/cur(rency)?/i
</headerPattern>
768 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
769 <comment>3 character string, value from config setting or input via user.
</comment>
772 <table>civicrm_currency
</table>
773 <keyColumn>name
</keyColumn>
774 <labelColumn>full_name
</labelColumn>
775 <nameColumn>name
</nameColumn>
782 <name>campaign_id
</name>
783 <type>int unsigned
</type>
784 <title>Campaign
</title>
785 <comment>The campaign for which this event has been created.
</comment>
787 <table>civicrm_campaign
</table>
788 <keyColumn>id
</keyColumn>
789 <labelColumn>title
</labelColumn>
793 <type>EntityRef
</type>
797 <name>campaign_id
</name>
798 <table>civicrm_campaign
</table>
800 <onDelete>SET NULL
</onDelete>
803 <name>is_share
</name>
804 <title>Is shared through social media
</title>
807 <comment>Can people share the event through social media?
</comment>
810 <type>CheckBox
</type>
814 <name>is_confirm_enabled
</name>
815 <title>Is the booking confirmation screen enabled?
</title>
818 <comment>If false, the event booking confirmation screen gets skipped
</comment>
821 <type>CheckBox
</type>
825 <name>parent_event_id
</name>
826 <type>int unsigned
</type>
827 <title>Parent Event ID
</title>
828 <default>NULL
</default>
829 <comment>Implicit FK to civicrm_event: parent event
</comment>
831 <type>EntityRef
</type>
836 <name>index_parent_event_id
</name>
837 <fieldName>parent_event_id
</fieldName>
841 <name>slot_label_id
</name>
842 <type>int unsigned
</type>
843 <title>Subevent Slot Label ID
</title>
844 <default>NULL
</default>
845 <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.
</comment>
852 <name>dedupe_rule_group_id
</name>
853 <type>int unsigned
</type>
854 <title>Dedupe Rule
</title>
855 <default>NULL
</default>
856 <comment>Rule to use when matching registrations for this event
</comment>
858 <table>civicrm_dedupe_rule_group
</table>
859 <keyColumn>id
</keyColumn>
860 <nameColumn>name
</nameColumn>
861 <labelColumn>title
</labelColumn>
869 <name>dedupe_rule_group_id
</name>
870 <table>civicrm_dedupe_rule_group
</table>
875 <name>is_billing_required
</name>
876 <title>Is billing block required
</title>
879 <comment>if true than billing block is required this event
</comment>
882 <type>CheckBox
</type>