Skip to main content

View Documents

Documents
List View Documents

PROCESS NAME

Asset Management (AM01)

FEATURE / USER STORY NAME

List View of Documents in Plant Profile (AM01US02/Critical)

DESCRIPTION

Enable back-office users to view documents associated with a plant’s profile in the SMART360 platform. The feature will include a sub-tab under the "Profile" tab where users can view the documents related to the plant, such as reports, manuals, inspection certificates, etc. The feature will display a list of document names for easy identification and management.

ACTORS

Back-office user

USER STORY

  • As a back-office user,
    I want to view documents of a plant’s profile under the "Documents" sub-tab,
    so that I can manage the associated documents effectively.

STORYTELLING

Maria, a back-office user at Samoa Water Authority, is tasked with verifying the compliance documents for a plant. Navigating through SMART360, she selects the plant, opens the detailed view, and clicks on the “Profile” tab. Under the “Documents” sub-tab, she sees a list of all the documents associated with the plant, such as inspection reports, maintenance logs, and certification forms. She can easily identify the documents by their names and access them for further action. This feature allows Maria to efficiently manage unit documentation without searching through external systems.

GOALS

  • Enable back-office users to view all documents associated with a plant’s profile.

PROCESS FLOW DIAGRAM

 

 

MAJOR STEPS INVOLVED

  1. Back-office user logs into SMART360.

  2. Navigates to the Asset Module and selects the plant of interest.

  3. Clicks on the Eye icon to view the plant details.

  4. Clicks on the Profile tab.

  5. Switches to the Documents sub-tab.

  6. Views the list of documents associated with the unit by document name.

BUSINESS RULES

  1. Only authorized users can access the detailed view of plants and the “Documents” sub-tab.

  2. The sub-tab must display:

    • A list of document names for the plant.

  3. The document list must adhere to the following specifications:

    • Supported formats: PDF, DOCX, XLSX, PNG, JPEG.

    • Maximum file size: 50 MB per document.

  4. The document list must support pagination for efficient browsing when there are multiple documents.

  5. Error messages:

    • "No documents available" if no documents are associated with the unit.

    • "Unable to load documents" if the documents fail to display.

  6. The Documents sub-tab must be visible only to authorized users with proper permissions.

SAMPLE DATA

  • Document Section:

    • Document Name: “Unit_Maintenance_Report.pdf”

    • Document Name: “Unit_Compliance_Certificate.docx”

    • Document Name: “Unit_Inspection_Log.xlsx”

ACCEPTANCE CRITERIA

  1. All documents associated with the unit are displayed in a list format under the Documents sub-tab.

  2. The list should only show document names.

  3. Pagination works smoothly when a large number of documents are uploaded.

  4. Proper error messages are displayed if:

    • No documents are available.

    • Documents fail to load.

  5. The Documents sub-tab is accessible only to authorized users with appropriate permissions.

View Documents

PROCESS NAME

Asset Management

FEATURE / USER STORY NAME

View Document in Plant Profile

DESCRIPTION

Enable back-office users to view a document in full screen by clicking on the view icon of a particular document in the Documents sub-tab. The feature will open a document viewer popup that allows the user to scroll through and view the document without downloading it.

ACTORS

Back-office user

USER STORY

  • As a back-office user,
    I want to view a document in full screen when I click the view icon,
    so that I can read or verify the content of the document without downloading it.

STORYTELLING

Maria, a back-office user at Samoa Water Authority, is tasked with verifying compliance documents for a unit. After navigating to the Profile tab of the plant, she sees a list of documents in the Documents sub-tab. She clicks the view icon next to the document “Unit_Maintenance_Report.pdf.” A document viewer popup appears on her screen, displaying the full document. Maria can now scroll through the pages of the document, read the content, and verify the details without downloading it or navigating away from the platform.

GOALS

  • Allow back-office users to view the full content of a document without downloading it.

PROCESS FLOW DIAGRAM

 

 

MAJOR STEPS INVOLVED

  1. Back-office user logs into SMART360.

  2. Navigates to the Asset Module and selects the plant of interest.

  3. Clicks on the Eye icon to open the detailed view of the plant.

  4. Clicks on the Profile tab.

  5. Switches to the Documents sub-tab.

  6. Clicks on the view icon next to a document name.

  7. A document viewer popup appears displaying the document content.

  8. User scrolls through the document to read all pages.

  9. User closes the document viewer to return to the document list.

BUSINESS RULES

  1. Only authorized users can access the View Document feature in the Documents sub-tab.

  2. Clicking the view icon will open the document in a viewer popup.

  3. The document viewer must display the document in its entirety (without requiring download).

  4. Supported formats for documents:

    • PDF

    • DOCX

    • XLSX

    • PNG

    • JPEG

  5. The document viewer must allow users to:

    • Scroll through the document.

    • Zoom in and out of the document.

  6. Error handling:

    • “Unable to load the document” message if the document fails to load.

    • “No document available” message if the selected document is unavailable.

  7. The popup viewer must be resizable, and users should be able to close it using the “X” button.

  8. The document viewer should maintain the current page view even when zooming in/out.

SAMPLE DATA

  • Document Section:

    • Document Name: “Unit_Maintenance_Report.pdf” (Uploaded on 01 Dec 2024)

    • Document Name: “Unit_Compliance_Certificate.docx” (Uploaded on 25 Nov 2024)

    • Document Name: “Unit_Inspection_Log.xlsx” (Uploaded on 05 Nov 2024)

ACCEPTANCE CRITERIA

  1. When the user clicks the view icon next to a document, the document is opened in a document viewer popup.

  2. The popup viewer allows the user to scroll through the entire document.

  3. The document viewer supports zooming in and out for better readability.

  4. If the document fails to load, the error message “Unable to load the document” is displayed.

  5. If no document is available, the error message “No document available” is displayed.

  6. The View Document feature is accessible only to authorized users with appropriate permissions.

  7. The document viewer popup can be closed by clicking the “X” button in the top-right corner.

Download Documents

PROCESS NAME

Asset Management (AM01)

FEATURE / USER STORY NAME

Download Document from Plant Profile (AM01US04/Critical)

DESCRIPTION

Enable back-office users to download a document from the Documents sub-tab in the Profile tab of a unit. When users click the download button, the document will be downloaded in the original format it was uploaded in, allowing the user to save the document locally on their system.

ACTORS

Back-office user

USER STORY

  • As a back-office user,
    I want to download a document from the Documents sub-tab by clicking the download button,
    so that I can save and view the document offline in its original format.

STORYTELLING

Maria, a back-office user at Samoa Water Authority, is working on verifying compliance documents for a plant. She navigates to the Profile tab and selects the Documents sub-tab. She sees a list of uploaded documents and clicks the download button next to “Unit_Maintenance_Report.pdf.” The document is then downloaded to her local system in the same format as it was uploaded (PDF). Maria can now access the document offline for further review or print it as needed.

GOALS

  • Allow back-office users to download documents in their original format.

PROCESS FLOW DIAGRAM

 

 

MAJOR STEPS INVOLVED

  1. Back-office user logs into SMART360.

  2. Navigates to the Asset Module and selects the plant of interest.

  3. Clicks on the Eye icon to open the detailed view of the plant.

  4. Clicks on the Profile tab.

  5. Switches to the Documents sub-tab.

  6. Clicks on the download button next to the desired document.

  7. The document is downloaded in its original format (e.g., PDF, DOCX).

  8. User verifies the downloaded document on their system.

BUSINESS RULES

  1. Only authorized users can access the Download Document feature in the Documents sub-tab.

  2. Clicking the download button next to a document will initiate the download process.

  3. The document will be downloaded in the original format it was uploaded in (e.g., PDF, DOCX, XLSX, PNG).

  4. The Download Document feature should allow downloading of files up to 50 MB in size.

  5. The downloaded document must remain in the same format as the uploaded file.

  6. If the document fails to download, an error message must be displayed: “Unable to download the document.”

  7. The Download Document feature is available for all document types supported by the system (PDF, DOCX, XLSX, PNG, JPEG, etc.).

  8. The Download Document feature should be accessible only to authorized users based on their role permissions.

SAMPLE DATA

  • Document Section:

    • Document Name: “Unit_Maintenance_Report.pdf”

    • Document Name: “Unit_Compliance_Certificate.docx”

    • Document Name: “Unit_Inspection_Log.xlsx”

ACCEPTANCE CRITERIA

  1. When the user clicks the download button next to a document, the document is downloaded in its original format (PDF, DOCX, XLSX, PNG, etc.).

  2. The document is saved to the user’s local system without any format conversion or corruption.

  3. If the document fails to download, the error message “Unable to download the document” is displayed.

  4. The Download Document feature is accessible only to authorized users with appropriate permissions.

  5. The document is downloaded successfully and can be opened offline in its native application (e.g., PDF viewer for PDF documents).

 

 

No Comments
Back to top