Creating Properties for Custom Components

  1. Open the custom component to which you want to add properties.
  2. Click New. The Add Property dialog box opens.
  3. Enter a Field Name for the property. This is the internal name.
  4. Enter a Display Name for the property. This is the name on the property label.
  5. Select the data Type for the property.
    Data Type
    Description
    Boolean
    Boolean property fields are used to define true/false property values. You can modify the possible values.
    Note: You can modify the True/False values in a boolean data type using the Advanced > Customize... command in the StarTeam Cross-Platform Client.
    Content
    Content property type fields can be used to store rich text values, such as HTML MIME types.
    Date
    Supports a date field.
    Date/Time
    Supports a date and time field.
    Enumerated
    Allows you to create a custom enumerated field. You can modify all possible values and set a default value.
    Group
    Use this type to store the user group values defined on the server. You can only select a single group.
    Group List
    Use this multi-select data type to store the more than one user group value defined on the server.
    Integer
    Support a numeric integer field
    Map
    Use this type to store structured values on items where the value types are not required to be the same or exist on every item instance
    Real
    Supports a numeric real field.
    Text
    Allows you to enter text.
    Time Span
    Allows you to enter a time span in days, hours, minutes, and seconds.
    User
    User data types can be used to store the user values defined on the server. You can only select one.
    User Groups
    Same as the User data type but you can choose multiple items.
  6. For Text or Map property types, enter the Length.
  7. For Enumerated data types, add values using the Possible Values list.
    1. Click Add. The Add Value dialog box opens.
    2. Enter a unique numeric key for the value in the Code field. This value must be an integer between 100 and 1,000,000.
    3. Enter a value in the Name field.
    4. To make a value a child of another value, click the Make child of option and select the parent value in the list.
    5. Click OK.
    6. Repeat these steps for as many values as you want to add.
  8. For the Enumerated data type, select the Supports multi-select option to allow multi value selections.
  9. Enter the Default value if it applies:
    Boolean
    True or False or whatever values you may have changed them to.
    Enumerated
    Select one of the values that you created.
    Integer
    Enter a valid Integer number.
    Real
    Enter a valid Real number.
    Time span
    Check the Time Span option. Enter the number of days and select the hours, minutes, and seconds.
Parent topic: Custom Component Builder