diff --git a/.diagrams/architecture/announcements/states.mermaid.png b/.diagrams/architecture/announcements/states.mermaid.png deleted file mode 100644 index 2ab83db34..000000000 Binary files a/.diagrams/architecture/announcements/states.mermaid.png and /dev/null differ diff --git a/.diagrams/architecture/announcements/states.mermaid.svg b/.diagrams/architecture/announcements/states.mermaid.svg new file mode 100644 index 000000000..22c89b283 --- /dev/null +++ b/.diagrams/architecture/announcements/states.mermaid.svg @@ -0,0 +1,3 @@ + + +

draft

published

expired

archived

Delete after 90 days

Save as

Save as

Save as

Save as

Save as

On
expires_on
date

Archive

Archive

Archive

Scheduled
task

Scheduled
task

Unpublish

 \ No newline at end of file diff --git a/.diagrams/architecture/data-flow-diagrams/pay-transparency-admin-portal-L1.mermaid b/.diagrams/architecture/data-flow-diagrams/pay-transparency-admin-portal-L1.mermaid index 061c78db3..6585952cb 100644 --- a/.diagrams/architecture/data-flow-diagrams/pay-transparency-admin-portal-L1.mermaid +++ b/.diagrams/architecture/data-flow-diagrams/pay-transparency-admin-portal-L1.mermaid @@ -2,13 +2,13 @@ title: Pay Transparency Admin Portal - Logical Data Flow Diagram (L1) --- flowchart LR - AdminMgr[Admin Manager] -->|User and roles| ChangePrivsProcess((Change user\nprivilege)) - AdminMgr --> |Username and\nemail address| InviteProcess((Invite user)) + AdminMgr[Admin Manager] -->|User and roles| ChangePrivsProcess((Change user
privilege)) + AdminMgr --> |Username and
email address| InviteProcess((Invite user)) InviteProcess --> |Invitation email| EmailService[Common hosted email service] EmailService -->|Invitation email| AdminUser - InviteProcess -->|Username and\email address| AdminUserOnboarding[/Admin user onboarding/] - AdminUser --> |User info| AcceptInviteProcess((Accept\ninvitation)) - AdminUser -->|isLocked|LockUnlockReportProcess((Lock or unlock\nreport)) + InviteProcess -->|Username and
email address| AdminUserOnboarding[/Admin user onboarding/] + AdminUser --> |User info| AcceptInviteProcess((Accept
invitation)) + AdminUser -->|isLocked|LockUnlockReportProcess((Lock or unlock
report)) LockUnlockReportProcess -->|isLocked| PayTransparencyReports[/Pay transparency reports/] AcceptInviteProcess -->|Invitation status| AdminUserOnboarding AcceptInviteProcess -->|User info| AdminUserTable[/Admin users/] @@ -16,10 +16,10 @@ flowchart LR QueryProcess((Query report)) -->|Published reports| AdminUser(Admin User) PayTransparencyReports -->|Pay transparency report 'body'| QueryProcess AdminUser -->|Credentials| AuthenticateProcess - AuthenticateProcess((Authenticate\nIDIR user)) --> |Access token|AdminUser - AdminUser[Admin User] -->|Report ID| DocGenProcess((Generate\ndocument)) + AuthenticateProcess((Authenticate
IDIR user)) --> |Access token|AdminUser + AdminUser[Admin User] -->|Report ID| DocGenProcess((Generate
document)) DocGenProcess -->|PDF report| AdminUser - Announcements[/Announcements/] <--> |Announcement|ManageAnnouncementsProcess((Manage\nannouncement)) + Announcements[/Announcements/] <--> |Announcement|ManageAnnouncementsProcess((Manage
announcement)) AnnouncementResources[/Announcement resources/] <--> |Link or attachment|ManageAnnouncementsProcess AdminUser -->|Announcement and resource| ManageAnnouncementsProcess diff --git a/.diagrams/architecture/data-flow-diagrams/pay-transparency-context-L0.mermaid b/.diagrams/architecture/data-flow-diagrams/pay-transparency-context-L0.mermaid index e456870ab..833a72331 100644 --- a/.diagrams/architecture/data-flow-diagrams/pay-transparency-context-L0.mermaid +++ b/.diagrams/architecture/data-flow-diagrams/pay-transparency-context-L0.mermaid @@ -8,7 +8,7 @@ flowchart LR AdminUser -->|Announcement| PT KeyCloak -->|OIDC discovery document|PT BCeIDBusiness[BusinessBCeID] -->|Company information|PT - PT --> |Email recipients,\ntitle, and body| EmailService[Common hosted\nemail service] + PT --> |Email recipients,
title, and body| EmailService[Common hosted
email service] PT -->|Pay transparency report| Org Org -->|Login credentials|BCeIDBusiness KeyCloak --> |Backend tokens|PT diff --git a/.diagrams/architecture/data-flow-diagrams/pay-transparency-reporting-tool-L1.mermaid b/.diagrams/architecture/data-flow-diagrams/pay-transparency-reporting-tool-L1.mermaid index 0c94c8d8b..2c6483055 100644 --- a/.diagrams/architecture/data-flow-diagrams/pay-transparency-reporting-tool-L1.mermaid +++ b/.diagrams/architecture/data-flow-diagrams/pay-transparency-reporting-tool-L1.mermaid @@ -2,18 +2,18 @@ title: Pay Transparency Reporting Tool - Logical Data Flow Diagram (L1) --- flowchart LR - Org["Organization\nUser"] -->|"Employee pay data"| SubmissionProcess(("Submit data")) - SubmissionProcess --> |"Employee pay data"| ValidateAndCalculateProcess(("Validate\nemployee pay data\n and calculate\nstatistics")) + Org["Organization
User"] -->|"Employee pay data"| SubmissionProcess(("Submit data")) + SubmissionProcess --> |"Employee pay data"| ValidateAndCalculateProcess(("Validate
employee pay data
and calculate
statistics")) ValidateAndCalculateProcess --> |Pay statistics| CalculatedData[/"Calculated data"/] ValidateAndCalculateProcess --> |Pay transparency report 'body'| Report[/"Pay transparency reports"/] ValidateAndCalculateProcess --> |"Validation errors"| SubmissionProcess Org -->|"Report ID"| PublishProcess(("Publish report")) PublishProcess --> |Report status| Report - Org --> |Report ID| DocGenProcess(("Generate\ndocument")) + Org --> |Report ID| DocGenProcess(("Generate
document")) DocGenProcess --> |HTML or PDF report| Org - Org --> |Credentials|AuthenticateProcess((Authenticate\nbusiness BCeID\nuser)) + Org --> |Credentials|AuthenticateProcess((Authenticate
business BCeID
user)) AuthenticateProcess --> |Access token|Org - PublishProcess -->|Report ID| HistoryProcess((Save report\nchange history)) - HistoryProcess --> |Pay statistics| CalculatedDataHistory[/"Calculated data\n history"/] - HistoryProcess --> |Pay transparency report 'body'| ReportHistory[/"Pay transparency\nreport history"/] - Backup(("Backup\ndata")) -->|Pay transparency data| ObjectStore[Object store] \ No newline at end of file + PublishProcess -->|Report ID| HistoryProcess((Save report
change history)) + HistoryProcess --> |Pay statistics| CalculatedDataHistory[/"Calculated data
history"/] + HistoryProcess --> |Pay transparency report 'body'| ReportHistory[/"Pay transparency
report history"/] + Backup(("Backup
data")) -->|Pay transparency data| ObjectStore[Object store] \ No newline at end of file