Occasionally, a report designer needs to provide supplementary documents for the end user. However, it is difficult to insert a document in a spreadsheet. The Download Action solves this problem and helps the designer provide downloadable files to the end user. The files can be any of the files that are stored in the Designer component, and the path where the file should be downloaded from can be parametrized.
You can use the Download Action in both the Jedox Spreadsheet and Canvas. To set this Action up in a spreadsheet, start by selecting a form element such as a Button, Checkbox, List, DatePicker, or Combobox. In Canvas, you should add a native component that supports Actions, such as a Combobox, Button, or Checkbox.
Below are the steps for configuring the Download Action for a Button in a spreadsheet. These steps are also applicable for setting up this Action in Canvas.
-
In the Insert menu, click on the Button icon.
-
Click on the Actions tab and click on Add action. Select the Download Action.
-
The next dialog offers several options for the Action. Using the close button, you can close the Action, and by clicking on the Bin icon you can delete the Action.
-
Path: clicking on the
icon opens the path dialog. In this dialog, the designer can select the path and choose the file they want the end user to download. Clicking on the 
icon opens a set of parameterizable options within the worksheet. You can choose between a range, a named range, a static value, a setting key, or a variable. Note that to add a dynamic inputs, the source must contain the full path to the file/folder as a string, e.g. "//Demo spreadsheets/Demos/Resources/Biker_Header.png" -
Download as: as the Report Designer you can set the file format (.zip or. pb) the end user will be allowed to download.
-
Allow user to select a file: you can limit the end user to download just one file at a time.
-
Allow multiple selections: you can allow the end user to download multiple files simultaneously.
-
-
Label and format the button as desired.
Download Confirmation dialog
When you choose the Download Action in the Type of action dropdown menu, you can see the Confirmation dialog option at the end of the Action dialog.
In the Confirmation dialog, you can customize a confirmation message for the end user. You can add a Title, Body, Primary button label, Secondary button label, and an Icon to your customized message. The screenshot below shows a confirmation message:
Action failure
You can choose between two options in case an Action fails. First, choose to show a pop-up feedback dialog, and second, ignore the failure and go to the next Action.
Updated November 4, 2024