Add or edit environment properties

This topic explains how to set or modify properties for an environment at the global level.

If an environment is shared by multiple applications, and you want all or most of the applications to use the same value for an environment property, set the value at the environment level. You can override the value for the same property at the application environment level.

Note: If you have added component environment properties to a component mapped to the environment, those properties are displayed in the environment's Component Mapping page, where you can edit their values as needed. For details, see Setting Component Environment Property Values.

Add or edit a single property for an environment

To create an environment property:

  1. Navigate to Management > Environments.

  2. Select your environment and 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 environment.
    Secure Select this option if you want the property to be secure.

    Secure properties are stored encrypted and 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 described in the next section.

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

${p:environment/<property name>}

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

Back to top

Add or edit multiple environment properties

To create or update several environment properties at once, use Batch Edit.

To add or edit multiple environment properties:

  1. Navigate to Management > Environments.
  2. Select your environment and 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 as described in the earlier section.
    • The value cannot contain the equals sign (=).
  5. Click Save.

Back to top

See also: