13. Parameters and filters

Parameters and filters

Parameters make a template reusable; Filters ensure that only the data required for the specific purpose gets into the report.

Open Report designer on the desktop Administration.

Your goal

You understand existing report parameters, can build a filter from fields and parameters and check the effects on data volume and preview.

Why this is crucial in the report designer

A template can use the same structure for different documents, partners or time periods. The parameter provides the context, the filter limits the data to this context.

Elements and settings at a glance

• Name: Technical, stable identifier of the parameter; Do not change existing X-ERP names carelessly.
• Description: Readable designation for a possible parameter display.
• Type: Data type such as text, number, date, true/false or GUID.
• Value / Default Value: Current or suggested value.
• Visible: Determines whether users select the parameter in a preview; X-ERP can hide integrated parameters.
• Multi-Value: Allows multiple values if the use case supports it.
• Filter String: Condition that includes or excludes records based on fields, values, and parameters.

Here's how to do it

1. Check the field list to see which parameters the initial template already has.
2. Identify where each parameter is used: filter, expression, subreport, or data source.
3. Create a filter with an available field and the appropriate parameter.
4. Test valid, empty and non-existent values.
5. Check whether filtering occurs early enough to avoid large amounts of data.

Exercise

In a test list, create a date or category parameter and filter the output on it. Additionally, display the selected value in the report title.

Check the result

• Parameter name and data type match the X-ERP transfer.
• The filter delivers exactly the expected data sets.
• An empty value has a deliberately defined behavior.
• Large amounts of data are not loaded completely unnecessarily.

Typical errors and their solutions

• Rename existing Id parameter: Can break built-in preview or process submission.
• Compare text with number: Data types must fit together.
• Only check visible parameters: Hidden parameters can also be crucial for X-ERP.

Your result

A single template reacts in a controlled manner to the data set, time period or selection - without copies for each individual case.

Further information / source

Related topics

1. For customizers – customize screens and forms › Report designer › 04. Data source, data member and field list
2. For customizers – customize screens and forms › Report designer › 09. Data fields and expression editor
3. For customizers – customize screens and forms › Report designer › 16. Master detail and subreports

Frequently asked questions