-
Notifications
You must be signed in to change notification settings - Fork 1.2k
(Actions) Add App Builder input parameters #33214
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
Merged
OliviaShoup
merged 18 commits into
master
from
olivia.shoup/docs-11452-input-parameters
Dec 12, 2025
Merged
Changes from 5 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
3972f9a
Add page for input parameters
OliviaShoup b2ff3bb
Add first draft
OliviaShoup 5f6bc36
Change screenshot size
OliviaShoup 8252abe
Revise instructions; add screenshot; cut Further reading section
OliviaShoup 17ed210
Change screenshot; update alt text
OliviaShoup 3a5f1b3
Update content/en/actions/app_builder/embedded_apps/input_parameters.md
OliviaShoup 634c1a5
Split duplication instructions into separate section
OliviaShoup 524f972
Merge branch 'olivia.shoup/docs-11452-input-parameters' of github.com…
OliviaShoup 611c15a
Add a link to input parameters blueprint
OliviaShoup 71bf0d1
Update blueprint text
OliviaShoup abbedf8
Update content/en/actions/app_builder/embedded_apps/input_parameters.md
OliviaShoup 5bdada8
Update content/en/actions/app_builder/embedded_apps/input_parameters.md
OliviaShoup 7bfd7d8
Update content/en/actions/app_builder/embedded_apps/input_parameters.md
OliviaShoup e3e56b1
Update content/en/actions/app_builder/embedded_apps/input_parameters.md
OliviaShoup 1e5cc94
Merge branch 'master' into olivia.shoup/docs-11452-input-parameters
OliviaShoup 323f85f
Merge branch 'master' into olivia.shoup/docs-11452-input-parameters
OliviaShoup 6881b31
Update content/en/actions/app_builder/embedded_apps/_index.md
OliviaShoup 5b84318
Merge branch 'master' into olivia.shoup/docs-11452-input-parameters
OliviaShoup 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
52 changes: 52 additions & 0 deletions
52
content/en/actions/app_builder/embedded_apps/input_parameters.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,52 @@ | ||
| --- | ||
| title: Input Parameters | ||
| description: Input parameters reduces maintenance overhead by managing one app that can use the same logic in different contexts. | ||
OliviaShoup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| disable_toc: false | ||
| --- | ||
|
|
||
| Input parameters allow you to embed the same app in multiple dashboards or notebooks using different configurations for each instance. | ||
|
|
||
| ## Example dashboard | ||
|
|
||
| A common use case for input parameters is an app that's used on separate dashboards for dev, staging, and production. In the screenshot below, one app was created then 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. | ||
OliviaShoup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| {{< 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%;" >}} | ||
|
|
||
| ## Create an input parameter | ||
|
|
||
| 1. In [App Builder][1], select an app and click **Edit**. | ||
| 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;">}}). | ||
| 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. | ||
| 1. Click the new input parameter to configure its elements: | ||
| - Parameter Name | ||
| - Display Name (Optional) | ||
| - Data Type | ||
| - Allowed Values | ||
| - Default Value | ||
| - Description (Optional) | ||
| 1. Click **Save**. | ||
|
|
||
| ### Example input parameter | ||
|
|
||
| This example input parameter was configured to show the same app in various staging environments: | ||
OliviaShoup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| {{< 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%;" >}} | ||
|
|
||
| ## Use input parameters | ||
|
|
||
| <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. | ||
| </div> | ||
|
|
||
| To embed an app with input parameters: | ||
|
|
||
| 1. In [App Builder][1], select an app with a configured input parameter(s). | ||
OliviaShoup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Click **Add to a dashboard**. | ||
| 1. Select a dashboard, then click **Save and Open**. | ||
| 1. In your dashboard, hover over the app and click the **Edit** icon ({{< img src="icons/pencil.png" inline="true" style="width:14px;">}}). | ||
| 1. In the **Input Parameters** section, select an input parameter: | ||
| {{< 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%;" >}} | ||
| 1. Click **Save**. | ||
| 1. Duplicate the app with copy + paste keyboard shortcuts, or clone it. | ||
| 1. Follow the steps above to select a different input parameter. | ||
OliviaShoup marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [1]: https://app.datadoghq.com/app-builder/apps/list | ||
Binary file added
BIN
+4.66 KB
static/images/service_management/app_builder/embedded_apps/app_properties_icon.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
+94 KB
...management/app_builder/embedded_apps/example-input-parameters-configuration.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
+478 KB
...e_management/app_builder/embedded_apps/example-input-parameters-dashboard-2.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
+307 KB
...ice_management/app_builder/embedded_apps/example-input-parameters-dashboard.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
+396 KB
...ent/app_builder/embedded_apps/example-input-params-configuring-in-dashboard.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.
Uh oh!
There was an error while loading. Please reload this page.