Merge pull request #100293 from agantony/ROX31089-rhacs-docs-main

[RHACS] [Docs] ROX-31089: Docs for CSV Effort for Vulnerability Management views

Author: agantony

_topic_maps/_topic_map.yml

@@ -255,7 +255,7 @@ Topics:
     File: vulnerability-management
   - Name: Viewing and addressing vulnerabilities
     File: common-vuln-management-tasks
-  - Name: Reporting vulnerabilities
+  - Name: Vulnerability reporting
     File: vulnerability-reporting
   - Name: Using the vulnerability management dashboard (deprecated)
     File: vulnerability-management-dashboard

modules/checking-job-status-and-downloading-a-vulnerability-report-in-csv-format.adoc

@@ -0,0 +1,30 @@
+// Module included in the following assemblies:
+//
+// * operating/manage-vulnerabilities/vulnerability-reporting.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="checking-job-status-and-downloading-a-vulnerability-report-in-csv-format_{context}"]
+= Checking job status and downloading a vulnerability report in CSV format
+
+You can check the job status and download a vulnerability report in CSV format when it is ready for download.
+
+[NOTE]
+====
+Vulnerability report generation jobs are purged according to the job retention settings.
+====
+
+.Procedure
+
+. To download a generated report, in the *View-based reports* list, click *Report ready for download*.
+. Optional: Choose the appropriate method to re-organize the view-based vulnerability report list:
+* To filter the list according to the job status, click *Report job status*, and then select one or more job statuses.
++
+The following values are associated with the job status:
++
+** `Waiting`
+** `Preparing`
+** `Report ready for download`
+** `Report failed to generate`
+
+* To sort the list in ascending or descending order according to the date and time the jobs are completed, click the *Completed* column heading.
+* To view only the jobs that you created, set *View only my jobs* to on.

modules/exporting-vulnerability-report-as-a-csv-file.adoc

@@ -0,0 +1,16 @@
+// Module included in the following assemblies:
+//
+// * operating/manage-vulnerabilities/vulnerability-reporting.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="exporting-vulnerability-report-as-a-csv-file_{context}"]
+= Exporting vulnerability report as a CSV file
+
+You can export a vulnerability report according to the custom filters you have applied to organize the vulnerability findings list.
+
+.Procedure
+
+. In the {product-title-short} portal, click *Vulnerability Management* -> *Results*.
+. Click *Create report*, and then select *Export report as CSV*.
+. In the *Export report as CSV* window, click *Generate report*.
+. To check the status and download the report, click *View status in reports table*.

modules/vulnerability-management20-clone-reports.adoc

@@ -10,8 +10,8 @@
 You can make copies of vulnerability report configurations by cloning them. This is useful when you want to reuse report configurations with minor changes, such as reporting vulnerabilities in different deployments or namespaces.
 
 .Procedure
-. In the {product-title-short} web portal, click *Vulnerability Management* -> *Vulnerability Reporting*.
+. In the {product-title-short} portal, click the *Vulnerability Management* -> *Vulnerability Reporting* -> *Report configurations* tab.
 . Locate the report configuration that you want to clone in the list of report configurations.
-. Click *Clone report*.
+. Click the overflow menu, {kebab}, and then click *Clone report*.
 . Make any changes that you want to the report parameters and delivery destinations.
-. Click *Create*.
+. Review the report parameters, and then click *Save*.

modules/vulnerability-management20-creating-report.adoc

@@ -10,19 +10,19 @@
 {product-title-short} guides you through the process of creating a vulnerability management report configuration. This configuration determines the information that will be included in a report job that runs at a scheduled time or that you run on demand.
 
 .Procedure
-. In the {product-title-short} portal, click *Vulnerability Management* -> *Vulnerability Reporting*.
+. In the {product-title-short} portal, click the *Vulnerability Management* -> *Vulnerability Reporting* -> *Report configurations* tab.
 . Click *Create report*.
 . In the *Configure report parameters* page, provide the following information:
 ** *Report name*: Enter a name for your report configuration.
 ** *Report description*: Enter a text describing the report configuration. This is optional.
 ** *CVE severity*: Select the severity of common vulnerabilities and exposures (CVEs) that you want to include in the report configuration.
-** *CVE status*: Select one or more CVE statuses. 
+** *CVE status*: Select one or more CVE statuses.
 +
 The following values are associated with the CVE status:
 +
 *** *Fixable*
 *** *Unfixable*
-** *Image type*: Select one or more image types. 
+** *Image type*: Select one or more image types.
 +
 The following values are associated with image types:
 +
@@ -40,9 +40,9 @@ You can select one or more columns to include in the report configuration.
 *** Select the *Include EPSS probability* checkbox, if you want to include the EPSS probability column in the report configuration.
 *** Select the *Include advisory name and link* checkbox, if you want to include the advisory name and link column in the report configuration.
 ** *Configure collection included*: To configure at least one collection, do any of the following tasks:
-*** Select an existing collection that you want to include. 
+*** Select an existing collection that you want to include.
 +
-To view the collection information, edit the collection, and get a preview of collection results, click *View*. 
+To view the collection information, edit the collection, and get a preview of collection results, click *View*.
 +
 When viewing the collection, entering text in the field searches for collections matching that text string.
 *** To create a new collection, click *Create collection*.

modules/vulnerability-management20-delete-reports.adoc

@@ -10,6 +10,6 @@
 Deleting a report configuration deletes the configuration and any reports that were previously run using this configuration.
 
 .Procedure
