Skip to content

Add UI Support for Displaying Action Output Parameters #31

@gravity-api

Description

@gravity-api

Description

Our sequential automation engine currently supports various actions via plugins. However, there is no built-in capability in the UI to display the output parameters that some plugins generate after execution. This feature request is to add functionality that shows the output parameter names and their values once the action is complete.

Feature Requirements

Display Output Parameters:

  • If an action returns output parameters, the UI should list them with their names and values.
  • The output parameter display should be clearly associated with the corresponding action in the sequential workflow.

UI Updates After Action Completion:

  • Once an action is executed and completes successfully, the output parameters (if any) should be dynamically populated in the UI.
  • In case of actions that do not produce output parameters, the UI should gracefully indicate that there are no outputs.

Plugin Integration:

  • The mechanism to retrieve output parameters from plugins should be standardized.
  • If possible, allow plugins to define custom formatting or additional metadata for their output parameters that can be leveraged by the UI.

Acceptance Criteria

Action With Output Parameters:

  • Given an action that produces output parameters,
  • When the action completes,
  • Then the UI displays a section showing each output parameter with its corresponding name and value.

Action Without Output Parameters:

  • Given an action that does not produce any output parameters,
  • When the action completes,
  • Then the UI either hides the output parameter section or indicates that there are no output values.

Dynamic Updates:

  • The output parameter information should be updated immediately after the action completes.
  • The UI should reflect any changes if the same action is re-run.

User Interface Consistency:

  • The display of output parameters should be visually consistent with other parts of the UI.
  • The design should accommodate various output types (e.g., strings, numbers, objects) in a user-friendly manner.

Additional Notes

  • Consider potential edge cases such as large output data or unexpected data types.
  • It might be beneficial to provide tooltips or help text for output parameters to improve user understanding.
  • Collaboration with the plugin development team might be needed to ensure output parameters are returned in a standardized format.

Impact

Adding this feature will improve the usability of the sequential automation engine by providing users with immediate feedback on action outputs. It will also aid in debugging and monitoring the behavior of various plugins in the workflow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions