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!  

This tab enables you to specify parameters for the action step that you're editing. The parameters will be configurable in the properties of the action step after it is incorporated into a workflow process.

 

You can manipulate parameters using the buttons next to the list of parameters:

 

Move up (Up) - moves the parameter up, which changes its position in the editing form of the action step.

Move down (Down) - moves the parameter down, which changes its position in the form.

New category (NewCategory) - creates a new category for parameters. Parameters belonging to a category are grouped together and displayed under a header in the form. Each category will contain the parameters defined below it.

New attribute (AddWebPart) - adds a new parameter.

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

 

In the right hand part of the tab, you can specify the following properties for the currently selected parameter:

 

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

 

Database

Column name

Sets the name used to identify the parameter.

Attribute type

Type of value that the parameter should contain.

Attribute size

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

Allow empty value

If enabled, the parameter allows empty values.

 

If disabled, users cannot save the editing form 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 steps of this type are inserted into a workflow process.

Display attribute in the editing form

If this property is not checked, the given parameter will not be available when configuring action steps of this type.

Field appearance

Field caption

Sets the text displayed in the editing form.

Form control

Selects the form control that should be used in the editing form to interact with the given parameter.

 

If the form control that you need is not available in the drop-down list, you should be able to select 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. See the tooltips of individual settings for more information.

Validation

Regular expression

This regular expression will be used by the validator of the parameter. 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 save the form.

CSS styles

Caption style

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

Input style

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

Control CSS class

Name of the CSS class used to style the parameter.

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 editing form.

 

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 other parameters, you can access them in the macro expression using the corresponding Column name. You can then retrieve the data of the parameters via the following properties:

 

Value - returns the current value of the parameter.

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

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

Info.<parameter setting> - may be used to access various settings configured for the parameter, for example: SiteName.Info.Caption

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 parameters

If enabled, the editing form will be refreshed 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.

 

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

Depends on another parameter

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 editing form.

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 form is loaded.

Visible

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

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 the settings of a parameter or category must be confirmed by clicking the Save Save button at the top.