experian-data-dictionary 1.4 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2be9a761b138c70353c802fefbe69bc5697904d6
-  data.tar.gz: 4c4093b5a4d77c6984fd34291d5ed8eef272bac9
+  metadata.gz: e57c48fcfdfb41e57dce8a6701e12bdc983e2ffb
+  data.tar.gz: 642b076be90c14a723ef915a57a75e0e3766ff80
 SHA512:
-  metadata.gz: 7993418f604b6872b06df2a968cd4e9104acdd2ab6fbf421b5799ab49083e5c11f6583faba8fa5beace7cb5a879bdba7fad72739b6012220c2080acb2c0a89eb
-  data.tar.gz: 62c448f2f2f331aabfd99af320358494db4db732c889e0dc365f829b6580a1131d8760df62765c1b736206d8f19615242581ab5ff5a7459e97afbcb2f20a4188
+  metadata.gz: 5272b04d59893d8b04cf3fa8217502210abd8b106675143da52f4f8034114e1043258a2ba458f57ac7bbc521846a93d7eea5767fa18d2cb236d43371ba410c6b
+  data.tar.gz: 536bd11741a32ed79860318ee78344c2903f2a35d4fb05b1ae8c057f2cf597eaf528bb6b544f4cd45cca81dd9c291f3483f360a068e6970540e3ebe36ad6386c

data/.ruby-gemset

@@ -0,0 +1 @@
+experian_data_dictionary

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/experian_data_dictionary.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'experian-data-dictionary'
-  PROJECT_GEM_VERSION = '1.4'
+  PROJECT_GEM_VERSION = '1.4.1'
 
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION

data/lib/element_numbers/en_0000.rb

@@ -4,11 +4,13 @@ module Experian
     def self.en_0000_column_name
       'Enhancement Mandatory Append'
     end
-    
+
     def self.en_0000_description
       'The enrichment mandatory append is required when any data from the enrichment master file is appended. It consists of a match type.'
     end
 
