Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Findings Report for all organizations in Crisis Room #3881

Open
4 tasks
Rieven opened this issue Nov 25, 2024 · 3 comments · May be fixed by #4007
Open
4 tasks

Findings Report for all organizations in Crisis Room #3881

Rieven opened this issue Nov 25, 2024 · 3 comments · May be fixed by #4007
Assignees

Comments

@Rieven
Copy link
Contributor

Rieven commented Nov 25, 2024

About this feature

Detailed description

On the Crisis Room page for all organizations we want to create an overview with all the identified findings for all the organizations of the member. This overview should look like the table in the current Findings Report.

In the feature we want to create something like a Dashboard, so we'll start working towards that functionality with this ticket.

Feature benefit/User story

As a user, I want to see all Findings for all my organizations in one overview, so that I can easily see what's happening with the assets across all my organizations.

Specifications

The implementation should include…

  • Aggregate Findings Report
  • Default ReportRecipe for all organizations (Aggregate Findings Report, daily, for all OOI's with L1 and higher)
  • Table on the Crisis Room page with all the Findings for all organizations
  • Edit default ReportRecipe for all organizations

Additional information

Any additional information, considerations, or context that might be helpful for understanding or evaluating the feature request.

Design

Figma link

The design implementation file for the current V1 MVP version of an aggregate findings report: https://www.figma.com/design/n04sOVtUJP9UAXICSq8zQu/%E2%9C%85-KAT-%7C-Approved-%7C-Reports-Content?node-id=2421-6827&t=JjvBXz1GnopnW88u-1

The design implementation file for MVP findings on the crisis room on 'all organisations' level:
https://www.figma.com/design/jDLNUhJ5GeQ4uoPagn2qrs/%E2%9C%85-KAT-%7C-Approved-%7C-Dashboard?node-id=2355-10110&t=yHxkPleycbgfnu16-1

Implementation

Possible solution

  • Create an Aggregate Findings Report
  • Create a default ReportRecipe for every (new) organization
    • Aggregate Report with report type Findings Report
    • Daily
    • Objects with L1 and higher
  • Collect the latest Report that has been generated by this ReportRecipe
  • Show them on the Crisis Room page for all organizations
  • Make it possible to edit the ReportRecipe for all organizations at the same time

Table should look like this:

  • Organization A (can be expanded)
    --- Table with all identified Findings for this organization
  • Organization B (can be expanded)
    --- Table with all identified Findings for this organization
  • Organization C (can be expanded)
    --- Table with all identified Findings for this organization

Steps:

  1. Create dashboard database table @Rieven
  2. When a new organization is created: @Rieven
    2.1 Create a ReportRecipe (and schedule) for this organization.
    (with Findings Report - All ewe_types - L1 and higher - daily - aggregate report)
    2.2 Add the organization and the ReportRecipe id to the dashboard database
  3. Add Findings Report to the Aggregate Report @madelondohmen
  4. Each day get the last report generated by ReportRecipe with the id that is in the database. Do this for each organization.
  5. Copy the HTML of the Findings Report table. @madelondohmen
  6. Add Findings Report to Aggregate Report. @madelondohmen
  7. For each retrieved report, insert the organizations into a table and when you open it, show the HTML table from the Findings Report for that organization. @madelondohmen

Alternatives considered

We thought about re-using the Findings page, but then for all organizations. But this is way to slow to use. We've to deal with a lot of API-calls, which isn't good for the performance. That's why we'll create a ReportRecipe to show the Findings.

@Rieven Rieven added this to KAT Nov 25, 2024
@github-project-automation github-project-automation bot moved this to Incoming features / Need assessment in KAT Nov 25, 2024
@Rieven
Copy link
Contributor Author

Rieven commented Nov 25, 2024

The order to show the data can be as follows:

DO WE HAVE TO SHOW ALL OBSERVED AT?

  • Organization A
    -- 25 nov - Findings Report for 5 objects (L2 objects) aggreagetd to 1 report)
    -- 26 nov - Findings Report for 4 objects

  • Organization B
    -- 25 nov - Findings Report for 3 objects

OR the order is:

  • Organization A
    -- 25 nov
    ----- mispo.es - Findings Report (all findings found for mispo.es)
    ----- minvws.nl - Finding Report (all findings for minvws.nl)

  • Organization B
    -- 25 nov
    ----- mispo.es - Findings Report (all findings found for mispo.es)
    ----- minvws.nl - Finding Report (all findings for minvws.nl)

@zcrt
Copy link
Contributor

zcrt commented Nov 25, 2024

The first stage is just the usual single-org findings-page with its search and filter options, but for all organisations at once; similar to how the all-tasks page is now built. (No fancy dashboards or reports needed for now, but indeed nice to have in the future)

By the way, Assets to scan should be the OOI with L1 or higher that are 'declared'/'submitted by the external DB boefje'. But that does not matter as much as the usual findings-page filters apply, so it can be changed by the end-user

@madelondohmen madelondohmen moved this from Incoming features / Need assessment to In Progress in KAT Nov 26, 2024
@zcrt
Copy link
Contributor

zcrt commented Dec 2, 2024

As disscussed with @underdarknl: a vanilla implementation querying all organisations for all findings may cause too much overhead on some systems. Therefore the MVP approach will be to only show the results after applying a filter (e.g. only show all critical findings, or all findings matching a specific string)

@madelondohmen madelondohmen changed the title Findings Report voor all orgs with default recipe Findings Report for all organizations in Crisis Room Dec 3, 2024
@madelondohmen madelondohmen linked a pull request Jan 7, 2025 that will close this issue
9 tasks
@madelondohmen madelondohmen moved this from In Progress to Review in KAT Jan 9, 2025
@Rieven Rieven moved this from Review to Blocked in KAT Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Blocked
Development

Successfully merging a pull request may close this issue.

6 participants