4.2 Creating and Deleting Property Pages and Properties

Property pages define a list of properties available as a tab in the Properties dialog box for the elements defined by matching rules in behavior models. Property pages act as a library of definitions that can be linked to one or more behavior models.

A specific type of property page called the SLA Metric Computed property page defines properties for the SLA Metric Catalog and is automatically associated with every element with the class SLA Metric Class that belongs to the behavior model called SLA Metric Model. The SLA Metric Computed property page is designed to generate an SQL query that retrieves custom properties for an element based on data in an external data source. Properties can be added to SLA Metric Computed property page but the existing properties cannot be edited or deleted and the page itself cannot be deleted. For more information about the SLA Metric Catalog, see the Operations Center 5.6 Service Level Agreement Guide.

To manage properties, review the following sections:

4.2.1 Creating a Property Page

  1. In the Explorer pane, expand Metamodel > Property Pages, then select the folder where the new property page should be added.

  2. Right-click the folder where you want to create a property page, then select Create Property Page to open its dialog box.

  3. Specify the name of the property page in the Name field.

  4. Specify the name used for the property page in the Properties dialog box in the Display Name field.

  5. (Optional) To specify a folder to be used in the Properties dialog box, specify folderName|pageName.

    For example, Boston|Headquarters|Contacts shows a Contacts property page under a Boston/Headquarters Hierarchical list in the Properties dialog box for associated elements.

  6. Enter a description for the property page in the Description field.

  7. (Optional) In the Prompt field, enter the text to display at the top of the Properties dialog box before property fields to provide additional information to the user or prompt a user for the information to be given.

    If null, no prompt displays before the property fields.

  8. Define properties as required.

    For more information, see Defining Properties for a Property Page.

  9. Click Create to create the property page.

    A new element displays in the Property Pages hierarchy for the page definition:

    Create Property Page Dialog Box

4.2.2 Deleting Property Pages

  1. Right-click the property page you want to delete, then select Delete Page to display a confirmation dialog box.

  2. Click OK to delete the property page.

    The property page is deleted from the Metamodel hierarchy.

    Properties related to a property page are not deleted when a property page is deleted.

4.2.3 Defining Properties for a Property Page

One or more properties can be defined for a property page. Properties are defined when creating the property page.

Understanding Property Types

Table 4-3 describes the different types of custom properties. The property types are listed in alphabetical order.

Table 4-3 Property Types

Property Types

Mask

Attribute Options

Automatic Validation Rules

Choice (combo box)

N/A

  • Fixed Choice: Define the combo box list options.

  • Dynamic Choice: Combo box options are derived from the element display names of children of a selected element.

Validation rules can be specified optionally, if the combo box is designated as editable.

For examples, see Working with a Multiple Choice Property.

Computed Property

N/A

  • Advanced rules only

 

Computed Property (2 fields)

N/A

  • Property1

  • Property2

  • Function (+,–,/,*,%)

  • Verify property1 and 2 are number types

  • Calculate using mathematical operators , which can be used to compare two properties(property1 * property2)

Currency

$####.##

  • Default Value

  • Input Mask

  • Number Range

  • Required Property

  • None

  • Mask enforces data entry on the input component

  • Value range sets the number range rule

  • Required property sets text length nonzero rule (ignore mask special characters)

Date

MM/DD/YY

(and 12 other allowable)

  • Default Value

  • Input Mask (only for input and property page display)

  • Required Property

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

Duration/Elapsed Time (computed property)

N/A

  • Property1

  • Property2

  • Verify property1 and 2 are date types

  • Calculate date difference (Property2–Property1)

Email Address

None

  • Default Value

  • Email Address

  • Required Property

  • Minimum and Maximum text length

  • None

  • Required property sets text length nonzero rule

  • Email Address sets Email address regular expression (variabletext@ variabletext.variabletext)

  • Minimum and Maximum text length sets text length range regular expression (ignore mask special characters)

Function

N/A

  • Required Property

  • Property1

  • Property2

  • Function (+,–,/,*,%)

  • Verify property1 and 2 are number types

  • Calculate using function (property1 and property2)

HTML Page

N/A

  • Width

  • Height

  • Open Links in External Browser

HTML Text

N/A

  • Width

  • Height

  • Open Links in External Browser

ID

###–##–####

  • Default Value

  • Input Mask

  • Required Property

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

