Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Create Your First Report

Steps to Create/Edit a Report

Open the Report Context Menu:

  • Right-click on the report grid to open the context menu.

  • Select New to create a new report.

...

  1. Define the Report:

    • The Report Definition page will open with the following fields:

      • Name: The name of the report.

      • Description: A description of the report.

      • Hash Code: An autogenerated hash for the report (this cannot be changed).

      • Connection: Specifies the database or REST service used as the data source.

      • Category: The category under which the report is classified.

      • Is Active: Indicates the current status of the report.

      • Is Drilldown: A checkbox that designates whether the report is standalone or connected to another report.

      • Log History: Determines if history will be preserved for this report.

      • Execute Queries Together: Executes queries simultaneously rather than sequentially.

    • After entering the required information, press the Save icon on the toolbar to create the new report. New options will become available once the report is saved.

...

  1. Report Definition Tab:

    • This tab allows you to modify report definitions (e.g., name and description).

  2. Report Code Tab:

    • This is where you define queries to retrieve data from one or more data sources.

Snimka reportCode-20241104-125907.pngImage Added

Here we will create out first simple query:

Select *
From abc_grids

  • In this example, abc_grids is the database table containing the list of grids.

  • You can save the report using the Save icon or test your query using the Test icon. To retrieve a list of database objects based on your connection, press the List Objects icon.

  • If both the connection and query are correct, the data will display below the query field.

image-20241104-130859.pngImage Added

  1. Report Designer:

    • This section allows you to add graphical elements to your report data.

      • Select data sources from the right-side menu and drag and drop the desired fields into the designer.

    • To see how the report will appear, press Preview.

image-20241104-133105.pngImage Added

To add some fields to designer we select datasources from right sidemenu and drag and drop desired fields:

image-20241104-135238.pngImage Added

When we press preview we can see how out new report looks like:

image-20241104-135319.pngImage Added

4. Report Parameters:

  • This is where you can add parameters to filter report data dynamically.

    Example:

    • Create a parameter that will display as a text box with the NVarChar field type. For testing, set the parameter to display reports that start with "Report."

    • Return to your query and use the parameter in a WHERE clause:

image-20241104-135836.pngImage Added

Here we added parameter that will show as a text box and is NVarChar field and for test value we want all reports that start with report.

Now we can go back to our query and now we can add “Where” clause using our parameter we just created.

image-20241104-140620.pngImage Added

Select abc.token, abc.name, abc.description,abc.active,abc.dtcreated
From abc_grids abc
where abc.name like @Test +'%'

image-20241104-141345.pngImage Added

And we now check designer our preview would show this:

image-20241104-141450.pngImage Added

In preview mode, this parameter will automatically filter results starting with "Report." In production, users can input a filter term manually.

Preview the Report:

  • Go back to the report list. Right-click the grid to open the context menu, and select Preview.

  • The preview page will display the test parameter, allowing you to filter reports interactively. Filtering will occur in the database to improve speed.

  • Press Run Report to generate and display the final report.

...

image-20241104-151350.pngImage Added

When we press “Run report” we get our report:

...

This quick guide provides an overview of BladeFx report creation capabilities. For more details, please refer to the full documentation.