BackPrevious Page Next PageNext

Specifying Parameter Values

Specifying multiple values for a parameter

Setting values for Date/Time/DateTime parameters

Customizing the display order of parameters

When you preview, print or export a report with parameters, or preview a query that contains parameters, JReport Designer will prompt you the Enter Parameter Values dialog to specify values for the parameters. All the parameters used in the report or query and the prompting information are listed.

Enter Parameter Values dialog

The way to specify a parameter value varies with the type and properties of the parameter. Here are several ways you can use to specify parameter values:

Note: You are recommended not to use blank as the thousands separator in Number-typed parameter values under French locale, otherwise your input will not be correctly recognized because of a JVM bug. For details, see http://bugs.sun.com/view_bug.do;jsessionid=c8cdaf911b20fffffffffd9fc6340b30d670?bug_id=4510618.

Specifying multiple values for a parameter

For a parameter that allows for multiple values (the parameter's Allow Multiple Values property is true), you can specify one or more values to it.

  1. Click More button next to the value text box of the parameter. The Enter Values dialog appears.

    Enter Values dialog

  2. If the parameter's Enable the "All" Option property is true, the All checkbox is available and by default it is selected. It means to apply the "All" value to the parameter, which could be all values of the parameter determined by JReport, all values in the database or all the available values according to the Scope of All Values setting of the parameter. When the parameter is inserted as a field into a report and All is selected as the value, the field will show the string "All". If you do not want to apply the "All" value to the parameter, deselect the All checkbox and then specify the desired values as shown in the following steps.
  3. Select the required values in the Available Values box and click Add button to add them to the Selected Values box; to add all the available values, click Add All button. You can make use of the Search text box to search for the required values among the available values: type in the keyword and the available values that contain the keyword will be listed with the keyword highlighted in the values.

    If some added values are not wanted, select them in the Selected Values box and click Remove button to remove them; to remove all added values, click Remove All button.

  4. When the parameter's Allow Type-in of Value property is true, the Search text box will be replaced by the Enter Values text box. You can type in a value manually and click Add button next to add it to the Selected Values box. When the parameter is bound with a column, but the display column is different from the bound column, make sure the value you enter is that of the bound column. If the parameter is of the Date, Time or DateTime type, you can also click the calendar button Calendar button to specify a date and time value.

    Enter Values dialog - allow type in

  5. Click OK to select the specified values for the parameter.

Setting values for Date/Time/DateTime parameters

When specifying value for a parameter of the Date, Time or DateTime type which allows for type-in values (the parameter's Allow Type-in of Value property is true), you can make use of the calendar to select a date and time as the value, or customize a dynamic date and time value by creating an expression using JReport's built-in Date/Time functions. For example you might want the start date to always be 7 days ago and the end date to be today, you can then customize the value for the start date parameter as dateadd('d', -7, today()) and today() for the end date parameter. The expression has higher priority than the value specified using the calendar.

To select a date and time value from the calendar:

  1. Click the calendar button Calendar button next to the value text box of the parameter. The following dialog appears.

    Calendar dialog

  2. In the calendar on the left, specify the month, year and day accordingly.

  3. If the parameter is of DateTime type, the time setting is available. From the Display Time Format drop-down list, specify in which format to display the time, 12 hours or 24 hours (each time when the calendar is accessed, the default selected format is always 12 hours), then select the hour, minute and second time from the corresponding drop-down lists and choose whether it is AM or PM.

  4. Click OK to add the value.

To customize a dynamic date and time value by creating an expression:

  1. Click the calendar button Calendar button next to the value text box of the parameter. The following dialog appears (if the right section of the dialog is not displayed, click Choose button on the bottom left corner to expand it).

    Calendar dialog

  2. The Template drop-down list provides some predefined expressions for you to use. You can customize your own expression either based on an existing template or by directly editing the contents in the Expression text box.
  3. You can make use of JReport's built-in Date/Time functions in the expression. To display the functions, click Choose button next to the Template drop-down list.
  4. The Expression dialog appears. The top text box shows the current expression statement if there is. Put the cursor where you want to insert the function in the statement, then double-click the required function to insert it there. Click OK to close the dialog.

    Expression dialog

  5. The Preview box calculates the result of the current expression. Each time you modify the expression, you can click in the box to refresh the result. The date/time in the calendar on the right can be synchronized with the date/time calculated by a valid expression. If it is an invalid expression, an error message will be shown in the box and no change will be made to the calendar and the currently selected date/time will be remained in the calendar.

  6. Click OK to add the value.

After you use an expression to specify the value, when you hover the mouse pointer over this value in the Enter Parameter Values dialog, a tip will appear showing its expression. Click in the value text box, the expression will be displayed in the text box. You can edit the expression in the text box directly if you want. After editing, when you click elsewhere outside of the value text box:

Customizing the display order of parameters

By default the parameters are displayed in ascending alphabetic order in the Enter Parameter Values dialog, thus the parameter pEndDate appears before pStartDate which would be very confusing to users. JReport allows you to customize the display order of the parameters in the dialog so that they could be shown in a more reasonable sequence. The order will not affect the display sequence of the parameters in the resource tree, which is determined by the Sort setting in the Options dialog.

You can customize the parameter display order at two levels: catalog and specific report. When the order of parameters in a catalog is specified, the order will be applied to all reports using the catalog. When both levels of orders are configured, the report level order has higher priority than the catalog level one.

To adjust the parameter order for a catalog:
  1. Open the catalog containing parameters for which you would like to adjust the order.
  2. In the Catalog Manager, expand a data source, select the Parameters node or any parameter in the node, then click Parameter Order on the Catalog Manager toolbar. The Parameter Order dialog appears.

    Parameter Order dialog

  3. Make use of the Move Up and Move Down buttons to adjust the order of the parameters, or simply drag and drop the parameters in the Parameters box. When a catalog contains a lot of parameters, it might be much easier by dragging and dropping.
  4. Click OK to accept the changes.

To adjust the parameter order for a specific report:

  1. Open the report containing parameters for which you would like to adjust the order, then click Report > Parameter Order. The Parameter Order dialog appears, listing only the parameters used in the currently open report.
  2. Make use of the Move Up and Move Down buttons to adjust the order of the parameters, or simply drag and drop a parameter. The parameter order specified in the report will override the one in the catalog if they are different.
  3. Click OK to apply the specified order.

BackPrevious Page Next PageNext