Adding and Configuring Parameters in VDM Views

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Article Goal

Learn how to add and configure parameters in a VDM View to allow dynamic filtering at runtime, using either static or dynamic value lists.

What Are Parameters?

Parameters in VDM allow users to filter their report results at runtime instead of hardcoding filter values into the View. This means you can use one View with many input options, saving time and avoiding the need to duplicate and modify Views for different criteria.

Tip: Parameters are especially helpful when Views are reused across multiple departments or clients with different filtering needs.

Why Use Parameters?

• Reduce the number of separate Views needed

• Customize filtering at runtime without editing Views

• Pass different values to the same View in Scheduler Jobs

• Support dynamic, multi-value, and date filtering

• Increase report flexibility and reusability

Use Case: A single View can be used by many users if it has a parameter for City, allowing each user to run the report for their own location.

Where Are Parameters Used?

Parameters are managed in the Parameters tab of any VDM View. Each parameter you add can be used inside filter conditions (FSGS), Dynamic Queries, or Scheduler executions.

Parameter Properties Overview

Behavior

• Dynamic: Enable to fetch value list from a query.

• Dynamic Query: The query used to populate values when dynamic is enabled.

• Enabled: Toggles whether the parameter is prompted at runtime.

• Parameter / Parameter Value: Set up dependency between parameters.

• Prompt Page: Choose what page the parameter appears on.

• Required: Forces input before running.

• Reset On Search: Clears previous parameter values on new search.

• Type: Controls how the parameter is displayed (e.g., Value, IN, Combo box).

Data

• Datatype: The data type of the parameter (String, DateTime, etc.).

• Description: Optional prompt name shown at runtime.

• Name: Unique parameter name.

• Object Identifier: Typically, ' for strings/dates.

• Values List: Static values list when not using a dynamic query.

Default Value

• Dynamic: Use a query to determine the default value.

• Query Value: Used when no value is entered.

• Value: A fixed default value.

Misc

• Variable Filter: Enables parameter use in variable filter logic.

Suppression

• Allow Suppress: Suppresses parameter’s SQL based on a value.

• SQL Statement: The SQL used when suppression is active.

• Suppress Value: Value that triggers suppression.

Steps to Add a Parameter to a View

Step 1: Open and Run a View

• Open VDM

• Create or open an existing View

• Run the View so the data is loaded

Step 2: Open the Parameters Tab

• Click on the Parameters button in the ribbon

• This opens the parameter editor

Step 3: Add a New Parameter

• Click Add Parameter

• Name your parameter (e.g., FilterCity, StartDate, etc.)

Tip: You can add multiple parameters using this process.

Step 4: Set Parameter Properties

Each parameter includes settings that define its behavior. Key options:

• Type: Determines how users interact with the parameter (ComboBox, IN, Value, etc.)

• Datatype: String, DateTime, Integer, etc.

• Dynamic: Set to True if using a Dynamic Query

• Required: Forces user input at runtime

• Prompt Page: Organize parameters across different prompt screens

• Enabled: Toggle whether this parameter appears at runtime

Tip: You can use Prompt Page numbers to group parameters for cleaner user input.

Step 5: Use the Parameter in Filters (FSGS)

• Go to the FSGS section of the View

• Add a filter that references your parameter

  • Example: City = ?FilterCity?

• Save the View

Step 6: Run and Test

• Run the View again

• A parameter prompt will appear

• Enter values and verify the output is correctly filtered

Example Parameter Types

Combo Box

• Type: Combo Box

• Values List: Static options (e.g., Anchorage, Berlin, London)

• Use when only one value is selected from a dropdown

IN Parameter

• Type: IN

• Values List: Multiple values (e.g., Seattle, Paris, Madrid)

• Use when selecting multiple values from a list

Dynamic IN Parameter

• Dynamic: Set to True

• Dynamic Query: Use SQL like SELECT DISTINCT City FROM Customers

• Allows the value list to be fetched live from the database

Date Time Parameter

• Type: Date Time Picker

• Datatype: DateTime

• Use for reports filtered by specific dates

Note: Some databases use different symbols for date values (e.g., # or '), so make sure your Object Identifier matches.

Article Summary

Parameters in VDM empower users to interactively filter their reports at runtime, eliminating the need to hardcode criteria into Views. With multiple parameter types and advanced configuration options like dynamic queries and suppression, parameters offer highly flexible, reusable reporting. Whether you're building a report for one-time use or embedding it into a job for automated delivery, well-configured parameters make your View smarter, lighter, and easier to maintain.

Use Case: You need a report that filters based on customer city. Instead of creating 10 Views for 10 cities, create one View with a Combo Box parameter and let the user choose the city at runtime.