• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Use case developmentWorkshopEvent-trigger & navigational widgetsInline Action

    Inline Action

    The Inline Action widget enables users to interact with the Ontology by embedding Action forms and tables. This widget requires an existing action type in the Ontology.

    Form LayoutTable Layout
    A sample Inline Action widget in the form layout.A sample Inline Action widget in the table layout.

    Action configuration

    You can display multiple action types in a single Inline Action widget, allowing users to select one of the available Actions. For each action type, you can configure the following elements:

    • Action: Select an existing action type from the Ontology. Ensure that your intended users can view and submit the Action.

    • Default layout: Choose between form or table layouts for each selected action type.

      • Form layout: Embeds the Action form in the widget so users can submit a single Action at a time. This layout is recommended for small scale datasets where a guided form interaction is desired.

      • Table layout: Embeds an editable Action table in the widget. Action tables are recommended for large scale datasets, or when the data is sourced from CSV files. This layout provides the following benefits:

        • Keyboard navigation that enables efficient data entry
        • The ability to drag and drop CSV files in the table and map columns to form fields
        • Instantly validated fields that surface errors to users
        • All Actions are executed at once upon submission

        Note: The data scale and supported configurations can be limited in the table layout. Explore the action type configuration page for more details.

    • Parameter defaults: You can configure local default values for parameters in the Inline Action view. If no parameter defaults are configured, the action type parameter configurations in the Ontology will be used.

    • Additional options:

      • Custom Action title: Sets a custom title for the widget header.
      • Invalid form state: If the action type's submission criteria is not met, you can define the Action form's display state. The options are disabled and hidden, which provide the option to disable or hide invalid Actions.
      • Hide header: Toggle to display or hide the Action header.
      • Apply to Scenario: Applies the Action to a selected Scenario.
      • On successful Action submit: Trigger a Workshop event on successful Action submission.
      • Output object set: An object set that is created or edited on Action submission.