ECM Document Portal

Business Requirement Document

Version <1>
Author: <Nguyen Hong Phi>
 ECM Admin Portal BRD

Version History
Version Date Author Description
1.0 11/10/2024 Nguyen Hong Phi Initial

1
 ECM Admin Portal BRD

Sign off
Name Position Signature and Date

Mr. Nguyen
IT Business Analyst
Hong Phi

Mr. Bui Huu IT Business Analyst –

Thanh Loi Risk Application

Unit Head of Internal

Mr. Nguyen
Application
Ngoc Tuan
Department

2
 ECM Admin Portal BRD

Content
ECM Document Portal..................................................................................................... 0
Sign off ............................................................................................................................. 2
I. Introduction ............................................................................................................... 4
1. Purpose ................................................................................................................. 4
2. Scope ..................................................................................................................... 4
3. Audience ............................................................................................................... 4
II. Detail Requirements ............................................................................................. 4
A. Non-Functional Requirements ............................................................................... 4
B. Functional Requirement ......................................................................................... 4
1. Login: ................................................................................................................. 5
2. Document List ................................................................................................... 6
3. Search Document ............................................................................................. 6
4. Application History ........................................................................................... 7
5. View Document ................................................................................................. 8
6. Download Document ........................................................................................ 9
7. Audit Log ......................................................................................................... 10

3
 ECM Admin Portal BRD

I. Introduction
1. Purpose
- Build an ECM document portal that allows viewing all the documents of the
application
2. Scope
- The portal includes the following features:
+ Search document by application ID
+ View document
+ Download document
+ View history document of the app
+ View audit log of the app

3. Audience
Audience Roles
Mr. Nguyen Hong Phi IT Business Analyst
IT Business Analyst – Internal Application
Mr. Bui Huu Thanh Loi
Department

Mr. Nguyen Ngoc Tuan Unit Head of Internal Application Department

II. Detail Requirements

A. Non-Functional Requirements
Name of Requirement Logic Note
Button show in Action button is only show
accordance with aligned with permission &
permission role grant.
Logic Update All records CRUD make by
CreatedDate/ CreatedBy/ user on UI UX must be
UpdatedDate/ UpdatedBy updated into database all
fields.
Session Log In timeout Maximum 15 mins from log
in time.
B. Functional Requirement
List of Features/ Function of system:
• Login
• Document List
• Search Document
• Document History
• View Document
• Download Document
• Audit Log

4
 ECM Admin Portal BRD

1. Login:

Step 1: Access URL on browse => Show login page of ECM Document Portal.

Step 2: Click button [Login with AD].

Step 2.2: System will transfer to AD login website.
• If user login AD success => move to step 3.
• If user login AD fail => End process.
Step 3: System will check the value of Users.Status on database:

Value Status Action Note

1 Active Show message:
“Log in
Successfully” and
move to step 4.
2 Locked Show message:
“Account is locked”.
3 Archived/ Deleted/ Show message:
Not found “Account not
found”.

5
 ECM Admin Portal BRD

Step 4: System will insert success into ECM database as follow detail:

Table Field Name Value Insert Note

SignInLogs UserId Username that AD
system response
when log in success
SignInLogs LogInDate Time that user Log
In success by AD
Users LatestLogInDate Time that user Log
In success by AD
End process.
2. Document List

When user log in success => this page is the default page.
The page will display two sections:
• A search box that allows the user to input the Application ID.
• An empty document list.
3. Search Document
To search, on [Document List], use can input application id on tab [Search].

6
 ECM Admin Portal BRD

Data Field:
Field Data source Data type Note
Application ID AppDocuments.AppId Hyperlink On-click:
[Document
History]
Document Show value of Hyperlink On-click:
Name MasterDocuments.MasterDocName [View
based on FK MasterDocuments.Id match Document]
with the value of
AppDocuments.MasterDocumentId
Document AppDocuments.DocumentIndex String
Index
Download Display “Download” Hyperlink On-click:
[Download
Document]
Audit Log Display “Audit Log” Hyperlink On-click:
[Audit Log]

4. Document History
To view the document history list, click on the Document ID => open new window on
browser
Mockup:

7
 ECM Admin Portal BRD

Data Field:
Field Data source Data type Note
Document Show the value of Hyperlink On-click:
Name MasterDocuments.MasterDocName where [View
MasterDocuments.Id Document]
matched
AppDocuments.MasterDocumentId and
AppDocuments.Id
matched
AppDocumentsVersions.AppDocumentId
Size Show the value of String
DocumentImages.DocumentSize where
DocumentImages.DocumentIndex
matched
AppDocumentsVersions.DocumentIndex
Extension AppDocumentsVersions.FileExtension String
Type
Uploaded AppDocumentsVersions.UploadedDate String
Date
Uploaded AppDocumentsVersions.UploadedBy String
By

In addition, this page will have a 'Download' button that allows users to select multiple
documents to download as a single file. When downloading, the file name will be the
current app ID. [Download Document]

5. View Document
To view document, click on the Document Name => open in new tab on browser

8
 ECM Admin Portal BRD

Flow:

Step1: User access [Document List], user input application id on tab Search. (Skip this
step if viewing from the application history)
Step2: User choose document need to view and click on the Document Name
Step3: Display document
Note: The document is displayed with a watermark: username - current timestamp
click view document.
Mockup:

Step4: Update log: “ConsumerLogs” Table:

Field Value Insert
ConsumerId ID of User view document
AppDocumentId ID of AppDocument
TransactionId <AS-IS>
- N/A
<TO-BE>
- mô tả requirement
Type Add value 3 (GetDocAPI)
Status Add value:
0 if Fail
1 if Success
RequestLog Request call GetDocAPI
ResponseLog Response call GetDocAPI

6. Download Document
To download document, click on “Download” hyperlink => the document will be
downloaded to the user's device.
Flow:

Step1: User access [Document List], user input application id on tab Search
Step2: User choose document need to download and click on the “Download” hyperlink
Step3: Download the document to the user’s device
Step4: Update Log: “ConsumerLogs” Table
Field Value Insert

9
 ECM Admin Portal BRD

ConsumerId ID of User view document

AppDocumentId ID of AppDocument
TransactionId <AS-IS>
- N/A
<TO-BE>
- mô tả value
Type Add value 1 (DownloadAPI)
Status Add value:
0: Fail
1: Success
RequestLog Request call DownloadAPI
ResponseLog Response call DownloadAPI

7. Audit Log
To view Audit log, click on the “Audit Log” hyperlink => open new window on browser
Mockup:

Data Field:
Field Data source Data type Note
No String Number: 1 to n
User Name Show the value of String
User.Name where
User.Id
matched
ConsumerLogs.ConsumerId
Action Done ConsumerLogs.Type String Show based on list:
1: DownloadAPI

10
 ECM Admin Portal BRD

2: UploadAPI
3: GetDocAPI
4: APS
Action Date ConsumerLogs. CreatedDate String

11