Typically in a planning application, users may need to execute an Integrator process. In prior versions of Jedox, a macro script was required to execute such a process. The Integrator Action now allows the report builder to completely parametrize an Integrator Load or Job via a form element (Button, Checkbox, List, Date Picker, or Combobox) on a spreadsheet.
You can use the Integrator 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 Integrator 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 Add Action. Select the Integrator 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.. Here you can also choose the Scope, the Project, and the Load or job.
For the Scope, and Load or job sections of an Integrator Action, you can define a named range, a range, and a variable. When using a named range in the Load or job section, the correct syntax for referring to an ETL load/job is to refer to the load/job locator, not the name of the job. For example, for a job called "default" in a project called "sampleBiker" the correct syntax is:sampleBiker.jobs.default
In the feedback section, you can choose whether to wait for the Integrator Load/Job to finish before the user can continue working, or to put the Integrator Load/Job in the background and receive a notification once it is finished. If you activate the Show execution result through notification banner option, a banner informs you when the Integrator process is finished.
Clicking on the info button opens a log that allows you to see the execution status.
- Label and format the button as desired.
When defining an Integrator Action, the designer can also see the Project variables for the selected Integrator job, and pass values to those variables. To define variable values, enable the option "Execute with parameters."
Integrator Confirmation dialog
When you choose the Integrator 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:
Assigning Actions to Workbook event
As a Jedox Report Designer, you can assign an Action to open, load, and close workbook events. This way, the states are initialized or cleaned up without needing to write any Macros.
To assign an Action for workbook events, click on File > Workbook event.
You can assign an Integrator Action to the Load, and Close workbook events.
Notes:
-
Actions assigned to the Workbook events in the "Resource" workbooks (workbooks loaded in the background while some reports are opened) will not be executed.
-
When using a Canvas, only Actions assigned to the Workbook events in the current Workbook, which contains the Canvas, are executed. Actions assigned to the Workbook events in other workbooks, from which the content is loaded into the Canvas, will not be executed
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. Note: If you set a button in a spreadsheet with 2 Actions assigned (eg: Upload and Integrator), and after executing the button you need to cancel the 1st action (Upload), the 2nd action (Integrator) will still be executed. Workaround: to avoid running an unwanted job, set a confirmation dialog for the Integrator Action.
Updated November 5, 2024