Kentico CMS 6.0 Context Help

Parameters tab

Parameters tab

Previous topic Next topic Mail us feedback on this topic!  

Parameters tab

Previous topic Next topic JavaScript is required for the print function  

Reports may be filtered using custom parameters. On this tab you can define these parameters. The following actions are possible:

 

Move up (Up) - moves the parameter up.

Move down (Down) - moves the parameter down.

New category (NewCategory) - creates a new category for parameters. Parameters belonging to a category are grouped together and displayed under a header.

New attribute (AddWebPart) - adds a new parameter.

Delete item (Delete) - deletes the currently selected parameter.

 

The following properties can be configured for individual parameters:

 

Please note: Not all options may be available depending on the selected Attribute type.

 

Database

Column name

The name that will be used to identify the parameter.

Attribute type

Type of value that the field should have.

Attribute size

Sets the maximum amount of characters that can be entered into the field. Only available if the Attribute type is set to Text.

Allow empty value

Enable this you do not wish the parameter to be checked for empty values. If not enabled, an asterisk (*) will be displayed next to the attribute.

Default value

Default value of the parameter that will be pre-filled when the report is displayed.

Display attribute in the editing form

If you uncheck this property, then the editing field of the given parameter will not be displayed when the report is viewed.

Field appearance

Field caption

Sets the text displayed next to the parameter's editing field.

Form control type

Filters the options available in the Form control drop-down list below according to their type.

Form control

Sets the specific form control that should be used to set the value of the parameter when the report is viewed.

Field description

Tooltip which will be displayed if a user hovers over the field.

Has depending fields

Indicates that other parameters may be updated dynamically depending on the value of the given parameter.

Depends on another field

Indicates that the behaviour (e.g. the available selection options) of the given parameter can be affected depending on the value of some other parameter of the report.

Editing control settings

The settings in this section are used to perform additional configuration of the selected Form control, which affects the behaviour or appearance of the field. Please see individual tooltips for more information.

Validation

Regular expression

This regular expression will be used by the validator of the parameter's field. Only available if the selected Attribute type is Text or Long text.

Min/Max length

Sets the minimum/maximum length for entered values. Only available if the selected Attribute type is Text or Long text.

Min/Max value

Sets the minimum/maximum value that can be entered. Only available if the selected Attribute type is numerical.

From/To

Can be used to specify a time interval into which the entered value must belong. Only available if the selected Attribute type is Date and time.

Error message

Error message displayed if a user enters invalid input into the parameter and attempts to refresh the report.

CSS styles

Caption style

Used to set CSS styles for the caption of the given field.

Input style

Used to set CSS styles for the input entered into the field.

Control CSS class

Name of the CSS class used to style the field.

 

This regular expression will be used by the validator of the field. Only available if the selected Attribute type is Text or Long text.

 

Any changes to parameter settings must be confirmed by clicking the Save Save field button at the top.

 

More resources can be found at:

 

Developer's Guide -> Modules -> Reporting -> Overview

Developer's Guide -> Modules -> Reporting -> Defining report parameters

Developer's Guide -> Development -> Form controls