diff --git a/docs/images/actions_icon.png b/docs/images/actions_icon.png new file mode 100644 index 000000000000..36e918c8cd18 Binary files /dev/null and b/docs/images/actions_icon.png differ diff --git a/docs/images/management-saved-objects.png b/docs/images/management-saved-objects.png index 24b01f58c061..8ae68c8102b0 100644 Binary files a/docs/images/management-saved-objects.png and b/docs/images/management-saved-objects.png differ diff --git a/docs/management/managing-saved-objects.asciidoc b/docs/management/managing-saved-objects.asciidoc index caeabd87727d..324ad46b6055 100644 --- a/docs/management/managing-saved-objects.asciidoc +++ b/docs/management/managing-saved-objects.asciidoc @@ -1,81 +1,83 @@ [[managing-saved-objects]] -== Managing Saved Objects +== Saved objects -You can view, edit, delete, import, and export saved objects from -*Management > Saved Objects*. A saved object can be a search, visualization, -dashboard, or index pattern. +*Saved Objects* helps you keep track of and manage your saved objects. These objects +store data for later use, including dashboards, visualizations, maps, index patterns, +Canvas workpads, and more. + +To get started, go to *Management > {kib} > Saved Objects*. With this UI, you can: + +* <> +* <> +* <> -To narrow the list of saved objects, enter a search term or select an object -type. [role="screenshot"] -image::images/management-saved-objects.png[] +image::images/management-saved-objects.png[Saved Objects] + [float] [[managing-saved-objects-view]] -=== View, edit, and delete objects +=== View, edit, and delete -Each object listed in *Saved Objects* has an *Actions* menu with two items: +* To view and edit an object in its associated application, click the object title. -* *In app* opens the object in its associated application so you can view and -edit it. -* *Relationships* shows other objects that use this object so you know the -impact of deleting it. +* To show objects that use this object, so you know the +impact of deleting it, click the actions icon image:images/actions_icon.png[Actions icon] +and select *Relationships*. + +* To delete one or more objects, select their checkboxes, and then click *Delete*. + +[float] +[[managing-saved-objects-export-objects]] +=== Import and export + +Using the import and export commands, you can move objects between different +{kib} instances. This action is useful when you +have multiple environments for development and production. +Import and export also work well when you have a large number +of objects to update and want to batch the process. + + +[float] +==== Import + +You can import multiple objects in a single operation. Click *Import* and +navigate to the NDJSON file that +represents the objects to import. By default, +saved objects already in {kib} are overwritten. + +[float] +==== Export + +You have two options for exporting saved objects. + +* Select the checkboxes of objects that you want to export, and then click *Export*. +* Click *Export x objects*, and export objects by type. + +This action creates an NDJSON with all your saved objects. By default, +the NDJSON includes related objects. Exported dashboards include their associated index patterns. -To delete a saved object, select its checkbox and click *Delete*. [float] [[managing-saved-objects-object-definition]] -=== Edit an object definition +=== Advanced editing -*Saved Objects* offers an advanced *Edit* page for modifying the object definition. -To open the page, click the object name in the list of objects. You can change -the object title, add a description, and modify the JSON that defines the -object properties. +Some objects offer an advanced *Edit* page for modifying the object definition. +To open the page, click the actions icon image:images/actions_icon.png[Actions icon] +and select *Inspect*. +You can change the object title, add a description, and modify +the JSON that defines the object properties. If you access an object whose index has been deleted, you can: * Recreate the index so you can continue using the object. * Delete the object and recreate it using a different index. -* Change the index name referenced in the object's `kibanaSavedObjectMeta.searchSourceJSON` to point to an existing +* Change the index name in the object's `reference` array to point to an existing index pattern. This is useful if the index you were working with has been renamed. WARNING: Validation is not performed for object properties. Submitting an invalid -change will render the object unusable. A more failsafe approach is to use the -*Discover*, *Visualize*, or *Dashboard* pages to create new objects instead of +change will render the object unusable. A more failsafe approach is to use +*Discover*, *Visualize*, or *Dashboard* to create new objects instead of directly editing an existing one. -[float] -[[managing-saved-objects-export-objects]] -=== Export and import objects - -In some cases you might want to export and import a set of save objects. -For example: - -* You might have multiple environments for development and production. The export -and import commands allow you to move objects between different {kib} instances. -* You have a large number of objects to update and want to batch this process. -You can export the objects to JSON, make the JSON modification, and re-import -the objects. - -[float] -==== Export objects - -Select the checkboxes of the objects you want to export, and click *Export*. -Or, to export objects by type: - -. Click *Export everything*. -. Select the object types you want to export. -. Click *Export All*. - -WARNING: Exported dashboards do not include their associated index patterns. -Re-create the index patterns manually before importing saved dashboards to a -{kib} instance running on another {es} cluster. - -[float] -==== Import objects - -. Click *Import*. -. Navigate to the JSON file that represents the objects to import. -. Indicate whether to overwrite objects already in {kib}. -. Click *Import*. \ No newline at end of file