kibana/docs/canvas/canvas-share-workpad.asciidoc

98 lines
3.3 KiB
Plaintext

[role="xpack"]
[[workpad-share-options]]
== Share your workpad
When you've finished your workpad, you can share it outside of {kib}.
[float]
[[export-single-workpad]]
=== Export workpads
Create a JSON file of your workpad that you can export outside of {kib}.
. From your workpad, click the *Share workpad* icon in the upper left corner.
. Select *Download as JSON*.
+
[role="screenshot"]
image::images/canvas-export-workpad.png[Export single workpad]
Want to export multiple workpads? Go to the *Canvas workpads* view, select the workpads you want to export, then click *Export*.
[float]
[[create-workpad-pdf]]
=== Create a PDF
If you have a license that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.
For more information, refer to <<reporting-getting-started, Reporting from Kibana>>.
. From your workpad, click the *Share workpad* icon in the upper left corner, then select *PDF reports*.
. Click *Generate PDF*.
+
[role="screenshot"]
image::images/canvas-generate-pdf.gif[Generate PDF]
[float]
[[create-workpad-URL]]
=== Create a POST URL
If you have a license that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using Watcher or a script.
For more information, refer to <<automating-report-generation, Automating report generation>>.
. From your workpad, click the *Share workpad* icon in the upper left corner, then select *PDF reports*.
. Click *Copy POST URL*.
+
[role="screenshot"]
image::images/canvas-create-URL.gif[Create POST URL]
[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.
. From your workpad, click the *Share this workpad* icon in the upper left corner, then select *Share on a website*.
. On the *Share on a website* pane, follow the instructions.
. To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters.
+
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. Canvas does not display elements that manipulate the data on the workpad.
+
[role="screenshot"]
image::images/canvas-embed_workpad.gif[Share the workpad on a website]
+
NOTE: Shareable workpads encode the current state of the workpad in a JSON file. When you make changes to the workpad, the changes do not appear in the shareable workpad on your website.
[float]
[[change-the-workpad-settings]]
=== Change the settings
After you've added the workpad to your website, you can change the autoplay and toolbar settings.
[float]
[[shareable-workpad-enable-autoplay]]
==== Change the autoplay settings
. In the lower right corner of the shareable workpad, click the settings icon.
. Click *Auto Play*, then change the settings.
+
[role="screenshot"]
image::images/canvas_share_autoplay_480.gif[Autoplay settings]
[float]
[[hide-workpad-toolbar]]
==== Change the toolbar settings
. In the lower right corner, click the settings icon.
. Click *Toolbar*, then change the settings.
+
[role="screenshot"]
image::images/canvas_share_hidetoolbar_480.gif[Hide toolbar settings]