IP Address

###.###.###.###

  • Default Value

  • Input Mask

  • Required Property

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

Number

N/A

  • Default Value

  • Required Property

  • Number Range

  • Decimal Places

  • A Number regular expression rule to enforce the allowable decimal places

  • Required property sets text length nonzero rule

  • Value range sets the number range rule

Text

None

  • Default Value

  • Input Mask

  • Required Property

  • Minimum and maximum text length

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

  • Minimum and Maximum length set text length range rule (ignore mask special characters)

Text Area

N/A

  • Default Value

  • Required Property

  • Minimum and maximum text length

  • Required property sets text length nonzero rule

  • Minimum and maximum length set text length range rule (ignore mask special characters)

Telephone

(###)###–####

  • Default Value

  • Input Mask

  • Required Property

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

URL

None

  • Default Value

  • URL Format

  • Required Property

  • Minimum and Maximum text length

  • URL Format sets regular expression to check for ftp://varialbletext or http/s://variabletext

  • Required property sets text length nonzero rule

  • Minimum and Maximum text length sets text length range regular expression (ignore mask special characters)

  • The URL displays only in the Property page; it does not display as a column in the Alarms view.

Zip Code

#####–####

  • Default Value

  • Input Mask

  • Required Property

  • Minimum and Maximum text length

  • None

  • Mask enforces data entry on the input component

  • Required property sets text length nonzero rule (ignore mask special characters)

  • Minimum and Maximum text length sets text length range regular expression (ignore mask special characters)

Creating a Property

  1. From the Create Property Page dialog box, click Create Property to open the Add Property dialog box:

    Add Property Dialog Box Dialog Box
  2. Specify a name and description for the property in the Name and Description fields.

    To make the property available as search criteria when finding elements, select the Include Property in Find Dialog check box. For more information, see Using Classes and Properties to Enhance Finding Elements.

    Property names cannot include the space character or the following special characters:

    < > # % " ’ { } ( ) [ ] | \ ^ `)

  3. Click Forward.

    The dialog box to define the property type opens:

    Add Property Dialog Box
  4. Specify a name to display for the property in the Label field.

  5. Click the Type drop-down list, then select the type of property.

    Select from the list described in Understanding Property Types.

  6. (Optional) Do any of the following to set property options in the Qualifiers section:

    • To indicate that this property is a key of a CIM class, select the Key check box.

      This option is not used by Operations Center but can be referenced by user scripts or applications.

    • To hide this property on the property page, select the Not Viewable check box.

    • To allow this property to override another property in a parent class, specify the property name to override in the Override field.

  7. (Optional) Do one of the following:

    • Specify a default value for the property in the Default Value field.

      The default property is not entered automatically on an element’s property page. It is necessary to edit the property by placing the cursor in the property field.

    • To enter the Operations Center default value in the property, click Set to Default.

  8. Specify the appropriate symbols or edit the default symbols to define a formatting and validation rule for the property value in the Input Mask field as defined in the following table:

    Symbol

    Description

      #

    Any valid number.

      ’

    Escape character, used to escape any of the special formatting characters.

      U

    Any character. All lowercase letters are mapped to upper case.

      L

    Any character. All upper case letters are mapped to lower case.

      A

    Any character or number.

      ?

    Any character.

      *

    Anything.

      #H

    Any hex character (0–9, a–f or A–F).

    When a mask is defined, you are automatically specifying the exact number of characters expected for the property value.

    Leave the Mask field empty if you do not want to use a mask for the property value.

  9. To make the property a required field, click the Required Property check box.

  10. Click Forward.

    The dialog box to specify validation rules opens. Validation options are based on the type selected.

    In the following example, the rule verifies a valid IP address is entered:

    Add Property Dialog Box
  11. Define validation and computational rules as required in the Validation and Computational Rules list.

    Rules are applied to the property value in the order they are listed in the Validation and Computational Rules list. Use the Add Property Dialog Box Up and Down arrows to sort the rules.

    For more information, see Defining Validation or Computational Rules for a Property.

  12. To create a rule based on another rule, click Add Property Dialog Box (Duplicate), select the rule, then click Add Property Dialog Box (Edit) to specify new criteria.

  13. To edit a rule, select the rule, then click Add Property Dialog Box (Edit) to open the Edit Rule wizard.

    For more information, see Defining Validation or Computational Rules for a Property.

  14. To delete a rule, select the rule, then click Add Property Dialog Box (Delete).

    The rule is removed from the list.

  15. Click Finish to save the property page.

    The property displays in the Property Definitions section of the Create Property dialog box:

    Create Property Page Dialog Box

Adding Separator Lines to Group Sets of Properties in the Property Page

Adding a Separator Between Two Properties

  1. In the Create Property Page dialog box, select a property in the Property Definitions section.

  2. Click Create Property Page Dialog Box (Add Separator).

    A line displays after the property selected in the previous step.

Adding a Separator to an Existing Property Page

  1. Right-click a Property page in the Explorer pane, then select Properties to open the Status property page.

  2. Click Property Page in the left pane to update the page.

  3. Select a property in the Property Definitions section.

  4. Click Create Property Page Dialog Box (Add Separator).

    A line displays after the property selected in the previous step.

Defining Validation or Computational Rules for a Property

Each property definition can have one or more validation rules but only one or computational rules. These can be used to further restrict acceptable values for a property or to perform a mathematical calculation to produce the value.

To define validation rules for a property:

  1. From the Edit Property dialog box, click Forward until you reach the Validation Rules dialog box:

    Create Rule Dialog Box
  2. Click Create Rule Dialog Box Create New Validation Rule to create a new validation rule:

  3. Click the Type drop-down list, then select the syntax type for the validation rule:

    Regular Expression: Specifies how to look for a specified pattern in text and how what processing occurs when a pattern match is found.

    Macro Expression: Specifies how to look for a pattern in text using a statement that contains some variable parameter information and what processing occurs when a pattern match is found.

    Script Expression Specifies how to validate using a script expression.

    Date Range: Validates the selected date matches the rule parameters (Is Before, After, or Between Specific Dates).

    After you select the syntax type, the dialog box options update to match it.

  4. Complete the rule parameters as defined in the following table:

    Validation Rule Types

    Input Types

    Rule Parameters

    Date Range

    Text

    Date

    • Lower Bound

    • Upper Bound

    • Date Format (used if Text input type)

    Regular Expression

    Any

    • Regular Expression

    • Invalid Value Message

    Script Expression

    Any

    • Script Expression

    • Invalid Value Message

    Macro Expression (Velocity)

    Any

    • Macro Expression

    • Invalid Value Message

  5. Enter the error message to display when the data does not meet the validation rule in the Validation Message field.

  6. Click Create.

4.2.4 Working with a Multiple Choice Property

The Choice property type enables creating a multiple choice property that displays in a service model element property page. Only one value can be selected from the Property drop-down list. When configuring the Choice property, it is necessary to specify the values to display in the drop-down list.

When configuring the drop-down list, specify the following:

Specifying a Default Value

When configuring a property, specifying a default value is optional. This value is used for the property until it is changed.

A default value can provide guidance for an expected property value. For example, specify <operating system> as the default value for a property named Operating System. For a multiple Choice property type, the default value should be a choice that displays in the drop-down list. Note that default values satisfy the Required property restriction when a user saves a property page.

To set a default value, enter a string value in the Default Value field in the Add Property dialog box.

Configuring Fixed vs. Dynamic Values

When defining the values for the multiple Choice property type, you can select one of the following:

  • Fixed: Specify a fixed list of values that display in the drop-down list for the property in the property page. Fixed is the default setting, and One, Two, Three, and Four are the default choices that appear in the drop-down list unless you change them.

    Use the Fixed option when there is a predefined list of possible values for a property that rarely changes, such as computer operating systems, usernames, or corporate locations. For example, assume there is a finite list of lab locations for your company. Create a multiple Choice property named Lab Name that includes all of the lab locations.

  • Dynamic: Use Browse to select a parent element whose first-level child element names display in the drop-down list for the property. The dynamic list ensures that all new child elements related to the selected parent automatically display in the drop-down list.

    Each multiple choice value appears in a separate line in the drop-down list and only one value can be selected.

To configure fixed values or a drop-down list:

Creating a List of Fixed Values for the Property

  1. In the Add Property dialog box, select the Fixed radio button.

  2. Replace the default One, Two, Three, Four text with the values that should appear in a drop-down list for this property.

    When you edit the property, these fixed values display as choices in the drop-down list.

  3. Click Create.

    The following illustrates configuring a new Multiple Choice property containing a fixed list of values:

    Add Property Dialog Box

    The following illustrates selecting from a fixed list of values in a Service Model element property page:

    Multiple Choice Property Excerpt

Generating a Drop-down List

If the list of values for a property can change over time, consider defining a Dynamic multiple Choice property based on element names that exist in the Operations Center hierarchy. As an example of an element with dynamic children, assume the business processes associated with the Supply Chain element are expected to change over a few months as new procedures are put in place. You could define the property Req. Process to display all the child elements of the Supply Chain element. When a new process is added, it automatically displays in the drop-down list for the multiple choice property.

To generate a drop-down list using the children of a specific parent element:

  1. In the Add Property dialog box, select the Dynamic (Derived from Element) radio button.

  2. Click Browse, then select a parent element (such as Supply Chain).

    When users edit the property, the selected element’s children display as choices in the drop-down list.

    The following illustrates configuring a new Multiple Choice property containing a dynamic list of the child elements of Supply Chain:

    Add Property Dialog Box

    The following illustrates viewing child elements under Supply Chain:

    Explorer Pane

    The following illustrates selecting from a dynamic list of values generated from the child elements under Supply Chain in a Service Model element property page:

    Multiple Choice Property

Storing and Displaying Different Property Values

Typically, the value displayed for a property is the same as the value stored in the configuration storage database. For each value defined for a multiple Choice property, you can define a displayed value and a corresponding different value that is stored in the configuration storage database.

Displaying One Set of Values

To display one set of values in the property page and store a different set of values in the configuration storage database:

  1. In the Add Property dialog box, select the Separate Values into Display Name and Stored Value (Regular Expression) check box.

  2. To specify the displayed value and the stored value, enter an expression in the field.

    The expression should be in the form: (.*)symbol(.*). The data before the symbol displays in the property page and the data after the symbol is the stored value. The default is (.*)::(.*) where (.*) indicates all data and :: is the separator. This option is available when using both fixed values and dynamic values.

    As an example, a list of system usernames might change over time, but the associated user IDs that are stored by the system remain constant. Assume Lisa Smith married and changed her name to Lisa Jones. The Username property value displayed in the property page might change from Lisa Smith to Lisa Jones, but her fixed, unique user ID, 123456, should remain the same.

Defining the Values Displayed

To define the values displayed in the property page and the stored values:

  1. In the Choice Type section, under Fixed, specify a value consisting of two parts: 1) the display value and 2) the stored value.

    Separate the values using the default regular expression string of “::” (double colon string).

    Using the previous example, enter:

    Lisa Jones::123456
    

    Lisa Jones displays in the property’s drop-down list, but the stored value is 123456.

  2. Select the Separate Values into Display Name and Stored Value check box.

    This ensures only the display names are shown in the drop-down list. If this check box is deselected, both the display names and stored values are shown in the drop-down list.

    The following illustrates configuring a new multiple Choice property to use a fixed value pair in which the values stored differ from those displayed in the property page:

    Add Property Dialog Box

    The following illustrates selecting the values for a property that is configured to display one value in the property page and to store a different value in the configuration storage database:

    Multiple Choice Property

