.. _getting-started:

================
Getting Started
================

This guide will walk you through your first steps with the tiger Rating Engine, from initial setup to performing your first premium calculation.

.. contents:: In This Guide
   :local:
   :depth: 2

Initial Setup
=============

Account Setup
-------------

When you first receive access to the tiger Rating Engine:

1. **Check Your Email**

   .. figure:: _static/screenshots/welcome_email.png
      :alt: Welcome Email
      :align: center
      :width: 60%

      *Screenshot Placeholder: Email showing welcome message with system URL, username, and temporary password link*

   You'll receive an email containing:

   * System URL
   * Your username
   * Temporary password or password reset link
   * Link to this documentation

2. **First Login**

   .. figure:: _static/screenshots/first_login.png
      :alt: First Login Screen
      :align: center
      :width: 60%

      *Screenshot Placeholder: Login screen with password change prompt for first-time users*

   On first login, you'll be prompted to:

   * Change your temporary password
   * Set up security questions (optional)
   * Review and accept terms of use

3. **Profile Configuration**

   .. figure:: _static/screenshots/user_profile.png
      :alt: User Profile Settings
      :align: center
      :width: 80%

      *Screenshot Placeholder: User profile page showing fields for name, email, timezone, notification preferences, and theme selection*

   Configure your profile:

   * **Display Name**: How your name appears in the system
   * **Email**: For notifications and reports
   * **Timezone**: For accurate timestamps
   * **Notifications**: Email alerts for completed calculations
   * **Theme**: Light or dark mode preference

Exploring the System
====================

Understanding Available Products
--------------------------------

Before performing calculations, familiarize yourself with available products:

1. **Navigate to Products Page**

   .. figure:: _static/screenshots/products_list.png
      :alt: Products List
      :align: center
      :width: 100%

      *Screenshot Placeholder: Products page showing a grid of product cards - BOP, AUTO, WORK_COMP - each with product name, code, description, effective date, and "View Details" button*

   Click **Products** in the navigation menu to see all available insurance products.

2. **View Product Details**

   .. figure:: _static/screenshots/product_details.png
      :alt: Product Details Page
      :align: center
      :width: 100%

      *Screenshot Placeholder: Product details page showing BOP product with tabs for Overview, Rating Factors, Tables, Formulas, and Sample Calculations*

   Click any product to view:

   * **Overview**: Product description and effective dates
   * **Rating Factors**: Required input fields
   * **Tables**: Available rating tables
   * **Formulas**: Calculation logic
   * **Sample Calculations**: Example scenarios

Understanding Rating Factors
----------------------------

Each product requires specific input data:

.. figure:: _static/screenshots/rating_factors_list.png
   :alt: Rating Factors for BOP
   :align: center
   :width: 100%

   *Screenshot Placeholder: Table showing rating factors with columns for Factor Code, Name, Data Type, Required, Default Value, and Validation Rules. Examples include territory (text, required), building_value (decimal, required, min: 50000), etc.*

Common factor types:

.. table:: Common Rating Factors
   :widths: 20 20 60

   +----------------+-------------+------------------------------------------------+
   | Factor         | Type        | Description                                    |
   +================+=============+================================================+
   | territory      | Text        | Geographic location code (e.g., "001", "002") |
   +----------------+-------------+------------------------------------------------+
   | building_value | Decimal     | Property replacement cost                     |
   +----------------+-------------+------------------------------------------------+
   | building_class | Choice      | Construction type (A, B, C, D)               |
   +----------------+-------------+------------------------------------------------+
   | liability_limit| Decimal     | Maximum coverage amount                       |
   +----------------+-------------+------------------------------------------------+
   | deductible     | Choice      | Out-of-pocket amount (500, 1000, 2500, 5000) |
   +----------------+-------------+------------------------------------------------+

Your First Calculation
======================

Let's perform a simple Business Owners Policy (BOP) calculation:

Step 1: Open the Calculator
----------------------------

.. figure:: _static/screenshots/calculator_main.png
   :alt: Rating Calculator
   :align: center
   :width: 100%

   *Screenshot Placeholder: Calculator page with product selector dropdown at top, input fields section on left, and results panel (currently empty) on right*

Navigate to **Calculator** from the main menu.

Step 2: Select Product
----------------------

.. figure:: _static/screenshots/calculator_product_select.png
   :alt: Product Selection
   :align: center
   :width: 60%

   *Screenshot Placeholder: Dropdown menu showing available products with "BOP - Business Owners Policy" being selected*

1. Click the **Product** dropdown
2. Select **BOP - Business Owners Policy**
3. The form will update with BOP-specific fields

Step 3: Enter Rating Information
---------------------------------

