Configure Toolbar Buttons

Overview

Toolbar buttons displays at the top of the Grid and Properties Card containers, and contains buttons that can be used for page navigation, to link to additional pages or to run a rule registered in an Event. These buttons can be created using the Toolbar Configuration section in the Grid and Properties Card containers.

Note

Toolbar buttons can execute events for single or multiple rows. Turn on the Allow Multi Row Action property to enable multi-row execution via row selection checkboxes.

Refer to the Add a Toolbar Button section for more information.

Parameter Datasets

Construct Preview supports passing in parameters via a toolbar parameter view (called a parameter dataset) for advanced event scenarios, like approval workflows and parameterized custom orchestrate events. Parameter datasets can be configured to pass dynamic values to toolbar button events that returns a single row based on drill-down criteria.

If the toolbar button is triggering an Orchestrate event, you can use the parameters dataset to pass additional data to it along with the data from the grid or properties card (form) containers.

Create a Toolbar Parameter View in SQL Server

Use the following guidelines to create toolbar parameter views in a SQL Server database:

• Use the naming convention web*Tbv, where * contains the name of the view or table registered to the gird or form container.

• Ensure that this view has the required additional fields needed to bind with the container. For example, you may want to bind using the container primary keys.

Run a Scan and Create Parameter Dataset

1. Access the datastore in the Syniti Knowledge Platform (SKP) Catalog module associated with the database where the toolbar parameter view was created.

2. Scan the datastore to ingest metadata into the SKP.

3. Create a dataset using the same view name.

4. Set the Affected Table field.

Add a Toolbar Button

1. On the Construct Preview’s home page, edit the required WebApp. The WebApp configuration page is displayed.

2. Access Pages > Your Page > Grid or Properties Card in the Tree Navigation panel. The Details panel is updated with the Grid or Properties Card fields.

3. Access the Toolbar Configuration section and click Add. The toolbar button configuration fields are displayed.

4. Enter the fields/properties listed in the following table as required using either form-based UI or Advanced mode:

   Note

   Only one of Page Event Name, Link to Page Name, or Link to URL may be populated for a button. If additional actions are required, add separate buttons for each specific need.

   Property (Name: Type)	Description	Supported Values/Notes
   label: string required	Enter the label that will be displayed on this button.	maxLength: 128
   tooltip: string	Enter the help tooltip that will be displayed when hovering over this button.	maxLength: 2000
   ordinal: integer	Specify the order in which buttons are rendered in the toolbar.	default: 0
   icon: string	Use the Preview and Select Icon button to open the Select Icon dialog box and add an icon to the toolbar button. You can either search for an icon or scroll through the list to find the one you want to preview, and then click Save to apply your selection.	To reset the Icon value, click Clear in the Select Icon dialog box. maxLength: 100
   icon_only: boolean	Toggle to control whether the toolbar button displays only the icon or both the icon and its label.	default: false
   page_event_name: string	Select the name of the event that will be executed when this button is clicked. The event must already exist within the same grid or properties card container. Note If the associated event has Row Level Event set to false, the toolbar button can be clicked without selecting a row. This setup is useful for container-level actions/events like bulk operations that don't require row context.	A new event can be created using the Create New Event button. However, you must access the newly created event to complete its configuration. Refer to Register an Event for more information. maxLength: 128
   link_to_page_name: string	Select the name of the internal page to navigate to when this button is clicked.	maxLength: 250
   link_to_url: string	Enter the external URL to navigate to when this button is clicked.	maxLength: 2000
   link_to_page_new_tab: boolean	Toggle to control whether a new browser tab is opened when navigating to the link defined for this button.	default: true
   allow_multi_row_action: boolean	Toggle to control whether this toolbar action can be applied to multiple selected rows in the grid container.	Note Only toolbar buttons with allow_multi_row_action = true support multi-row execution. Buttons without this flag always execute for the selected single row only. default: false

5. Configuring Toolbar Parameterized Events: When toolbar buttons trigger events, you can configure parameter mappings to pass dynamic values from a parameter dataset to the event:

   1. From the Parameter Dataset list, select the required parameter dataset. The parameter dataset allows passing additional data to the event. Refer to the Parameter Datasets section for more information.

      Note

      • The Update Dataset button opens a dialog box that allows you to rescan the dataset and add/replace any newly available fields from the underlying table or view to the dataset.

      • Specify the dataset classification.

      • If the scan errors out, access the associated Datastore’s scan logs in the SKP Catalog module to troubleshoot the error.

   2. Click Add to configure the required parameter bindings, which are used to relate the records from the grid or form container dataset and the parameters dataset using the following fields:

      Note

      Either Source Column or Source Value must be populated, but not both.

      Property (Name: Type)	Description	Supported Values/Notes
      source_column: string	Select a column from the container that will be used to join the container dataset with the parameter dataset. This property should be empty for container-level events.	maxLength: 128
      source_value: string	Enter a constant value used to filter records from the parameter dataset where the target column equals this value.	maxLength: 255
      target_column: string required	Select a column in the parameter dataset used to filter available records to those that match either the container dataset source column or the source value.	maxLength: 128

6. To add multiple buttons to the toolbar, repeat Steps 3 through 5.

7. Click Save & Preview WebApp to preview WebApp changes.

8. Click Save WebApp .