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 ControlThe 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:
Important Note: This functionality is not currently available for Cortex XSOAR 6.x. Using engine_placeholder
in Cortex XSOAR 6.x UI will create a non-functional parameter with the name engine_placeholder
.
#
3. Implementing Dynamic Behavior with TriggersThe 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:
Example: Hide the token
field if the username
field has a value:
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.