Skip to main content

Notes

List View Notes

PROCESS NAME

Asset Management (AM01)

FEATURE / USER STORY NAME

List View of Notes in Plant Profile (AM01US02/Medium)

DESCRIPTION

Enable back-office users to view a list of all notes 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 a list of notes, including the note name, content, and color. Each note will be displayed in the order it was added, allowing for easy access and review.

ACTORS

Back-office user

USER STORY

As a back-office user,
I want to view a list of all notes associated with a unit in the Notes sub-tab,
so that I can efficiently access and review all notes related to the plant.

STORYTELLING

Maria, a back-office user at Samoa Water Authority, is tasked with reviewing the notes related to a specific plant. Navigating through SMART360, she selects the plant, opens the detailed view, and clicks on the “Profile” tab. In the Notes sub-tab, Maria sees a list of all notes, each with its name, content, and the selected color. This feature allows her to quickly review all the relevant notes without needing to open each one individually.

GOALS

  • Display a list of all notes associated with a Plant under the Notes sub-tab.

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 Notes sub-tab.

  6. Views the list of all notes associated with the unit, including the note name, note content, and color.

BUSINESS RULES

  • Only authorized users with appropriate permissions can access the Notes sub-tab.

  • The Notes sub-tab must display:

    • A list view of all notes associated with the plant.

    • Each note must display:

      • Note Name.

      • Note Content.

      • Note Color (as selected when the note was added).

    • Notes should be displayed in the order they were added, with the most recently added note at the top.

  • Pagination should be available for a large number of notes, ensuring efficient browsing.

  • If no notes are available, a message “No notes available” should be displayed.

SAMPLE DATA

  • Note 1:

    • Note Name: “Unit Inspection”

    • Note Content: “Inspection completed on 01 Jan 2024.”

    • Note Color: Green

  • Note 2:

    • Note Name: “Maintenance Required”

    • Note Content: “Maintenance needed for pump replacement.”

    • Note Color: Red

ACCEPTANCE CRITERIA

  1. Notes Display:

    • The Notes sub-tab should display all notes associated with the unit, showing the note name, note content, and the selected color for each note.

  2. Ordering:

    • Notes should be displayed in the order they were added, with the most recently added note at the top.

  3. Empty State:

    • If no notes are available, the message “No notes available” should be displayed.

  4. Pagination:

    • The Notes sub-tab should support pagination for a large number of notes to ensure efficient browsing.

  5. Color Display:

    • The selected color for each note should be reflected in the display, allowing visual distinction between different notes.

  6. Authorization:

    • Only authorized users should be able to view the Notes sub-tab. Unauthorized users should not be able to access this feature.

Add Notes

PROCESS NAME

Asset Management (AM01)

FEATURE / USER STORY NAME

Add Note in Plant Profile (AM01US05/Critical)

DESCRIPTION

Enable back-office users to add notes for a unit within the Notes sub-tab under the Profile tab. When users click the Add Notes button, a form opens where they can enter the note's name, content, and select a color for the note. Upon submitting, the note is saved and displayed in the Notes sub-tab.

ACTORS

Back-office user

USER STORY

  • As a back-office user,
    I want to add a note in the Notes sub-tab by filling out a form with the note's name, content, and a selected color,
    so that I can store and organize important information related to the plant in a visual and accessible way.

STORYTELLING

Maria, a back-office user at Samoa Water Authority, needs to add a note for a particular unit to record a maintenance observation. She navigates to the Profile tab and switches to the Notes sub-tab. She clicks the Add Notes button, and a form appears, where she enters the note's name, content, and selects a color for the note. After clicking Submit, the note is saved and displayed in the Notes sub-tab, where she can view it along with other notes for the unit.

GOALS

  • Allow back-office users to add notes with a name, content, and color selection..

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 Notes sub-tab.

  6. Clicks on the Add Notes button.

  7. Fills out the form with the note name, note content, and selects a color.

  8. Clicks Submit to save the note.

  9. The new note is displayed in the Notes sub-tab.

BUSINESS RULES

  1. Only authorized users can access the Add Note feature in the Notes sub-tab.

  2. The Add Notes form must include fields for the note name, note content, and a color picker for selecting the note’s color.

  3. The note name must be a non-empty text field with a maximum length of 100 characters.

  4. The note content must be a non-empty text area with a maximum of 500 characters.

  5. The color picker must allow users to select a color from a predefined set of colors.

  6. The note must be saved and displayed in the Notes sub-tab once the user clicks Submit.

  7. If any required field is left blank (note name or content), the user should see an error message: “Both note name and content are required.”

  8. The note will be displayed with its name, content, and the selected color in the Notes sub-tab.

  9. The Add Notes button is available only to authorized users with the appropriate permissions.

SAMPLE DATA

  • Note Section:

    • Note Name: “Maintenance Observation”

    • Note Content: “The pump was inspected and requires further review in two weeks.”

    • Color: Yellow

ACCEPTANCE CRITERIA

  1. Success Message:

    1. A success message “Note added successfully” should be displayed after the user clicks Submit and the note is successfully saved.

  2. Notes Display:

    1. The added note should appear in the list view of the Notes sub-tab with the following details:

      1. Note Name

      2. Note Content

      3. The color selected for the note should be applied visually in the list view.

  3. Validation for Required Fields:

    1. If the user attempts to submit the form without filling in the Note Name or Note Content, an error message “Both note name and content are required” should be displayed.

  4. Color Selection:

    1. The selected color should be applied to the note when viewed in the Notes sub-tab, matching the color chosen during note creation.

  5. Accessibility:

    1. Only authorized users with appropriate permissions should be able to add notes. Unauthorized users should not see or access the Add Notes button or the Notes sub-tab.

No Comments
Back to top