xml/schema/Event/Event.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Event</base>
   5   <class>Event</class>
   6   <name>civicrm_event</name>
   7   <add>1.7</add>
   8   <log>true</log>
   9   <field>
  10     <name>id</name>
  11     <type>int unsigned</type>
  12     <title>Event ID</title>
  13     <required>true</required>
  14     <comment>Event</comment>
  15     <add>1.7</add>
  16   </field>
  17   <primaryKey>
  18     <name>id</name>
  19     <autoincrement>true</autoincrement>
  20   </primaryKey>
  21   <field>
  22     <name>title</name>
  23     <uniqueName>event_title</uniqueName>
  24     <type>varchar</type>
  25     <import>true</import>
  26     <title>Event Title</title>
  27     <headerPattern>/(event.)?title$/i</headerPattern>
  28     <length>255</length>
  29     <localizable>true</localizable>
  30     <comment>Event Title (e.g. Fall Fundraiser Dinner)</comment>
  31     <add>1.7</add>
  32   </field>
  33   <field>
  34     <name>summary</name>
  35     <type>text</type>
  36     <title>Event Summary</title>
  37     <html>
  38       <type>TextArea</type>
  39       <rows>4</rows>
  40       <cols>60</cols>
  41     </html>
  42     <localizable>true</localizable>
  43     <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>
  44     <add>1.7</add>
  45   </field>
  46   <field>
  47     <name>description</name>
  48     <type>text</type>
  49     <uniqueName>event_description</uniqueName>
  50     <title>Event Description</title>
  51     <html>
  52       <type>TextArea</type>
  53       <rows>8</rows>
  54       <cols>60</cols>
  55     </html>
  56     <localizable>true</localizable>
  57     <comment>Full description of event. Text and html allowed. Displayed on built-in Event Information screens.</comment>
  58     <add>1.7</add>
  59   </field>
  60   <field>
  61     <name>event_type_id</name>
  62     <type>int unsigned</type>
  63     <uniqueName>event_type_id</uniqueName>
  64     <title>Event Type ID</title>
  65     <default>0</default>
  66     <pseudoconstant>
  67       <optionGroupName>event_type</optionGroupName>
  68     </pseudoconstant>
  69     <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.</comment>
  70     <add>1.7</add>
  71   </field>
  72   <index>
  73     <name>index_event_type_id</name>
  74     <fieldName>event_type_id</fieldName>
  75     <add>1.8</add>
  76   </index>
  77   <field>
  78     <name>participant_listing_id</name>
  79     <type>int unsigned</type>
  80     <uniqueName>participant_listing_id</uniqueName>
  81     <title>Participant Listing ID</title>
  82     <default>0</default>
  83     <comment>Should we expose the participant list? Implicit FK to civicrm_option_value where option_group = participant_listing.</comment>
  84     <add>2.0</add>
  85   </field>
  86   <index>
  87     <name>index_participant_listing_id</name>
  88     <fieldName>participant_listing_id</fieldName>
  89     <add>2.0</add>
  90   </index>
  91   <field>
  92     <name>is_public</name>
  93     <type>boolean</type>
  94     <title>Is Event Public</title>
  95     <default>1</default>
  96     <comment>Public events will be included in the iCal feeds. Access to private event information may be limited using ACLs.</comment>
  97     <add>1.7</add>
  98   </field>
  99   <field>
 100     <name>start_date</name>
 101     <type>datetime</type>
 102     <uniqueName>event_start_date</uniqueName>
 103     <title>Event Start Date</title>
 104     <headerPattern>/^start|(s(tart\s)?date)$/i</headerPattern>
 105     <import>true</import>
 106     <comment>Date and time that event starts.</comment>
 107     <add>1.7</add>
 108   </field>
 109   <field>
 110     <name>end_date</name>
 111     <type>datetime</type>
 112     <uniqueName>event_end_date</uniqueName>
 113     <title>Event End Date</title>
 114     <headerPattern>/^end|(e(nd\s)?date)$/i</headerPattern>
 115     <import>true</import>
 116     <comment>Date and time that event ends. May be NULL if no defined end date/time</comment>
 117     <add>1.7</add>
 118   </field>
 119   <field>
 120     <name>is_online_registration</name>
 121     <type>boolean</type>
 122     <title>Is Online Registration</title>
 123     <default>0</default>
 124     <comment>If true, include registration link on Event Info page.</comment>
 125     <add>1.7</add>
 126   </field>
 127   <field>
 128     <name>registration_link_text</name>
 129     <type>varchar</type>
 130     <title>Event Registration Link Text</title>
 131     <length>255</length>
 132     <localizable>true</localizable>
 133     <comment>Text for link to Event Registration form which is displayed on Event Information screen when is_online_registration is true.</comment>
 134     <add>1.7</add>
 135   </field>
 136   <field>
 137     <name>registration_start_date</name>
 138     <type>datetime</type>
 139     <comment>Date and time that online registration starts.</comment>
 140     <add>1.8</add>
 141   </field>
 142   <field>
 143     <name>registration_end_date</name>
 144     <type>datetime</type>
 145     <comment>Date and time that online registration ends.</comment>
 146     <add>1.8</add>
 147   </field>
 148   <field>
 149     <name>max_participants</name>
 150     <type>int unsigned</type>
 151     <title>Max Participants</title>
 152     <default>NULL</default>
 153     <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>
 154     <add>1.7</add>
 155   </field>
 156   <field>
 157     <name>event_full_text</name>
 158     <type>text</type>
 159     <title>Event Information</title>
 160     <html>
 161       <type>TextArea</type>
 162       <rows>4</rows>
 163       <cols>60</cols>
 164     </html>
 165     <localizable>true</localizable>
 166     <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>
 167     <add>1.7</add>
 168   </field>
 169   <field>
 170     <name>is_monetary</name>
 171     <title>Is this a PAID event?</title>
 172     <type>boolean</type>
 173     <default>0</default>
 174     <comment>If true, one or more fee amounts must be set and a Payment Processor must be configured for Online Event Registration.</comment>
 175     <add>1.7</add>
 176   </field>
 177   <field>
 178     <name>contribution_type_id</name>
 179     <type>int unsigned</type>
 180     <default>0</default>
 181     <comment>Contribution type assigned to paid event registrations for this event. Required if is_monetary is true.</comment>
 182     <add>1.7</add>
 183     <drop>4.3</drop>
 184   </field>
 185   <field>
 186     <name>financial_type_id</name>
 187     <type>int unsigned</type>
 188     <title>Financial Type ID</title>
 189     <default>NULL</default>
 190     <comment>Financial type assigned to paid event registrations for this event. Required if is_monetary is true.</comment>
 191     <pseudoconstant>
 192       <table>civicrm_financial_type</table>
 193       <keyColumn>id</keyColumn>
 194       <labelColumn>name</labelColumn>
 195     </pseudoconstant>
 196     <add>4.3</add>
 197   </field>
 198   <field>
 199     <name>payment_processor</name>
 200     <type>varchar</type>
 201     <length>128</length>
 202     <comment>Payment Processors configured for this Event (if is_monetary is true)</comment>
 203     <pseudoconstant>
 204       <table>civicrm_payment_processor</table>
 205       <keyColumn>id</keyColumn>
 206       <labelColumn>name</labelColumn>
 207     </pseudoconstant>
 208     <add>1.8</add>
 209   </field>
 210   <field>
 211     <name>is_map</name>
 212     <title>Map Enabled</title>
 213     <type>boolean</type>
 214     <default>0</default>
 215     <comment>Include a map block on the Event Information page when geocode info is available and a mapping provider has been specified?</comment>
 216     <add>1.7</add>
 217   </field>
 218   <field>
 219     <name>is_active</name>
 220     <title>Is Active</title>
 221     <type>boolean</type>
 222     <default>0</default>
 223     <comment>Is this Event enabled or disabled/cancelled?</comment>
 224     <add>1.7</add>
 225   </field>
 226   <field>
 227     <name>fee_label</name>
 228     <type>varchar</type>
 229     <import>true</import>
 230     <title>Fee Label</title>
 231     <headerPattern>/^fee|(f(ee\s)?label)$/i</headerPattern>
 232     <length>255</length>
 233     <localizable>true</localizable>
 234     <add>1.8</add>
 235   </field>
 236   <field>
 237     <name>is_show_location</name>
 238     <type>boolean</type>
 239     <title>show location</title>
 240     <default>1</default>
 241     <comment>If true, show event location.</comment>
 242     <add>1.7</add>
 243   </field>
 244   <field>
 245     <name>loc_block_id</name>
 246     <type>int unsigned</type>
 247     <title>Location Block ID</title>
 248     <comment>FK to Location Block ID</comment>
 249     <add>2.0</add>
 250   </field>
 251   <foreignKey>
 252     <name>loc_block_id</name>
 253     <table>civicrm_loc_block</table>
 254     <key>id</key>
 255     <onDelete>SET NULL</onDelete>
 256     <add>2.0</add>
 257   </foreignKey>
 258   <field>
 259     <name>receipt_text</name>
 260     <type>varchar</type>
 261     <html>
 262       <type>TextArea</type>
 263       <rows>6</rows>
 264       <cols>50</cols>
 265     </html>
 266     <length>255</length>
 267     <comment>Receipt Text for off-line event participation</comment>
 268     <add>2.0</add>
 269     <drop>2.1</drop>
 270   </field>
 271   <field>
 272     <name>default_role_id</name>
 273     <uniqueName>default_role_id</uniqueName>
 274     <title>Participant Role</title>
 275     <import>true</import>
 276     <type>int unsigned</type>
 277     <default>1</default>
 278     <comment>Participant role ID. Implicit FK to civicrm_option_value where option_group = participant_role.</comment>
 279     <add>2.0</add>
 280   </field>
 281   <field>
 282     <name>intro_text</name>
 283     <type>text</type>
 284     <html>
 285       <type>TextArea</type>
 286       <rows>6</rows>
 287       <cols>50</cols>
 288     </html>
 289     <title>Introductory Message</title>
 290     <localizable>true</localizable>
 291     <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.</comment>
 292     <add>1.7</add>
 293   </field>
 294   <field>
 295     <name>footer_text</name>
 296     <title>Footer Message</title>
 297     <type>text</type>
 298     <html>
 299       <type>TextArea</type>
 300       <rows>6</rows>
 301       <cols>50</cols>
 302     </html>
 303     <localizable>true</localizable>
 304     <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.</comment>
 305     <add>1.7</add>
 306   </field>
 307   <field>
 308     <name>confirm_title</name>
 309     <type>varchar</type>
 310     <title>Confirmation Title</title>
 311     <length>255</length>
 312     <default>NULL</default>
 313     <localizable>true</localizable>
 314     <comment>Title for Confirmation page.</comment>
 315     <add>1.7</add>
 316   </field>
 317   <field>
 318     <name>confirm_text</name>
 319     <type>text</type>
 320     <html>
 321       <type>TextArea</type>
 322       <rows>6</rows>
 323       <cols>50</cols>
 324     </html>
 325     <title>Confirm Text</title>
 326     <localizable>true</localizable>
 327     <comment>Introductory message for Event Registration page. Text and html allowed. Displayed at the top of Event Registration form.</comment>
 328     <add>1.7</add>
 329   </field>
 330   <field>
 331     <name>confirm_footer_text</name>
 332     <type>text</type>
 333     <title>Footer Text</title>
 334     <html>
 335       <type>TextArea</type>
 336       <rows>6</rows>
 337       <cols>50</cols>
 338     </html>
 339     <localizable>true</localizable>
 340     <comment>Footer message for Event Registration page. Text and html allowed. Displayed at the bottom of Event Registration form.</comment>
 341     <add>1.7</add>
 342   </field>
 343   <field>
 344     <name>is_email_confirm</name>
 345     <type>boolean</type>
 346     <title>Is confirm email</title>
 347     <default>0</default>
 348     <comment>If true, confirmation is automatically emailed to contact on successful registration.</comment>
 349     <add>1.7</add>
 350   </field>
 351   <field>
 352     <name>confirm_email_text</name>
 353     <type>text</type>
 354     <title>Confirmation Email Text</title>
 355     <html>
 356       <type>TextArea</type>
 357       <rows>4</rows>
 358       <cols>50</cols>
 359     </html>
 360     <localizable>true</localizable>
 361     <comment>text to include above standard event info on confirmation email. emails are text-only, so do not allow html for now</comment>
 362     <add>1.7</add>
 363   </field>
 364   <field>
 365     <name>confirm_from_name</name>
 366     <type>varchar</type>
 367     <title>Confirm From Name</title>
 368     <length>255</length>
 369     <localizable>true</localizable>
 370     <comment>FROM email name used for confirmation emails.</comment>
 371     <add>1.7</add>
 372   </field>
 373   <field>
 374     <name>confirm_from_email</name>
 375     <type>varchar</type>
 376     <title>Confirm From Email</title>
 377     <length>255</length>
 378     <comment>FROM email address used for confirmation emails.</comment>
 379     <add>1.7</add>
 380   </field>
 381   <field>
 382     <name>cc_confirm</name>
 383     <type>varchar</type>
 384     <length>255</length>
 385     <comment>comma-separated list of email addresses to cc each time a confirmation is sent</comment>
 386     <add>1.7</add>
 387   </field>
 388   <field>
 389     <name>bcc_confirm</name>
 390     <type>varchar</type>
 391     <length>255</length>
 392     <comment>comma-separated list of email addresses to bcc each time a confirmation is sent</comment>
 393     <add>1.7</add>
 394   </field>
 395   <field>
 396     <name>default_fee_id</name>
 397     <type>int unsigned</type>
 398     <title>Default Fee ID</title>
 399     <comment>FK to civicrm_option_value.</comment>
 400     <add>1.7</add>
 401   </field>
 402   <field>
 403     <name>default_discount_fee_id</name>
 404     <type>int unsigned</type>
 405     <title>Default Discount Fee ID</title>
 406     <comment>FK to civicrm_option_value.</comment>
 407     <add>1.7</add>
 408   </field>
 409   <field>
 410     <name>thankyou_title</name>
 411     <type>varchar</type>
 412     <title>ThankYou Title</title>
 413     <length>255</length>
 414     <default>NULL</default>
 415     <localizable>true</localizable>
 416     <comment>Title for ThankYou page.</comment>
 417     <add>1.7</add>
 418   </field>
 419   <field>
 420     <name>thankyou_text</name>
 421     <type>text</type>
 422     <html>
 423       <type>TextArea</type>
 424       <rows>6</rows>
 425       <cols>50</cols>
 426     </html>
 427     <title>ThankYou Text</title>
 428     <localizable>true</localizable>
 429     <comment>ThankYou Text.</comment>
 430     <add>1.7</add>
 431   </field>
 432   <field>
 433     <name>thankyou_footer_text</name>
 434     <type>text</type>
 435     <title>Footer Text</title>
 436     <html>
 437       <type>TextArea</type>
 438       <rows>6</rows>
 439       <cols>50</cols>
 440     </html>
 441     <localizable>true</localizable>
 442     <comment>Footer message.</comment>
 443     <add>1.7</add>
 444   </field>
 445   <field>
 446     <name>is_pay_later</name>
 447     <title>Pay Later Allowed</title>
 448     <type>boolean</type>
 449     <default>0</default>
 450     <comment>if true - allows the user to send payment directly to the org later</comment>
 451     <add>2.0</add>
 452   </field>
 453   <field>
 454     <name>pay_later_text</name>
 455     <title>Pay Later Text</title>
 456     <type>text</type>
 457     <localizable>true</localizable>
 458     <comment>The text displayed to the user in the main form</comment>
 459     <add>2.0</add>
 460   </field>
 461   <field>
 462     <name>pay_later_receipt</name>
 463     <title>Pay Later Receipt Text</title>
 464     <type>text</type>
 465     <localizable>true</localizable>
 466     <comment>The receipt sent to the user instead of the normal receipt text</comment>
 467     <add>2.0</add>
 468   </field>
 469   <field>
 470     <name>is_partial_payment</name>
 471     <title>Partial Payments Enabled</title>
 472     <type>boolean</type>
 473     <default>0</default>
 474     <comment>is partial payment enabled for this event</comment>
 475     <add>4.3</add>
 476   </field>
 477   <field>
 478     <name>initial_amount_label</name>
 479     <title>Initial Amount Label</title>
 480     <type>varchar</type>
 481     <length>255</length>
 482     <localizable>true</localizable>
 483     <comment>Initial amount label for partial payment</comment>
 484     <add>4.3</add>
 485   </field>
 486   <field>
 487     <name>initial_amount_help_text</name>
 488     <title>Initial Amount Help Text</title>
 489     <type>text</type>
 490     <localizable>true</localizable>
 491     <comment>Initial amount help text for partial payment</comment>
 492     <add>4.3</add>
 493   </field>
 494   <field>
 495     <name>min_initial_amount</name>
 496     <title>Minimum Initial Amount</title>
 497     <type>decimal</type>
 498     <comment>Minimum initial amount for partial payment</comment>
 499     <add>4.3</add>
 500   </field>
 501   <field>
 502     <name>is_multiple_registrations</name>
 503     <title>Allow Multiple Registrations</title>
 504     <type>boolean</type>
 505     <default>0</default>
 506     <comment>if true - allows the user to register multiple participants for event</comment>
 507     <add>2.1</add>
 508   </field>
 509   <field>
 510     <name>allow_same_participant_emails</name>
 511     <type>boolean</type>
 512     <title>Does Event allow multiple registrations from same email address?</title>
 513     <default>0</default>
 514     <comment>if true - allows the user to register multiple registrations from same email address.</comment>
 515     <add>2.2</add>
 516   </field>
 517   <field>
 518     <name>has_waitlist</name>
 519     <title>Waitlist Enabled</title>
 520     <type>boolean</type>
 521     <comment>Whether the event has waitlist support.</comment>
 522     <add>3.0</add>
 523   </field>
 524   <field>
 525     <name>requires_approval</name>
 526     <type>boolean</type>
 527     <comment>Whether participants require approval before they can finish registering.</comment>
 528     <add>3.0</add>
 529   </field>
 530   <field>
 531     <name>expiration_time</name>
 532     <type>int unsigned</type>
 533     <comment>Expire pending but unconfirmed registrations after this many hours.</comment>
 534     <add>3.0</add>
 535   </field>
 536   <field>
 537     <name>waitlist_text</name>
 538     <type>text</type>
 539     <html>
 540       <type>TextArea</type>
 541       <rows>4</rows>
 542       <cols>60</cols>
 543     </html>
 544     <localizable>true</localizable>
 545     <comment>Text to display when the event is full, but participants can signup for a waitlist.</comment>
 546     <add>3.0</add>
 547   </field>
 548   <field>
 549     <name>approval_req_text</name>
 550     <type>text</type>
 551     <html>
 552       <type>TextArea</type>
 553       <rows>4</rows>
 554       <cols>60</cols>
 555     </html>
 556     <localizable>true</localizable>
 557     <comment>Text to display when the approval is required to complete registration for an event.</comment>
 558     <add>3.0</add>
 559   </field>
 560   <field>
 561     <name>is_template</name>
 562     <title>Is an Event Template</title>
 563     <type>boolean</type>
 564     <default>0</default>
 565     <comment>whether the event has template</comment>
 566     <add>3.0</add>
 567   </field>
 568   <field>
 569     <name>template_title</name>
 570     <uniqueName>template_title</uniqueName>
 571     <type>varchar</type>
 572     <import>true</import>
 573     <title>Event Template Title</title>
 574     <headerPattern>/(template.)?title$/i</headerPattern>
 575     <length>255</length>
 576     <localizable>true</localizable>
 577     <comment>Event Template Title</comment>
 578     <add>3.0</add>
 579   </field>
 580   <field>
 581     <name>created_id</name>
 582     <type>int unsigned</type>
 583     <title>Created By Contact ID</title>
 584     <comment>FK to civicrm_contact, who created this event</comment>
 585     <add>3.0</add>
 586   </field>
 587   <foreignKey>
 588     <name>created_id</name>
 589     <table>civicrm_contact</table>
 590     <key>id</key>
 591     <add>3.0</add>
 592     <onDelete>SET NULL</onDelete>
 593   </foreignKey>
 594   <field>
 595     <name>created_date</name>
 596     <type>datetime</type>
 597     <title>Event Created Date</title>
 598     <comment>Date and time that event was created.</comment>
 599     <add>3.0</add>
 600   </field>
 601   <field>
 602     <name>currency</name>
 603     <type>varchar</type>
 604     <length>3</length>
 605     <import>true</import>
 606     <headerPattern>/cur(rency)?/i</headerPattern>
 607     <dataPattern>/^[A-Z]{3}$/i</dataPattern>
 608     <comment>3 character string, value from config setting or input via user.</comment>
 609     <add>3.3</add>
 610     <pseudoconstant>
 611       <table>civicrm_currency</table>
 612       <keyColumn>name</keyColumn>
 613       <labelColumn>full_name</labelColumn>
 614       <nameColumn>numeric_code</nameColumn>
 615     </pseudoconstant>
 616   </field>
 617   <field>
 618     <name>campaign_id</name>
 619     <type>int unsigned</type>
 620     <title>Campaign ID</title>
 621     <comment>The campaign for which this event has been created.</comment>
 622     <add>3.4</add>
 623   </field>
 624   <foreignKey>
 625     <name>campaign_id</name>
 626     <table>civicrm_campaign</table>
 627     <key>id</key>
 628     <onDelete>SET NULL</onDelete>
 629   </foreignKey>
 630   <field>
 631     <name>is_share</name>
 632     <title>Is shared through social media</title>
 633     <type>boolean</type>
 634     <default>1</default>
 635     <comment>Can people share the event through social media?</comment>
 636     <add>4.1</add>
 637   </field>
 638   <field>
 639     <name>parent_event_id</name>
 640     <type>int unsigned</type>
 641     <title>Parent Event ID</title>
 642     <default>NULL</default>
 643     <comment>Implicit FK to civicrm_event: parent event</comment>
 644     <add>4.1</add>
 645   </field>
 646   <index>
 647     <name>index_parent_event_id</name>
 648     <fieldName>parent_event_id</fieldName>
 649     <add>4.1</add>
 650   </index>
 651   <field>
 652     <name>slot_label_id</name>
 653     <type>int unsigned</type>
 654     <title>Subevent Slot Label ID</title>
 655     <default>NULL</default>
 656     <comment>Subevent slot label. Implicit FK to civicrm_option_value where option_group = conference_slot.</comment>
 657     <add>4.1</add>
 658   </field>
 659 </table>