mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 10:23:14 -04:00
524fe6dfe2
* [DOCS] Updates to thee Reporting docs * Adds the main sharing page * Final changes * Changed configuring-reporting link to secure-reporting * Updates from meeting with Tim and Larry * Moves reporting and sharing content above ML * Update docs/setup/configuring-reporting.asciidoc Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Review comments from Tim and Larry * Fixes broken links * Fixes redirect * Fixes broken link from ES docs * Adds metadata to changed pages * Review comments Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
29 lines
1.4 KiB
Text
29 lines
1.4 KiB
Text
[role="xpack"]
|
|
[[reporting-integration]]
|
|
== Reporting integration
|
|
Integrating a {kib} application with the {report-features} requires a minimum
|
|
amount of code, and the goal is to not have to modify the reporting code as we
|
|
add additional applications. Instead, applications abide by a contract that
|
|
{report-features} use to determine the information that is required to export
|
|
CSVs and PDFs.
|
|
|
|
[IMPORTANT]
|
|
==============================================
|
|
These pages document internal APIs and are not guaranteed to be supported across future versions of {kib}.
|
|
However, these docs will be kept up-to-date to reflect the current implementation of Reporting integration in {kib}.
|
|
==============================================
|
|
|
|
[float]
|
|
[[reporting-nav-bar-extensions]]
|
|
=== Share menu extensions
|
|
X-Pack uses the `share` plugin of the Kibana platform to register actions in the share menu.
|
|
|
|
[float]
|
|
=== Generate job URL
|
|
To generate a new reporting job, different export types require different `jobParams` that are Rison encoded into a URL
|
|
that abide by the following convention: `/api/reporting/generate?jobParams=${rison.encode(jobParams)}`. If you use the
|
|
aforementioned <<reporting-nav-bar-extensions, nav bar extensions>> then this detail will be abstracted away, but if you
|
|
provide a custom UI for generating the report, you will have to generate the URL and create a POST request to the URL.
|
|
|
|
include::csv-integration.asciidoc[]
|
|
include::pdf-integration.asciidoc[]
|