Component Properties

Properties are parameters that can be preset and passed from step to step in processes.

The component properties available are: custom, environment, and version. Another type, component, is defined by template and becomes part of any component created from the template. See Component Template Properties. Property versions, or changes, are maintained and remain available.

The three types can be defined on the component's Properties pane Management > Components > [selected component] > Properties. The three types are described in the Component Properties table.

Component Properties table

Property Type	Description
Properties	Custom property; can be used in scripts and plug-ins. Properties inherited from templates cannot be modified on the component level.
Environment	Available to environments that use the component. The property will appear on the environment's Properties and Component Mappings tabs. See Environments. Each property must have a type: `Text` Enables users to enter text characters. `Text Area` Enables users to enter an arbitrary amount of text, limited to limited to 4064 characters. `Check Box` Displays a check box. If checked, a value of `true` will be used; otherwise the property is not set. `Select` Requires a list of one or more values which will be displayed in a drop-down list box. Enables a single selection. Note: Not currently implemented. `Multi Select` Requires a list of one or more values which will be displayed in a drop-down list box. Enables multiple selections. `Secure` Used for passwords. Similar to `Text` except values are redacted.
Version	Available to every component version `Management > Components > [selected component] > Versions > [selected version] > Properties`. Values can be set at the individual version level. Each property must have a type (described above).

Property Type

Description

Properties

Custom property; can be used in scripts and plug-ins. Properties inherited from templates cannot be modified on the component level.

Environment

Available to environments that use the component. The property will appear on the environment's Properties and Component Mappings tabs. See Environments.

Each property must have a type:

Text

Enables users to enter text characters.
Text Area

Enables users to enter an arbitrary amount of text, limited to limited to 4064 characters.
Check Box

Displays a check box. If checked, a value of true will be used; otherwise the property is not set.
Select

Requires a list of one or more values which will be displayed in a drop-down list box. Enables a single selection.

Note: Not currently implemented.
Multi Select

Requires a list of one or more values which will be displayed in a drop-down list box. Enables multiple selections.
Secure

Used for passwords. Similar to Text except values are redacted.

Version

Available to every component version Management > Components > [selected component] > Versions > [selected version] > Properties. Values can be set at the individual version level. Each property must have a type (described above).

Component Properties

Component Properties table

Related Topics