Working With PopUps
“PopUps” are components of the application which are not navigated to directly as a screen but exist as sub-components of another screen (either a Dashboard, View or Widget). A PopUp as the name implies is a modal window which will “float” on top of the screen from which it is called. This allows another task to be performed or extra detail to be examined then return to the main screen. A PopUp always contains a Widget, which can be of any widget type.
Apliqo UX supports 2 kinds of PopUps:
- ToolBar PopUp:
ToolBar PopUps are called from a button on the ToolBar. The PopUp can take the context of the FilterBar for displaying data either in a grid or chart widget.
- Table PopUp:
A Table PopUp in called from a cell within a table or grid component. (The name refers to how the PopUp is called not what the Widget contains). Within the demo application the magnifying glass icon is typically used for Table PopUps although any icon could be used. Table PopUps in addition to taking the FilterBar context can also take the row element context. This can be used for a variety of applications, for example simulating a drill-through.
A toolbar popup appears inside the toolbar as a clickable button. When clicking on it a popup opens, displaying data as per its configuration. It is possible to insert one or more toolbar popups in both Views and Dashboards. To do it just click the “Add” button and select “Toolbar popup”
As an example, the “Expense overview by region” View, under the “Expense planning” application, contains several toolbar popups differently configured. Let’s analyze the first two of them:
It is possible to open and edit them inside the “View definition” app, as usual:
The first one is titled “GL view”, its type is set to “toolbar” and has also an icon assigned (see previous sceenshots):
The popup type can be set to “toolbar” or “grid”
The “Widgets Ordering Style” property, instead, can be set to “process” or “tabview” to indicate whether the popup should be used to launch a TI process (the result would actually be what is known in TM1 as an “action button”) or to open a new popup tab containing views or widgets, like every other dashboard could do:
This popup is implicitly set to “tabView”, since it contains two widgets:
It is possible to add widgets as one would do for a Dashboard, that is using the “Add” button. Then the “cube” button is used to configure the query and the style of the widgets. The procedure is the same as for widgets inside a Dashboard (see section n. 5).
When clicking on this example tollbar popup the result is as following – a new tab pops up and the two widgets are shown inside of it:
It is obviously possible to close the popup using the “x” button in the upper right corner.
Let’s have a look now to the second button inside the View:
This one has the “Widgets Ordering Style” property set to “process”.
It is possible to specify the parameters for the process inside the “Advanced options” tab on the right side of the settings pane.
When clicking on this popup, a small tab pops up, asking for additional parameters before triggering the process:
After inputting the desired parameters, to trigger the process execution, press “RUN”.
A table popup is somehow different from the toolbar popup in the way that it is available inside a table row to show a detail of the data inside that row or any other related data or graphs. It is equivalent to what is know as Drill Trough function in TM1. If we still consider example View “Expanse overview by region”, the second columns contains a list on table popups, showing a clickable magnifier symbol to open the popup itself:
In, fact if the magnifier on the first row is clicked a popup with the following Widget appears on the screen:
In the “View definition” app is clearly visible that the Dashboard has a Table popup defined, named “General Ledger Overview” and containing a widget named “Comparison”:
The second column in the View is in fact named “General Ledger Overview”.
Let’s click the Settings button of the popup. Its Type is set to “Grid”:
The configuration is equivalent to one of a toolbar popup. By clicking on the cube button, it is possible to set the cubes and queries to retrieve the data to be visualized inside the various Widgets added into the popup.
The procedure is the same used to configure Widgets inside a Dashboard. The dimensions left as Undefined are retrieved from the context of the row from which the popup is generated.
How to use “Action Buttons”
To create an action button in the Apliqo UX interface, there are two possibilities. The first one is to display an button in the toolbar which runs a TI process. To do this simply create a toolbar popup having its Widget Type set to “process”. This is explained in the section above.
The second option, instead, would be the one of placing a button inside a separated widget show in a Dashboard, like the following one:
To obtain this, add a widget to the dashboard, set its title and size, configure the Type as ‘process’.
In the “Select Process” selector it is possible to pick the process to be executed. Note: the cube and query settings are available for a widget having type of “process” but not applicable.