Kentico CMS 7.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 Mail us feedback on this topic!  

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 selected parameter up, which also changes its position in the report's filter.

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. Each category will contain the parameters defined below it.

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

Sets an identifier for the parameter.

Attribute type

Type of value that the parameter should have.

Attribute size

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

Allow empty value

If enabled, the parameter allows empty values.

 

If disabled, users cannot apply the filter to the report unless there is a value entered in the given parameter. In this case the parameter is required and an asterisk (*) is displayed next to it.

Default value

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

Translate field

Indicates if the field should be included when using translation services for the report and its content.

 

Only available if the selected Attribute type is Text, Long text or File.

Display attribute in the editing form

Indicates if the the editing field of the given parameter should be displayed when the report is viewed.

Field appearance

Field caption

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

Form control

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

 

If the form control that you need is not available in the drop-down list, you should be able to assign it through the dialog opened via the (more items ...) option.

Field description

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

Editing control settings

The settings in this section are used to perform additional configuration of the selected Form control, which affects the behavior or appearance of the parameter. The available options depend on the parameters defined for the given form control. Please see the tooltips of individual settings for more information.

 

You can switch between Advanced and Simplified mode using the link on the side of the section. In simplified mode, only a limited set of parameters is offered (typically the most important ones).

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.

Field advanced settings

Visible condition

May be used to enter a macro condition that must be fulfilled in order for the specific parameter to be visible in the report's filter.

 

You can write any condition according to your specific requirements. For details about available macro options and syntax, please refer to the Development -> Macro expressions chapter of the Developer's Guide.

 

If you wish to create a condition that depends on the state of the other parameters in the filter, you can access them in the macro expression using the corresponding Column name. The data of the given fields may then be retrieved through the following properties:

 

Value - returns the current value of the parameter. For example, FromDate.Value is resolved into the value entered into the report's FromDate parameter.

Visible - returns a true value if the given parameter is currently visible in the filter.

Enabled - true if the parameter is currently enabled, i.e. its value can be edited.

Info.<field setting> - may be used to access various settings configured for the parameter's field, for example: FromDate.Info.DefaultValue

Enabled condition

Allows you to enter a macro condition that determines when the parameter should be enabled. If this condition is resolved as false, the parameter will be visible, but it will not be possible to edit its value.

 

You can use the same macro options as described above for the Visible condition property.

Has depending fields

If enabled, the report filter will be refreshed via autopostback whenever the value of the given parameter is changed. This means that other parameters can be dynamically updated according to the current value of the parameter.

 

Please note that the actual logic of the dependencies needs to be implemented in the code of the used form controls.

Depends on another field

This option must be enabled if you wish to have the behavior of the parameter dynamically changed according to the value of some other parameter.

 

The following properties are available when creating or editing categories:

 

Category

Category name

Sets the name of the category that is displayed in the report's filter.

Collapsible

If enabled, users will be able to collapse and expand the content of the category.

Collapsed by default

If enabled, the category will initially be collapsed when the filter is loaded.

Visible

Indicates if the category and all of the parameters under it should be visible in the filter.

Visible condition

May be used to enter a macro condition that must be fulfilled in order for the category to be visible. You can use the same macro options as described above for the Visible condition property of parameters.

 

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

 

More resources can be found in:

 

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

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

Developer's Guide -> Development -> Form controls