Skip to content

Commit

Permalink
[DOCS] Add custom fields to cases
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl committed Oct 18, 2023
1 parent 8c35541 commit dbf9fc7
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 16 deletions.
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
78 changes: 63 additions & 15 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,52 @@ 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::[]

[role="screenshot"]
image::images/case-files.png[A list of files attached to a case]
You can add optional and required fields for customized case collaboration.

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

NOTE: To view and change case settings, you must have the appropriate {kib} feature privileges. Refer to <<setup-cases>>.
--

. In the *Custom fields* section, click *Add field*.
+
--
// [role="screenshot"]
// image::images/cases-custom-fields-add.png[Add a custom field 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].
. Enter a field label.

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.
. Choose a field type: text or toggle.

[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.
============================================================================
. 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.

WARNING: If you remove a custom field, it is removed from all cases.
The field values that you added to your cases are no longer accessible.

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.
// For example, you must click the pencil icon next to `my-field` to set it:

// [role="screenshot"]
// image::images/cases-custom-fields.png[A case that has an unset custom field]
// // NOTE: This is an autogenerated screenshot. Do not edit it directly.

[float]
[[add-case-notifications]]
Expand All @@ -51,8 +78,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 +102,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

0 comments on commit dbf9fc7

Please sign in to comment.