.. figure:: _static/screenshots/calculator_input_fields.png
   :alt: Input Fields
   :align: center
   :width: 100%

   *Screenshot Placeholder: Form showing filled fields - Effective Date: 2025-01-15, Territory: 001, Building Value: 500000, Building Class: B (dropdown), Occupancy: OFFICE, etc.*

Fill in the required fields:

.. code-block:: text

   Basic Information:
   ├── Effective Date: [2025-01-15]
   └── External Reference: [QUOTE-2025-001] (optional)

   Property Information:
   ├── Territory: [001]
   ├── Building Value: [500,000]
   ├── Building Class: [B - Joisted Masonry]
   └── Occupancy Type: [OFFICE]

   Liability Information:
   ├── Liability Limit: [1,000,000]
   └── Medical Payments: [5,000]

   Additional Options:
   ├── Deductible: [1,000]
   └── Payment Plan: [ANNUAL]

Step 4: Calculate Premium
-------------------------

.. figure:: _static/screenshots/calculator_calculate_button.png
   :alt: Calculate Button
   :align: center
   :width: 40%

   *Screenshot Placeholder: Blue "Calculate Premium" button with calculator icon*

Click the **Calculate Premium** button.

Step 5: Review Results
----------------------

.. figure:: _static/screenshots/calculator_results.png
   :alt: Calculation Results
   :align: center
   :width: 100%

   *Screenshot Placeholder: Results panel showing Total Premium: $3,450.00 at top, then breakdown - Building Coverage: $1,850, Liability Coverage: $1,200, Additional Coverages: $400, with "View Details" and "Save Quote" buttons*

The results panel will display:

* **Total Premium**: Annual premium amount
* **Coverage Breakdown**: Individual coverage premiums
* **Calculation ID**: Unique reference number
* **Actions**: View details, save, or export

Step 6: View Detailed Results
------------------------------

.. figure:: _static/screenshots/calculation_details.png
   :alt: Detailed Calculation View
   :align: center
   :width: 100%

   *Screenshot Placeholder: Detailed view with tabs for Summary, Inputs, Calculation Steps, Formulas Applied, and Audit Trail. Shows step-by-step calculation with intermediate values*

Click **View Details** to see:

* **Summary**: Overview of the calculation
* **Inputs**: All factor values used
* **Calculation Steps**: Each formula execution
* **Audit Trail**: Complete calculation log

Understanding Results
=====================

Reading the Premium Breakdown
------------------------------

.. figure:: _static/screenshots/premium_breakdown_explained.png
   :alt: Premium Breakdown Explained
   :align: center
   :width: 100%

   *Screenshot Placeholder: Annotated premium breakdown showing how base rate × territory factor × class factor × other modifiers = final premium for each coverage*

The premium breakdown shows:

1. **Base Premium**: Starting rate for the coverage
2. **Territory Factor**: Geographic adjustment
3. **Class Factor**: Building/business type adjustment
4. **Other Modifiers**: Deductible credits, etc.
5. **Final Premium**: Calculated amount per coverage

Calculation Steps
-----------------

.. figure:: _static/screenshots/calculation_steps_detail.png
   :alt: Calculation Steps
   :align: center
   :width: 100%

   *Screenshot Placeholder: Table showing execution order, formula name, type, input values, calculation, and result for each step*

Each calculation follows these steps:

.. code-block:: text

   1. Load Product Configuration
      └── Retrieve factors, tables, formulas

   2. Validate Inputs
      └── Check required fields and data types

   3. Execute Formulas (in order)
      ├── Step 1: Table lookups
      ├── Step 2: Factor calculations
      └── Step 3: Premium summation

   4. Generate Results
      └── Calculate total and coverage premiums

   5. Store Audit Trail
      └── Save complete calculation record

Viewing Rating History
======================

Access Previous Calculations
-----------------------------

.. figure:: _static/screenshots/rating_history_page.png
   :alt: Rating History
   :align: center
   :width: 100%

   *Screenshot Placeholder: History page with filter bar at top (date range, product, status) and table below showing Run ID, Date/Time, Product, Premium, Status, and Actions columns*

Navigate to **Rating History** to view past calculations:

1. **Filter Options**:

   * Date range
   * Product type
   * Status (success/failed)
   * Reference ID search

2. **History Table**:

   * Run ID (click to view details)
   * Timestamp
   * Product used
   * Calculated premium
   * Status indicator

3. **Actions**:

   * View details
   * Re-run calculation
   * Export to PDF/Excel
   * Copy inputs for new calculation

Re-running Calculations
-----------------------

.. figure:: _static/screenshots/rerun_calculation.png
   :alt: Re-run Calculation
   :align: center
   :width: 60%

   *Screenshot Placeholder: Dialog box asking "Re-run this calculation?" with options to use same inputs or modify before calculating*

