Abbreviations, used in manual:
FW - Form Wizard
DD - Drop Down
KPI buttons allow the user to evaluate data regarding a chosen calculation from related Data Sources by using aggregation functions or SQL query(s). KPI is updated when a user adds or edits rows in the FW.
In RDA Designer module, under specific Project, go to “Forms Wizard” component, go to a specific FW, Step 3, click “Edit settings”, scroll down to the KPI section. Click "Add KPI (Agg)" button:
Next fields will appear:
Headline text - KPI’s name that will appear in Step 4/RDA Editor module.
Aggregate Function - choose a function from the list that will be applied to the column chosen in the "Column" field.
Column - select a column from the list of FW's columns' that will be used with chosen Aggregate Function value.
Statement - will contain chosen Aggregate Function with chosen Column. For example: Sum(age).
If needed to edit "Statement" value, enable the “Edit” switcher and change the statement. For example: changed from Sum(age) to Sum(distinct age):
By activating the "Edit" switcher fields "Aggregate Function" and "Column" are disabled and KPI value will be calculated using "Statement" field value.
Validate - "Statement" field validity can be checked by clicking "Validate" button. "Valid query" message will be shown, for example, in case of success:
"External KPI" - when enabled, allows to generate SQL queries using tables related to FW's Data Source. When activating the External KPI, the "Aggregate Function" and "Column" fields are disabled. Insert an SQL query into the "Statement" field, for example:
Use Form Filtering - in order to use KPI functions and have the option to use other FW's filters such as Advanced Search, Filter Form By DropDown and so on, you have to switch on “Use Form Filtering” option and to add system variable “@applyFormFilters;” to the "Statement" SQL query.
For example, we will use another (not FW's base) table “locations” from the same Data Source in order to create External KPI using all of the above options:
When the end user will try to use “Advanced Search” in Step 4/RDAE, system variable “@applyFormFilters;” in previously created External KPI SQL query will be automatically replaced with the value(s) used in “Advanced Search”:
Note: columns used in “Advanced Search” (or any other filters) in Step 4/RDAE should exist in the table(s) used in SQL query for External KPI in case when "Statement" field contains system variable “@applyFormFilters;”! Otherwise External KPI's SQL query will become invalid!
Position - locate the KPI in the RDA Editor screen. Choose out of 4 options:
Type - select suitable type in order to define how to display the Statement in the RDA Editor screen:
Text - display data as a text.
Percentage - add a percent sign to the original number.
Number - display data as a number. For example, the value 1000.5678 returned from KPI's SQL query, will be displayed as 1,000.5678.
Thousands - add a "K" sign as a thousand mark.
Space - display as a white box to separate between KPIs. By choosing this option you won't be able to fill in any fields (except headline text, position, height, width).
Background color - KPI's background color.
Text color - KPI's text color.
Font Size - KPI's text font size.
Height (in pixels) - KPI's button height.
Width (in pixels) - when default value isn't changed, the system will set a default size in pixels.
Default width allows to fit the KPI boxes to any screen size automatically. It’s recommended not to change the auto-size value in this field.
Preview Screen - In Step 4 it's possible to see all the defined KPIs:
Comments
0 comments
Please sign in to leave a comment.