Overview

1. Creating a report.
2. Modifying this report to support the parameters:
   • Retrieving the parameters in the "Open" event of the report via the following syntax:
     
     PROCEDURE <ReportName>(<NameParam1>, ...
     <NameParam2>= "<DefaultValueParam2>", ...
     ...
     <NameParamN> = "<DefaultValueParamN>")
     
     Reminder: Some of the parameters passed to a procedure can be optional parameters. When declaring the procedure, the optional parameters must be described in last position (on the right), with a default value preceded by the "=" sign. For more details, see Procedure parameters.
   • Using these parameters in the report controls.
3. Modifying (if necessary) the application in order to specify the different parameters.
4. Printing the report while passing parameters. For more details, see Printing a report with parameters.

Example

• "RPT_ParamReport" corresponds to a mailing sent to customers.
• This report expects the text of the mailing entered in "EDT_MailingText" as parameter.

1. Create the "RPT_ParamReport" report:
   • Click in the quick access buttons.
   • The new element window appears: click "Report" then "Report".
   • The report creation wizard starts.
   • In the wizard, select "Mailshot" and validate.
     This report is linked to the "Customer" file of your analysis. For more details on how to create reports, see Reports.
2. Customize this report.
3. Write the following code in the "Open" event of "RPT_ParamReport":
   
   // Retrieve the parameter passed to the report and
   // pass a default parameter for the report test
   PROCEDURE RPT_ParamReport(sText = "Default value")
   
4. In the Body block of this report, add the "STC_MailingText" static control used to display the text of the mailing.
5. Write the following code in the "Before printing" of "STC_MailingText" event:
   
   // Retrieve the mailing text
   STC_MailingText = sText
   
6. In an application window, add:
   • the "EDT_MailingText" edit control allowing the user to type the text of the mailing.
   • the "BTN_Print" button used to print the report.

1. Set the report print destination with iDestination (report viewer, print in an HTML file, etc.).
2. Specify the following parameters with iPrintReport:
   • the name of the report to print.
   • the parameters.

• If the report is based on an HFSQL view, the name of this HFSQL view must be specified in iPrintReport, before the parameters. For more details, see Report based on an HFSQL view.
• If the report is based on a memory area, the name of this memory area must be specified in iPrintReport, before the parameters. For more details, see Report based on a memory area.
• If the report is bounded, the maximum and minimum values of the bounds must be specified in iPrintReport, before the parameters. For more details, see Bounded report.

Example