mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
* [DOCS] Updates reporting and Canvas share options * Update docs/canvas/canvas-share-workpad.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Resizes images and minor text edits * Updates dashboard embed content Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
parent
8811deeb84
commit
df4ba4c8f5
9 changed files with 32 additions and 65 deletions
|
@ -4,6 +4,8 @@
|
|||
|
||||
When you've finished your workpad, you can share it outside of {kib}.
|
||||
|
||||
For information on how to create PDFs and POST URLs, refer to <<reporting-getting-started, Reporting from {kib}>>.
|
||||
|
||||
[float]
|
||||
[[export-single-workpad]]
|
||||
=== Export workpads
|
||||
|
@ -17,37 +19,12 @@ image::images/canvas-export-workpad.png[Export single workpad through JSON, from
|
|||
|
||||
Want to export multiple workpads? Go to the *Canvas* home page, select the workpads you want to export, then click *Export*.
|
||||
|
||||
[float]
|
||||
[[create-workpad-pdf]]
|
||||
=== Create a PDF
|
||||
|
||||
If you have a subscription that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.
|
||||
|
||||
To begin, click *Share > PDF reports > Generate PDF*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas-generate-pdf.gif[Image showing how to generate a PDF]
|
||||
|
||||
For more information, refer to <<reporting-getting-started, Reporting from Kibana>>.
|
||||
|
||||
[float]
|
||||
[[create-workpad-URL]]
|
||||
=== Create a POST URL
|
||||
|
||||
If you have a subscription that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using <<watcher-ui,Watcher>> or a script.
|
||||
|
||||
To begin, click *Share > PDF reports > Advanced options > Copy POST URL*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/canvas-create-URL.gif[Image showing how to create POST URL]
|
||||
|
||||
For more information, refer to <<automating-report-generation, Automating report generation>>.
|
||||
|
||||
[float]
|
||||
[[add-workpad-website]]
|
||||
=== Share the workpad on a website
|
||||
|
||||
beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.
|
||||
beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website.
|
||||
To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.
|
||||
|
||||
. Click *Share > Share on a website*.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
:blog-ref: https://www.elastic.co/blog/
|
||||
:wikipedia: https://en.wikipedia.org/wiki
|
||||
|
||||
include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[]
|
||||
include::{docs-root}/shared/versions/stack/7.10.asciidoc[]
|
||||
|
||||
:docker-repo: docker.elastic.co/kibana/kibana
|
||||
:docker-image: docker.elastic.co/kibana/kibana:{version}
|
||||
|
|
|
@ -253,10 +253,8 @@ When you're finished making changes, save the dashboard.
|
|||
|
||||
To share the dashboard with a larger audience, click *Share* in the toolbar, then choose one of the following options:
|
||||
|
||||
* *Embed code* — Embed the dashboard as an iframe on a web page. Embedded dashboards are fully interactive, but you can
|
||||
hide some parts of the dashboard using the menu options. User authentication is required, which the user provides or via reverse proxy.
|
||||
<<anonymous-authentication, Anonymous access>> is also supported. For more details,
|
||||
learn about <<kibana-authentication>>.
|
||||
* *Embed code* — Embed a fully interactive dashboard as an iframe on a web page. To access embedded dashboards, you can require users to
|
||||
log in using their {kib} credentials, via reverse proxy, or enable <<anonymous-access-and-embedding, anonymous access>>.
|
||||
|
||||
* *Permalinks* — Share a direct link to a {kib} dashboard. User authentication is required.
|
||||
|
||||
|
|
|
@ -8,17 +8,16 @@ include::report-intervals.asciidoc[]
|
|||
[float]
|
||||
=== Create a POST URL
|
||||
|
||||
Create the POST
|
||||
URL that triggers a report to generate.
|
||||
Create the POST URL that triggers a report to generate PDF and CSV reports.
|
||||
|
||||
To create the POST URL for PDF reports:
|
||||
|
||||
. Open then main menu, click *Dashboard*, then open a dashboard.
|
||||
+
|
||||
To specify a relative or absolute time period, use the time filter.
|
||||
. Open the dashboard, visualization, or **Canvas** workpad.
|
||||
|
||||
. From the {kib} toolbar, click *Share*, then select *PDF Reports*.
|
||||
|
||||
. If you are using **Canvas**, click *Advanced options*.
|
||||
|
||||
. Click *Copy POST URL*.
|
||||
+
|
||||
[role="screenshot"]
|
||||
|
@ -27,9 +26,7 @@ image::images/report-automate-pdf.png[Generate Visualize and Dashboard reports]
|
|||
|
||||
To create the POST URL for CSV reports:
|
||||
|
||||
. Load the saved search in *Discover*.
|
||||
+
|
||||
To specify a relative or absolute time period, use the time filter.
|
||||
. In *Discover*, open the saved search.
|
||||
|
||||
. From the {kib} toolbar, click *Share*, then select *CSV Reports*.
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 56 KiB |
Binary file not shown.
Before Width: | Height: | Size: 164 KiB After Width: | Height: | Size: 62 KiB |
Binary file not shown.
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 36 KiB |
|
@ -11,7 +11,7 @@ saved search, or Canvas workpad. Depending on the object type, you can export th
|
|||
a PDF, PNG, or CSV document, which you can keep for yourself, or share with others.
|
||||
|
||||
Reporting is available from the *Share* menu
|
||||
in *Discover*, *Dashboard*, and *Canvas*.
|
||||
in *Discover*, *Dashboard*, *Visualize Library*, and *Canvas*.
|
||||
|
||||
[role="screenshot"]
|
||||
image::user/reporting/images/share-menu.png["Share"]
|
||||
|
@ -38,31 +38,32 @@ for an example.
|
|||
|
||||
[float]
|
||||
[[manually-generate-reports]]
|
||||
== Generate a report manually
|
||||
== Manually generate and download reports
|
||||
|
||||
. Open the dashboard, visualization, Canvas workpad, or saved search that you want to include in the report.
|
||||
Generate and download PDF, PNG, and CSV files of dashboards, visualizations, **Canvas** workpads, and saved searches.
|
||||
|
||||
. In the {kib} toolbar, click *Share*. If you are working in Canvas,
|
||||
click the share icon image:user/reporting/images/canvas-share-button.png["Canvas Share button"].
|
||||
. Open the dashboard, visualization, **Canvas** workpad, or saved search.
|
||||
|
||||
. Select the option appropriate for your object. You can export:
|
||||
+
|
||||
** A dashboard or visualization as either a PNG or PDF document
|
||||
** A Canvas workpad as a PDF document
|
||||
** A saved search as a CSV document
|
||||
. From the {kib} toolbar, click **Share**, then select one of the following options:
|
||||
|
||||
** **PDF Reports** — Generates a PDF file of the dashboard, visualization, or **Canvas** workpad.
|
||||
** **PNG Reports** — Generates a PNG file of the dashboard or visualization.
|
||||
** **CSV Reports** — Generates a CSV report of the saved search.
|
||||
|
||||
. Generate the report.
|
||||
+
|
||||
A notification appears when the report is complete.
|
||||
When the report completes, a notification appears.
|
||||
|
||||
NOTE: When you export a data table or saved search from a dashboard report, the PDF includes only the visible data.
|
||||
. Click **Download report**.
|
||||
|
||||
NOTE: When you create a dashboard report that includes a data table or saved search, the PDF includes only the visible data.
|
||||
|
||||
[float]
|
||||
[[reporting-layout-sizing]]
|
||||
== Layout and sizing
|
||||
The layout and size of the PDF or PNG image depends on the {kib} app
|
||||
with which the Reporting plugin is integrated. For Canvas, the
|
||||
worksheet dimensions determine the size for Reporting. In other apps,
|
||||
with which the Reporting plugin is integrated. For *Canvas*, the
|
||||
worksheet dimensions determine the size for reports. In other apps,
|
||||
the dimensions are taken on the fly by looking at
|
||||
the size of the visualization elements or panels on the page.
|
||||
|
||||
|
@ -72,9 +73,9 @@ This resizes the shareable container before generating the
|
|||
report, so the desired dimensions are passed in the job parameters.
|
||||
|
||||
In the following {kib} dashboard, the shareable container is highlighted.
|
||||
The shareable container is captured when you click the
|
||||
*Generate* or *Copy POST URL* button. It might take some trial and error
|
||||
before you're satisfied with the layout and dimensions in the resulting
|
||||
The shareable container is captured when you click
|
||||
*Generate* or *Copy POST URL* from the *Share* menu. It might take some trial and error
|
||||
before you're satisfied with the layout and dimensions in the
|
||||
PNG or PDF image.
|
||||
|
||||
[role="screenshot"]
|
||||
|
@ -107,16 +108,9 @@ image::user/reporting/images/canvas-full-page-layout.png["Full Page Layout"]
|
|||
== View and manage report history
|
||||
|
||||
For a list of your reports, open the main menu, then click *Stack Management > Reporting*.
|
||||
From this view, you can monitor the generation of a report and
|
||||
From this view, you can monitor the status of a report and
|
||||
download reports that you previously generated.
|
||||
|
||||
[float]
|
||||
[[automatically-generate-reports]]
|
||||
== Automatically generate a report
|
||||
|
||||
To automatically generate a report from a script or with
|
||||
{watcher}, see <<automating-report-generation, Automating report generation>>.
|
||||
|
||||
--
|
||||
|
||||
include::automating-report-generation.asciidoc[]
|
||||
|
|
|
@ -379,6 +379,7 @@ xpack.security.authc.providers:
|
|||
--------------------------------------------------------------------------------
|
||||
|
||||
[float]
|
||||
[[anonymous-access-and-embedding]]
|
||||
===== Anonymous access and embedding
|
||||
|
||||
One of the most popular use cases for anonymous access is when you embed {kib} into other applications and don't want to force your users to log in to view it. If you configured {kib} to use anonymous access as the sole authentication mechanism, you don't need to do anything special while embedding {kib}.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue