From 0d94665e009d3c7235faaafc08e983aa130cbb3b Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 25 Aug 2014 12:11:07 +1200 Subject: [PATCH] CRM-15168 add some additional titles to schema --- xml/schema/Contribute/Premium.xml | 7 +++++++ xml/schema/Contribute/Product.xml | 1 + xml/schema/Core/ActionSchedule.xml | 12 ++++++++++++ xml/schema/Core/MessageTemplate.xml | 9 +++++++++ xml/schema/Core/OptionGroup.xml | 6 ++++++ xml/schema/Core/OptionValue.xml | 8 ++++++++ xml/schema/Core/PrintLabel.xml | 6 ++++++ xml/schema/Event/ParticipantPayment.xml | 1 + xml/schema/Event/ParticipantStatusType.xml | 8 ++++++++ xml/schema/Financial/FinancialType.xml | 1 + xml/schema/Financial/PaymentProcessor.xml | 10 ++++++++++ xml/schema/Financial/PaymentProcessorType.xml | 6 ++++++ xml/schema/Mailing/Component.xml | 5 +++++ xml/schema/Mailing/Event/Confirm.xml | 3 +++ xml/schema/Mailing/Event/Subscribe.xml | 5 +++++ xml/schema/Mailing/Event/Unsubscribe.xml | 4 ++++ xml/schema/Mailing/Mailing.xml | 12 ++++++++++++ xml/schema/Mailing/MailingGroup.xml | 7 +++++++ xml/schema/Mailing/MailingJob.xml | 11 +++++++++++ xml/schema/Mailing/Recipients.xml | 5 +++++ xml/schema/Member/MembershipBlock.xml | 11 +++++++++++ xml/schema/Member/MembershipPayment.xml | 3 +++ xml/schema/Member/MembershipType.xml | 15 +++++++++++++++ 23 files changed, 156 insertions(+) diff --git a/xml/schema/Contribute/Premium.xml b/xml/schema/Contribute/Premium.xml index 2cb96974f8..039d1921a9 100644 --- a/xml/schema/Contribute/Premium.xml +++ b/xml/schema/Contribute/Premium.xml @@ -9,6 +9,7 @@ true id + Premium ID int unsigned true 1.4 @@ -19,6 +20,7 @@ entity_table + Premium Entity varchar 64 true @@ -27,6 +29,7 @@ entity_id + Premium entity ID int unsigned true 1.4 @@ -38,6 +41,7 @@ premiums_active + Is Premium Active? boolean 0 true @@ -55,6 +59,7 @@ premiums_intro_text + Premium Introductory Text text true Displayed in <div> at top of Premiums section of page. Text and HTML allowed. @@ -62,6 +67,7 @@ premiums_contact_email + Premium Contact Email varchar 100 This email address is included in receipts if it is populated and a premium has been selected. @@ -77,6 +83,7 @@ premiums_display_min_contribution + Display Minimum Contribution? boolean true Boolean. Should we automatically display minimum contribution amount text after the premium descriptions. diff --git a/xml/schema/Contribute/Product.xml b/xml/schema/Contribute/Product.xml index 5bb0c9e301..2f3ec72ec3 100644 --- a/xml/schema/Contribute/Product.xml +++ b/xml/schema/Contribute/Product.xml @@ -9,6 +9,7 @@ true id + Product ID int unsigned true 1.4 diff --git a/xml/schema/Core/ActionSchedule.xml b/xml/schema/Core/ActionSchedule.xml index 12ba64815e..c519fa89f6 100644 --- a/xml/schema/Core/ActionSchedule.xml +++ b/xml/schema/Core/ActionSchedule.xml @@ -155,6 +155,7 @@ is_active + Schedule is Active? boolean 1 Is this option active? @@ -178,18 +179,21 @@ body_text + Reminder Text longtext Body of the mailing in text format. 3.4 body_html + Reminder HTML longtext Body of the mailing in html format. 3.4 subject + Reminder Subject varchar 128 Subject of mailing @@ -197,6 +201,7 @@ record_activity + Record Activity for Reminder? boolean NULL Record Activity for this reminder? @@ -204,6 +209,7 @@ mapping_id + Reminder Mapping int unsigned FK to mapping which is being used by this reminder 3.4 @@ -216,6 +222,7 @@ group_id + Reminder Group int unsigned FK to Group @@ -236,6 +243,7 @@ msg_template_id + Reminder Template int unsigned FK to the message template. @@ -247,12 +255,14 @@ absolute_date + Fixed Date for Reminder date Date on which the reminder be sent. 4.1 from_name + Reminder from Name varchar 255 Name in "from" field @@ -260,6 +270,7 @@ from_email + Reminder From Email varchar 255 Email address in "from" field @@ -282,6 +293,7 @@ sms_provider_id + SMS Provider int unsigned 4.5 diff --git a/xml/schema/Core/MessageTemplate.xml b/xml/schema/Core/MessageTemplate.xml index 5f8cc7ca5e..bfc64f8740 100644 --- a/xml/schema/Core/MessageTemplate.xml +++ b/xml/schema/Core/MessageTemplate.xml @@ -8,6 +8,7 @@ 1.6 id + Message Template ID int unsigned true Message Template ID @@ -19,6 +20,7 @@ msg_title + Message Template Title varchar 255 Descriptive title of message @@ -26,6 +28,7 @@ msg_subject + Message Template Subject text Subject for email message. 1.6 @@ -33,6 +36,7 @@ msg_text + Message Template Text longtext TextArea @@ -45,6 +49,7 @@ msg_html + Message Template HTML longtext RichTextEditor @@ -64,12 +69,14 @@ workflow_id + Message Template Workflow int unsigned a pseudo-FK to civicrm_option_value 3.1 is_default + Message Template Is Default? boolean 1 is this the default message template for the workflow referenced by workflow_id? @@ -77,12 +84,14 @@ is_reserved + Message Template Is Reserved? boolean is this the reserved message template which we ship for the workflow referenced by workflow_id? 3.1 pdf_format_id + Message Template Format int unsigned a pseudo-FK to civicrm_option_value containing PDF Page Format. diff --git a/xml/schema/Core/OptionGroup.xml b/xml/schema/Core/OptionGroup.xml index 9aecfd8aa2..1da22f5b5c 100644 --- a/xml/schema/Core/OptionGroup.xml +++ b/xml/schema/Core/OptionGroup.xml @@ -8,6 +8,7 @@ true id + Option Group ID int unsigned true Option Group ID @@ -28,6 +29,7 @@ title + Option Group title varchar 255 true @@ -36,6 +38,7 @@ description + Option Group Description varchar 255 true @@ -44,6 +47,7 @@ is_reserved + Option Group Is Reserved? boolean 1 Is this a predefined system option group (i.e. it can not be deleted)? @@ -51,12 +55,14 @@ is_active + Option Group Is Active? boolean Is this option group active? 1.5 is_locked + Option Group Is Locked boolean A lock to remove the ability to add new options via the UI. 4.5 diff --git a/xml/schema/Core/OptionValue.xml b/xml/schema/Core/OptionValue.xml index 77da2acd5f..0d54ef7a92 100644 --- a/xml/schema/Core/OptionValue.xml +++ b/xml/schema/Core/OptionValue.xml @@ -86,6 +86,7 @@ is_default + Option is Default? boolean 0 Is this the default option for the group? @@ -93,6 +94,7 @@ weight + Option Weight int unsigned true Controls display sort order. @@ -100,6 +102,7 @@ description + Option Description text TextArea @@ -112,6 +115,7 @@ is_optgroup + Option is Header? boolean 0 Is this row simply a display header? Expected usage is to render these as OPTGROUP tags within a SELECT field list of options? @@ -119,6 +123,7 @@ is_reserved + Option Is Reserved? boolean 0 Is this a predefined system object? @@ -134,6 +139,7 @@ component_id + Option Component int unsigned Component that this option value belongs/caters to. 2.0 @@ -154,6 +160,7 @@ domain_id + Option Domain int unsigned civicrm_domain
@@ -171,6 +178,7 @@ visibility_id + Option Visibility int unsigned NULL 2.2 diff --git a/xml/schema/Core/PrintLabel.xml b/xml/schema/Core/PrintLabel.xml index 6017f2f843..b5e2ee0ec5 100644 --- a/xml/schema/Core/PrintLabel.xml +++ b/xml/schema/Core/PrintLabel.xml @@ -41,6 +41,7 @@ label_format_name + Label Format varchar 255 @@ -54,6 +55,7 @@ label_type_id + Label Type int unsigned label_type @@ -72,6 +74,7 @@ is_default + Label is Default? boolean 1 Is this default? @@ -79,6 +82,7 @@ is_active + Label Is Active? boolean 1 Is this option active? @@ -86,6 +90,7 @@ is_reserved + Is Label Reserved? boolean 1 Is this reserved label? @@ -93,6 +98,7 @@ created_id + Label Created By int unsigned Created By Contact ID FK to civicrm_contact, who created this label layout diff --git a/xml/schema/Event/ParticipantPayment.xml b/xml/schema/Event/ParticipantPayment.xml index c751945685..00edfcde04 100644 --- a/xml/schema/Event/ParticipantPayment.xml +++ b/xml/schema/Event/ParticipantPayment.xml @@ -34,6 +34,7 @@ contribution_id + Contribution int unsigned true FK to contribution table. diff --git a/xml/schema/Event/ParticipantStatusType.xml b/xml/schema/Event/ParticipantStatusType.xml index 407c6d1b1e..ee3e033712 100644 --- a/xml/schema/Event/ParticipantStatusType.xml +++ b/xml/schema/Event/ParticipantStatusType.xml @@ -8,6 +8,7 @@ true id + Participant Status Type ID int unsigned true unique participant status type id @@ -30,6 +31,7 @@ label + Participant Status Label varchar 255 true @@ -39,6 +41,7 @@ class + Participant Status Class varchar 8 the general group of status type this one belongs to @@ -52,12 +55,14 @@ is_reserved + Participant Status Is Reserved?> boolean whether this is a status type required by the system 3.0 is_active + Participant Status is Active boolean 1 whether this status type is active @@ -65,12 +70,14 @@ is_counted + Participant Status Counts? boolean whether this status type is counted against event size limit 3.0 weight + Status Weight int unsigned true controls sort order @@ -78,6 +85,7 @@ visibility_id + Participant Status Visibility int unsigned whether the status type is visible to the public, an implicit foreign key to option_value.value related to the `visibility` option_group 3.0 diff --git a/xml/schema/Financial/FinancialType.xml b/xml/schema/Financial/FinancialType.xml index 6b580813c1..ddd3d4324d 100644 --- a/xml/schema/Financial/FinancialType.xml +++ b/xml/schema/Financial/FinancialType.xml @@ -9,6 +9,7 @@ true id + Financial Type ID int unsigned 10 true diff --git a/xml/schema/Financial/PaymentProcessor.xml b/xml/schema/Financial/PaymentProcessor.xml index efc34c4846..bae7d10a26 100644 --- a/xml/schema/Financial/PaymentProcessor.xml +++ b/xml/schema/Financial/PaymentProcessor.xml @@ -7,6 +7,7 @@ 1.8 id + Payment Processor ID int unsigned true Payment Processor ID @@ -18,6 +19,7 @@ domain_id + Payment Processor Domain int unsigned true @@ -44,6 +46,7 @@ description + Processor Description varchar 255 Payment Processor Description. @@ -59,6 +62,7 @@ payment_processor_type_id + Payment Processor Type ID int unsigned 10 4.3 @@ -71,18 +75,21 @@ is_active + Processor is Active? boolean Is this processor active? 1.8 is_default + Processor Is Default? boolean Is this processor the default? 1.8 is_test + Is Test Processor? boolean Is this processor for a test site? 1.8 @@ -159,6 +166,7 @@ billing_mode + Processor Billing Mode int unsigned true Billing Mode @@ -166,12 +174,14 @@ is_recur + Processor Supports Recurring? boolean Can process recurring contributions 1.8 payment_type + Payment Type int unsigned 1 Payment Type: Credit or Debit diff --git a/xml/schema/Financial/PaymentProcessorType.xml b/xml/schema/Financial/PaymentProcessorType.xml index 6aef995e31..0e4de4de4d 100644 --- a/xml/schema/Financial/PaymentProcessorType.xml +++ b/xml/schema/Financial/PaymentProcessorType.xml @@ -7,6 +7,7 @@ 1.8 id + Payment Processor Type ID int unsigned true Payment Processor Type ID @@ -34,6 +35,7 @@ description + Processor Type De varchar 255 Payment Processor Description. @@ -41,12 +43,14 @@ is_active + Processor Type Is Active? boolean Is this processor active? 1.8 is_default + Processor Type is Default? boolean Is this processor the default? 1.8 @@ -163,12 +167,14 @@ is_recur + Processor Type Supports Recurring? boolean Can process recurring contributions 1.8 payment_type + Processor Type Payment Type int unsigned 1 Payment Type: Credit or Debit diff --git a/xml/schema/Mailing/Component.xml b/xml/schema/Mailing/Component.xml index 9de2ef1fba..76a27f027b 100644 --- a/xml/schema/Mailing/Component.xml +++ b/xml/schema/Mailing/Component.xml @@ -7,6 +7,7 @@ Stores information about the mailing components (header/footer). id + Mailing Component ID int unsigned true @@ -23,6 +24,7 @@ component_type + Mailing Component Type varchar 12 Type of Component. @@ -40,6 +42,7 @@ body_html + Mailing Component Body HTML text Body of the component in html format. @@ -60,12 +63,14 @@ is_default + Mailing Component is Default? boolean 0 Is this the default component for this component_type? is_active + Mailing Component Is Active? boolean Is this property active? diff --git a/xml/schema/Mailing/Event/Confirm.xml b/xml/schema/Mailing/Event/Confirm.xml index 093941f211..0dc679c0b0 100644 --- a/xml/schema/Mailing/Event/Confirm.xml +++ b/xml/schema/Mailing/Event/Confirm.xml @@ -8,6 +8,7 @@ true id + Mailing Confirmation ID int unsigned true @@ -17,6 +18,7 @@ event_subscribe_id + Mailing Subscribe ID int unsigned true FK to civicrm_mailing_event_subscribe @@ -29,6 +31,7 @@ time_stamp + Confirm Timestamp datetime true When this confirmation event occurred. diff --git a/xml/schema/Mailing/Event/Subscribe.xml b/xml/schema/Mailing/Event/Subscribe.xml index 5e9299de19..e281de8443 100644 --- a/xml/schema/Mailing/Event/Subscribe.xml +++ b/xml/schema/Mailing/Event/Subscribe.xml @@ -8,6 +8,7 @@ true id + Mailing Subscribe ID int unsigned true @@ -17,6 +18,7 @@ group_id + Mailing Subscribe Group int unsigned true FK to Group @@ -37,6 +39,7 @@ contact_id + Mailing Subscribe Contact int unsigned true FK to Contact @@ -49,6 +52,7 @@ hash + Mailing Subscribe Hash varchar 255 true @@ -56,6 +60,7 @@ time_stamp + Mailing Subscribe Timestamp datetime true When this subscription event occurred. diff --git a/xml/schema/Mailing/Event/Unsubscribe.xml b/xml/schema/Mailing/Event/Unsubscribe.xml index 9309bc6b48..3504bf8c81 100644 --- a/xml/schema/Mailing/Event/Unsubscribe.xml +++ b/xml/schema/Mailing/Event/Unsubscribe.xml @@ -8,6 +8,7 @@ true id + Unsubscribe ID int unsigned true @@ -17,6 +18,7 @@ event_queue_id + Mailing Event Queue int unsigned true FK to EventQueue @@ -29,12 +31,14 @@ org_unsubscribe + Unsubscribe is for Organization? boolean true Unsubscribe at org- or group-level time_stamp + Unsubscribe Timestamp datetime true When this delivery event occurred. diff --git a/xml/schema/Mailing/Mailing.xml b/xml/schema/Mailing/Mailing.xml index b861ff6255..7686851406 100644 --- a/xml/schema/Mailing/Mailing.xml +++ b/xml/schema/Mailing/Mailing.xml @@ -8,6 +8,7 @@ true id + Mailing ID int unsigned true @@ -17,6 +18,7 @@ domain_id + Mailing Domain int unsigned civicrm_domain
@@ -35,6 +37,7 @@ header_id + Mailing Header int unsigned FK to the header component. @@ -46,6 +49,7 @@ footer_id + Mailing Footer int unsigned FK to the footer component. @@ -57,6 +61,7 @@ reply_id + Mailing Reply int unsigned FK to the auto-responder component. @@ -68,6 +73,7 @@ unsubscribe_id + Mailing Unsubscribe int unsigned FK to the unsubscribe component. @@ -79,6 +85,7 @@ resubscribe_id + Mailing Resubscribe int unsigned @@ -89,6 +96,7 @@ optout_id + Mailing Opt Out int unsigned FK to the opt-out component. @@ -100,6 +108,7 @@ name + Mailing Name varchar 128 Mailing Name. @@ -109,6 +118,7 @@ from_name + Mailing From Name varchar 128 From Header of mailing @@ -118,6 +128,7 @@ from_email + Mailing From Email varchar 128 From Email of mailing @@ -347,6 +358,7 @@ sms_provider_id + Mailing SMS Provider int unsigned 4.2 diff --git a/xml/schema/Mailing/MailingGroup.xml b/xml/schema/Mailing/MailingGroup.xml index 7109333c63..3bb7ec4fa6 100644 --- a/xml/schema/Mailing/MailingGroup.xml +++ b/xml/schema/Mailing/MailingGroup.xml @@ -8,6 +8,7 @@ true id + Mailing Group ID int unsigned true @@ -17,6 +18,7 @@ mailing_id + Mailing int unsigned true The ID of a previous mailing to include/exclude recipients. @@ -29,6 +31,7 @@ group_type + Mailing Group Type varchar 8 Are the members of the group included or excluded?. @@ -41,6 +44,7 @@ entity_table + Mailing Group Entity Table varchar 64 true @@ -48,6 +52,7 @@ entity_id + Mailing Group Entity int unsigned true Foreign key to the referenced item. @@ -58,11 +63,13 @@ search_id + Mailing Group Search int The filtering search. custom search id or -1 for civicrm api search search_args + Mailing Group Search Arguments text The arguments to be sent to the search function diff --git a/xml/schema/Mailing/MailingJob.xml b/xml/schema/Mailing/MailingJob.xml index b0467700ce..8444b8b21f 100644 --- a/xml/schema/Mailing/MailingJob.xml +++ b/xml/schema/Mailing/MailingJob.xml @@ -8,6 +8,7 @@ true id + Mailing JOb ID int unsigned true @@ -17,6 +18,7 @@ mailing_id + Mailing int unsigned true The ID of the mailing this Job will send. @@ -29,21 +31,25 @@ scheduled_date + Mailing Scheduled Date datetime date on which this job was scheduled. start_date + Mailing Job Start Date datetime date on which this job was started. end_date + Mailing Job End Date datetime date on which this job ended. status + Mailing Job Status varchar 12 The state of this job @@ -56,6 +62,7 @@ is_test + Mailing Job Is Test? boolean 0 Is this job for a test mail? @@ -63,6 +70,7 @@ job_type + Mailing Job Type varchar 255 Type of mailling job: null | child @@ -70,6 +78,7 @@ parent_id + Mailing Job Parent int unsigned Parent job id NULL @@ -83,6 +92,7 @@ job_offset + Mailing Job Offset int Offset of the child job 0 @@ -90,6 +100,7 @@ job_limit + Mailing Job Limit int Queue size limit for each child job 0 diff --git a/xml/schema/Mailing/Recipients.xml b/xml/schema/Mailing/Recipients.xml index f53a7d241a..188f64dbb1 100644 --- a/xml/schema/Mailing/Recipients.xml +++ b/xml/schema/Mailing/Recipients.xml @@ -8,6 +8,7 @@ true id + Mailing Recipients ID int unsigned true @@ -17,6 +18,7 @@ mailing_id + Mailing int unsigned true The ID of the mailing this Job will send. @@ -29,6 +31,7 @@ contact_id + Mailing Recipient int unsigned true FK to Contact @@ -41,6 +44,7 @@ email_id + Recipient Email int unsigned NULL FK to Email @@ -53,6 +57,7 @@ phone_id + Recipient Phone int unsigned NULL FK to Phone diff --git a/xml/schema/Member/MembershipBlock.xml b/xml/schema/Member/MembershipBlock.xml index 6a4ca68ba6..a7dbccae28 100644 --- a/xml/schema/Member/MembershipBlock.xml +++ b/xml/schema/Member/MembershipBlock.xml @@ -9,6 +9,7 @@ true id + Membership Block ID int unsigned true Membership Id @@ -20,6 +21,7 @@ entity_table + Membership Block Entity Table varchar 64 Name for Membership Status @@ -27,6 +29,7 @@ entity_id + Membership Block Entity ID int unsigned true FK to civicrm_contribution_page.id @@ -40,6 +43,7 @@ membership_types + Membership Block Membership Types varchar 255 Membership types to be exposed by this block @@ -47,6 +51,7 @@ membership_type_default + Membership Block Default Type int unsigned Optional foreign key to membership_type 1.5 @@ -59,6 +64,7 @@ display_min_fee + Membership Block Display Minimum Fee boolean 1 Display minimum membership fee @@ -66,6 +72,7 @@ is_separate_payment + Membership Block Is Separate Payment boolean 1 Should membership transactions be processed separately @@ -73,6 +80,7 @@ new_title + Membership Block New Title varchar 255 true @@ -81,6 +89,7 @@ new_text + Membership Block New Text text true Text to display below title @@ -88,6 +97,7 @@ renewal_title + Membership Block Renewal Title varchar 255 true @@ -96,6 +106,7 @@ renewal_text + Membership Block Renewal Text text true Text to display for member renewal diff --git a/xml/schema/Member/MembershipPayment.xml b/xml/schema/Member/MembershipPayment.xml index dec458571f..3f8a7399cd 100644 --- a/xml/schema/Member/MembershipPayment.xml +++ b/xml/schema/Member/MembershipPayment.xml @@ -9,6 +9,7 @@ true id + Membership Payment ID int unsigned true 1.5 @@ -19,6 +20,7 @@ membership_id + Membership int unsigned true FK to Membership table @@ -33,6 +35,7 @@ contribution_id + Contribution int unsigned FK to contribution table. 2.0 diff --git a/xml/schema/Member/MembershipType.xml b/xml/schema/Member/MembershipType.xml index ef26a62a52..db21761192 100644 --- a/xml/schema/Member/MembershipType.xml +++ b/xml/schema/Member/MembershipType.xml @@ -9,6 +9,7 @@ true id + Membership Type ID int unsigned true Membership Id @@ -20,6 +21,7 @@ domain_id + Membership Type Domain int unsigned true @@ -49,6 +51,7 @@ description + Membership Type Description varchar TextArea @@ -62,6 +65,7 @@ member_of_contact_id + Membership Type Organization int unsigned true Owner organization for this membership type. FK to Contact ID @@ -91,6 +95,7 @@ financial_type_id + Membership Financial Type int unsigned true @@ -109,6 +114,7 @@ minimum_fee + membership Type Minimum Fee decimal Minimum fee for this membership (0 for free/complimentary memberships). 0 @@ -116,6 +122,7 @@ duration_unit + Membership Type Duration Unit varchar 8 Unit in which membership period is expressed. @@ -129,12 +136,14 @@ duration_interval + Membership Type Duration Interval int Number of duration units in membership period (e.g. 1 year, 12 months). 1.5 period_type + Membership Type Plan varchar 8 Rolling membership period starts on signup date. Fixed membership periods start on fixed_period_start_day. @@ -145,18 +154,21 @@ fixed_period_start_day + Fixed Period Start Day int For fixed period memberships, month and day (mmdd) on which subscription/membership will start. Period start is back-dated unless after rollover day. 1.5 fixed_period_rollover_day + Fixed Period Rollover Day int For fixed period memberships, signups after this day (mmdd) rollover to next period. 1.5 relationship_type_id + Membership Type Relationship varchar 64 FK to Relationship Type ID @@ -182,6 +194,7 @@ max_related + Max Related Members for Type int Maximum number of related memberships. 4.3 @@ -207,6 +220,7 @@ receipt_text_signup + Membership Type Receipt Text varchar TextArea @@ -219,6 +233,7 @@ receipt_text_renewal + Membership Type Renewal Text varchar TextArea -- 2.25.1