To re-run a previous calculation:

1. Find the calculation in history
2. Click **Re-run** button
3. Choose:
   * **Same Inputs**: Immediate recalculation
   * **Modify Inputs**: Opens calculator with pre-filled values

Exporting Results
-----------------

.. figure:: _static/screenshots/export_options.png
   :alt: Export Options
   :align: center
   :width: 50%

   *Screenshot Placeholder: Export menu showing options for PDF Quote, Excel Breakdown, CSV Data, and Email Results*

Export calculations in multiple formats:

* **PDF Quote**: Professional quote document
* **Excel Breakdown**: Detailed spreadsheet
* **CSV Data**: Raw data for analysis
* **Email**: Send directly to client/colleague

Common Tasks
============

Comparing Multiple Quotes
-------------------------

To compare different scenarios:

1. **Run Base Calculation**

   * Enter standard values
   * Note the premium

2. **Modify and Re-calculate**

   .. figure:: _static/screenshots/quote_comparison.png
      :alt: Quote Comparison
      :align: center
      :width: 100%

      *Screenshot Placeholder: Split screen showing two calculations side by side with differences highlighted*

   * Change deductible, limits, or other factors
   * System highlights differences
   * Compare premiums side-by-side

Batch Rating
------------

For multiple similar quotes:

.. figure:: _static/screenshots/batch_rating.png
   :alt: Batch Rating
   :align: center
   :width: 100%

   *Screenshot Placeholder: Batch rating interface with CSV upload area and progress indicator showing "Processing 15 of 50 quotes"*

1. Prepare CSV file with all inputs
2. Navigate to **Tools → Batch Rating**
3. Upload CSV file
4. Review and confirm
5. Download results file

Quick Tips
==========

Keyboard Shortcuts
------------------

Speed up your workflow with shortcuts:

.. table:: Keyboard Shortcuts
   :widths: 30 70

   +-------------------+--------------------------------+
   | Shortcut          | Action                         |
   +===================+================================+
   | ``Ctrl+K``        | Quick search                   |
   +-------------------+--------------------------------+
   | ``Alt+C``         | Open calculator                |
   +-------------------+--------------------------------+
   | ``Alt+H``         | View history                   |
   +-------------------+--------------------------------+
   | ``Alt+N``         | New calculation                |
   +-------------------+--------------------------------+
   | ``Ctrl+S``        | Save current work              |
   +-------------------+--------------------------------+
   | ``Ctrl+P``        | Print/Export                   |
   +-------------------+--------------------------------+
   | ``Esc``           | Close dialog/modal             |
   +-------------------+--------------------------------+

Best Practices
--------------

1. **Always Verify Effective Dates**

   Ensure the effective date matches your quote requirements

2. **Use External References**

   Add quote numbers for easy tracking

3. **Save Important Calculations**

   Mark quotes as favorites for quick access

4. **Review Calculation Steps**

   Check the audit trail for complex quotes

5. **Keep Notes**

   Add comments to calculations for future reference

Troubleshooting
===============

Common Issues
-------------

.. table:: Common Issues and Solutions
   :widths: 30 70

   +---------------------------+------------------------------------------------+
   | Issue                     | Solution                                       |
   +===========================+================================================+
   | "Product not available"   | Check effective date is after product start   |
   +---------------------------+------------------------------------------------+
   | "Invalid territory"       | Verify territory code exists in rating tables |
   +---------------------------+------------------------------------------------+
   | "Calculation timeout"     | Break complex calculations into steps         |
   +---------------------------+------------------------------------------------+
   | "Missing required field"  | Review all fields marked with red asterisk    |
   +---------------------------+------------------------------------------------+
   | "No rates found"         | Check table values for effective date         |
   +---------------------------+------------------------------------------------+

Getting Help
------------

If you encounter issues:

1. **Check Field Validation**

   Hover over ⓘ icons for field help

2. **Review Error Messages**

   .. figure:: _static/screenshots/error_message.png
      :alt: Error Message
      :align: center
      :width: 60%

      *Screenshot Placeholder: Red error banner showing "Validation Error: Building value must be at least $50,000" with details link*

   Click error details for specific guidance

3. **Contact Support**

   * Use in-app chat (bottom right)
   * Email: support@tigerrating.com
   * Phone: 1-800-RATING-1

Next Steps
==========

Now that you're familiar with the basics:

* **Learn Product Configuration**: :doc:`product_configuration`
* **Master Calculations**: :doc:`performing_calculations`
* **Follow Real Example**: :doc:`real_world_scenario`
* **Integrate via API**: :doc:`api_integration`

.. tip::
   Practice with the sample BOP product before working with real quotes. This helps you understand the system without affecting production data.