Creating and editing properties

You can define properties when you are creating or editing objects such as channel templates, channels, packages (or repositories), instances, servers, and environments. These properties become environment variables when you run a command. You can also create or edit global server properties that are available on all these objects by default.

You can also lock properties of a package, repository or an instance. If you lock a repository or instance property, you cannot update or edit it. You can only unlock and edit the package property in a package. Locked properties cannot be edited during the deployment of a package. 

Note

When you specify a property name, do not use the name PATH, because there is an environment variable with the name PATH on a remote host. 

For more information about locking the properties via the API, see Commands.

In addition to the regular field properties, you can also create list propertiesthat display as drop-down lists. For more information, see Creating and editing list properties.

For conceptual information and the property precedence available for the various objects, see Properties.

This topic contains the following information:

To create or edit a package reference property

  1. Navigate to the Define > Packages page.
  2. Click New Package, provide the necessary details, and then click Create and navigate to the Properties tab.
    Alternatively, you can also open a package appearing in the list displayed on the Define > Packages page and then navigate to the References tab. 
  3. Either create a new reference (step 4), or open an existing one and navigate to the Properties sub-tab (step 5).
  4. To create a reference, proceed as follows:
    1. Click Add Reference.
    2. Specify a reference name, method, and other fields if required.
    3. Click Create.
  5. Under a package reference, click the Properties sub-tab, and add properties by specifying their name and value. Click the Submit icon.
  6. To edit a package property, proceed as follows:
    1. Under the Properties tab, click open a property by clicking the property name that appears as a link under the Name column.
    2. If you need to unlock a locked property, click the closed Property Lock icon.
    3. Make your changes to the property name or value.
  7. If you want to lock the property, click the Property Lock icon.
    After you lock a package property, you cannot edit it in the instance. However, you can still unlock it in the package.
  8. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

Note

