-
Notifications
You must be signed in to change notification settings - Fork 58
Add to docs: YAML configuration, dynamic UI, triggers, engine placement #1749
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
RosenbergYehuda
wants to merge
3
commits into
master
Choose a base branch
from
YR/Add-new-features-to-the-docs/CIAC-13645
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
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Dynamic UI and Parameter Management for Integrations | ||
|
||
This guide outlines new features for integrations: controlling parameter order, the `engine_placeholder` field (type 23), and the `triggers` section. These enhancements improve user experience and enable more dynamic configuration. | ||
|
||
## 1. Parameter Order Control | ||
|
||
The order of parameters in the YAML file determines their display order in the user interface. This applies to standard parameters only; built-in parameters, such as `Log Level` and the `Do Not Use by Default` checkbox ,and other system parameters, are static and cannot be repositioned. An exception is made for the `engine` dropdown, as detailed below. | ||
|
||
## 2. Specifying Engine Location (Type 23) | ||
|
||
The `engine` dropdown's location in the user interface is now explicitly defined using the `engine_placeholder` field (type 23). This replaces the previous implicit handling. Built-in parameters such as `log_level` remain static and cannot be repositioned. Positioning the `engine` dropdown is achieved by placing the `engine_placeholder` within the YAML configuration. The `engine` dropdown then appears at the `engine_placeholder`'s location. | ||
|
||
**YAML Structure:** | ||
|
||
```yaml | ||
- name: engine_placeholder | ||
type: 23 | ||
section: Connect | ||
``` | ||
|
||
**Important Note:** This functionality requires a compatible UI version. Using `engine_placeholder` in an outdated UI will create a non-functional parameter with the name `engine_placeholder`. | ||
|
||
|
||
## 3. Implementing Dynamic Behavior with Triggers | ||
The `triggers` section enables dynamic UI behavior based on user input and enables you to define conditions and effects to control the visibility (`hidden`) and required status (`required`) of UI elements. | ||
|
||
**YAML Structure:** | ||
|
||
```yaml | ||
triggers: | ||
- conditions: | ||
- name: <field_to_check> # Field whose value determines the effect | ||
operator: <operator> # (exists, not_exists, equals, not_equals) | ||
value: <value> # Value to compare against (required only for equals/not_equals) | ||
effects: | ||
- name: <field_to_affect> # Field whose properties are modified | ||
action: | ||
required: <true/false> # Set to true to make the field required, false otherwise | ||
required: true # Makes the field mandatory if the condition is met | ||
# hidden: <true/false> Can also be used here to hide/show the field. | ||
# Other UI actions are also possible. | ||
``` | ||
|
||
**Example:** Hide the `token` field if the `username` field has a value: | ||
|
||
```yaml | ||
triggers: | ||
- conditions: | ||
- name: username | ||
operator: exists | ||
effects: | ||
- name: token | ||
action: | ||
hidden: true | ||
``` | ||
|
||
The example demonstrates how to dynamically hide UI elements based on the existence of a username. This prevents unnecessary display of the token field and avoids confusion. | ||
|
||
**Note:** Multiple conditions within a trigger use an "AND" relationship; all conditions must be true for the effect to apply. | ||
|
||
|
||
|
||
For a complete example, see the generic webhook integration. |
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
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.
do we want to say from which UI version?