Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add custom fields to cases #3293

Merged
merged 4 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ automatically close when they are sent to an external system.
+
--
[role="screenshot"]
image::images/add-case-connector.png[]
image::images/cases-settings.png[View case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
--
. From the *Incident management system* list, select *Add new connector*.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/grant-cases-access.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here are the minimum required privileges:
|===

| Action | {kib} Privileges
| Give full access to manage cases
| Give full access to manage cases and settings
a|
* `All` for the *Cases* feature under *{observability}*.
* `All` for the *{connectors-feature}* feature under *Management*.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 54 additions & 14 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,44 @@ default setting is `No connector selected`.
. After you've completed all of the required fields, click *Create case*.

[float]
[[add-observability-case-files]]
=== Add files
[[case-custom-fields]]
== Add custom fields

After you create a case, you can upload and manage files on the *Files* tab:
preview::[]

You can add optional and required fields for customized case collaboration.

. Go to *Cases* -> *Settings*.
+
--
[role="screenshot"]
image::images/case-files.png[A list of files attached to a case]
image::images/cases-custom-field-settings.png[View custom fields in case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

The acceptable file types and sizes are affected by your {kibana-ref}/cases-settings.html[{kib} case settings].
NOTE: To view and change case settings, you must have the appropriate {kib} feature privileges. Refer to <<grant-cases-access>>.
--

When you upload a file, a comment is added to the case activity log.
To view an image, click its name in the activity or file list.
. In the *Custom fields* section, click *Add field*.
+
--
[role="screenshot"]
image::images/cases-add-custom-field.png[Add a custom field in case settings]
NOTE: This is an autogenerated screenshot. Do not edit it directly.
--

[NOTE]
============================================================================
Uploaded files are also accessible in *{stack-manage-app} > Files*.
When you export cases as {kibana-ref}/managing-saved-objects.html[saved objects], the case files are not exported.
============================================================================
. Enter a field label.

. Choose a field type: text or toggle.

. If you want the text field to be mandatory in all cases, select *Make this field required*.

. Click *Save field*.

You can subsequently remove or edit custom fields on the *Settings* page.

After you create custom fields, they're added to all new and existing cases.

Existing cases have null values for the new text fields until you set them in each case.

[float]
[[add-case-notifications]]
Expand All @@ -51,8 +70,8 @@ cases.

For hosted {kib} on {ess}:

. Add the email addresses to the monitoring email allowlist. Follow the steps in
{cloud}/ec-watcher.html#ec-watcher-allowlist[Send alerts by email].
. Add the email domains to the
{cloud}/ec-organizations-notifications-domain-allowlist.html[notifications domain allowlist].
+
--
You do not need to take any more steps to configure an email connector or update
Expand All @@ -75,6 +94,27 @@ must configure the {kibana-ref}/settings.html#server-publicBaseUrl[server.public

When you subsequently add assignees to cases, they receive an email.

[float]
[[add-observability-case-files]]
== Add files

After you create a case, you can upload and manage files on the *Files* tab:

[role="screenshot"]
image::images/case-files.png[A list of files attached to a case]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

The acceptable file types and sizes are affected by your {kibana-ref}/cases-settings.html[{kib} case settings].

When you upload a file, a comment is added to the case activity log.
To view an image, click its name in the activity or file list.

[NOTE]
============================================================================
Uploaded files are also accessible in *{stack-manage-app} > Files*.
When you export cases as {kibana-ref}/managing-saved-objects.html[saved objects], the case files are not exported.
============================================================================

[discrete]
[[manage-case-observability]]
== Manage existing cases
Expand Down
Loading