Best Practices for Working with the UCMDB Browser Module

This section provides a brief list of settings that impact system performance and enable you to configure the UCMDB Browser module in a way that is faster for production, and reduces the time needed to apply particular settings.

For more information about these and other settings, see the relevant section in this help.

UCMDB Browser module URL

After each Tomcat/Jetty restart, when you first log in to the CMS UI, the UCMDB Browser URL setting is updated with the used URL. This URL is used to create the direct links needed in the reports/notification emails.

To prevent the URL to be overridden, go to UCMDB > Administration > Infrastructure Settings Manager > UCMDB Browser Settings, and change the value of the Override UCMDB Browser URL on first login setting to False.

Settings affecting overall system operation

• Time for which information in the Browser cache is valid. The UCMDB Browser module uses the Time for which information in the Browser cache is valid setting to cache the information about the CIs and dynamic widgets. The default value is 5 minutes. This results in a faster login. When you change the information about a CI or a dynamic widget, it may take the same amount of time for it to be visible. To clear this cache, go to Administration Console > Cache Operations, and invalidate the UCMDB Browser module cache data by clicking the Invalidate EhCache Data button.

• Time for which UCMDB Settings in the Browser cache is valid. The UCMDB Browser module uses the Time for which UCMDB Settings in the Browser cache is valid setting to cache all the settings that are read form UCMDB Server, and the information about the available widgets.

  By default, the values stored in cache are valid for 120 minutes. If you increase this, more users will be able to log in faster. For example, with a 150 minute value, the values in the cache are considered valid for up to 150 minutes. This means that if user1 logs in, for 150 minutes after that, all users that log in and read the same settings will use the values from the cache. This results in a faster login and a better performance.

  To change the default value, go to UCMDB > Administration > Infrastructure Settings > UCMDB Browser Settings > Time for which UCMDB Settings in the Browser cache is valid setting, specify a new value (in minutes), and then restart the CMS UI for the change to take effect.

  When you change a setting, it may take the same amount of time for it to be visible. To clear this cache, go to Administration Console > Cache Operations, and invalidate the UCMDB Browser module cache data by clicking the Invalidate EhCache Data button.

• Maximum parallel calls from UCMDB Browser UI to UCMDB Browser web server. The UCMDB Browser module can throttle its asynchronous calls from the UCMDB Browser module UI to the UCMDB Browser module web server. If you have more than 8 widgets visible, increase this setting for a faster loading UI. The default value is 10. This value should always be a few increments above number of widgets, since besides each widget that runs a call when selecting a CI’s details, some other calls are also made (such as updating the most visited page).
• Enable user statistics. The logging of user statistics is disabled by default, for improved performance.
• Enable notifications. The ability to receive notifications is useful; however, this feature does put a load on the application. Notifications are enabled by default, but if you do not use them, you can improve performance by disabling them. Searching would also be faster, since notification data is not gathered for each CI returned by a search before results are displayed.

Settings affecting search

• Search results page size. This setting specifies the number of rows that are displayed in the results grid on a single page. The default value should be fine, but you can increase it to see more results in a single glance. A very high value will result in a slower overall performance, because many more elements must be loaded in the UI.

• Legacy search

  • Show federated search results. This setting only affects the legacy search engine and widgets. Disable it if issues occur such as the search not working, widgets failing to load, or you notice exceptions from the UCMDB Federation engine in the logs. An alternative to disabling this setting is to disable integration points (one by one, or all of them), and then enable them one at a time.
  • Return CIs belonging to classes that have MODELING_ENABLED qualifier in legacy search engine. This setting affects only the legacy search engine. Its value is set to True by default, which means the legacy search engine works in the same way it did since the first version. However, search rules that used the MODELING_ENABLED qualifier took 50% more search time. Changing the value to False reduces the time of the legacy search dramatically if you have MODELING_ENABLED added to many classes. You can still add custom classes to search results, using the CMS_BROWSER_SEARCH qualifier.

• Enhanced search

  • Search results update interval. This setting affects the enhanced search engine, and specifies the time period (in milliseconds) after which the UCMDB Browser module asks for updates. The default setting should be fine.