From 455cfd164952b15f53909506179b56ab3d8f32a6 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 22 Aug 2014 21:35:11 +1200 Subject: [PATCH] CRM-15168 more metadata titles (& whitespace --- xml/schema/Contribute/Contribution.xml | 1 + xml/schema/Contribute/ContributionPage.xml | 1 + xml/schema/Contribute/Product.xml | 372 ++++++++++----------- xml/schema/Core/OptionGroup.xml | 78 ++--- xml/schema/Core/OptionValue.xml | 3 + xml/schema/Core/Phone.xml | 1 + xml/schema/Member/Membership.xml | 1 + xml/schema/Member/MembershipStatus.xml | 1 + 8 files changed, 233 insertions(+), 225 deletions(-) diff --git a/xml/schema/Contribute/Contribution.xml b/xml/schema/Contribute/Contribution.xml index adb74025d3..735822e094 100644 --- a/xml/schema/Contribute/Contribution.xml +++ b/xml/schema/Contribute/Contribution.xml @@ -403,6 +403,7 @@ address_id + Contribution Address int unsigned Conditional foreign key to civicrm_address.id. We insert an address record for each contribution when we have associated billing name and address data. 2.2 diff --git a/xml/schema/Contribute/ContributionPage.xml b/xml/schema/Contribute/ContributionPage.xml index 27b67554e3..d2d61ce6cb 100644 --- a/xml/schema/Contribute/ContributionPage.xml +++ b/xml/schema/Contribute/ContributionPage.xml @@ -9,6 +9,7 @@ true id + Contribution Page ID int unsigned true Contribution Id diff --git a/xml/schema/Contribute/Product.xml b/xml/schema/Contribute/Product.xml index 93c401305c..5bb0c9e301 100644 --- a/xml/schema/Contribute/Product.xml +++ b/xml/schema/Contribute/Product.xml @@ -8,200 +8,200 @@ 1.4 true - id - int unsigned - true - 1.4 + id + int unsigned + true + 1.4 - id - true + id + true - name - product_name - Product Name - varchar - 255 - true - true - true - Required product/premium name - 1.4 - - - description - Description - text - true - Optional description of the product/premium. - 1.4 - - - sku - SKU - varchar - 50 - true - Optional product sku or code. - 1.4 - - - options - Options - text - true - Store comma-delimited list of color, size, etc. options for the product. - 1.4 - - - image - Image - varchar - 255 - Full or relative URL to uploaded image - fullsize. - 1.4 - - - thumbnail - Thumbnail - varchar - 255 - Full or relative URL to image thumbnail. - 1.4 - - - price - Price - decimal - Sell price or market value for premiums. For tax-deductible contributions, this will be stored as non_deductible_amount in the contribution record. - 1.4 - - - currency - varchar - 3 - NULL - 3 character string, value from config setting or input via user. - 3.2 - - civicrm_currency
- name - full_name - numeric_code - - - Select - - - - financial_type_id - Financial Type - int unsigned - NULL - - civicrm_financial_type
- id - name - - FK to Financial Type. - 4.3 + name + product_name + Product Name + varchar + 255 + true + true + true + Required product/premium name + 1.4 + + + description + Description + text + true + Optional description of the product/premium. + 1.4 + + + sku + SKU + varchar + 50 + true + Optional product sku or code. + 1.4 + + + options + Options + text + true + Store comma-delimited list of color, size, etc. options for the product. + 1.4 + + + image + Image + varchar + 255 + Full or relative URL to uploaded image - fullsize. + 1.4 + + + thumbnail + Thumbnail + varchar + 255 + Full or relative URL to image thumbnail. + 1.4 + + + price + Price + decimal + Sell price or market value for premiums. For tax-deductible contributions, this will be stored as non_deductible_amount in the contribution record. + 1.4 + + + currency + varchar + 3 + NULL + 3 character string, value from config setting or input via user. + 3.2 + + civicrm_currency
+ name + full_name + numeric_code + + + Select + + + + financial_type_id + Financial Type + int unsigned + NULL + + civicrm_financial_type
+ id + name + + FK to Financial Type. + 4.3 - financial_type_id - civicrm_financial_type
- id - SET NULL - 4.3 + financial_type_id + civicrm_financial_type
+ id + SET NULL + 4.3 - min_contribution - Minimum Contribution - decimal - Minimum contribution required to be eligible to select this premium. - 1.4 - - - cost - Cost - decimal - Actual cost of this product. Useful to determine net return from sale or using this as an incentive. - 1.4 - - - is_active - Is Active - boolean - true - Disabling premium removes it from the premiums_premium join table below. - 1.4 - - - period_type - Period Type - varchar - 8 - 'rolling' - Rolling means we set start/end based on current day, fixed means we set start/end for current year or month -(e.g. 1 year + fixed -> we would set start/end for 1/1/06 thru 12/31/06 for any premium chosen in 2006) - - CRM_Core_SelectValues::periodType - - 1.4 - - Select - - - - fixed_period_start_day - Fixed Period Start Day - int - 0101 - Month and day (MMDD) that fixed period type subscription or membership starts. - 1.4 - - - duration_unit - Duration Unit - varchar - 8 - 'year' - - CRM_Core_SelectValues::getPremiumUnits - - 1.4 - - Select - - - - duration_interval - Duration Interval - int - Number of units for total duration of subscription, service, membership (e.g. 12 Months). - 1.4 - - - frequency_unit - Frequency Unit - varchar - 8 - 'month' - Frequency unit and interval allow option to store actual delivery frequency for a subscription or service. - - CRM_Core_SelectValues::getPremiumUnits - - 1.4 - - Select - - - - frequency_interval - Frequency Interval - int - Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months). - 1.4 + min_contribution + Minimum Contribution + decimal + Minimum contribution required to be eligible to select this premium. + 1.4 + + + cost + Cost + decimal + Actual cost of this product. Useful to determine net return from sale or using this as an incentive. + 1.4 + + + is_active + Is Active + boolean + true + Disabling premium removes it from the premiums_premium join table below. + 1.4 + + + period_type + Period Type + varchar + 8 + 'rolling' + Rolling means we set start/end based on current day, fixed means we set start/end for current year or month + (e.g. 1 year + fixed -> we would set start/end for 1/1/06 thru 12/31/06 for any premium chosen in 2006) + + CRM_Core_SelectValues::periodType + + 1.4 + + Select + + + + fixed_period_start_day + Fixed Period Start Day + int + 0101 + Month and day (MMDD) that fixed period type subscription or membership starts. + 1.4 + + + duration_unit + Duration Unit + varchar + 8 + 'year' + + CRM_Core_SelectValues::getPremiumUnits + + 1.4 + + Select + + + + duration_interval + Duration Interval + int + Number of units for total duration of subscription, service, membership (e.g. 12 Months). + 1.4 + + + frequency_unit + Frequency Unit + varchar + 8 + 'month' + Frequency unit and interval allow option to store actual delivery frequency for a subscription or service. + + CRM_Core_SelectValues::getPremiumUnits + + 1.4 + + Select + + + + frequency_interval + Frequency Interval + int + Number of units for delivery frequency of subscription, service, membership (e.g. every 3 Months). + 1.4 diff --git a/xml/schema/Core/OptionGroup.xml b/xml/schema/Core/OptionGroup.xml index 2a998c97cc..9aecfd8aa2 100644 --- a/xml/schema/Core/OptionGroup.xml +++ b/xml/schema/Core/OptionGroup.xml @@ -7,59 +7,59 @@ 1.5 true - id - int unsigned - true - Option Group ID - 1.5 + id + int unsigned + true + Option Group ID + 1.5 - id - true + id + true - name - Option Group Name - varchar - 64 - true - Option group name. Used as selection key by class properties which lookup options in civicrm_option_value. - 1.5 + name + Option Group Name + varchar + 64 + true + Option group name. Used as selection key by class properties which lookup options in civicrm_option_value. + 1.5 - title - varchar - 255 - true - Option Group title. - 1.5 + title + varchar + 255 + true + Option Group title. + 1.5 - description - varchar - 255 - true - Option group description. - 1.5 + description + varchar + 255 + true + Option group description. + 1.5 - is_reserved - boolean - 1 - Is this a predefined system option group (i.e. it can not be deleted)? - 1.5 + is_reserved + boolean + 1 + Is this a predefined system option group (i.e. it can not be deleted)? + 1.5 - is_active - boolean - Is this option group active? - 1.5 + is_active + boolean + Is this option group active? + 1.5 - is_locked - boolean - A lock to remove the ability to add new options via the UI. - 4.5 + is_locked + boolean + A lock to remove the ability to add new options via the UI. + 4.5 UI_name diff --git a/xml/schema/Core/OptionValue.xml b/xml/schema/Core/OptionValue.xml index f18a8022d0..707132c8b8 100644 --- a/xml/schema/Core/OptionValue.xml +++ b/xml/schema/Core/OptionValue.xml @@ -8,6 +8,7 @@ true id + Option Value ID int unsigned true Option ID @@ -19,6 +20,7 @@ option_group_id + Option Group ID int unsigned true Group which this option belongs to. @@ -124,6 +126,7 @@ is_active + Option Is Active boolean 1 Is this option active? diff --git a/xml/schema/Core/Phone.xml b/xml/schema/Core/Phone.xml index 4f01f75e56..dd854ec11d 100644 --- a/xml/schema/Core/Phone.xml +++ b/xml/schema/Core/Phone.xml @@ -81,6 +81,7 @@ mobile_provider_id + Mobile Provider int unsigned Which Mobile Provider does this phone belong to. 1.1 diff --git a/xml/schema/Member/Membership.xml b/xml/schema/Member/Membership.xml index c1c1d52346..9abca1d424 100644 --- a/xml/schema/Member/Membership.xml +++ b/xml/schema/Member/Membership.xml @@ -219,6 +219,7 @@ contribution_recur_id + Memberhip Recurring Contribution int unsigned Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events. 3.3 diff --git a/xml/schema/Member/MembershipStatus.xml b/xml/schema/Member/MembershipStatus.xml index 03cbec8012..3033319ca5 100644 --- a/xml/schema/Member/MembershipStatus.xml +++ b/xml/schema/Member/MembershipStatus.xml @@ -9,6 +9,7 @@ true id + Membership Status ID int unsigned true Membership Id -- 2.25.1