If you create a property of any level for the Windows or Unix dispatcher, follow the next instructions concerning the use of special characters:

 Unix dispatcher

  1. Place the backward slash before the double quotes character ( \" )
  2. Place the backward slash before the ampersand character ( \& )
  3. Enclose every string containing spaces and the semicolon character in double quotes ( " ; " )

 Windows dispatcher

  1. Place the backward slash before the double quotes character ( \" )

  2. Character & have to be escaped (^&);

  3. Enclose every string containing spaces, semicolon ";", comma ",", and backward slash "\" in double quotes ( " " )

To create or edit an instance property

  1. Navigate to the Define > Instances page.
  2. Open an instance in the list displayed, by clicking the instance name under the Instance column.
  3. Click the Properties tab.
  4. To create an instance property, proceed as follows:
    1. Click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.

  5. To edit an instance property, proceed as follows:
    1. Open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  6. If you want to lock the property, click the Property Lock  icon.
    After you lock the instance property, you cannot edit it. A locked instance property can only be deleted.
  7. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To edit a deployment property

  1. Navigate to the Define > Instances page.
  2. Open an instance in the list displayed, by clicking the instance name under the Instance column.
  3. Click the Deploy button.
  4. Select the appropriate route to deploy the instance to, and then click the Submit button.
  5. Go to the Properties tab,  and edit the property value. 
  6. Click Deploy.

To create or edit a repository property

  1. Navigate to the Define > Repositories page.
  2. Click New Repository, provide the necessary details and then click Create and navigate to the Properties tab.
    Alternatively, you can also open a repository appearing in the list displayed on the Define > Repositories page and then navigate to the Properties tab.
  3. To create a repository property, proceed as follows:
    1. Under the Properties tab, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  4. To edit a repository property, proceed as follows:
    1. Under the Properties tab, click open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  5. If you want to lock the property, click the Property Lock  icon.
    After you lock the repository property, you cannot edit it. A locked repository property can only be deleted.
  6. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To create or edit a package property

  1. Navigate to the Define > Packages page.
  2. Click New Package, provide the necessary details and then click Create and navigate to the Properties tab.
    Alternatively, you can also open a package appearing in the list displayed on the Define > Packages page and then navigate to the Properties tab.
  3. To create a package property, proceed as follows:
    1. Under the Properties tab, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  4. To edit a package property, proceed as follows:
    1. Under the Properties tab, click open a property by clicking the property name that appears as a link under the Name column.
    2. If you need to unlock alocked property, click the closed Property Lock  icon.
    3. Make your changes to the property name or value.
  5. If you want to lock the property, click the Property Lock  icon.
    After you lock a package property, you cannot edit it in the instance. However,you can still unlock it in the package.
  6. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (orchanges).

Tocreate or edit a channel property

  1. Navigate to the Topology > Channels page.
  2. Click open a channel appearing in the list displayed, by clicking the channel name appearing under the Label column.
  3. Click the Properties tab.
  4. To create a channel property, proceed as follows:
    1. Under the Channel panel, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  5. To edit a channel property, proceed as follows:
    1. Under the Channel panel, click open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  6. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To create or edit a channel template property

  1. Navigate to the Topology > Channel Templates page.
  2. Click open a channel template appearing in the list displayed, by clicking the channel template name appearing under the Name column.
  3. To create a channel template property, proceed as follows:
    1. Under the Properties tab, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  4. To edit a channel template property, proceed as follows:
    1. Under the Properties tab, click open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  5. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To create or edit an environment property

  1. Navigate to the Topology > Environments page.
  2. Click New Environment, provide the necessary details and then click Create and navigate to the Properties tab.
    Alternatively, you can also open an environment appearing in the list displayed on the Topology > Environments page and then navigate to the Properties tab.
  3. To create an environment property, proceed as follows:
    1. Under the Properties tab, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  4. To edit an environment property, proceed as follows:
    1. Under the Properties tab, click open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  5. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To create or edit a server property

  1. Navigate to the System > Servers page.
  2. On the Servers tab, open one of the servers in the list displayed, by clicking the server name appearing under the Hostname column.
  3. Click the Properties tab.
  4. To create a server property, proceed as follows:
    1. Under the Server panel, click Add Property.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  5. To edit a server property, proceed as follows:
    1. Under the Server panel, click open a property by clicking the property name that appears as a link under the Name column.
    2. Make your changes to the property name or value.
  6. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To create or edit a global server property

  1. Navigate to the System > Servers > Properties page.
  2. To create a global server property, proceed as follows:
    1. Click Add Property on the right side of your screen.
    2. Specify a property name in the field appearing under the Name column and specify a corresponding property value in the field appearing under the Value column.
  3. To edit a global server property, proceed as follows:
    1. Open one of the properties displayed.
    2. Click the property name that appears as a link under the Name column.
    3. Make your changes to the property name or value.
  4. Click the Submit  icon to save your details (or changes) or click the Cancel  icon to exit without saving any details (or changes).

To override or reset global server property values for a particular server

  1. Navigate to the System > Servers page.
  2. Open one of the servers displayed on the list by clicking the server name under the Hostname column.
  3. On the Properties tab, you can see properties listed under the Server and Global Server panels.
  4. To override a global server property value, proceed as follows:
    1. On the Actions menu displayed at the right of the particular global server property, click Override.
    2. The global server property displayed under the Global Server panel is displayed under the Server panel. Change the property value and then click the Submit icon. The new value is displayed under the Override column next to the global server property.

      Note

      If on clicking Override, you make changes to the property name along with the property value or if you change the property name only, then that property is treated as a new property and the global server property value remains unchanged.

  5. To reset a global server property value to its original state, proceed as follows:
    1. On the Actions menu displayed at the right of the overridden global server property, click Reset.
    2. Click OK.

To delete a property

  1. On the Actions menu, displayed at the right of the particular property, click Delete.
  2. Click OK.

To protect properties with encryption

  1. Click the Encrypt Value  icon next to the Value field when you are creating or editing the property.
  2. Click the Submit icon to save your details (or changes).
    After saving the property, the property value is displayed with asterisks (***).

Related topics

Creating and editing list properties

Properties

Was this page helpful? Yes No Submitting... Thank you

Comments