Add or edit component properties

This topic describes the types of component properties and explains how to add or edit these properties.

Overview

Component properties include not only properties to be resolved for the component, but also settings that can be overridden for each environment to which the component is mapped and for each version of the component.

For more information on the use of properties in Deployment Automation, see Use properties.

The following table lists the types of properties you can define for components:

Type Description
Properties These general component properties can be used in scripts and plugins. Properties inherited from templates cannot be modified on the component level.
Environment Property Definitions These environment properties are available to environments that use the component. You can set values at the individual environment level.
Version Property Definitions These version properties are available to the component's versions. You can set values at the individual version level.

Back to top

Add or edit component properties

You can add component properties one at a time or in a batch.

To add a single property to a component:

  1. Navigate to Management > Components > [select component].

  2. Select Properties and then click the Properties tab.

  3. Click Add Property. The Add Property dialog box opens.
  4. Specify the following details for the new property:

    Field Description
    Name Enter a name for the property.
    Description (Optional) Provide additional information for the property that may be specific to the component.
    Secure Select this option if you want the property to be secure.

    Secure properties are stored encrypted, and their values are displayed obscured in the Deployment Automation user interface.
    Value (Optional) Enter the value of the property to be used by steps in a process.
  5. Click Save.

    To create another property, click Save and New.

To edit a property, click the Edit icon next to the property.

Note: When editing a single property, you can't rename it. To change the name, use the Batch Edit option.

You can create or update multiple component properties at once with Batch Edit.

To add multiple component properties:

  1. Navigate to Management > Components > [select component].

  2. Select Properties and then click the Properties tab.
  3. Click Batch Edit. The Edit Entry dialog box opens.
  4. In the Properties field, specify properties with or without their values.

    Enter each property on a new line in the following format:

    Format Description
    myProperty
    myProperty=
    Use this format to specify properties without values. For example, for the port property, enter:
    port
    or
    port=

    Note: When you save properties without values, the system automatically changes the myProperty format to myProperty=
    myProperty=value Use this format for properties with values, for example:
    host=myServer
    port=8080

    Note: Take into account the following restrictions for batch editing:

    • You cannot set the Secure option. If you want the properties to be secure, edit them individually.
    • The value cannot contain the equals sign (=).
  5. Click Save.

To use component properties in a process, reference them in relevant process steps with the following syntax:

${p:component/<property name>}

For details on applying user-defined properties, see How properties are resolved.

Back to top

Add or edit component environment properties

You can define properties with unique values for each of the environments mapped to the component. This enables you to run the same process step in multiple environments that have different configurations.

Deployment Automation resolves the property values when the component is deployed to each environment. For example, if you have different web server instances on each environment, you can add a component environment property and set a different value for each environment, DEV, INT, UAT, and PROD.

To add component environment properties:

  1. Navigate to Management > Components > [select component].

  2. Select Properties and then click the Environment PropDefs tab.

  3. Click the Add Property button.

  4. In the Add Property dialog box, specify the following property details:

    Field Description
    Name Enter a name for the property.
    Description (Optional) Enter additional information about the property.
    Label (Optional) Enter a label to be associated with the property in the user interface.
    Required Select this option if you want the property to be required.
    Type

    Select the type of expected value from the following options:

    • Text. Enables you to enter text characters. This is the default type.
    • Text area. Enables you to enter an amount of text.
    • Check box. Displays the check box. If selected, a value of true is used. Otherwise, the property is not set.
    • Select. Requires one or more values to be selected from the list. Enables a single selection.
    • Multi select. Requires one or more values to be selected from the list. Enables multiple selections.
    • Secure. Used for passwords. It is similar to Text, except the values are displayed obscured.
    Default Value (Optional) Enter a default value (if any).
  5. Click Save.

To edit a property, click the Edit icon next to the property listing.

To set values for the property in each of the component's application environments, see Setting Component Environment Property Values.

Back to top

Add or edit component version properties

You can define properties with unique values for each version of the component.

To add component version properties:

  1. Navigate to Management > Components > [select component].

  2. Select Properties and then click the Version PropDefs tab.

  3. Click the Add Property button.

  4. In the Add Property dialog box, specify the following property details:

    Field Description
    Name Enter a name for the property.
    Description (Optional) Enter additional information about the property.
    Label (Optional) Enter a label to be associated with the property in the user interface.
    Required Select this option if you want the property to be required.
    Type

    Select the type of expected value from the following options:

    • Text. Enables you to enter text characters. This is the default type.
    • Text area. Enables you to enter an amount of text.
    • Check box. Displays the check box. If selected, a value of true is used. Otherwise, the property is not set.
    • Select. Requires one or more values to be selected from the list. Enables a single selection.
    • Multi select. Requires one or more values to be selected from the list. Enables multiple selections.
    • Secure. Used for passwords. It is similar to Text, except the values are displayed obscured.
    Default Value Enter a default value (if any).
  5. Click Save.

To edit a property, click the Edit icon next to the property listing.

To set values for the property in each of this component's versions, see Setting Component Version Property Values.

Back to top

See also: