Inspection Portal and its feature
==================================

This guide outlines the inspection portal functionality and its feature


Inspection portal Overview
-------------

- **Portal Overview**:

     Portal contails the features where it shows all the features that inspection portal support. 
     It supports following types of feature

    -  Dashboard: The dashboard provides a comprehensive view of client inspection statistics, including key metrics such as "Inspection Performed," "Inspected Vehicles," "Users Added," and "Sites Added" within a specified date range. Additionally, it displays overall AI-detected damages and rejected damages for a clear assessment of inspection outcomes.

.. raw:: html

    <iframe src="https://www.youtube.com/embed/py-HW7w9YRw?si=5LiLmSY9qr026aPE"
          style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>


Dashboard 
------------------------------

-  **Inspection**:

     - The inspection statistics are presented in a graphical format for the specified date range, displaying the number of inspections "Created" and "Closed"

-  **Damage stats**:
     - The damage statistics are represented in a pie chart format, differentiating the counts for "AI Detected," "Added," and "Rejected" damages


.. raw:: html

    <iframe src="https://www.youtube.com/embed/Gtl-TVbXVts?si=CZd0nj0bSB1Xz8Uo"
           style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>

Inspection views
------------------------------

1. **Inspection view and search**:

     - The inspection screen displays all inspections, regardless of the user. It includes a global search feature that allows users to find inspections by entering a registration number.
Additionally, inspections can be viewed based on different timeframes, including Daily, Weekly, and Monthly.
A key feature of this screen is the Advanced Search, which enables users to efficiently filter inspections using various criteria such as Number Plate, VIN, Status, Damage Category, Damage Status, Body Type, Occurrence, and Created By, within a specified date range.

.. raw:: html

    <iframe src="https://www.youtube.com/embed/88oLy4xEhYc?si=Qfo-4m0dCwOxaD4T"
           style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>

2. **Inspection Report**:
     - The Screen provides inspection report details, how to export pdf report and dynamic form. 

.. raw:: html

    <iframe src="https://www.youtube.com/embed/WLED7kJhMTw?si=jevd43QhUfbzX9L_"
           style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>

3. **Archive**:
     - The Archive Screen provides access to deleted inspections while ensuring that no inspection data is permanently lost. It allows users to restore deleted inspections by moving them back to the Inspection Screen whenever needed, ensuring easy retrieval of past records.

.. raw:: html

    <iframe src="https://www.youtube.com/embed/vv75VssNnCs?si=7IZeTOPOZOBMJMUj"
            style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>



User views
------------------------------

1. **Creating user**:
     - The User Screen displays user details associated with the specific client account currently logged in. It also provides the functionality to create new users to expand the workforce.
There are two methods for creating a user:

- By Official Email ID : Creating a user with login credentials.
- One-Time User:  Adding a user without login credentials, intended for temporary access.

.. raw:: html

    <iframe src="https://www.youtube.com/embed/VS5aPWup-Nk?si=WTeeZzU_VtZawn9Z"
            style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>

2. **One time link creation**:
     - The One-Time Link user creation process is a simple and efficient method for granting temporary access. By entering the user's email ID, the system generates and sends a login link to their email. The user can then access the application with a single click from the email, without requiring login credentials.
This feature is primarily designed for trial purposes, allowing users to explore the application effortlessly.

.. raw:: html

    <iframe src="https://www.loom.com/embed/3689164416f24819b7e10738a56f4194?sid=fae9323d-71c8-49e8-8a0f-b969d3ffe984"
            style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>


Settings views
------------------------------

1. **Customer settings**:
     - The Settings Page serves as the central hub for configuring all client-specific settings. It allows customization and management of various system preferences to align with the client's requirements.

2. **Submit report**:
     - The Submit Report Setting is a security-focused feature that generates a unique API security key for each client. This ensures that the client’s dashboard remains secure and accessible only to authorized users.

3. **Custom images**:
     - The system includes predefined exterior and interior car images for capturing inspection photos. However, if a customer requires additional specific images beyond the predefined set, they have the flexibility to customize and add "Custom Images" as per their needs.

