Ttahub 3371

docs/sequence-diagrams/access.puml

@@ -0,0 +1,24 @@
+@startuml
+
+title "TTA Hub"
+
+actor User as TTAProvider
+participant "HSES\n Login" as HSESLogin
+participant "TTA Hub\n frontend" as TTAHUBF
+
+group Access: Accessing TTA Hub pages
+    autonumber
+    TTAProvider -> HSESLogin : Enter credentials
+    TTAProvider <- HSESLogin : Provide access token
+    else
+    TTAProvider <-- HSESLogin : Invalid credentials
+end
+
+group Logout: Logging out of TTA Hub pages
+    autonumber
+    TTAProvider -> TTAHUBF: Click profile icon
+    TTAProvider -> TTAHUBF: Click Logout
+    TTAProvider <- HSESLogin: Login Screen displayed
+end
+
+@enduml

docs/sequence-diagrams/account-management.puml

@@ -0,0 +1,21 @@
+@startuml
+
+title "TTA Hub Admin"
+
+actor TTAUSER as TU
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group Account: Account Management
+    autonumber 1
+    TU -> FRONTEND : View Landing Page
+    TU -> FRONTEND : Navigate to User\Account Management
+    FRONTEND <- BACKEND : Display Account Management settings for user
+    TU --> FRONTEND : Create A Group
+    FRONTEND <-- BACKEND : Display My Groups\Create Group page
+    TU --> FRONTEND : Create Group Name, Select Recipients, Set Privacy, Co-Owners, Region
+    FRONTEND <-- BACKEND : Display User\Account Management page with new group
+    TU --> FRONTEND : Send Verification Mail
+end
+
+@enduml

docs/sequence-diagrams/activity-reports.puml

@@ -0,0 +1,78 @@
+@startuml
+
+title "TTA Hub Activity Reports"
+
+actor User as TTAProvider
+participant "TTA Hub\n frontend" as TTAHUBF
+participant "TTA Hub\n backend" as TTAHUBB
+
+group View: Activity Reports
+    autonumber 1
+    TTAProvider -> TTAHUBF : View landing page
+    TTAProvider -> TTAHUBF : Navigate to Activity Reports
+    TTAHUBF -> TTAHUBB : Request Page Data
+    TTAHUBF <- TTAHUBB : Send display results
+    TTAProvider -> TTAHUBF : [Optional] Filter results
+    TTAHUBF -> TTAHUBB : send filter query
+    TTAHUBF <- TTAHUBB : send display results
+    TTAProvider -> TTAHUBF : [Optional] select spefic report
+    TTAHUBF -> TTAHUBB : query specific report
+    TTAHUBF <- TTAHUBB : send report results
+end
+
+group Edit: Edit Activity Reports
+    autonumber 1
+    TTAProvider -> TTAHUBF : Navigate to Activity Reports
+    TTAProvider -> TTAHUBF : Select Report ID
+    TTAHUBF -> TTAHUBB : Request selected report
+    TTAHUBF <- TTAHUBB : Send Report Data
+    TTAProvider -> TTAHUBF : Make changes as needed
+    TTAProvider -> TTAHUBF : [Optional] Save Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : [Optional] Submit for approval
+    TTAHUBF -> TTAHUBB : Send completed report for approval
+    TTAHUBF <- TTAHUBB : Accept Submission
+    TTAHUBF -> TTAHUBF : Dispaly Activity Reports page
+end
+
+group Create: Create Activity Report
+    autonumber 1
+    TTAProvider -> TTAHUBF : Navigate to Activity Reports
+    TTAProvider -> TTAHUBF : Click New Activity Report button
+    TTAHUBF -> TTAHUBF : Display New Report Form
+    TTAProvider -> TTAHUBF : Complete Activity Summary
+    TTAProvider -> TTAHUBF : [Optional] Save As Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : Save and Continue
+    TTAHUBF -> TTAHUBF : Display Goals and Objectives
+    TTAProvider -> TTAHUBF : Create/Select Goals and Objectives
+    TTAProvider -> TTAHUBF : [Optional] Save As Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : Save and Continue
+    TTAHUBF -> TTAHUBF : Display Supporting Attachments 
+    TTAProvider -> TTAHUBF : [Optional] Add supporting attachments
+    TTAProvider -> TTAHUBF : [Optional] Save As Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : Save and Continue
+    TTAHUBF -> TTAHUBF : Display Next Steps
+    TTAProvider -> TTAHUBF : Complete Next Steps
+    TTAProvider -> TTAHUBF : [Optional] Save As Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : Save and Continue
+    TTAHUBF -> TTAHUBF : Display Review and Submit
+    TTAProvider -> TTAHUBF : Complete Submit options
+    TTAProvider -> TTAHUBF : [Optional] Save As Draft
+    TTAHUBF -> TTAHUBB : Send draft report
+    TTAHUBF <- TTAHUBB : Acknowledge Draft report saved
+    TTAProvider -> TTAHUBF : Save and Submit
+    TTAHUBF -> TTAHUBB : Send completed report for approval
+    TTAHUBF <- TTAHUBB : Accept Submission
+    TTAHUBF -> TTAHUBF : Dispaly Activity Reports page
+end
+
+@enduml

