Documentation

Coverage Configuration Guide

Coverage configurations define the structure and requirements for different types of insurance coverage. This guide explains how to set up and manage coverage configurations in the Tax Management System.

Overview

A coverage configuration specifies:

  • Coverage Name and Code - Human-readable name and unique identifier
  • Description - Detailed explanation of the coverage type
  • Inputs - Data fields required for this coverage
  • Country-Specific Inputs - Variations for different countries
  • Additional Premium Types - Types of additional premiums that can apply

Accessing Coverage Configuration

Navigate to Coverage Configurations from the sidebar menu to manage coverage configurations.

Creating a Coverage Configuration

Basic Information

  1. Click "Create Coverage Configuration"
  2. Fill in the basic information:
    • Coverage Name - Human-readable name (e.g., "Motor Insurance")
    • Coverage Code - Unique identifier (e.g., "MOTOR")
    • Description - Detailed description of the coverage

Coverage-Specific Inputs

Define the input fields that are required for this coverage type:

Input Fields

For each input, specify:

  • Name - Field identifier (e.g., "vehicleValue", "driverAge")
  • Type - Data type:
    • String - Text values
    • Number - Numeric values
    • Boolean - True/false values
    • Date - Date values
  • Default Value - Optional default value for the field
  • Mandatory - Whether this field is required

Example

For motor insurance, you might define:

  • vehicleValue (Number, Mandatory) - Value of the insured vehicle
  • driverAge (Number, Mandatory) - Age of the primary driver
  • vehicleType (String, Mandatory) - Type of vehicle (car, motorcycle, etc.)
  • noClaimsDiscount (Boolean, Optional) - Whether no-claims discount applies

Country-Specific Inputs

Different countries may require different input fields. Add country-specific variations:

  1. Click "Add Country Input"
  2. Select the country code
  3. Add input fields specific to that country

Example

  • GB (United Kingdom) - Might require ukRegistrationNumber
  • US (United States) - Might require usStateCode and zipCode
  • DE (Germany) - Might require germanLicenseNumber

Additional Premium Types

Define types of additional premiums that can apply to this coverage:

  1. Click "Add Additional Premium Type"
  2. Specify:
    • Name - Name of the premium type (e.g., "Windscreen Cover")
    • Code - Unique code (e.g., "WINDSCREEN")
    • Countries - Countries where this premium type applies

Example

Additional premium types for motor insurance:

  • WINDSCREEN - Windscreen cover premium
  • BREAKDOWN - Breakdown cover premium
  • LEGAL_EXPENSES - Legal expenses cover

Notes

Use the notes field to provide additional context or instructions:

  • Business rules specific to this coverage
  • Calculation considerations
  • Integration notes
  • Historical information

Editing Coverage Configurations

  1. Navigate to the coverage configuration list
  2. Click on a configuration to view details
  3. Click "Edit" to modify the configuration
  4. Make changes and save

Input Types Reference

String

  • Used for text values
  • Examples: names, codes, descriptions
  • Validation: Can specify format patterns

Number

  • Used for numeric values
  • Examples: amounts, ages, percentages
  • Validation: Can specify min/max values

Boolean

  • Used for true/false values
  • Examples: flags, indicators
  • Validation: Must be true or false

Date

  • Used for date values
  • Examples: start dates, birth dates
  • Validation: Must be valid date format

Best Practices

Naming Conventions

  • Use camelCase for input field names
  • Use descriptive names that clearly indicate the field's purpose
  • Keep codes short but meaningful
  • Use consistent naming across related coverages

Mandatory Fields

  • Mark fields as mandatory only when truly required
  • Consider providing sensible defaults for optional fields
  • Document why certain fields are mandatory

Country-Specific Variations

  • Only create country-specific inputs when truly necessary
  • Keep common inputs in the base configuration
  • Document the reasons for country-specific requirements

Additional Premium Types

  • Define premium types at the appropriate level (coverage vs. country)
  • Use clear, descriptive codes
  • Consider reusability across coverage types

Common Use Cases

Motor Insurance

Name: Motor Insurance
Code: MOTOR
Inputs:
  - vehicleValue (Number, Mandatory)
  - driverAge (Number, Mandatory)
  - vehicleType (String, Mandatory)
  - noClaimsDiscount (Boolean, Optional)
Country-Specific:
  GB: [ukRegistrationNumber]
  US: [usStateCode, zipCode]
Additional Premiums:
  - WINDSCREEN (GB, IE)
  - BREAKDOWN (All countries)

Property Insurance

Name: Property Insurance
Code: PROPERTY
Inputs:
  - propertyValue (Number, Mandatory)
  - propertyType (String, Mandatory)
  - constructionType (String, Mandatory)
  - yearBuilt (Number, Mandatory)
Country-Specific:
  FR: [frenchTaxCode]
  DE: [germanBuildingClass]
Additional Premiums:
  - CONTENTS (All countries)
  - FLOOD_RISK (Specific countries)

Travel Insurance

Name: Travel Insurance
Code: TRAVEL
Inputs:
  - destinationCountry (String, Mandatory)
  - tripDuration (Number, Mandatory)
  - travelerAges (Number[], Mandatory)
  - coverageType (String, Mandatory)
Country-Specific:
  None typically needed
Additional Premiums:
  - MEDICAL_COVER (All countries)
  - CANCELLATION (All countries)

Integration with Tax Configurations

Coverage configurations are referenced by tax configurations:

  • Tax configurations specify which coverages they apply to
  • Coverage inputs are used in tax rule conditions
  • Additional premium types are used in tax calculations

Ensure that:

  • Input field names match between coverage and tax configurations
  • Data types are consistent
  • Country-specific alignments are correct

Troubleshooting

Issues with Input Fields

  • Problem: Tax rules not recognizing input fields
  • Solution: Ensure input names match exactly between coverage and tax configurations

Country-Specific Inputs Not Working

  • Problem: Country-specific inputs not appearing
  • Solution: Verify country code format (e.g., "GB" not "UK")

Additional Premium Types Not Available

  • Problem: Premium types not showing in tax calculations
  • Solution: Ensure premium types are defined for the correct countries