-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add case customization docs and references #30647
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
Open
estherk15
wants to merge
3
commits into
master
Choose a base branch
from
esther/docs-11465-case-customization
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
content/en/service_management/case_management/customization.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,92 @@ | ||||||
--- | ||||||
title: Customization | ||||||
further_reading: | ||||||
- link: "service_management/case_management/" | ||||||
tag: "Documentation" | ||||||
text: "Case Management Overview" | ||||||
- link: "service_management/case_management/create_case" | ||||||
tag: "Documentation" | ||||||
text: "Create a case" | ||||||
- link: "service_management/case_management/settings" | ||||||
tag: "Documentation" | ||||||
text: "Settings" | ||||||
--- | ||||||
|
||||||
## Overview | ||||||
|
||||||
Datadog Case Management allows customization to align with your team's unique workflows, data capture needs, and reporting requirements. | ||||||
|
||||||
## Custom Case Types | ||||||
|
||||||
<div class="alert alert-warning"> | ||||||
You must have Case Shared Settings Write (<code>cases_shared_settings_write</code>) permissions. For more information, see | ||||||
<a href="https://docs.datadoghq.com/account_management/rbac/permissions/#case_management">Datadog Role Permissions</a>. | ||||||
</div> | ||||||
|
||||||
Datadog provides five [built-in case types][1], each designed for common workflows. To customize Case Management for your team's needs, you can define your own custom case types. This allows you to: | ||||||
|
||||||
* Scope custom data capture to relevant work types | ||||||
* Enable targeted automation | ||||||
* Conduct more granular analytics and reporting | ||||||
|
||||||
##### Create a custom case type | ||||||
|
||||||
1. Navigate to [**Settings > Shared Settings > Case Types**][2]. | ||||||
2. Click **+ Create Case Type**. | ||||||
3. Provide a **Name** and an optional **Description**. | ||||||
4. Save your new case type. | ||||||
5. (Optional) Add [custom attributes](#custom-attributes). | ||||||
|
||||||
##### Enable a custom case type | ||||||
|
||||||
After you create a custom case type, you must explicitly assign it to each project where it should be available. Follow the steps below to enable your new case type within a specific Case Management project. | ||||||
|
||||||
1. Back on the [**Settings** page][2], locate the target project under either **Starred Projects** or **Other Projects**. | ||||||
2. Expand the project menu by clicking on the project name. | ||||||
3. Click **General** to open the project's settings panel. | ||||||
4. Scroll down to the Case Types section in the settings panel. | ||||||
5. Under **From your organization**, open the dropdown and select the custom case type you created. | ||||||
|
||||||
{{< img src="/service_management/case_management/customization/enable_custom_attribute.png" alt="Enable a custom case type in project settings" style="width:100%;" >}} | ||||||
|
||||||
After you add the case type, it is available as an option when you create a new case within that project. | ||||||
|
||||||
Your new case type is available for: | ||||||
|
||||||
* Manual case creation | ||||||
* API-based creation | ||||||
* Automated case creation through Workflows | ||||||
|
||||||
## Custom attributes | ||||||
|
||||||
Custom attributes allow you to capture the structured data your team needs to work efficiently and report effectively. All case types, whether Datadog-provided or custom, include five reserved attributes that cannot be removed or modified: | ||||||
|
||||||
* Teams | ||||||
* Services | ||||||
* Environments | ||||||
* Datacenters | ||||||
* Versions | ||||||
|
||||||
{{< img src="/service_management/case_management/customization/add_custom_attribute.png" alt="Add a custom attribute to a case type" style="width:100%;" >}} | ||||||
|
||||||
You can add attributes that reflect your team's specific needs, such as escalation levels, component owners, business impact, or external links. To add a custom attribute: | ||||||
|
||||||
1. Navigate to [**Settings > Shared Settings > Case Types**][2]. | ||||||
2. Click the desired case type. | ||||||
3. Click **+ Add Attribute**. | ||||||
4. Provide: | ||||||
* Display Name (such as "Region") | ||||||
* Key (used for programmatic access and reporting) | ||||||
* Description (optional context for your team) | ||||||
* Data Type, choose from: | ||||||
* Text | ||||||
* URL | ||||||
* Number | ||||||
* Choose whether to allow multiple values for this attribute. | ||||||
|
||||||
## Further reading | ||||||
|
||||||
{{< partial name="whats-next/whats-next.html" >}} | ||||||
|
||||||
[1]: /service_management/case_management/create_case#manual-case-creation | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[2]: https://app.datadoghq.com/cases/settings?type=shared |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+381 KB
...mages/service_management/case_management/customization/add_custom_attribute.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+311 KB
...es/service_management/case_management/customization/enable_custom_attribute.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.