Skip to main content

common_modules

Common Modules Documentation​

1. Team Management​

**PRD
**The Team Management is designed to organize and manage organizational structures. It comprises the following components:

  • **Company Management:
    **Facilitates the creation and oversight of companies within the organization. This component ensures that data and reports are correctly associated with the respective company.

  • **Department Management:
    **Supports the setup and administration of departments within each company. When departments are defined, reports and data can be segmented according to the respective department structure.

  • **Users Management:
    **Provides the ability to add, update, and remove user accounts, ensuring that each user is properly recorded in the system.

    Users can be invited under a company and department as per the need.

2. Credit Management​

The Credit Management is used to manage and track the credits required for generating risk reports. In this, each report generated deducts one credit from the available balance. This module ensures that credit consumption is monitored in a transparent and straightforward manner, facilitating clear cost management and accountability.

  • **Credit Usage:
    **Provides a real-time display of credits consumed during report generation, ensuring that every report generation event is clearly accounted for.
  • **Credit History:
    **Maintains a detailed record of all credit transactions, including report generation deductions and any additions. This history supports audit trails and financial review processes.
  • **Credit Top-Up:
    **Offers a simple mechanism to purchase and add additional credits, ensuring continuous service availability for report generation without interruption.

Process Flow

  1. Report Generation:
    • Each time a risk report is generated, one credit is deducted automatically from the available balance.
  2. Usage Tracking:
    • The system updates the credit usage in real time, providing a clear overview of consumption patterns.
  3. Transaction Recording:
    • A comprehensive credit history is maintained, recording every deduction and top-up action for future reference.
  4. Top-Up Process:
    • Additional credits can be added via a straightforward top-up process, ensuring that the service remains operational as needed
    • A sum of 100, 250, or 500 credits can be added to on organisations account by toping up.

**3. ~~Customer Support Module \​

~~**

This module ensures that assistance is readily available when issues or inquiries arise. It includes:

  • Raise a Ticket:
    Allows for the creation of support tickets to log issues or requests for assistance.
  • Ticket Status:
    Provides real-time tracking of the status of each support ticket, indicating whether the issue is under review or resolved.

**4. Notification \​

**

This module ensures timely communication of important updates and actions. It consists of:

  • **In-App Notifications:
    **Displays alerts within the platform to inform users of new activities and important system events.
    • The notification shows all the information performed by the platform mentioned below:
      • Report Generated
      • Ticket Resolved
      • Credit reminder when 50, 25, 10, 5, 1 credits remaining
      • Report shared
      • Commented on report
  • **Email Notifications:
    **Sends notifications via email, ensuring that information is communicated even when the platform is not actively in use.
    • Report Generated
    • Requested for reports
    • Ticket Resolved

**5. Login \​

**

Implements secure authentication to ensure that only authorized users can access the system.

Two-factor authentication is implemented using the username & password, and after that, an OTP will be sent to the respective mail.

**6. User Activity/Logs \​

**

This module tracks system interactions for monitoring and auditing purposes.

Records significant actions and events performed by users, such as.

  • Report Requested
  • Project created
  • Ticket Raised
  • Entity List uploaded
  • Credit Purchased
  • Card moved manually
  • Multiviews created
  • Configurations changed

7. Weightage Configuration​

**
**The Weightage Configuration module enables the generation of customized reports based on user-defined weightages. It allows for the configuration of dimensions and parameters that are essential to report analysis, ensuring that the output reflects specific criteria set during the configuration process.

Key Features

  • **Selection of Dimensions and Parameters:
    **Allows selection of relevant dimensions (such as Financial Health, Corporate Structure, etc.) and their corresponding parameters from the available dataset. These selections determine the key factors that will influence the report outcomes.
  • **Custom Weight:
    **Provides a mechanism to assign numerical weightages to each chosen parameter the sum needs to be 100.
  • **Automated Calculation:
    **Once the dimensions and parameters are selected and assigned weightages, the system calculates the overall scores by aggregating the weighted values.
  • **Report Generation:
    **After all configurations and calculations are completed, the system generates reports based on the newly applied weights. The final reports present a tailored risk analysis that reflects the customized settings, offering insights aligned with the defined criteria.

The new configuration is applicable, for only those reports that are generated after the new configuration is set.