Parameters tab

This tab is used to define parameters for the currently edited macro rule. Parameters make rules more flexible by allowing users to specify values that affect the resulting macro condition. Once the rule is added to the Rule designer, values can be entered for individual parameters through separate editing dialogs.

For example, in a macro rule that requires the current user to be a member of a role, the exact role could be determined by a parameter. This way, the same rule can be used for various different situations.

Please note that in order for the parameters to be functional, it is also necessary to place them into the User text and Condition fields on the rule's General tab.

The following actions are possible:

•Move up () - moves the selected parameter up in the field editor.

•Move down () - moves the parameter down.

•New attribute () - adds a new parameter.

•Delete item () - deletes the currently selected parameter or category.

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

Database
Column name	The name that will serve as the identifier of the parameter. This name is used when adding the parameter into the rule's text or condition on the General tab.
Attribute type	Type of value that the parameter should have.
Attribute size	Sets the maximum amount 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, it will be possible to insert an empty value for the parameter.
Default value	Default value that will be pre-filled when a user edits the parameter in the rule designer for the first time.
Translate field	Indicates if the parameter's field should be included when using translation services for the given macro rule. Only available if the selected Attribute type is Text, Long text or File.
Display attribute in the editing form	This option needs to be enabled in order for the parameter to be editable in the rule designer. You may disable it for fields that store internal values required by other parameters.
Field appearance
Field caption	Sets the text displayed for the parameter in the rule designer before a value is entered. The caption is replaced by the parameter's value after one is specified. The caption is also shown next to the field in the parameter's editing dialog.
Form control	The selected form control will be used to set the parameter's value in the editing dialog. 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's field in the value editing dialog.
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's editing field. The available options depend on the parameters defined for the given form control. Please see the tooltips of individual parameters 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.
CSS styles
Caption style	Used to set CSS styles for the caption of the parameter's editing field.
Input style	Used to set CSS styles for the input entered into the parameter's editing field.
Control CSS class	Name of the CSS class used to style the parameter's editing field.
Field advanced settings
Visible condition	May be used to enter a macro condition that must be fulfilled in order for the parameter's editing field to be visible. Because parameters only have one editing field, it is recommended to use the Enabled condition instead.
Enabled condition	Allows you to enter a macro condition that determines when the parameter should be enabled. If this condition is resolved as false, it will not be possible to edit the parameter's value. 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.
Has depending fields / Depends on another field	Because the editing interface of each parameter is provided by a single field, these settings do not have any effect for macro rule parameters.

Additional resources may be found in:

•Developer's Guide -> Development -> Macro expressions -> Macro conditions

•Developer's Guide -> Development -> Form controls

Help URL: http://devnet.kentico.com/docs/7_0/contexthelp/index.html?macros_macrorule_parameters.htm