docs/sequence-diagrams/admin.puml

@@ -0,0 +1,38 @@
+@startuml
+
+title "TTA Hub Admin"
+
+actor ADMIN as AD
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group Administration: Admin Options
+    autonumber 1
+    AD -> FRONTEND : View landing page
+    AD -> FRONTEND : Navigate to User\Admin
+    FRONTEND <- BACKEND : Display Admin Page
+    AD --> FRONTEND : Select CDI Grants
+    FRONTEND <-- BACKEND : Display CDI Grant page
+    AD --> FRONTEND : Select Courses
+    FRONTEND <-- BACKEND : Display Course page
+    AD --> FRONTEND : Select Diag
+    FRONTEND <-- BACKEND : Display Diag page
+    AD --> FRONTEND : Select Goals
+    FRONTEND <-- BACKEND : Display Goals page
+    AD --> FRONTEND : Select Feature Flags
+    FRONTEND <-- BACKEND : Display Feature Flags page
+    AD --> FRONTEND : Select National Centers
+    FRONTEND <-- BACKEND : Display National Centers page
+    AD --> FRONTEND : Select Site Alerts
+    FRONTEND <-- BACKEND : Display Site Alerts page
+    AD --> FRONTEND : Select Training Reports
+    FRONTEND <-- BACKEND : Display Training Reports page
+    AD --> FRONTEND : Select Users
+    FRONTEND <-- BACKEND : Display Users page
+    AD --> FRONTEND : Select SS
+    FRONTEND <-- BACKEND : Display Sheet List page
+    AD --> FRONTEND : Select Redis info
+    FRONTEND <-- BACKEND : Display Redis info page
+end
+
+@enduml

docs/sequence-diagrams/notifications.puml

@@ -0,0 +1,16 @@
+@startuml
+
+title "TTA Hub Notifications"
+
+actor TTAUSER as TU
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group View: Notifications
+    autonumber 1
+    TU -> FRONTEND : View Landing Pages
+    TU -> FRONTEND : Navigate to User\Notifications
+    FRONTEND <- BACKEND : Display Notifications page
+end
+
+@enduml

docs/sequence-diagrams/qa-dashboard.puml

@@ -0,0 +1,15 @@
+@startuml
+
+title "TTA QA Dashboard"
+
+actor CREATOR as CR
+actor COLLABORATOR as CL
+actor REGIONALPOC as RPOC
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group View : Quality Assurance Dashboard
+' not yet implemented
+end
+
+@enduml

docs/sequence-diagrams/regional-dashboard.puml

