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 #4070

Merged
merged 6 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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
43 changes: 41 additions & 2 deletions docs/cases/cases-manage.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,46 @@ NOTE: If you've selected a connector for the case, the case is automatically pus
image::images/cases-ui-open.png[Shows an open case]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

[float]
[[cases-ui-custom-fields]]
== Add custom fields

preview::[]

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

. Go to *Cases* and click *Settings*.
+
--
[role="screenshot"]
image::images/cases-custom-field-settings.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 <<case-permissions>>.
--

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

. 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*.
lcawl marked this conversation as resolved.
Show resolved Hide resolved

. Click *Save field*.

You can subsequently remove or edit custom fields on the *Settings* page.
lcawl marked this conversation as resolved.
Show resolved Hide resolved

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]
[[cases-ui-notifications]]
== Add email notifications
Expand All @@ -46,8 +86,7 @@ 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 Down
Binary file added docs/cases/images/cases-add-custom-field.png
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.
2 changes: 1 addition & 1 deletion docs/getting-started/cases-req.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To grant access to cases, set the {kib} space privileges for the *Cases* and *{c
|==============================================

| Action | {kib} Privileges
| Give full access to manage cases
| Give full access to manage cases and settings
a|
* **All** for the *Cases* feature under *Security*
* **All** for the *{connectors-feature}* feature under *Management*
Expand Down