-. In the {product-title-short} web portal, click *Vulnerability Management* -> *Vulnerability Reporting*.
+. In the {product-title-short} portal, click the *Vulnerability Management* -> *Vulnerability Reporting* -> *Report configurations* tab.
 . Locate the report configuration that you want to delete in the list of reports.
 . Click the overflow menu, {kebab}, and then select *Delete report*.

modules/vulnerability-management20-download-reports.adoc

@@ -15,14 +15,14 @@ You can only download reports that you have generated; you cannot download repor
 ====
 
 .Procedure
-. In the {product-title-short} web portal, click *Vulnerability Management* -> *Vulnerability Reporting*.
+. In the {product-title-short} portal, click the *Vulnerability Management* -> *Vulnerability Reporting* -> *Report configurations* tab.
 . In the list of report configurations, locate the report configuration that you want to use to create the downloadable report.
-. Generate the vulnerability report by using one of the following methods:
-* To generate the report from the list:
-.. Click the overflow menu, {kebab}, and then select *Generate download*. The *My active job status* column displays the status of your report creation. After the *Processing* status goes away, you can download the report.
-* To generate the report from the report window:
-.. Click the report configuration name to open the configuration detail window.
-.. Click *Actions* and select *Generate download*.
-. To download the report, if you are viewing the list of report configurations, click the report configuration name to open it.
-. Click *All report jobs* from the menu on the header.
-. If the report is completed, click the *Ready for download* link in the *Status* column. The report is in `.csv` format and is compressed into a `.zip` file for download.
+. Choose the appropriate method to generate the vulnerability report:
+* To generate the report from the *Report configurations* tab, complete the following steps:
+.. Click the overflow menu, {kebab}, and then select *Generate download*.
+.. After the report is generated, click the *Ready for download* link in the *My last job status* column. The report is in `.csv` format and is compressed into a `.zip` file for download.
+* To generate the report from the *Configuration details* tab, complete the following steps:
+.. To open the *Configuration details* tab, click the report configuration name.
+.. Click *Actions*, and then select *Generate download*.
+.. Click the *All report jobs* tab from the menu on the header.
+.. After the report is generated, click the *Ready for download* link in the *Status* column. The report is in `.csv` format and is compressed into a `.zip` file for download.

modules/vulnerability-management20-edit-reports.adoc

@@ -10,8 +10,8 @@
 You can edit existing vulnerability report configurations from the list of report configurations, or by selecting an individual report configuration first.
 
 .Procedure
-. In the {product-title-short} web portal, click *Vulnerability Management* -> *Vulnerability Reporting*.
+. In the {product-title-short} portal, click the *Vulnerability Management* -> *Vulnerability Reporting* -> *Report configurations* tab.
 . To edit an existing vulnerability report configuration, complete any of the following actions:
 * Locate the report configuration that you want to edit in the list of report configurations. Click the overflow menu, {kebab}, and then select *Edit report*.
 * Click the report configuration name in the list of report configurations. Then, click *Actions* and select *Edit report*.
-. Make changes to the report configuration and save.
+. Make changes to the report configuration, and then click *Save*.

modules/vulnerability-management20-report-review-create.adoc

@@ -10,5 +10,5 @@
 You can review the details of your vulnerability report configuration before creating it.
 
 .Procedure
-. In the *Review and create* section, you can review the report configuration parameters, delivery destination, email template that is used if you selected email delivery, delivery schedule, and report format. To make any changes, click *Back* to go to the previous section and edit the fields that you want to change.
-. Click *Create* to create the report configuration and save it.
+. In the *Review* section, you can review the report configuration parameters, delivery destination, email template that is used if you selected email delivery, delivery schedule, and report format. To make any changes, click *Back* to go to the previous section and edit the fields that you want to change.
+. To create the report configuration and save it, click *Save*.

modules/vulnerability-management20-retention-settings.adoc

@@ -22,11 +22,10 @@ These settings do not affect the following vulnerability report jobs:
 
 .Procedure
 . In the {product-title-short} web portal, go to *Platform Configuration* -> *System Configuration*. You can configure the following settings for vulnerability report jobs:
-* *Vulnerability report run history retention*: The number of days that a record is kept of vulnerability report jobs that have been run. This setting controls how many days that report jobs are listed in the *All report jobs* tab under *Vulnerability Management* -> *Vulnerability Reporting* when a report configuration is selected. The entire report history after the exclusion date is deleted, with the exception of the following jobs:
+* *Vulnerability report run history retention*: The number of days that a record is kept of vulnerability report jobs that have been run. This setting controls how many days that report jobs are listed in the *Report configurations* tab under *Vulnerability Management* -> *Vulnerability Reporting* when a report configuration is selected. The entire report history after the exclusion date is deleted, with the exception of the following jobs:
 ** Unfinished jobs.
 ** Jobs for which prepared downloadable reports still exist in the system.
 ** The last successful report job for each job type (scheduled email, on-demand email, or download). This ensures users have information about the last run job for each type.
-* *Prepared downloadable vulnerability reports retention days*: The number of days that prepared, on-demand downloadable vulnerability report jobs are available for download on the *All report jobs* tab under *Vulnerability Management* -> *Vulnerability Reporting* when a report configuration is selected.
+* *Prepared downloadable vulnerability reports retention days*: The number of days that prepared, on-demand downloadable vulnerability report jobs are available for download on the *Report configurations* tab under *Vulnerability Management* -> *Vulnerability Reporting* when a report configuration is selected.
 * *Prepared downloadable vulnerability reports limit*: The limit, in MB, of space allocated to prepared downloadable vulnerability report jobs. After the limit is reached, the oldest report job in the download queue is removed.
 . To change these values, click *Edit*, make your changes, and then click *Save*.
-