For the complete documentation index, see llms.txt. This page is also available as Markdown.

Account Management

Overview

The Account Management Module is responsible for handling tenant information within the application. It includes components for displaying tenant homes, managing tenants, creating new tenants, and editing existing tenants. This module interacts with the host app to fetch tenant details and perform CRUD operations.

Components

  1. Tenant Home: Displays the main tenant dashboard with a list of tenants.

  2. Manage Tenant: Provides functionality to manage existing tenants.

  3. Create Tenant: Allows the creation of new tenants.

  4. Edit Tenant: Enables editing of existing tenant information.

Account Management

Data Flow

  1. Tenant Home:

    • Screen Route: /sandbox-ui/account/tenant-home

    • Data Fetch: Retrieves list of tenants from MDMS (Master Data Management System), tenant name, address, and other relevant details.

    • Client Store: Updates client store with fetched data for display.

  2. Manage Tenant:

    • Screen Route: /sandbox-ui/account/tenant-manage

    • Data Fetch: Retrieves tenant details from MDMS, including home address and other necessary information.

    • Client Store: Updates client store with tenant details for management.

  3. Create Tenant:

    • Screen Route: Accessed from Manage Tenant component.

    • Data Fetch: Fetches data from MDMS, including subdomain and tenant name.

    • Client Store: Updates client store with new tenant information upon creation.

  4. Edit Tenant:

    • Screen Route: Accessed from Manage Tenant component.

    • Data Fetch: Retrieves existing tenant details from MDMS, including subdomain and other information for editing.

    • Client Store: Updates client store with edited tenant information.

Interaction With Host App

  • The Tenant Management Module fetches the tenant from the host app.

  • Ensures synchronization between tenant data in the host app and the Tenant Management Module.

Web API sequence Diagrams

Tenant Management

Last updated

Was this helpful?