4. **Create inspection**:
     - When creating an inspection, the client needs to collect essential vehicle details such as Registration Number, Make, Model, etc.
The Car Information Settings allow clients to customize the required fields by enabling or disabling options such as: Registration Number, VIN, Make, Model, Mileage, Body Type, Year.
This ensures that only the necessary vehicle details are requested during the inspection process.
         
5. **Custom workflow**:

     - The Workflow provides a structured and simplified approach to managing inspections by allowing users to:

     Capture images efficiently.
     Answer required inspection questions.
     Review AI-detected damages in the Damage Detail Screen.

All these functionalities are configurable within the Workflow Settings, where users can enable or disable the following options:
    
     - AI Guide: Controls the image capturing screen.
     - Dynamic Form : Manages checklist-related questions.
     - Damage Detail Screen:  Enables reviewing of AI-detected damages.

This flexibility allows clients to tailor the workflow according to their inspection requirements.

6. **Dynamic form and check list**:
     - The Dynamic Form serves as a checklist-based interactive form where users can respond to questions configured by the client.
We support five types of question formats to enhance flexibility in data collection:

 - True or False
 - Single Answer Selection
 - Multiple Answer Selection
 - Comment Only
 - Single Image Capturing
 - Multiple Image Capturing

Additionally, for image-related question types, a comment box can be configured, allowing users to provide additional details along with the captured images.

7. **Personal information on inspection**:
     - The Personal Information setting allows clients to configure whether user details should be collected during the inspection process.

Clients can enable or disable the following fields based on their requirements:
 - Name
 - Email
 - Contact

This ensures flexibility in gathering necessary user information as needed.

8. **Report showing options**:
     - The Report Display Setting is a key feature that allows clients to generate a PDF report containing all relevant details of an inspected vehicle, including detected damages. This report helps clients easily validate inspection results.
Additionally, the PDF report is configurable, enabling clients to customize the information displayed. The configurable settings include:
 
 - Source of Damage
 - Damage Type
 - Severity

As an added benefit, clients can also enable or disable the option to download damaged images and car images within the PDF report, ensuring flexibility based on their reporting needs.

9. **Bucket storage information**:
     - If customer want focalx to store images in their bucket then customer can configure that by specifiying the keys. Right we only support AWS bucket storage


.. raw:: html

    <iframe src="https://www.youtube.com/embed/rh12FdqJuZM?si=5NAkd5pDrdbaitxf"
            style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>


Multisubportal Feature Documentation
------------------------------

 **Overview**:

Our system provides the ability to create subportals under a parent portal. This feature allows for segmentation, allowing the parent portal to manage multiple subportals. Each subportal functions independently, with its own users, inspections, and settings, while still being connected to the parent portal.


 **Key Features**:

1. **Subportal Creation and Management**

The parent portal can create subportals, which operate as isolated entities. Each subportal has its own:

**Users**: Users are specific to each subportal and can only access the subportal they belong to.

**Inspections**: Each subportal has its own set of inspections.

**Settings**: Subportals have independent configurations that can be customized to meet their individual needs.

2. **Parent Portal Admin Access**

The Parent Portal Admin has full access to all subportals and their corresponding data. This includes the following permissions:

**View Inspections**: The Parent Portal Admin can view all inspections performed in any of the subportals, regardless of which subportal they belong to.

**View Subportal Statistics**: The admin can also access detailed statistics and reports for each subportal, providing an overview of performance and activities within the subportals.


**Coming Soon**

User Management for Parent Portal Admin

We are working on a new feature that will allow Parent Portal Admins to manage users within the subportals. This will provide even more control, enabling admins to add, edit, or remove users from specific subportals.


.. raw:: html

    <iframe src="https://www.youtube.com/embed/FLEi6u5P6aM?si=7rjT9oOqowkkJx0w"
            style="margin-top: 40px; margin-bottom: 20px;"
            width="640"
            height="360"
            frameborder="0"
            webkitallowfullscreen
            mozallowfullscreen
            allowfullscreen></iframe>