digit-ui-module-workbench

Install

npm install --save digit-ui-module-workbench

Limitation

This Package is more specific to DIGIT-UI's can be used across mission's

Usage

After adding the dependency make sure you have this dependency in

frontend/micro-ui/web/package.json

"@nudmcdgnpm/digit-ui-module-workbench":"0.1.0",

then navigate to App.js

 frontend/micro-ui/web/src/App.js

/** add this import **/

import { initWorkbenchComponents } from "@nudmcdgnpm/digit-ui-module-workbench";

/** inside enabledModules add this new module key **/

const enabledModules = ["workbench"];

/** inside init Function call this function **/

const initDigitUI = () => {
  initWorkbenchComponents();
};

In MDMS

Add this configuration to enable this module MDMS Enabling Workbench Module

List of Screens available in this versions were as follows

1 . Search Master Data > -Provides a screen based on Schema and renders the search result if data is present > -It also provides a dynamic filter based on which data can be filtered

2 . Add Master Data based on selected schema > -Provides a screen to add new master data according to the schema > -Provides a Dropdown if it has any referenced master

3 . Update Master data for selected data. > -View the master data from search screen > -Disable/Enable the master data if required > -Update the master data value except the unique-identifier field mentioned in the schema

4 . Localisation screens > -Provides a screen to search the localisation present in the environment > -Add new localisation > -Update existing localisation > -Bulk Upload of Localisation data

5 . MDMS UI Schema

6 . Data push for any API based on schema

Mandatory changes to use Workbench module

1 . Assuming core module is already updated with 1.5.38+ and related changes were taken

2 . add the following hook method in micro-ui-internals/packages/libraries/src/hooks/useCustomAPIMutationHook.js

reference:: https://github.com/egovernments/DIGIT-Dev/blob/6e711bdc005c226c7debd533209681fc77078a3e/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/useCustomAPIMutationHook.js

3 . add the following utility method in micro-ui-internals/packages/libraries/src/utils/index.js

didEmployeeHasAtleastOneRole

const didEmployeeHasAtleastOneRole = (roles = []) => {
  return roles.some((role) => didEmployeeHasRole(role));
};

4 . stylesheet link has to be added

<link rel="stylesheet" href="https://unpkg.com/@egovernments/[email protected]/dist/index.css" />

Reference commit for the enabling workbench https://github.com/egovernments/DIGIT-OSS/pull/99/commits/6e711bdc005c226c7debd533209681fc77078a3e

Changelog

1.0.1 Fixes related to the limits
1.0.0 Workbench v1.0 release
1.0.0-beta workbench base version beta release
0.0.3 readme updated
0.0.2 readme updated
0.0.1 base version

Contributors

• jagankumar-egov
• nipun-egov

License

MIT

Documentation

Documentation Site (https://core.digit.org/guides/developer-guide/ui-developer-guide/digit-ui) Workbench Documentation(https://workbench.digit.org/platform/functional-specifications/workbench-ui)

Maintainer

• jagankumar-egov

Published from DIGIT Frontend

DIGIT Frontend Repo (https://github.com/egovernments/Digit-Frontend/tree/master)