Adding or modifying properties

You can add properties to both custom and built-in classes. You can also add local properties to BLPackages and system packages stored in the Depot folder and component templates stored in the Component Templates folder.

When you add a property to a built-in property class, the property is automatically associated with all existing instances of those types of objects. For example, if you add a new property to the Jobs class, the property is:

• Automatically associated with all jobs.
• Inherited by all subordinate built-in subclasses.

When you create a property in the Property Dictionary, the property is available globally throughout TrueSight Server Automation. All roles have access to the property. You can use a parameter to reference the new property in any situation where TrueSight Server Automation supports parameters. When defining BLPackages, component templates, and system packages, you can also create local properties. Properties created in those contexts are not available globally.

Before you begin

Property class properties reference another property class. To apply a custom property class to an object, you must create a property class property that refers to that custom property class. Then, assign the property class property to a built-in property class or create a local property for a BLPackage or component template.

To assign a value for a property class property, you must select an instance of the referenced property class. For more information, see Creating-or-modifying-an-instance-of-a-property-class.

To add or modify a property

1. Do any of the following:
   • Choose Configuration > Property Dictionary View. Using the Property Class Navigation pane, select a property class or subclass for which you want to add or modify a property. In the property list at right, select the Properties tab.
   • Using the Property Dictionary, add a new custom property class (see Adding-a-custom-property-class). In the property list at right, select the Properties tab.
   • Create a BLPackage, component template, or system package that requires a local property. Open the BLPackage, component template, or system package for editing. Click the Local Properties tab.
   • Import an object that references a missing property. When the Import wizard asks you to map a property, add a new property to the Property Dictionary.
2. Do one of the following:
   • To create a new property, click Add New Property .
   • To modify an existing property, select the property and click Edit Property . A property dialog box opens. Depending on your context, the name of this dialog box may vary.

3. For Name, enter the name of the property. For Description, you can optionally provide descriptive text. The name can be a maximum of 255 characters.

   If the name of a property contains more than 30 characters, update the BDSSA_DW system_property table to set the value of EnableLongPropertyName as true.

4. For Type, select one of the following options:

   The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
   This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
   

   For an extended discussion of using property classes and property class property types, see Custom-property-class-description.

5. To specify a default value for the property, check Use this default value. For Default value, enter a default. The method you use for entering a default value depends on the property type you select in the previous step. For example, if the property type is Boolean, you can select True or False from a drop-down list.
   • If the property type is Encrypted String, you must enter a value and then confirm your typing by entering it a second time.

   • If the property type is Long Text, click Browse to the right of Default value, which displays the Edit Long Text dialog box. Enter a long block of text, such as a script. The text block can be a maximum of 2000 characters.

     Note

     When using the Property Dictionary to add a property to a property class or subclass, you must always define a default value for the property. That default value can be null (that is, an empty value). Because of this requirement, the Use this default value option is always checked when you are creating a property. If you are modifying a property inherited from a parent class, you can choose not to use a default value by clearing Use this default value.

6. Specify additional characteristics for the property by checking any of the following:
   • Editable — Users can alter the value of this property.
   • Required — A value must be provided for this property. If you check this, you must provide a default value, and the default value cannot be null (that is, an empty value).
   • Used in reports — This property can be included in reports generated by TrueSight Smart Reporting for Server Automation. This flag is set to true for most properties provided in a standard installation of TrueSight Server Automation. By default it is set to false for all new properties you create.
7. Click OK. The property is added to the list on the Properties tab.