You can create property definitions to allow for additional levels of vRealize Automation customization. When you create a property definition, you specify a data type for the property, for example String, and a display type, for example Email.

About this task

To avoid potential conflict with supplied vRealize Automation custom properties, use a naming format of my_prefix.my_property_name1. For example, use a standard and meaningful prefix such as company or feature name, followed by a dot (.), followed by a brief but descriptive name. Properties that you create that do not follow this recommendation may conflict with vRealize Automation-supplied custom properties. In that event, the vRealize Automation custom properties take precedence over properties that you create.


Log in to the vRealize Automation console as a tenant administrator or fabric administrator.


  1. Select Administration > Property Dictionary > Property Definitions.
  2. Click New (Add).
  3. Enter the new property definition name in the Name text box.

    Use a standard naming convention for the new property name such as my_grouping_prefix.my_property_name.

    The Name value is stored internally as the property identifier (ID).

  4. Accept the generated value in the Label text box.

    The Label value is automatically populated with the value that you entered in the Name text box. If you enter a Label value first, the Name text box is populated with the same value.

    The Label value is displayed in the user interface when requesting properties, for example when adding a property to a blueprint, as the property name.

    The Label value can contain a wider range of characters than the Name value.

  5. In the Visibility section, select All tenants or This tenant to determine where the property is to be available.

    If you are logged in with only tenant administrator privileges, then only This tenant is available. If you are logged in with only fabric administrator privileges, then only All tenants is available.

    You cannot change the All tenants or This tenant setting after you create the item.

  6. (Optional) Enter a property description in the Description text box.

    Describe the intent of the property definition and any other helpful information about the property.

  7. (Optional) Enter a value in the Order Index text box.

    The number that you enter controls how the property name appears on the request form. The following ordering rules apply:

    • The order index applies only to properties that are configured with Prompt User or Show in Request Form settings.

    • All properties with an order index appear before properties with no order index.

    • Properties with an order index are sorted from lowest to highest order index value. Negative numbers are allowed.

    • All properties are ordered alphabetically, with all ordered index properties appearing before non-order-indexed properties.

    • If two properties have the same order index value, then they are sorted alphabetically.

  8. Select a property definition data type from the Data type drop-down menu.
    Table 1. Property Definition Data Types

    Data type



    Allows for a boolean value.

    The display advice options are Checkbox and Yes/No.


    Allows for a value entered in a date and time format.

    The display advice option is Date Time Picker.


    Allows for an integer or decimal value.

    The display advice options are Dropdown, Slider, and Textbox.


    Allows for an integer value.

    The display advice options are Dropdown, Slider, and Textbox.

    Secure String

    Allows for secure or encrypted content such as a password.

    The display advice option is Textbox.


    Allows for a string value.

    The display advice options are Dropdown, Email, Hyperlink, Textarea, and Textbox.

  9. If the Required option is available, select Yes or No from the drop-down menu to specify if a value must be supplied for this property.
  10. If the Minimum value option is available, specify a minimum value.
  11. Select a display control type for this property in the Display advice drop-down menu. Available options are derived from your Data type selection.
    Table 2. Property Definition Display Advice Options

    Display Advice Option



    Provides a single check box control.

    Date Time Picker

    Provides a date and time control that adheres to a YYYY-MM-DD or MM/DD/YYYY format and a time in HH:MM format, 24-hour clock or followed by AM or PM.


    Provides a drop-down menu control.


    Provides an email control.


    Displays a link with the property display name as the link text and the property value as the URL.


    Provides a slider control for a range of values.


    Provides a text area in which to enter or display information.


    Provides a text box in which to enter a value.


    Specifies a Yes or No value.

  12. Click the Pre-defines values option in the Values area.

    Click New in the Pre-defines values area and add a property name and value.

  13. (Optional) Optionally select the Enable custom values check box to allow the user to specify custom values in addition to pre-defined values.
  14. Click OK.


The property is created and available on the Property Definitions page.