Using Dynamic Resources and Local Parameters in Reports

When working with reports that use business views, sometimes you may find the predefined view elements in the business views the reports use, or the predefined parameters in the current catalog cannot meet your requirements. In this case, you can create dynamic resources (including formulas and aggregations) and local parameters and use them in the reports to get the desired data. Then when you save the reports, Designer saves the dynamic resources and local parameters along with the reports as their resources in the report files. This topic describes how you can create and use dynamic resources and local parameters in a report.

Dynamic resources and local parameters are report level resources, which means they are only available to the report for which they are created. Unless you need to use the formulas, aggregations, or parameters in multiple reports, it is always better to create dynamic resources and local parameters rather than create them in the catalog.

This topic contains the following sections:

Creating and Using Dynamic Formulas
- Using User-Defined Functions in Dynamic Formulas

Creating and Using Dynamic Aggregations
Creating and Using Local Parameters

Creating and Using Dynamic Formulas

To create a dynamic formula:

In the Data panel of the main window, expand the Dynamic Resources > Formulas node and select <New Formula…>, or in the component wizard or dialog box which contains a dynamic formula list, select <New Formula…>.
In the displayed dialog box, specify the name of the formula and select OK. Designer displays the Formula Editor dialog box.
By default, Designer decides whether the formula can be used as an aggregation object, and if not, the formula is used as a detail object. You can specify to use the formula as a detail, group, or an aggregation object, by selecting the corresponding view element type from the Use As drop-down list on the toolbar.
Whether a dynamic formula can be used as a certain type depends on the following rules:
- Any formula can be used as Detail.
- Any formula that references a DBField and not an aggregation can be used as Group.
- A formula that refers only to aggregations can be used as Aggregation. For example, there are two aggregations "Sum_Total" and "Sum_Quantity", and you can create a formula @"Sum_Total" / @"Sum_Quantity" and use it as an aggregation.
- A formula that follows the custom aggregation expression can be used as Aggregation.
Create the formula by double-clicking the required fields, functions including Logi Report built-in functions and user-defined functions, and operators from the Fields, Functions, and Operators panels respectively. You can also write the formula by yourself in the editing panel.
Save the formula and exit editor.

Once you have created a dynamic formula, you can drag it from the Data panel to the desired position in the report, or add it as report field when working with the component wizard.

In the Data panel, you can use the shortcut menu of any existing dynamic formula to edit or delete the formula, or change the formula type as Group, Detail, or Aggregation. You cannot delete dynamic formulas that you have used in the report.

Using User-Defined Functions in Dynamic Formulas

Logi Report supports the User-Defined Formula Function feature which enables you to create any functions as you want and use them in your formulas. However, if you want to use user-defined functions in dynamic formulas, you need to create them specifically for the current report via the dynamic resource list.

To create a user-defined function for a report:

In the Data panel of the main window, expand the Dynamic Resources > User Defined Functions node and select <New Function…>, or in the component wizard or dialog box which contains a dynamic resource list, select <New Function…>.
In the displayed dialog box, specify the name of the function and select OK.
In the User Defined Function Editor dialog box, create the function according to your requirement.
Save the function.
The function is then available under the User Defined Functions node in the Functions panel of the Formula Editor and User Defined Function Editor. You can then call it in a dynamic formula or another user-defined function by double-clicking it.

In the case a user-defined function named "function1" is arguments: integer age, string name;, you can call it as follows:

@function1(25, "John Smith");
@'function1'(25, "John Smith");
@"function1"(25, "John Smith");

If you want to further edit an existing user-defined function or remove any that is not required, right-click the function in the Data panel of the main window and then select the corresponding command on the shortcut menu. You cannot delete functions that you have used in the report.

Creating and Using Dynamic Aggregations

To creating a dynamic aggregation:

In the Data panel of the main window, or in the Resources box of the component wizard, expand the Dynamic Resources > Aggregations node, then select <New Aggregation…>. Designer displays the New Aggregation dialog box.
In the Aggregation Name text box, specify the name of the dynamic aggregation.
Select the ellipsis to specify the field on which the dynamic aggregation is based.
You can map dynamic aggregations to the available resources such as group objects and detail objects in the current business view, or the dynamic formulas that you have created in the report.
From the Aggregate Function drop-down list, select the function to calculate the mapping field. If you select DistinctSum, you should select the ellipsis next to the Distinct On text box to specify one or more fields according to whose unique values to calculate DistinctSum using the Select Fields dialog box.
Select OK to create the dynamic aggregation.

Once you have created a dynamic aggregation, you can drag it from the Data panel to the desired position in the report, or add it as report field when working with the component wizard.

In the Data panel, you can use the shortcut menu of any existing dynamic aggregation to edit it in the Edit Aggregation dialog box or delete it. You cannot delete dynamic aggregations that you have used in the report.

Creating and Using Local Parameters

In the Data panel of the main window, or when specifying the value of a filter condition for a data component using a business view with the Format Filter dialog box, select <New Parameter…> in the Local Parameters node.
In the New Parameter dialog box, create the parameter according to your requirement.
Select OK to create the parameter.

Once you have created a local parameter, you can then use it to dynamically filter data of the data component in the report, add it to a parameter control or parameter form control in the report, or reference it in a dynamic record level pass one formula used in the report.

In the Data panel, you can also use the shortcut menu of any existing local parameter to edit or delete it. You cannot delete local parameters that you have used in the report.

Note icon

You can only use JDK (not JRE) to compile dynamic formulas created in Logi Report.
Currently, you cannot use global variables in dynamic formulas and user-defined functions.
When dynamic formulas and user-defined functions reference display names or mapping names, the names should not contain any of the following characters if you do not quote the names with the double-quotation marks "":
"~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "+", "=", "{", "}", "[", "]", "|", "\\", ":", ";", "\", " ' ", "<", ",", ">", ".", "?", "/"
Examples:
- Expression @Customer#; causes a syntax error, but @"Customer#" is ok.
- If a field has the display name Category.Aggregation, quote it as "Category.Aggregation" or "Category"."Aggregation".

Previous Topic Next Topic