Custom Rate Evaluation Functions

Custom Rate Evaluations' context has access to a variety of methods, variables and associated objects. Below is a breakdown of the functions available in the evaluation context.

Variables

1. Basic Attributes

   • deductible
   • limit
   • limit2
   • limit3
   • name
   • itemid
   • reference_id
   • premium
   • categories
   • revision_id
   • sub_line_name
   • sub_line_instance_id
   • is_a_fee
   • is_a_calculation
     
     

2. Policy and Revision Details

   • policy_term_effective_date
   • policy_term_is_renewal
   • policy_term_committed_revision_count
   • policy_inception_date
   • revision
   • renewal_iteration
   • is_renewal_revision
     
     

3. Custom Variables

   • customVariables (populated dynamically based on the rate chain)
     
     

4. Property and Driver Details

   • property (instance of ScopedProperty)
   • vehicle
   • driver
     
     

5. Location Details

   • location_id
     
     

6. Instance List

   • instance_list (list of instances of the same item)

Associated Objects

1. this.property

   • Methods:
     • all_items()
     • items_
     • sublines
     • has_mortgagee
       
       
   • Variables:
     • id
     • line_items
     • premium
     • address1, address2, city, state, zip
     • replacementCostValue
     • writtenPremium, annualPremium
     • latitude, longitude
       
       

2. this.subline

   • Methods:
     • get_items_grouped_by_subline(scoped_entity)
     • get_scoped_subline(sub_line_instance_id, scoped_entity)
     • get_scoped_sublines(scoped_entity)
       
       
   • Variables:
     • id
     • items
     • items_
       
       

3. this.revision

   • Methods:
     • all_items()
       
       
   • Variables:
     • id
     • risks
     • properties
     • revision_date
     • effective_date
     • drivers
     • vehicles
       
       
4. this.named_insureds / this.revision.named_insureds 
   • Variables:
     • contact_id
     • contact_gender
     • date_added
     • birth_year
     • age
       
5. this.driver / this.revision.drivers / this.vehicle.primary_driver
   • Variables:
     • accidents_violations
     • full_name
     • stock
     • items
       
   • Internal Reference (Driver+Standard+Fields)
     
     
6. this.vehicle / this.revision.vehicles
   • Variables:

     • Stock fields: this.vehicle.stock_field_name

     • Primary Driver: this.vehicle.primary_driver

     • Secondary Driver: this.vehicle.secondary_driver

     • Items/Categories/Variables: this.property.* (No changes specific for auto)

        

   • Internal Reference (Vehicle+Standard+Fields) 

      

7. this.creditscore

   • • Variables:
       • report_number
       • score
       • date

Methods

1. Premium and Limit Calculations

   • get_premium_or_rate_it(line_items, force_rate=False, referenced_item=False, return_dict=False)
   • get_rate(rate_obj=None, combination=None)
   • get_rate_chain_premium(line_items)
   • compute_deductible()
   • compute_limit()
   • check_min_and_max_limits(limit)
   • get_deductible_options()
   • get_derived_deductible()
     
     

2. Evaluation and Context

   • run_evaluation(eval_code, line_items, chain_premium, index)
   • eval_item_exists_in_scope(item_name, items_in_scope)
   • build_legacy_eval_item_dict(eval_code, line_items)
   • is_item_needed_in_context(line_item, eval_code)
   • is_item_rate_needed_for_evaluation(line_item, eval_code)
   • add_item_to_legacy_dict(items_dict, line_item, line_items, do_not_rate_item=False)
     
     

3. Reference and Variable Handling

   • find_reference(name, line_items, find_limit=False, find_premium=False)
   • find_first_reference_in_rate_items(reference_name, rate_items)
   • rebuild_eval_str_from_code_references(eval_str, index, line_items)
   • _get_variable_running_total(variable_name, rating_objects)
     
     

4. Location and Rating Factors

   • get_location_rating_factors(property=None, latitude=None, longitude=None)
   • get_location_rating_factor(factor_name, property=None, latitude=None, longitude=None)
     
     

5. Commission and Prorata Calculations

   • compute_commission_rate(line_items, premium, index)
   • get_prorata(factor, key='annual_premium', term_length=None)
     
     

6. Item and Property Summations

   • sum_item_variable_within_subline(item_name, custom_variable_name)
   • sum_property_item_value(item_name, attribute_name="annualPremium", filter_by_category=None, property_group_id=None)
   • max_property_item_value(item_name, attribute_name="annualPremium", filter_by_category=None, property_group_id=None)
     
     

7. Miscellaneous

   • age_from_date(from_date, unit='years')
   • age_from_year(from_year)
   • previous_revision_value(attribute_name, default=None)
   • stage_properties()