Run Script

Use this widget action to configure script execution directly from the dashboard.

The script may require you to define input methods. Script launch parameters vary depending on the widget used.

For more information about action configuration parameters, see Running a Script from the Dashboard.

Usage Example

Consider how the Run Script action can transfer data from one table to another and remove it upon clicking a button in Browse mode.

1. Add two tables to the Data Model — product_sales and new_product_sales.
2. Create a script to handle populating data from the product_sales table into new_product_sales (named Importing data in this example). The script has two blocks. The first one is Manual start. Add the block and test it. Add the second block, SQL query, which would execute the query upon run. The query for the block:
   CREATE OR REPLACE TABLE new_product_sales
   ENGINE MergeTree()
   ORDER BY tuple()
   as
   select * from product_sales
   

   
3. Publish the script.
4. Create the second script (named Remove imported data in this example) for clearing the table. The query for the block:
   truncate new_product_sales
   

   
5. Test the block and publish the script.
6. Add Button and Table widgets to the view.
7. Name the first button Import data. Assign the Run Script click action to it and select the Importing data script. In the Auto update parameter select the All views option.
8. Name the second button Remove data. Assign the same click action and select the Remove imported data script. In the Auto update parameter select the All views option.
9. In the Table widget add all the columns from the new_product_sales table as dimensions.
10. Publish the dashboard.
11. Now, in Browse mode, clicking the Import data button populates the table.
12. Clicking the Remove data button restores the widget to its original, empty state.

Click Action in YAML

To add a click action (EXECUTE_SCRIPT), use the keys listed in the tables below. Specify these keys within the onClick block. Keys for the onClick block are described on the page Click Actions.

If the script requires parameters, include a parameters block. Inside this block, use the name and inputMethod keys.

Example:

onClick:
  - name: "Run Script"
    type: EXECUTE_SCRIPT
    scriptKey: script_9124125
    parameters: 
      - name: Parameter 1
        inputMethod: COLUMN
        tableName: table_1
        columnName: column_1
      - name: Parameter 2
        inputMethod: VARIABLE
        sourceVariable: variable_10
      - name: Parameter 3
        inputMethod: FORMULA
        formula: 'avg("table_1"."column_1")'
    updateAfterExecution:
        updateObject: CURRENT_WIDGET