kibana/docs/user/reporting
Tim Sullivan 2ff5410161
[Reporting/CSV] Deprecate Download CSV, add a config flag to enable (#178159)
Closes https://github.com/elastic/kibana/issues/164104

## Summary

**Replace "Download CSV" with "Generate CSV report" to export a CSV file
from saved search panel, deprecate "Download CSV", use a config flag for
providing the deprecated feature.**

This PR uses the `xpack.reporting.csv.enablePanelActionDownload`
kibana.yml setting, which was previously unused, for choosing behavior
of CSV export in a Dashboard saved search panel, and sets the default
value to `false`. The options allow the user to download a CSV file
without creating a report (deprecated, support will be removed in the
future) or to generate a CSV report (default).

1. Use the config as a flag to switch between implementations:
    - downloading a CSV file without a generated report
    - generating a CSV report
2. Updated documentation
3. Refactored / cleaned up tests
4. Increased API test coverage in Serverless
5. Better error handling in
`packages/kbn-reporting/public/reporting_api_client.ts`

### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)

## Release Note
Kibana CSV Reporting offered a feature allowing users to download a CSV
file from a saved search panel in a dashboard, without having a report
generated. This feature is now deprecated. Now, when users need to
access saved search data from a dashboard panel as CSV, a normal report
will be generated. To access the deprecated functionality, you can add
`xpack.reporting.csv.enablePanelActionDownload: true` to kibana.yml, but
this ability will be removed in a future version of Kibana.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-03-22 18:28:09 -07:00
..
images [Reporting] Document steps to grant users reporting access under Basic (#127513) 2022-03-14 10:50:40 -07:00
automating-report-generation.asciidoc Update automating-report-generation.asciidoc (#134410) 2022-06-15 13:01:14 -07:00
index.asciidoc [Reporting/CSV] Deprecate Download CSV, add a config flag to enable (#178159) 2024-03-22 18:28:09 -07:00
reporting-csv-limitations.asciidoc [Docs] Clarifying CSV limitations (#175208) 2024-01-25 11:04:15 -05:00
reporting-troubleshooting.asciidoc [DOCS] Update 'xpack.screenshotting.browser.chromium.disableSandbox` documentation (#148425) 2023-01-10 09:26:57 -05:00
response-codes.asciidoc [DOCS] Changes Visualize to Visualize Library (#93055) 2021-03-08 13:44:30 -06:00
script-example.asciidoc Fix curl documentation (#141971) 2022-09-27 17:18:41 -04:00
watch-example.asciidoc [DOCS] Updates to the Reporting docs (#101326) 2021-06-30 12:10:04 -05:00