diff --git a/docs/admin-panel/ServerSettings.mdx b/docs/admin-panel/ServerSettings.mdx index 038d74b15..f04b58d38 100644 --- a/docs/admin-panel/ServerSettings.mdx +++ b/docs/admin-panel/ServerSettings.mdx @@ -88,6 +88,30 @@ or +## Features + +An admin can disable the "Important launches" functionality to better control storage usage and prevent launches from being stored indefinitely on the instance. + +By default, the "Important launches" functionality is enabled on all instances. Users can then [mark launches as important](/configuration/LaunchesRetentionPolicy/#mark-launch-as-important-on-ui) using the launch burger menu or [report launch as important](/configuration/LaunchesRetentionPolicy/#report-launch-as-important), and these launches can only be deleted manually or when [storage limits are exceeded](/configuration/LaunchesRetentionPolicy/#important-launch-deletion-on-full-storage). + +To **turn off the "Important launches" functionality**: + +1. Log in as an ADMIN. +2. Navigate to Administrate > Server Settings > "Features" tab. +3. Turn the toggle "Important launches" off. + + + +When toggling "Important Launches" off: + +1. The "Mark as important" option is disabled on the launch burger menu, and there is a tooltip with an explanation. + + + +2. A background job runs to remove the "Important" flag from launches that were previously marked as important, converting them to regular launches and making them subject to the standard [retention policy](/configuration/LaunchesRetentionPolicy/). +3. If the toggle is off, then even if a user reports a launch with the system attribute retentionPolicy:important, the launch will not be marked as important and will still be subject to the standard retention policy. +4. If you previously had important launches, then turned off the toggle, and later turn it back on, the old launches that were once marked as important will not become important again. + ## Analytics To turn on [Google Analytics](/terms-and-conditions/GoogleAnalyticsUsageByReportPortal/) on ReportPortal UI: diff --git a/docs/admin-panel/img/server-settings/ImportantLaunches1.png b/docs/admin-panel/img/server-settings/ImportantLaunches1.png new file mode 100644 index 000000000..aa7695d0d Binary files /dev/null and b/docs/admin-panel/img/server-settings/ImportantLaunches1.png differ diff --git a/docs/admin-panel/img/server-settings/ImportantLaunches2.png b/docs/admin-panel/img/server-settings/ImportantLaunches2.png new file mode 100644 index 000000000..6ea671fd1 Binary files /dev/null and b/docs/admin-panel/img/server-settings/ImportantLaunches2.png differ diff --git a/docs/configuration/LaunchesRetentionPolicy.mdx b/docs/configuration/LaunchesRetentionPolicy.mdx index c2020ee3f..675347a3f 100644 --- a/docs/configuration/LaunchesRetentionPolicy.mdx +++ b/docs/configuration/LaunchesRetentionPolicy.mdx @@ -6,6 +6,11 @@ You can also mark some launches as important, meaning they are generally not sub You can mark a launch as important either through the application's UI or during test reporting using special system attributes. +:::note +By default, the "Important launches" functionality is enabled on all instances.
+An admin can [disable the "Important launches" functionality](/admin-panel/ServerSettings#features) if needed. +::: + ## Mark launch as important on UI 1. Go to the 'Launches' page. diff --git a/docs/work-with-reports/OperationsUnderLaunches.mdx b/docs/work-with-reports/OperationsUnderLaunches.mdx index 291514c7d..f794d98cb 100644 --- a/docs/work-with-reports/OperationsUnderLaunches.mdx +++ b/docs/work-with-reports/OperationsUnderLaunches.mdx @@ -209,6 +209,7 @@ Launch structure being exported: * launch * suit * test +* step :::note Nested steps and logs are not exported. @@ -218,13 +219,74 @@ To export a launch, perform the following steps: 1. Go to the 'Launches' page. 2. Open the burger menu for the launch. -3. Click on the 'Export' option on the menu. +3. Click on the 'Export report' option in the menu. - + + +4. Select export file format in the dropdown (PDF, XLS, HTML). +5. Check the 'Include Attachments' checkbox if needed. +6. Click 'Export' button. + + + +:::important +Do not refresh the page while export report is being generated. +::: + +System alerts appear at the bottom of the page and include: + +* Notification about the start of a launch report export + + + +* Notification about the completion of a launch report export + + + +The notification about report generation appears at the top of the page. It also displays the number of reports that are currently in progress. + + + +:::important +The export operation works for a separate launch only. You cannot export multiple launches at once. +::: :::note -The export operation works for a separate launch only. No multiple actions for the export of launches. +The XLS and HTML reports are exported in a one-page format, while the PDF report is generated with page breaks. ::: + +**Export with attachments** + +When exporting with the 'Include Attachments' checkbox selected, the generated report is a ZIP archive. + +:::note +If you export launches with attachments and their total size is large, the export process will take longer.
+PDF is the fastest export format, regardless of whether attachments are included. HTML is slightly slower, while XLS is the slowest. +::: + +If the launch doesn't have attachments, then the ZIP file will contain only the launch report in the selected format. + +In case the launch has attachments, the ZIP archive will contain the launch report, parent folders, and subfolders for the test items with attachments. + +The hierarchical folder structure: + +* Launch level +* Suite level +* Test level +* Step level + + + + + + + +In the launch report, you can find the attachment names at the corresponding test item level. + + + + + ## Delete launches The system allows deleting launches on the "Launches" and "Debug" pages. diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches1.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches1.png new file mode 100644 index 000000000..99869ab2a Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches1.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches2.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches2.png new file mode 100644 index 000000000..3a30c4d91 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches2.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches3.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches3.png new file mode 100644 index 000000000..df27c80af Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches3.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches4.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches4.png new file mode 100644 index 000000000..98c5229a1 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches4.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches5.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches5.png new file mode 100644 index 000000000..4b83aecd3 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches5.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches6.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches6.png new file mode 100644 index 000000000..0bd8e3938 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches6.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches7.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches7.png new file mode 100644 index 000000000..42b4a2123 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches7.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches8.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches8.png new file mode 100644 index 000000000..5ace047c6 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches8.png differ diff --git a/docs/work-with-reports/img/operations-under-launches/ExportLaunches9.png b/docs/work-with-reports/img/operations-under-launches/ExportLaunches9.png new file mode 100644 index 000000000..dcf1499e5 Binary files /dev/null and b/docs/work-with-reports/img/operations-under-launches/ExportLaunches9.png differ