Workbench

Overview

The Workbench Module is designed to manage Master Data Management System (MDMS) data and localization data within the system. This module supports comprehensive CRUD operations (Create, Read, Update, Delete) for both MDMS data and localization settings, ensuring efficient and seamless data management across the application. When users interact with the Workbench Module to set up any module, the base Workbench fetches the required MDMS data, determines the number of masters that need to be configured, and loads them accordingly.

Components

  1. Workbench Home: Displays the main dashboard for MDMS and localization management features.

  2. Setup MDMS: Provides functionality to configure and manage MDMS data structures and schemas.

  3. Create MDMS Data: Allows the creation of new entries in the MDMS, including defining data attributes and relationships.

  4. Edit MDMS Data: Enables the modification of existing MDMS entries, allowing updates to data attributes and relationships.

  5. Manage Localization: Provides tools for managing localization data, including adding, editing, and deleting localized content.

  6. Create Localization Data: Allows the addition of new localization entries for supported languages.

  7. Edit Localization Data: Enables the editing of existing localization entries to ensure up-to-date and accurate translations.

Data Flow

  1. Workbench Home:

    • Screen Route: /sandbox-ui/workbench/home

    • Data Fetch: Retrieves an overview of MDMS and localization data, including tenant-specific configurations and available datasets.

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

  2. Setup MDMS:

    • Screen Route: /sandbox-ui/workbench/mdms-setup

    • Data Fetch: Retrieves details on MDMS schemas, data structures, and related configurations from the MDMS.

    • Client Store: Updates the client store with setup details, enabling management of MDMS configurations.

  3. Create MDMS Data:

    • Screen Route: Accessed via the Setup MDMS component.

    • Data Fetch: Fetches schema and structural data from MDMS to facilitate the creation of new entries.

    • Client Store: Updates the client store with new data after creation, ensuring the data is reflected across the system.

  4. Edit MDMS Data:

    • Screen Route: Accessed via the Setup MDMS component.

    • Data Fetch: Retrieves existing MDMS data based on the selected entry for editing, including related schema details.

    • Client Store: Updates the client store with edited data upon submission, ensuring accurate data representation.

  5. Manage Localization:

    • Screen Route: /sandbox-ui/workbench/localization-manage

    • Data Fetch: Retrieves existing localization data, including supported languages and current translations.

    • Client Store: Updates the client store with localization data for management and display.

  6. Create Localization Data:

    • Screen Route: Accessed via the Manage Localization component.

    • Data Fetch: Fetches the list of supported languages and existing localization keys from the system.

    • Client Store: Updates the client store with newly created localization entries.

  7. Edit Localization Data:

    • Screen Route: Accessed via the Manage Localization component.

    • Data Fetch: Retrieves existing localization data for editing, including language-specific entries.

    • Client Store: Updates the client store with edited localization data after submission.

Interaction With Host App

  • The Workbench Module fetches tenant information from the host app to ensure data consistency.

  • Synchronizes tenant data and related configurations between the host app and the Workbench Module.

User Interface

  1. Workbench Home Screen: Displays a comprehensive dashboard for managing MDMS and localization features, with options to view, manage, create, or edit entries.

  2. Setup MDMS Screen: Provides tools for managing MDMS data structures, including schema configuration and data entry points.

  3. Create MDMS Data Screen: A form to define and submit new MDMS data entries.

  4. Edit MDMS Data Screen: A form pre-populated with existing data for editing and submission.

  5. Manage Localization Screen: Tools for managing localization entries, including viewing, adding, editing, or deleting localized content.

  6. Create Localization Data Screen: A form to input new localization details, including translations for supported languages.

  7. Edit Localization Data Screen: A form pre-filled with existing localization data for modification and submission.

Last updated

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.