.. _user-guide: ================================ tiger Rating Engine User Guide ================================ Welcome to the tiger Rating Engine User Guide. This comprehensive documentation will help you understand and effectively use the insurance rating system to configure products, set up rating factors, manage rating tables, create formulas, and calculate insurance premiums. .. contents:: Table of Contents :local: :depth: 2 Overview ======== The tiger Rating Engine is a sophisticated insurance premium calculation system that supports multiple insurance products, complex rating factors, multi-dimensional tables, and flexible formula-based calculations. This guide is designed for: * **Insurance Underwriters** - Configure products and perform rating calculations * **Product Managers** - Set up new insurance products and maintain existing ones * **System Administrators** - Manage users, monitor system performance * **Integration Partners** - Connect external systems via API Key Capabilities ---------------- * **Multi-Product Support**: Configure different insurance products (BOP, Auto, Workers Comp, etc.) * **Flexible Rating Factors**: Define any rating variable your products need * **Multi-Dimensional Tables**: Create complex lookup tables with multiple dimensions * **Formula Engine**: Build sophisticated rating algorithms using Python expressions * **Complete Audit Trail**: Track every calculation with full input/output history * **REST API**: Integrate with external systems for automated rating * **Version Control**: Manage effective dates for products and rates System Architecture ------------------- .. figure:: _static/screenshots/system_architecture.png :alt: System Architecture Diagram :align: center :width: 80% *Screenshot Placeholder: System architecture diagram showing Web Interface, Admin Interface, REST API, Rating Engine Core, and Database components with their relationships* The system consists of: 1. **Web Interface**: User-friendly rating calculator and history viewer 2. **Admin Interface**: Configuration and management portal 3. **REST API**: Integration endpoints for external systems 4. **Rating Engine**: Core calculation logic 5. **Database**: PostgreSQL storage for configurations and results Getting Started =============== First-Time Login ---------------- .. figure:: _static/screenshots/login_page.png :alt: Login Page :align: center :width: 60% *Screenshot Placeholder: Login page showing username and password fields with "Sign In" button and tiger Rating Engine logo* 1. Navigate to your tiger Rating Engine URL (e.g., ``https://rating.yourcompany.com``) 2. Enter your username and password provided by your administrator 3. Click **Sign In** Dashboard Overview ------------------ .. figure:: _static/screenshots/dashboard.png :alt: Main Dashboard :align: center :width: 100% *Screenshot Placeholder: Dashboard showing four cards - Total Runs (count), Success Rate (percentage), Average Premium (dollar amount), Recent Activity (line chart), plus a table of recent rating runs below* After login, you'll see the main dashboard with: * **Statistics Cards**: Key metrics at a glance * **Activity Chart**: Recent rating trends * **Recent Runs**: Latest calculations performed * **Quick Actions**: Links to calculator and configuration Main Navigation --------------- .. figure:: _static/screenshots/navigation_menu.png :alt: Navigation Menu :align: center :width: 100% *Screenshot Placeholder: Top navigation bar with menu items - Dashboard, Calculator, Rating History, Products, Admin, API Docs, and user profile dropdown* The navigation menu provides access to: * **Dashboard** (``/rating/``): Main overview and statistics * **Calculator** (``/rating/calculator/``): Perform rating calculations * **Rating History** (``/rating/runs/``): View past calculations * **Products** (``/rating/products/``): Browse available products * **Admin** (``/admin/``): Configuration portal (requires admin rights) * **API Docs** (``/api/docs/``): REST API documentation User Roles and Permissions --------------------------- .. table:: User Roles and Access Levels :widths: 20 80 +-----------------+-------------------------------------------------------------------+ | Role | Permissions | +=================+===================================================================+ | Viewer | • View dashboard and statistics | | | • Browse products and documentation | | | • View rating history (own calculations) | +-----------------+-------------------------------------------------------------------+ | Underwriter | All Viewer permissions plus: | | | • Perform rating calculations | | | • View all rating history | | | • Export rating results | +-----------------+-------------------------------------------------------------------+ | Product Manager | All Underwriter permissions plus: | | | • Configure products, factors, tables, formulas | | | • Manage effective dates and versions | | | • Access admin interface | +-----------------+-------------------------------------------------------------------+ | Administrator | All permissions plus: | | | • Manage users and permissions | | | • System configuration | | | • View system logs and performance metrics | +-----------------+-------------------------------------------------------------------+ Quick Start Checklist --------------------- For new users, follow these steps: .. code-block:: text ☐ 1. Log in with provided credentials ☐ 2. Explore the dashboard ☐ 3. Browse available products in Products page ☐ 4. Try a sample calculation in Calculator ☐ 5. Review calculation in Rating History ☐ 6. Read API documentation if integrating Key Concepts ============ Before diving into system usage, understand these fundamental concepts: Products -------- A **Product** represents an insurance line (e.g., Business Owners Policy, Auto Insurance). Each product has: * **Product Code**: Unique identifier (e.g., "BOP", "AUTO") * **Product Name**: Display name (e.g., "Business Owners Policy") * **Effective Date**: When the product configuration becomes active * **Active Status**: Whether the product is currently available for rating Rating Factors -------------- **Rating Factors** are the input variables used in premium calculations: * **Territory**: Geographic location (state, ZIP code, etc.) * **Class Code**: Business or vehicle classification * **Building Value**: Property replacement cost * **Limits**: Coverage amounts * **Deductibles**: Out-of-pocket amounts Each factor has: * **Data Type**: text, decimal, integer, boolean, date * **Validation Rules**: Required fields, min/max values, allowed choices * **Default Values**: Pre-populated values for convenience Rating Tables ------------- **Rating Tables** are multi-dimensional lookup matrices for rates and factors: .. figure:: _static/screenshots/rating_table_example.png :alt: Rating Table Example :align: center :width: 80% *Screenshot Placeholder: Table showing a grid with Territory (rows) and Building Class (columns) with rate values in cells. Example: Territory "001" and Building Class "A" = 1.25 rate* Tables support: * **Multiple Dimensions**: Up to 10 factors per table * **Date Versioning**: Different rates for different effective dates * **Interpolation**: Optional calculation between values * **Default Values**: Fallback rates when exact match not found Formulas -------- **Formulas** define the calculation logic: 1. **Python Expression**: Mathematical calculations Example: ``base_premium * territory_factor * class_factor`` 2. **Table Lookup**: Retrieve values from rating tables Example: Look up rate based on territory and building class 3. **Factor Multiply**: Chain multiple factors together Example: Multiply base rate by all applicable factors Each formula has: * **Execution Order**: Sequence of calculation (1, 2, 3, etc.) * **Dependencies**: Which formulas must run first * **Conditions**: Optional rules for when to apply * **Result Variable**: Where to store the calculated value Rating Run ---------- A **Rating Run** represents a complete premium calculation: * **Input Data**: All factor values provided * **Calculation Steps**: Each formula execution in sequence * **Results**: Final premium and coverage breakdowns * **Audit Trail**: Complete record of the calculation Next Steps ========== Depending on your role, continue with: .. toctree:: :maxdepth: 2 getting_started performing_calculations product_configuration real_world_scenario api_integration troubleshooting For immediate help: * **Quick Calculation**: Go to :doc:`performing_calculations` * **Product Setup**: See :doc:`product_configuration` * **Real Example**: Follow :doc:`real_world_scenario` * **API Integration**: Read :doc:`api_integration` Support Resources ================= Need assistance? * **Help Documentation**: Available at ``/help/`` * **API Documentation**: Interactive API docs at ``/api/docs/`` * **Support Email**: support@tigerrating.com * **Training Videos**: Available in the Help Center * **Release Notes**: Check ``/releases/`` for latest updates .. note:: This user guide covers tiger Rating Engine version 1.0. Features may vary in other versions. .. tip:: Use keyboard shortcuts for faster navigation: * **Ctrl+K**: Quick search * **Alt+C**: Open calculator * **Alt+H**: View history * **Alt+D**: Return to dashboard