Requiring a Property Value

When defining a multiple Choice property, decide whether the property is required, which requires selecting a property value prior to saving property value changes entered on the property page. Note that if a Default value is specified, it satisfies the Required property option.

To specify a required property:

  1. In the Add Property dialog box, select the Required Property check box.

    By default, the check box is not selected, so a property value is not required.

User Entry of a Multiple Choice Property Value

Another feature of a multiple Choice property is allowing users to directly enter a property value in the property page. This allows greater flexibility in determining a property value for an element, but it can have a negative impact on standardization of data.

To allow users to enter a value for a multiple Choice property:

  1. In the Add Property dialog box, select the Editable check box.

    By default, this option is not selected, meaning users cannot enter property values; they must select a value from the drop-down list.

    The option to make the property editable is applicable for Fixed and Dynamic values. The exception is if you choose to display and store different values, then the property cannot be edited in the property page.

    When the Separate values into display name and stored value check box is selected, the Editable check box is not available.

4.2.5 Working with HTML Pages or Text

To create custom properties that display HTML pages or text, create two custom property pages. One page contains a HTML Page (or HTML Text) property type that contains a specific Web page URL (or HTML text). The other page contains a TextArea property that displays the Web page (or HTML text). Use a common property name to link the two pages. If you enter a different URL in the first property, the displayed Web page updates automatically in the second property.

