Documents: Implementation Details

Document Inbox

- This page lists all created documents in reverse-chronological order with the latest created document appearing on the top and the first created one at the end. This table supports pagination and employees have the option to specify the list size for the page. - Inbox has a search feature that helps employees quickly find documents based on selected ULB, document name and posted by fields. - Inbox also has a filter option where employees can filter the documents based on categories.

Inbox Default View

API

Create Document

Employees can add new documents using the Add New Document button. A form gets rendered which can be used to fill in necessary details and upload documents if any or add links to document stored somewhere else.

Create New Document

API

Success Screen With Document ID

Document Details

This page provides complete information about the created document. By clicking on the name of any document employee gets navigated to the details page.

Here, employees can take action to edit or delete the document.

Document Details Screen

Edit Documents

To make some changes in the listed document employees have to navigate to the Details page and then click on the Take Action button → Edit Document Details button. This redirects the user to the edit form where fields are pre-populated with previously entered details. Employees can edit and update the details accordingly.

Edit Document Details Page

API

Document Updated Message Screen

Delete Documents

Employees can remove documents from the listing by navigating to the inbox → selecting the document → moving to the document details page → clicking on the take action button and then the Delete option. A prompt screen asks for confirmation of the action and on selecting Yes Delete the selected document is deleted.

Delete Confirmation Prompt
Delete Message

Citizen Screens

Citizens can view all uploaded documents on information & updated section on the home page. Here, all the categories are listed and also enable search by document title. Selecting any category fetches all the documents for the selected category.

Category of Documents
Documents Under Citizen Charter Category

Citizens can view, open or download the uploaded documents or the link.

API

MDMS Data

MDMS contains and fetches the static data like forms config and Document Categories. MDMS KEYS: API + "DocumentUploader", ["UlbLevelCategories"]

Localization

Localization keys are added under the ‘rainmaker-common’ locale module. In future, if any new labels are implemented in the Trade License (Citizen) these should also be pushed to the locale DB under rainmaker-tl locale module. Below is an example of a few locale labels.

API Call Role Action Mapping

API

Action id

Roles

/egov-mdms-service/v1/_search

954

CITIZEN

/egov-document-uploader

1685

EMPLOYEE

/filestore/v1/files/url

1528

CITIZEN, EMPLOYEE

/localization/messages/v1/_search

1531

CITIZEN, EMPLOYEE

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

Last updated

Was this helpful?