BladeFX Documentation

Parameters in Report

🧩 What Are Parameters in Report Code?

In Blade FX Reports, a parameter represents a dynamic input value that controls how a report is executed and filtered.

Parameters allow reports to be:

  • Reusable
  • Dynamic
  • User-driven or system-driven

A parameter can be:

  • Entered manually by the user
  • Passed programmatically
  • Loaded from a database query
  • Hidden and used internally by the report

A single report can contain one or multiple parameters, each serving a specific purpose.

🧠 Conceptual Meaning of a Parameter

A report parameter is not just a UI input field.

Instead, it is:

  • A typed variable
  • A runtime input
  • A binding point between the report UI and report data sources

Think of a parameter as:

One parameter → one value → reused across tables, queries, and logic

📋 Parameter List

The List of Parameters view provides an overview of all parameters defined for a report.

Each parameter includes:

  • Parameter name (used in queries, e.g. )
  • Caption (display name in UI)
  • Description
  • Data type
  • Test value
  • Visibility
  • Sort position
  • Usage count

This view helps you:

  • Understand which parameters exist
  • See where they are used
  • Manage visibility and order

⚙️ Parameter Definition

The Definition tab defines the core identity of a parameter.

Required fields:

  • Name – technical identifier (e.g. )
  • Caption – label shown to the user
  • Control – UI input type (TextBox, ComboBox, etc.)
  • Data type – Int, Varchar, Text, etc.
  • Connection – database connection used (if applicable)

Optional fields:

  • Description
  • Test value
  • Is visible

This section answers the question:

👉 What is this parameter and how is it entered?

🧩 Report Definition (Parameter Behavior)

The Report Definition tab defines how the parameter behaves inside the report.

Here you configure:

  • Sort position – order of parameters in the UI
  • Max items (combo) – selection limit for list-based parameters
  • Is mandatory – must be provided to run the report
  • History off – exclude from parameter history
  • Is hidden – used internally, not shown to users

This section answers the question:

👉 How does this parameter behave during report execution?

🔗 Linked Parameters

Linked parameters allow:

  • Dependencies between parameters
  • Cascading selections
  • Conditional logic

If no linked parameters exist, the list remains empty.

📚 Value List

The Value List tab defines how parameter values are populated.

A parameter can use:

🔹 Fixed values

  • Manually defined
  • Static
  • Suitable for constants or internal parameters

🔹 Values retrieved from database

  • Loaded dynamically
  • Based on parameter connection
  • Used for dropdowns, lookups, selectors

This section answers the question:

👉 Where do the allowed values for this parameter come from?

📌 Existing Parameters

The Existing Parameters tab provides a full overview across the system.

It shows:

  • Parameter usage across reports
  • Connections used
  • Data types
  • Test values
  • Visibility
  • Usage count

This is especially useful for:

  • Reuse
  • Refactoring
  • Impact analysis