+    def self.en_0000_value_description(key); ''; end
+
     def self.en_0000(key)
       values = {
         'H' => 'Household Match',

data/lib/element_numbers/en_0100.rb

@@ -17,6 +17,10 @@ module Experian
       self.en_0100_description
     end
 
+    def self.en_0100_value_description(key); ''; end
+    def self.en_0100c_value_description(key); ''; end
+
+
     # CCYYMM
     def self.en_0100(key)
       return nil if key.empty?
@@ -30,7 +34,7 @@ module Experian
       if key[0].nil?
         return 'Unknown age'
       else
-        return nil unless %w(e i u).include?(key[0].downcase) # I noticed another 0100c column that uses M and F which is probably for Male and Female
+        return nil unless %w(e i u).include?(key[0].to_s.downcase) # I noticed another 0100c column that uses M and F which is probably for Male and Female
         text = case key[0].downcase
           when 'e' then 'Exact age'
           when 'i' then 'Estimated age'

data/lib/element_numbers/en_0103.rb

@@ -4,11 +4,13 @@ module Experian
     def self.en_0103_column_name
       'Gender Code'
     end
-    
+
     def self.en_0103_description
       'Gender information is applied during the convert prior to enhancement. Approximately five to eight percent of the client records are coded as gender unknown because of ambiguous or unisex names. Records coded as gender both include those with prefixes of Mr. & Mrs. and/or first names like John & Mary.'
     end
 
+    def self.en_0103_value_description(key); ''; end
+
     def self.en_0103(key)
       values = {
         'M' => 'Male',

data/lib/element_numbers/en_0107.rb

@@ -9,6 +9,8 @@ module Experian
       'Marital status is determined based on the composition of the Living unit or through the application of a predictive model. Note: Single refers to an individual that has never married and not single because of divorce or spouse\'s death.'
     end
 
+    def self.en_0107a_value_description(key); ''; end
+
     def self.en_0107a(key)
       likely = {
         '1' => 'Extremely Likely',

data/lib/element_numbers/en_0108.rb

@@ -6,6 +6,9 @@ module Experian
       'Country of Origin'
     end
 
+    def self.en_0108c_value_description(key); ''; end
+
+
     def self.en_0108c_description
       'Indicates Country of Origin using a sophisticated program that analyzes first name, last name, expert system rules and geography.'
     end
@@ -15,6 +18,8 @@ module Experian
       'Ethnicity Detail'
     end
 
+    def self.en_0108d_value_description(key); ''; end
+
     def self.en_0108d_description
       'Indicates the likely ethnicity using a sophisticated program that analyzes first name, last name, expert system rules and geography.'
     end
@@ -24,6 +29,8 @@ module Experian
       'Ethnic Insight'
     end
 
+    def self.en_0108e_value_description(key); ''; end
+
     def self.en_0108e_description
       'Ethnic Insight Elements. Ethnic Insight is a comprehensive predictive name analysis process which identifies ethnic origin, probable religion, and the language preference of individuals. Experian can now code and identify 177 ethnicities, 33 groups, 10 religions, 79 language groups and 22 Country of Origin codes.The Ethnic Insight software utilizes over 550,000 surnames by ethnicity, over 75,000 first names unique to a given ethnicity, and over 3000 expert system rules. Also utilized are a group of geographic reference tables for determining the proper codes to apply to an individual. Each record passed through the process uses the above files as references while examining the individuals first name, last names, and the zip code of the record. Note: Element 0108E calls elements 0108C, 0108D, 0108G, 0108L, 0108R, 0108T'
     end
@@ -33,6 +40,8 @@ module Experian
       'Ethnic Group Code'
     end
 
+    def self.en_0108g_value_description(key); ''; end
+
     def self.en_0108g_description
       'Experian derived code that groups ethnicities in general categories.'
     end
@@ -42,6 +51,8 @@ module Experian
       'Language'
     end
 
+    def self.en_0108l_value_description(key); ''; end
+
     def self.en_0108l_description
       'Ethnic Insight Language indicates the language preference.'
     end
@@ -51,6 +62,8 @@ module Experian
       'Religion'
     end
 
+    def self.en_0108r_value_description(key); ''; end
+
     def self.en_0108r_description
       'Ethnic Insights Religion indicates the likely religion.'
     end
@@ -60,6 +73,8 @@ module Experian
       'e-Tech Group'
     end
 
+    def self.en_0108t_value_description(key); ''; end
+
     def self.en_0108t_description
       'e-Tech derived code that groups ethnicities in general categories.'
     end

data/lib/element_numbers/en_0110.rb

@@ -5,6 +5,8 @@ module Experian
       'Person Type'
     end
 
+    def self.en_0110p_value_description(key); ''; end
+
     def self.en_0110p_description
       'Assignment of person type in the living unit based on age and activity.'
     end

data/lib/element_numbers/en_0112.rb

@@ -5,6 +5,8 @@ module Experian
       'Deceased Indicator'
     end
 
+    def self.en_0112_value_description(key); ''; end
+
     def self.en_0112_description
       'Deceased Indicator identifies client input records that Experian believes are deceased individuals. This information is sourced primarily from Social Security records and other proprietary sources, as well as consumers who may have contacted Experian directly. The deceased indicator communicates that we have reason to believe that the individual is deceased based on this source information.'
     end

data/lib/element_numbers/en_0113.rb

@@ -5,6 +5,8 @@ module Experian
       'Combined Homeowner'
     end
 
+    def self.en_0113a_value_description(key); ''; end
+
     def self.en_0113a_description
       'Combined homeowner is a mixture of several data elements / fields. This element provides these separate data components in a single position. Homeowner information indicates the likelihood of a consumer owning a home, and is received from tax assessor and deed information. For records where exact Homeownership information is not available, homeownership propensity is calculated using a proprietary statistical model which predicts the likelihood of homeownership. Renter status is derived from self reported data. Unit numbers are not used to infer rented status because units may be owner condominium/coop. Probable Renter is calculated using an algorithm based on lack of Homeowner, the Address Type, and Census Percent Renter.'
     end

data/lib/element_numbers/en_0118.rb

@@ -5,7 +5,9 @@ module Experian
     def self.en_0118_column_name
       'Dwelling Type'
     end
-    
+
+    def self.en_0118_value_description(key); ''; end
+
     def self.en_0118_description
       'Each household is assigned a dwelling type code based on United States Postal Service (USPS) information. Single Family Dwelling Units are residences for one family or living unit (S). If the address contains an apartment number or has a small dwelling size (5 units or less), the code is set to Multi-Family (A). Marginal Multi Family Dwelling Units lack an apartment number and are considered of questionable deliverability (M). Values also include P.O. Boxes (P) and Unknown dwelling types (U).'
     end

data/lib/element_numbers/en_0119.rb

@@ -6,6 +6,8 @@ module Experian
       'Length Of Residence'
     end
 
+    def self.en_0119_value_description(key); ''; end
+
     def self.en_0119_description
       'Length of Residence (LOR) is the length of time a Living Unit has resided at their current address. A primary source of LOR is public source white page compilation initiating a counter showing the first time a name and number appear in the directory. LOR information is also received from proprietary sources and through updates of our source files against the USPS National Change of Address* file. For all sources, LOR data is aged over time.\n\nWhen there is insufficient data to match a customer\'s record to our Enrichment master for Length of Residence, a median LOR based on the LOR\'s assigned to other living units in the same ZIP+4 area is used. In the rare case that the ZIP+4 is not on the record, median LOR is based on the LOR\'s assigned to other records in that ZIP region.\n\nThe median level data applied to records for this element can be identified through the Enrichment Mandatory Append - Total Enrichment Match Type indicator (E).'
     end

data/lib/element_numbers/en_0130.rb

@@ -5,6 +5,8 @@ module Experian
       'Direct Mail Responder - Individual Level'
     end
 
+    def self.en_0130_value_description(key); ''; end
+
     def self.en_0130_description
       'Direct Mail Responder information identifies consumers who have purchased by direct mail. Data is carried at the individual level. If one member of a household is a direct mail responder, that member will be coded as a direct mail responder at the individual level.'
     end

data/lib/element_numbers/en_0131.rb

@@ -5,6 +5,8 @@ module Experian
       'Multi-Company Direct Mail Responder - Living Units Level'
     end
 
+    def self.en_0131_value_description(key); ''; end
+
     def self.en_0131_description
       'Direct Mail Responder information identifies consumers who have purchased by direct mail. Data is carried at both the individual and household level. If one member of a household is a direct mail responder at the individual level, the remaining members of the household will be coded as a direct mail responder at the household level.'
     end

data/lib/element_numbers/en_0132.rb

@@ -6,6 +6,8 @@ module Experian
       'MOR Bank- Deduped Hit Count'
     end
 
+    def self.en_0132a_value_description(key); ''; end
+
     def self.en_0132a_description
       'The total number of categories in which the living unit has at least one hit, but with any specific participant counted in only one category.'
     end
@@ -14,12 +16,14 @@ module Experian
       return 'Unknown' if key.size != 3 or key.to_i > 999
       key
     end
-    
+
     #MOR Bank- Non-Deduped Hit Count
     def self.en_0132b_column_name
       'MOR Bank- Non-Deduped Hit Count'
     end
 
+    def self.en_0132b_value_description(key); ''; end
+
     def self.en_0132b_description
       'The total number of categories in which the living unit has at least one hit, with participant hits counted in all applicable categories.'
     end

data/lib/element_numbers/en_0133.rb

@@ -5,6 +5,8 @@ module Experian
       'Multi-Category Buyer'
     end
 
+    def self.en_0133_value_description(key); ''; end
+
     def self.en_0133_description
       'Multi-category buyer information identifies consumers who have made purchases by direct mail in multiple product categories. Data is carried at the household level.'
     end

data/lib/element_numbers/en_0134.rb

@@ -6,6 +6,8 @@ module Experian
       'Direct Mail Merchandise Buyer Categories'
     end
 
+    def self.en_0134_value_description(key); ''; end
+
     def self.en_0134_description
       'The Direct Mail Merchandise Buyer Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0135.rb

@@ -5,6 +5,8 @@ module Experian
       'Magazine Buyer Categories'
     end
 
+    def self.en_0135_value_description(key); ''; end
+
     def self.en_0135_description
       'The Direct Mail Magazine Buyer Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0136.rb

@@ -5,6 +5,8 @@ module Experian
       'Contributors Categories'
     end
 
+    def self.en_0136_value_description(key); ''; end
+
     def self.en_0136_description
       'The Contributors Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0137.rb

@@ -5,6 +5,8 @@ module Experian
       'Sweepstakes / Contests'
     end
 
+    def self.en_0137_value_description(key); ''; end
+
     def self.en_0137_description
       'The Sweepstakes/Contests Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0138.rb

@@ -5,6 +5,8 @@ module Experian
       'Do-It-Yourself'
     end
 
+    def self.en_0138_value_description(key); ''; end
+
     def self.en_0138_description
       'The Do-It-Yourself Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0139.rb

@@ -5,6 +5,8 @@ module Experian
       'News & Financial'
     end
 
+    def self.en_0139_value_description(key); ''; end
+
     def self.en_0139_description
       'The News & Financial Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0140.rb

@@ -6,6 +6,8 @@ module Experian
       'Photography'
     end
 
+    def self.en_0140_value_description(key); ''; end
+
     def self.en_0140_description
       'The Photography Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0141.rb

@@ -6,6 +6,8 @@ module Experian
       'Mail Responders - Odds & Ends / Miscellaneous'
     end
 
+    def self.en_0141_value_description(key); ''; end
+
     def self.en_0141_description
       'The Miscellaneous/Odds & Ends Categories information is compiled via mail order responsiveness by categorized offers/media. Information is collected from 300+ proprietary participants who give us mail order responders and we subsequently categorize them into 1 of 25 categories. No single participant\'s information may exceed 25% of any category.'
     end

data/lib/element_numbers/en_0155.rb

@@ -6,6 +6,8 @@ module Experian
       'Presence Of Young Adult'
     end
 
+    def self.en_0155_value_description(key); ''; end
+
     def self.en_0155_description
       'Presence of Young Adult indicates if there is a young adult in the household.'
     end

data/lib/element_numbers/en_0156.rb

@@ -6,6 +6,8 @@ module Experian
       'Presence Of Elderly Parent'
     end
 
+    def self.en_0156_value_description(key); ''; end
+
     def self.en_0156_description
       'Presence of Elderly Parent indicates if there is an elderly parent in the household.'
     end

data/lib/element_numbers/en_0160.rb

@@ -6,6 +6,8 @@ module Experian
       'Occupation Group'
     end
 
+    def self.en_0160a_value_description(key); ''; end
+
     def self.en_0160a_description
       'Information is compiled from self-reported surveys, derived from state licensing agencies, or calculated through the application of predictive models. When there is insufficient data to match a customer\'s record in our enrichment master for occupation group, a median occupation group based on the Experian modeled occupation assigned to other living units in the same zip+4 area is used. In the rare case that zip+4 is not on the record, occupation group is based on the occupation assigned to other records in that zip region. Note: the median level data applied to records for this element can be identified through the Enrichment Mandatory Append û Total Enrichment Match Type indicator (E).'
     end

data/lib/element_numbers/en_0162.rb

@@ -5,6 +5,8 @@ module Experian
       'Individual Education'
     end
 
+    def self.en_0162_value_description(key); ''; end
+
     def self.en_0162_description
       'Information is compiled from self-reported surveys, derived based on occupational information, or calculated through the application of predictive models.'
     end

data/lib/element_numbers/en_0164.rb

@@ -5,6 +5,8 @@ module Experian
       'Political Persona'
     end
 
+    def self.en_0164_value_description(key); ''; end
+
     def self.en_0164_description
       'PoliticalPersona Segments provide a detailed understanding of key voter segments, demographics, responsiveness to various media platforms, and attitudes and opinions on important political issues and social trends. Gain in-depth information to the demographics and insights on voter attitudes by segment and detailed analysis of media preferences by segment. PoliticalPersona provide actionable data on voter attitudes and opinions in key areas such as healthcare, employment and social security, education, and more.'
     end

data/lib/element_numbers/en_0174.rb

@@ -5,6 +5,8 @@ module Experian
       'Presence of Children Age Ranges'
     end
 
+    def self.en_0174_value_description(key); ''; end
+
     def self.en_0174_description
       'Known & Inferred Children\'s Age Ranges are a combination of known children\'s age ranges, and where not available, an Experian model which predicts the likelihood that a child within the age group is present in the living unit. When there is insufficient data to match a customer record to our Enrichment master for Inferred Children\'s Age Range, a median Inferred Children\'s Age Range based on the Known & Inferred Children\'s Age Ranges assigned to other living units in the same ZIP+4 area is used. In the rare case that the ZIP+4 is not on the record, median Children\'s Age Range is based on the Known & Inferred children\'s age ranges assigned to other records in that ZIP region. The median level data applied to records for this element can be identified through the Enrichment Mandatory Append - Total Enrichment Match Type indicator (G).'
     end

data/lib/element_numbers/en_0177.rb

@@ -0,0 +1,25 @@
+module Experian
+  class DataDictionary
+
+    def self.en_0177_column_name
+      'Presence of Children 0-18'
+    end
+
+    def self.en_0177_value_description(key); ''; end
+
+    def self.en_0177_description
+      'Presence of Children in Household identifies households with children. A child is 0 to 18 years old. This field is sourced from birth records, newspaper birth announcements and proprietary sources. This field is comprised of known and inferred data. When there is insufficient data to match a customer\'s record to our Enrichment master for Presence of Children, a median Presence of Children based on the Presence of Children scores assigned to other living units in the same ZIP+4 area is used. In the rare case that the ZIP+4 is not on the record, median Presence of Children is based on the Presence of Children scores assigned to other records in that ZIP region. The median level data applied to records for this element can be identified through the Enrichment Mandatory Append - Total Enrichment Match Type indicator (4).'
+    end
+
+    def self.en_0177(key)
+      values = {
+        '1Y' => 'Confirmed Presence of Children',
+        '5Y' => 'Inferred Presence of Children',
+        '5N' => 'Inferred No Children Present',
+        '5U' => 'Unknown'
+      }
+      key.empty? ? 'Unknown' : values[key]
+    end
+
+  end
+end

data/lib/element_numbers/en_0601.rb

@@ -0,0 +1,19 @@
+module Experian
+  class DataDictionary
+
+    def self.en_0601_column_name
+      'Estimated Current Home Value'
+    end
+
+    def self.en_0601_value_description(key); ''; end
+
+    def self.en_0601_description
+      'Estimated Current Home Value is Experian\'s proprietary model that predicts the current home value. The ECHV model uses county, state and national trends in home sale prices and assessed home values to determine property appreciation rates and current home values. Data was examined at county level and the model inputs, such as sale price, sale year or assessed price of the property that were acquired from realty deed records and county tax assessor records.'
+    end
+
+    def self.en_0601(key)
+      return nil unless /[0-9]+/ =~ key
+      key.gsub(/[^0-9]/,'').to_i
+    end
+  end
+end