Categorizing and maintaining your System Properties

General Add comments
by:

I am working on the support desk and sometimes customers ask us how to maintain the system properties on a configurable page, so they can be easily set instead of changing the property directly in the sys_properties table. A page, just like the out-of-the-box “Email Properties” page for example.


Figure 1: Email Properties page sample

As there isn’t much information about this on the official Service-now.com Wiki site, I thought : “This is a nice idea for a blog article”. Besides that, it is very easy to accomplish. đŸ˜‰
System Property Categories
You can define categories for your properties to get them “grouped” in some way. If you look at the “out-of-the-box” Email properties page (see figure 1 above), you see that the text “SMTP Server Settings – also used for POP s..” is displayed in bold. That is in fact the title of this system property category.

You can find these categories in the Categories module of the System Properties application:

If you open a category item in the list (see figure 2 below), you can select one or more properties for that category by using the Edit button

.

Figure 2: System Property Category sample

As you probably know, it might happen that a specific property doesn’t exist in the instance. No worries, you can create it yourself with the New button. More information can be found here: Adding a property

It is possible to specify the name, the title for the category and – if you want – you can add some styling or provide some extra information for the specific category.

After having specified the properties and if this category is already visible for you, like the “email ” category in this example, you can now see and configure the new properties directly from the page. It’s that easy!

Some final questions….
If you look at the standard “Email Properties” page, you will see that it is containing 5 different categories. So the two final questions left are:

1. How can I define the page name of the “properties” page?
2. How to specify the categories that should show up on this page?

Looking again at the “Email Properties” page, we see that it is “started” by the “Email” module by using the URL (from arguments) method. See figure 3 below.


Figure 3: The email module (Link to the properties page) sample

Look closely at the Arguments field.
The title of the page is specified in this part: sysparm_title=Email%20Properties.

Categories that should show up on the page are comma separated in this part:
&sysparm_category= Email, POP3,Email%20Security,Email%20Auto%20User,Email%20Advanced

So if you want to make changes in the page title or the categories on the page, simply modify the “arguments” line with the page name or titles of the system property categories. That’s it.

Some final notes:
If you create a new module for your properties, please be sure you create the module in an application that is restricted to the admin role, so your end user won’t have access to it.
Also, make sure that you are not using the same property twice on the page, otherwise your property will not be saved when you change the value.

I hope this blog article is helpful for you. If you have any question you can leave a reply or send me an email at ben.hankel@2e2.nl .

Leave a Reply