How to add a System Property to a Properties Page

The capability exists to allow the addition of a new Property (or an existing property that may not currently be displayed on the page) to an existing System Properties configuration page (such as the Incident Properties page, Change Management Properties page, etc).

The following information will describe how a System Property can be configured such that it will appear on an existing Properties settings page.

Procedure

To begin, determine which existing Properties Page you want to add the property to. A property can be added to multiple properties pages if needed and each property page can include many properties, from multiple properties categories. Each existing Properties page on the system has a specific Category Name with which it can be distinguished. This name will be needed to ensure the property displays on the page. The following are the Category Names for some of the most common properties pages as found on the system:

Once you have determined the properties page you want to add the property to, make a note of the column from the chart that shows the Properties Category Names associated to that property page. As will be noticed, some pages display properties from multiple categories.

Properties can also be added to a custom properties page. See KB Article (How to Create a Custom Properties Page) which describes how to create a new Properties page. Additional properties can be added to such a custom page by using these same steps, using the category names as specified for your custom properties page.

After determining the property page, the category or categories associated with that page, and the specific property to add to that page, follow these steps.

1. Log in to the instance with an admin account.
2. Type sys_properties.list in the Filter Navigator text box and press the Enter key.
3. A list of properties should appear. Filter the list to locate the specific property you intend to add to a properties page.
4. Click on the name of the property to open the record for that system property.
5. Scroll to the related list section at the bottom of the record that corresponds to the list of Categories.
6. Click the Edit button.
   
   • A slushbucket screen should appear, with the available categories on the left and the current categories in which this property is found, on the right.
7. Using the standard slushbucket controls, add the Categories from the left side to the right side that you want this property to be associated with which will correspondingly cause the control to appear on the properties page which includes that category.
   
   • Note that from this same slushbucket screen you can also remove properties from the corresponding category (and thus associated page). If a particular properties page has multiple categories associated with the page, it will list all the properties associated with a particular category in its own headed section on the page.
8. After modifying the list of categories as associated with the system property, click the Save button to save the list configuration.

Example

To help illustrate how this is done, a simple example can be used to depict these steps in detail.

Say we wanted to add a custom property with the example name com.snc.incident.criticality_threshold to the Incident Management Properties page.

We first determine that the Category associated with the Incident Management Properties page, from the chart, is "Incident Management". We thus open the system property record for the com.snc.incident.criticality_threshold property.

In the Categories related list for this property, the Edit button is clicked, which opens a slushbucket selector. We find the category with the name Incident Management and transfer it to the Category list on the right side of the slushbucket.

Clicking the Save button will return to the property definition.

This property will then be immediately available for viewing and modification in the Incident Management properties page.

The text in the Description field of the system property record added to the page will be displayed directly above the property. Thus, for clarity, this text may be modified to indicate what this particular property might be used for. HTML tags can be used in the Description field to control the formatting of the property display text.

If a properties page is configured for multiple categories, the properties on the page will be grouped as per the category. The category name and description are based on the data in that Properties Category record (in the Name and Title field respectively from the Category record). The Title field can include HTML to allow the Category header, as it appears in the properties page, to be formatted.

The order in which the properties appear on a specific properties page (as well as the ordering of the categorized sections on the page) can also be modified. Please refer to the article How to Change the Display Order of Properties on a Properties Page for instructions on how that can be done.

As indicated in the chart above, certain properties pages are rendered using different mechanisms and forms. This includes the following Property Pages:

• Standard Change Properties
• Service Catalog Configuration
• Mid-Server Properties
• Service Portal Properties
• Email Properties
• Basic Configuration
• Basic Configuration UI16
• SLA Properties
• Import Export Properties

For details on the various methods by which a property can be added to these properties forms, please see KB Article How to Add Properties to the Non-Standard Properties Pages.