BladeFX Documentation

Reports

πŸ“ Location in Application:

Left-hand sidebar β†’ Reports

πŸ†•Creating a New Report

You can create a report either from scratch or by copying an existing one.

Option A: Create a Blank Report

To create a new empty report:

  1. Navigate to Reports.
  2. Right-click anywhere in the reports grid (or use the context menu).
  3. Select βž• New.
  4. The Report Definition screen will open with empty fields.

Option B: Copy an Existing Report (Recommended)

To create a report based on an existing one:

  1. Right-click an existing report in the list.
  2. Select πŸ“„ Copy report.
  3. A new report will be created with duplicated settings.
  4. Adjust the name, category, and logic as needed.

πŸ’‘ This approach is recommended when creating similar reports or dashboards.

πŸ“ 2. Report Definition

The Report Definition tab defines the basic metadata and behavior of the report.

Required Fields

The following fields must be filled in:

  • Name* - The display name of the report (e.g. Top sold products).
  • Connection* - Select the data source used by this report (e.g. database or ODBC connection).
  • Category* - Defines where the report appears in the application (e.g. Monitor / Dashboard, Catalog).

Optional Fields

  • Description - Short explanation of what the report shows.
  • Hash code - Automatically generated unique identifier (read-only).

βš™οΈ 3. Report Rules

Configure additional report behavior using the following options:

  • βœ… Is active - Enables or disables the report for end users.
  • πŸ” Is Drilldown report - Marks the report as a drilldown target from other reports.
  • πŸ•˜ Log history - Stores execution history and usage logs.
  • πŸ”„ Execute queries together - Runs all queries in a single execution batch.
  • πŸ’Ύ Autosave queries - Automatically saves changes made in the Report Code tab.

πŸ’Ύ 4. Save the Report

To save the report definition:

  1. Verify that all required fields are filled in.
  2. Click the πŸ’Ύ Save icon in the top toolbar.
  3. The report will now appear in the reports list.

🧩 5. Additional Configuration Tabs

After saving the report definition, configure advanced options using the tabs at the top:

</> Report Code

  • Define SQL queries and data retrieval logic.
  • Define grouping and sorting logic at query level.
  • Multiple queries can be used depending on configuration.

🎨 Report Designer

  • Configure pixel-perfect visual layout of the report.
  • Define column order, widths, alignment, and formatting.
  • Control how data is rendered, not how it is calculated.

πŸ”§ Report Parameters

  • Define user input parameters.
  • Pass parameters (e.g. date range, customer ID) to report queries.

πŸ‘₯ Report Rights

  • Control which users or roles can access the report.
  • Restrict visibility and execution permissions.

🏷️ Report Attributes

  • Define additional metadata for the report.
  • Support dashboards, integrations, and categorization.

▢️ 6. Preview the Report

From the reports list:

  1. Right-click the report.
  2. Choose one of the following options:
  • Preview – runs the report with full layout and formatting.
  • Preview only data – shows raw query results without UI formatting.

βœ… 7. Best Practices

  • Use Copy report whenever possible.
  • Choose clear and consistent report names.
  • Assign the correct category to improve discoverability.
  • Test queries using Preview only data first.
  • Disable reports instead of deleting them when unsure.

πŸ› οΈ 8. Troubleshooting

Report not visible β†’ Ensure Is active is enabled and user has permissions.

No data shown β†’ Check connection and SQL logic.

Slow performance β†’ Optimize queries and use parameters.