Skip to content

CRM_Core.md

Latest commit

 

History

History
106 lines (60 loc) · 5.15 KB

CRM_Core.md

File metadata and controls

106 lines (60 loc) · 5.15 KB
graph LR
    Core_Entity_Models["Core Entity Models"]
    CrmModelAdmin_Base_Controller_["CrmModelAdmin (Base Controller)"]
    Core_Entity_Admins_Entity_Controllers_["Core Entity Admins (Entity Controllers)"]
    Request_Model["Request Model"]
    RequestAdmin_Request_Controller_["RequestAdmin (Request Controller)"]
    ImportEmails_Ingestion_Service_["ImportEmails (Ingestion Service)"]
    Task_Queue_Decoupling_Mechanism_["Task Queue (Decoupling Mechanism)"]
    CreateEmailInquiry_Processing_Service_["CreateEmailInquiry (Processing Service)"]
    Core_Entity_Admins_Entity_Controllers_ -- "inherits from" --> CrmModelAdmin_Base_Controller_
    Core_Entity_Admins_Entity_Controllers_ -- "manages" --> Core_Entity_Models
    ImportEmails_Ingestion_Service_ -- "enqueues task in" --> Task_Queue_Decoupling_Mechanism_
    CreateEmailInquiry_Processing_Service_ -- "dequeues task from" --> Task_Queue_Decoupling_Mechanism_
    CreateEmailInquiry_Processing_Service_ -- "creates" --> Request_Model
    RequestAdmin_Request_Controller_ -- "manages" --> Request_Model
    RequestAdmin_Request_Controller_ -- "creates or updates" --> Core_Entity_Models
Loading

CodeBoardingDemoContact

Details

One paragraph explaining the functionality which is represented by this graph. What the main flow is and what is its purpose.

Core Entity Models

These are the foundational data models that represent the primary entities of the CRM: Contact, Company, Lead, and Deal. They define the database schema and are the single source of truth for all customer-related data.

Related Classes/Methods:

CrmModelAdmin (Base Controller)

An abstract base class that provides common functionality for all CRM entity administration views in the Django admin. It standardizes features like ownership tracking, permissions, and UI layout, ensuring a consistent administrative experience.

Related Classes/Methods:

  • CrmModelAdmin

Core Entity Admins (Entity Controllers)

Concrete controller classes (ContactAdmin, CompanyAdmin, LeadAdmin, DealAdmin) that manage the lifecycle and business logic for their respective core entities. They inherit from CrmModelAdmin and implement entity-specific administrative views and actions.

Related Classes/Methods:

  • ContactAdmin
  • CompanyAdmin
  • LeadAdmin
  • DealAdmin

Request Model

Represents an incoming customer inquiry or request, typically created from a parsed email. This model serves as a temporary holding record that bridges raw, inbound communication with structured CRM entities, pending review and action.

Related Classes/Methods:

RequestAdmin (Request Controller)

The dedicated controller for the Request model. It manages the lifecycle of a request, including its assignment, status changes, and the crucial action of converting a qualified request into a Deal.

Related Classes/Methods:

  • RequestAdmin

ImportEmails (Ingestion Service)

A service responsible for connecting to an IMAP email server to fetch new messages. For each message, it enqueues a processing task for asynchronous handling, decoupling ingestion from processing.

Related Classes/Methods:

  • import_emails

Task Queue (Decoupling Mechanism)

An intermediary message broker or task queue that decouples the email ingestion process from the email processing logic. It receives task definitions from the ImportEmails service and ensures they are processed reliably by available workers.

Related Classes/Methods:

  • (Conceptual Component)

CreateEmailInquiry (Processing Service)

A background task worker that consumes messages from the Task Queue. It takes raw email data from a task, parses its content (sender, subject, body), and creates a structured Request record in the database.

Related Classes/Methods:

FAQ