A subset of HTML is supported for this feature, so some HTML code might not be rendered in the page displayed using the HTML custom properties.

The following example steps through the process of creating two custom properties to display a Web page. Change the Web page content by changing the URL.

To display a Web page as a custom property:

  1. Create a property page named Web Page.

  2. In this page, create and name a property named Page1 that is the HTML Page type.

    If creating HTML text, select the HTML Text type.

    Add Property Dialog Box
  3. Specify the page height=500 and width=100.

  4. Select Open Links in External Browser.

  5. Copy and rename the Web Page property page to Web Page Edit.

  6. Edit Web Page Edit and change the Page1 property type to TextArea:

    Add Property Dialog Box
  7. To attach both new custom property pages to an element, right-click a service model element, then select Manage Properties.

  8. Click the Browse icon, then select both Web Page and Web Page Edit.

  9. Click Apply.

  10. Right-click the same service model element, then select Properties.

  11. Click Web Page Edit.

  12. Enter the URL, and then click Apply.

    Alternatively, if displaying HTML text, enter the HTML text here. It displays in the corresponding HTML Text type property:

    [Text type property]
  13. To verify the setting, click the Web Page property.

    For the example in the above illustration, the Google home page displays:

    [Managed Objects home page]

4.2.6 Configuring Macro Expressions

