Skip to content

Commit 1c565af

Browse files
OliviaShoupurseberryhestonhoffman
authored
(Actions) Add App Builder input parameters (#33214)
* Add page for input parameters * Add first draft * Change screenshot size * Revise instructions; add screenshot; cut Further reading section * Change screenshot; update alt text * Update content/en/actions/app_builder/embedded_apps/input_parameters.md Co-authored-by: Ursula Chen <[email protected]> * Split duplication instructions into separate section * Add a link to input parameters blueprint * Update blueprint text * Update content/en/actions/app_builder/embedded_apps/input_parameters.md Co-authored-by: Ursula Chen <[email protected]> * Update content/en/actions/app_builder/embedded_apps/input_parameters.md Co-authored-by: Heston Hoffman <[email protected]> * Update content/en/actions/app_builder/embedded_apps/input_parameters.md Co-authored-by: Heston Hoffman <[email protected]> * Update content/en/actions/app_builder/embedded_apps/input_parameters.md Co-authored-by: Heston Hoffman <[email protected]> * Update content/en/actions/app_builder/embedded_apps/_index.md Co-authored-by: Heston Hoffman <[email protected]> --------- Co-authored-by: Ursula Chen <[email protected]> Co-authored-by: Heston Hoffman <[email protected]>
1 parent 5b5e1a4 commit 1c565af

File tree

8 files changed

+65
-0
lines changed

8 files changed

+65
-0
lines changed

config/_default/menus/main.en.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2968,6 +2968,11 @@ menu:
29682968
parent: app_builder
29692969
identifier: app_builder_embedded_apps
29702970
weight: 9
2971+
- name: Input Parameters
2972+
url: actions/app_builder/embedded_apps/input_parameters/
2973+
parent: app_builder_embedded_apps
2974+
identifier: app_builder_input_parameters
2975+
weight: 901
29712976
- name: Save and Reuse Actions
29722977
url: actions/app_builder/saved_actions/
29732978
parent: app_builder
File renamed without changes.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Input Parameters
3+
description: Input parameters allow you to embed the same app in multiple dashboards or notebooks using different configurations for each instance.
4+
disable_toc: false
5+
---
6+
7+
Input parameters allow you to embed the same app in multiple dashboards or notebooks using different configurations for each instance.
8+
9+
## Example app
10+
11+
A common use case for input parameters is to reuse and customize an app for different environments, like dev, staging, and production. In the screenshot below, one app is embedded twice in a dashboard. The app on the left shows monitors in the demo environment, while the app on the right shows the same information for monitors in the staging environment. You can play around with this app by cloning the blueprint [How to: Input Parameters][3].
12+
13+
{{< img src="/service_management/app_builder/embedded_apps/example-input-parameters-dashboard.png" alt="Two embedded apps with different input parameters selected" style="width:100%;" >}}
14+
15+
## Create an input parameter
16+
17+
1. In [App Builder][1], select an app and click **Edit**.
18+
1. Click the **App Properties** icon ({{< img src="service_management/app_builder/embedded_apps/app_properties_icon.png" inline="true" width="12px" style="position:relative; bottom:1px;">}}).
19+
1. Click the plus icon (<i class="icon-plus-2" style="position:relative; top:2px;font-size: 12px; max-width: 12px"></i>) to add an input parameter.
20+
1. Click the new input parameter to configure its elements:
21+
- Parameter Name
22+
- Display Name (Optional)
23+
- Data Type
24+
- Allowed Values
25+
- Default Value
26+
- Description (Optional)
27+
1. Click **Save**.
28+
29+
### Example input parameter
30+
31+
This example input parameter shows the same app in various staging environments:
32+
33+
{{< img src="/service_management/app_builder/embedded_apps/example-input-parameters-configuration.png" alt="An example of configured input parameters inside an app" style="width:35%;" >}}
34+
35+
## Use input parameters
36+
37+
<div class="alert alert-info">Apps with input parameters work best in dashboards and notebooks. While you can add an app to Self-Service Actions, you can't select the input parameters you've configured.
38+
</div>
39+
40+
To embed an app with input parameters:
41+
42+
1. In [App Builder][1], select an app with a configured input parameter.
43+
1. Click **Add to a dashboard**.
44+
1. Select a dashboard, then click **Save and Open**.
45+
1. In your dashboard, hover over the app and click the **Edit** icon ({{< img src="icons/pencil.png" inline="true" style="width:14px;">}}).
46+
1. In the **Input Parameters** section, select an input parameter:
47+
{{< img src="/service_management/app_builder/embedded_apps/example-input-params-configuring-in-dashboard.png" alt="An example of an app in editing mode with Input Parameters circled" style="width:80%;" >}}
48+
1. Click **Save**.
49+
50+
## Reuse an app
51+
52+
After embedding an app in a dashboard or notebook, you can create a copy to reuse it with different contexts:
53+
1. Select the embedded app.
54+
1. Click the **Options** icon (<i class="icon-kebab-wui" style="position:relative; top:2px;font-size: 12px; max-width: 12px"></i>), then click **Clone**.
55+
- Alternatively, you can select the app and use copy and paste keyboard shortcuts.
56+
1. Follow the steps [above][2] to select a different input parameter.
57+
58+
[1]: https://app.datadoghq.com/app-builder/apps/list
59+
[2]: /actions/app_builder/embedded_apps/input_parameters/#use-input-parameters
60+
[3]: https://app.datadoghq.com/app-builder/apps/edit?template=how_to_input_parameters&viewMode=templatePreview
4.66 KB
Loading
94 KB
Loading
478 KB
Loading
307 KB
Loading
396 KB
Loading

0 commit comments

Comments
 (0)