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

Master Data

Overview

The Master Data is designed to handle various entities within the application. This includes managing modules, tenants, boundaries, and schemas.

Components

  • Component: Sidebar

  • Attributes:

    • actionId: string

    • order: number

    • path: string

    • navigationURL: string

    • iconName: string

    • name: string// Some code

  • Functionality:

    • Based on logged in user and roles we get list of actions user can perform,

    • Fetches navigation data based on actionId,

    • Renders navigation links in order based on order attribute.

    • Uses navigationURL for navigation and iconName for displaying icons.

Signup Component

  • Component: Signup

  • Attributes:

    • screenName: string

    • steps: Array<{bannerImage: string, text: string}>

  • Functionality:

    • Renders steps of the signup process.

    • Handles user input for each step.

    • Validates input and progresses to the next step.

SignIn Component

  • Component: SignIn

  • Attributes:

    • type: 'password' | 'otp'

    • fields: {username: string, password?: string, otp?: string}

  • Functionality:

    • Renders login form based on type.

    • Handles OTP resend logic if type is otp.

Home (Help) Component

  • Component: HomeHelp

  • Attributes:

    • youtubeLink: string

    • locale: string

  • Functionality:

    • Fetches and displays YouTube help link.

    • Provides localized help content.

Setup Sandbox Home Component

  • Component: SetupSandboxHome

  • Attributes:

    • actionId: string

    • order: number

    • buttonName: string

    • navigationURL: string

    • iconName: string

    • name: string

    • module: string

  • Functionality:

    • Fetches setup data from Role Action service.

    • Renders buttons and links for initial sandbox setup.

Application Home Component

  • Component: ApplicationHome

  • Attributes:

    • actionId: string

    • order: number

    • buttonName: string

    • navigationURL: string

    • iconName: string

    • name: string

    • module: string

  • Functionality:

    • Fetches application features from Role Action service.

    • Displays dashboard for managing active applications.

ModuleMaster Component

  • Component: ModuleMaster

  • Attributes:

    • moduleName: string

    • schemas: Array<{schemaCode: string, type: 'common' | 'module' | 'other', canShowDefaultData: boolean}>

  • Functionality:

    • Links modules to master data schemas.

    • Displays list of schemas and their attributes.

Master Home Screen Info Component

  • Component: MasterHomeScreenInfo

  • Attributes:

    • masterName: string

    • content: {headerCode: string, data: any}

    • helpVideo: string

    • buttonName: string

    • buttonLink: string

    • icon: string

  • Functionality:

    • Fetches and displays master data entities.

    • Provides navigation links and help videos.

ModuleBoundaryTenant Component

  • Component: ModuleBoundaryTenant

  • Attributes:

    • moduleName: string

    • tenant: string

    • subTenant: string

    • boundaryHierarchyType: string

    • boundaryHierarchyLevel: number

  • Functionality:

    • Links modules to boundaries and tenants.

    • Displays hierarchy and levels for each boundary and tenant.

Last updated

Was this helpful?