Operations Center macro expressions use Velocity, which is a third party package provided by the Apache Organization and bundled into Operations Center for macro expressions. Documentation for Velocity is available at http://jakarta.apache.org/velocity.

Macro expressions use the following syntax rules:

  • No spaces are used in macro expressions.

  • The notation for a variable consists of a leading “$” character following by a VTL identifier. A VTL identifier must start with an alphabetic character.

  • Characters in a macro expression are limited to:

    • Alphabetic characters (a–z or A–Z)

    • Numeric characters (0–9)

    • Hyphen (–)

    • Underscore (_)

Example of a Macro Expression

The following is an example of a macro expression for a computed property that generates an e‑mail address by concatenating the first initial of the ContactFirstName property with the ContactLastName property and uses the CompanyDomain property after the @ symbol:

#if( ${ContactFirstName} && ${ContactFirstName.length()} > 0 )
${ContactFirstName.substring(0,1).toLowerCase()}${ContactLastName.toLowerCase()}@${CompanyDomain}
#else 
E‑mail address not computed
#end

ContactFirstName and ContactLastName are both text properties. CompanyDomain is a text property such as NetIQ.com.

If no ContactFirstName is provided, the e‑mail address displays the message: “E‑mail address not computed.”

Using Script Expressions

Script expressions can be used within macro expressions for validation rules and computed fields for custom properties. Also, predefined scripts can be saved and used in macro expressions. This is useful if you are more familiar with NOC Script than with macro expressions.

The following example creates a computed field script expression consisting of an element name concatenated with the text “IS GOOD!”:

Creating the Custom Property

  1. Create a custom property named Good Check.

  2. Select Computed Field as the property type.

  3. Select Script Expression from the drop-down list.

  4. In the text area enter:

    element.getName() + ' IS GOOD! '
    
  5. Click Create.

Testing the Custom Property

  1. Attach the custom property page to a service model element.

  2. Open the custom property page and the Good Check field should display the element name and the words “IS GOOD!”:

    Properties View

Creating the Validation Rule

Assume a property value is valid only if it contains an asterisk (*). Create a validation rule that uses a script expression to check the property value entered by a user.

To create a validation rule:

  1. In the same custom property page as above, define a new property named Validation Check.

  2. Select Text for the property type.

  3. Click Forward to display the validation rules.

    Edit Rule Dialog Box
  4. Create a validation rule, then select Script Expression for the validation rule type.

  5. In the text area, enter:

    valueText.indexOf( '*' ) != –1
    
  6. Click Update and save the new property.

Testing the Validation Rule

  1. Apply the new custom property page to a service model element.

    The Validation Check property is red and marked with an exclamation point until a valid value (containing an asterisk in this example) is entered.

    Properties Dialog Box
    Properties Dialog Box