@@ -0,0 +1,42 @@
+@startuml
+
+title "TTA Regional Dashboard"
+
+actor CREATOR as CR
+actor COLLABORATOR as CL
+actor REGIONALPOC as RPOC
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group View : Regional Dashboard
+    autonumber 1
+    CR -> FRONTEND : View Landing Pages
+    CR -> FRONTEND : Navigate to Regional Dashboard
+    FRONTEND <- BACKEND: Display Regional Dashboard
+    CR --> FRONTEND : Adjust Filters
+    FRONTEND <-- BACKEND : Dipslay Regional Dashboard filter results
+    CR --> FRONTEND : Click What does each status mean link
+    FRONTEND <-- FRONTEND : Display help popup
+    CR --> FRONTEND : Toggle Reason Table/Graph link
+    FRONTEND <-- FRONTEND : Display selected view
+    CR --> FRONTEND : Save Screenshot
+    FRONTEND <-- FRONTEND : Cause browser to download screenshot
+    CR --> FRONTEND : Toggle TTA Hours Table/Graph link
+    FRONTEND <-- FRONTEND : Display selected view
+    CR --> FRONTEND : Toggle Number of Reports High/Low
+    FRONTEND <-- FRONTEND : Display selected sort
+    CR --> FRONTEND : Number of Reports Save Screenshot
+    FRONTEND <-- FRONTEND : Cause browser to download screenshot
+    CR --> FRONTEND : Toggle Number of Reports Table/Graph link
+    FRONTEND <-- FRONTEND : Display selected view
+    CR --> FRONTEND : Export reports
+    FRONTEND <-- FRONTEND : Cause browser to download csv reports
+    CR --> FRONTEND : Click Report ID
+    FRONTEND <-- BACKEND : Dispaly Activity Report page
+    CR --> FRONTEND : Copy URL Link
+    FRONTEND <-- FRONTEND : Copy URL link to clipboard
+    CR --> FRONTEND : Print to PDF
+    FRONTEND <-- FRONTEND : Cause Print dialog to open
+end
+
+@enduml

docs/sequence-diagrams/regional-goal-dashboard.puml

@@ -0,0 +1,29 @@
+@startuml
+
+title "TTA Regional Goal Dashboard"
+
+actor CREATOR as CR
+actor COLLABORATOR as CL
+actor REGIONALPOC as RPOC
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group View : Regional Goal Dashboard
+    autonumber 1
+    CR -> FRONTEND : View Landing Pages
+    CR -> FRONTEND : Navigate to Regional Goal Dashboard
+    FRONTEND <- BACKEND: Display Regional Goal Dashboard
+    CR --> FRONTEND : Adjust Filters
+    FRONTEND <-- BACKEND : Dipslay Regional Goal Dashboard filter results
+    CR --> FRONTEND : Click What does each status mean link
+    FRONTEND <-- FRONTEND : Display help popup
+    CR --> FRONTEND : Toggle Status Table/Graph link
+    FRONTEND <-- FRONTEND : Display selected view
+    CR --> FRONTEND : Save Screenshot
+    FRONTEND <-- FRONTEND : Cause browser to download screenshot
+    CR --> FRONTEND : Toggle TTA Hours Table/Graph link
+    FRONTEND <-- FRONTEND : Display selected view
+end
+
+
+@enduml

docs/sequence-diagrams/resource-dashboard.puml

@@ -0,0 +1,29 @@
+@startuml
+
+title "TTA Resource Dashboard"
+
+actor CREATOR as CR
+actor COLLABORATOR as CL
+actor REGIONALPOC as RPOC
+participant "TTA Hub\n frontend" as FRONTEND
+participant "TTA Hub\n backend" as BACKEND
+
+group View : Resource Dashboard
+    autonumber 1
+    CR -> FRONTEND : View Landing Pages
+    CR -> FRONTEND : Navigate to Resource Dashboard
+    FRONTEND <- BACKEND: Display Resource Dashboard
+    CR --> FRONTEND : Adjust Filters
+    FRONTEND <-- BACKEND : Dipslay Resource Dashboard filter results
+    CR --> FRONTEND : Export reports
+    FRONTEND <-- FRONTEND : Cause browser to download csv reports
+    CR --> FRONTEND : Select report ID link
+    FRONTEND <-- BACKEND : Display TTA Activity Report
+    CR --> FRONTEND : Copy URL Link
+    FRONTEND <-- FRONTEND : Copy URL link to clipboard
+    CR --> FRONTEND : Print to PDF
+    FRONTEND <-- FRONTEND : Cause Print dialog to open
+end
+
+
+@enduml