kibana/docs/canvas/canvas-share-workpad.asciidoc
2020-10-08 12:04:59 -05:00

66 lines
2.5 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}.
To begin, click *Share > Download as JSON*.
[role="screenshot"]
image::images/canvas-export-workpad.png[Export single workpad through JSON, from Share dropdown]
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 > 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.
. Click *Share > Share on a website*.
. Follow the *Share on a website* 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::canvas/images/canvas-embed_workpad.gif[Image showing how to 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.
. To change the settings, click the settings icon, then choose the settings you want to use.