Use > JMX Reference > Administration Methods > UCMDB Browser module JMX Methods

UCMDB Browser Module JMX Methods

How to Modify the Currently Indexed List

  1. Go to JMX Console > UCMDB:service=Topology Search Services.

  2. Choose one or more of the following operations:

    • editIndexerConfiguration – displays and enables editing of the Search_Indexer_Configuration_XML file.

    • editParserConfiguration – displays and enables editing of the Search_Parser_Configuration_XML file.

    • editRankingConfiguration – displays and enables editing of the Search_Ranking_Configuration_XML file.

  3. For each operation, enter the relevant customer ID and click Invoke.

How to Enable/Disable the Search Engine

  1. Go to JMX Console > UCMDB:service=Settings Services > setGlobalSettingValue.
  2. In the name field enter cmdb.search.enabled.

  3. In the value field enter:

    true: If you want the search enabled.

    false: If you want the search disabled.

  4. Click Invoke.
  5. Restart the UCMDB server.

Note If you disable the Enhanced Search Engine, the UCMDB Browser module automatically reverts to the legacy search engine.

How to Enable/Disable Searching for Federated Data

The search engine can be configured to perform searches on federated data. By default, it is disabled.

To enable or disable this setting:

  1. Go to JMX Console > UCMDB:service=Settings Services > setSettingValue.
  2. In the name field enter cmdb.federation.search.enabled.

  3. In the value field enter:

    true: If you want to enable searching federated data.

    false: If you want to disable searching federated data.

  4. Click Invoke.
  5. Restart the UCMDB server.

How to Configure Repetition of the Enriching Mechanism

To configure the number of times that enriching is performed on search results:

  1. Go to JMX Console > UCMDB:service=Settings Services > setSettingValue.
  2. In the name field enter cmdb.search.enriching.depth.

  3. In the value field enter the number of times that you want enriching to be repeated on search results.

  4. Click Invoke.
  5. Restart the UCMDB server.

How to Configure the Date Format

The search engine supports two dates formats: day-month-year (DMY) and month-day-year (MDY), which can be configured as follows:

  1. Go to JMX Console > UCMDB:service=Settings Services > setSettingValue.
  2. In the name field enter: cmdb.search.date.format.
  3. In the value field enter the desired date format: DMY, MDY, or both.
  4. Click Invoke.
  5. Restart the UCMDB server.

How to Restore Factory Defaults

To restore the default configuration XML files from the factory content, go to JMX Console > UCMDB:service=Topology Search Services and invoke the restoreFactoryDefaults() method.

Caution This method overwrites the current configuration. You should back up the configuration files before invoking it.

Content of Solr Database

By default, the Solr search engine is embedded inside UCMDB server. To query it directly, go to JMX Console > UCMDB:service=Topology Search Services and invoke the debugSolrQuery() method.

How to Access CMS UI by IP Address

If you access CMS UI by IP address (not by FQDN), you should add the CMS UI IP address to the UCMDB’s trusted hosts. You can do this from the JMX console. Under LW-SSO Configuration Management, locate the addTrustedIPs method and invoke it using the CMS UI IP address value.

How to Specify Persistency Values for Notifications

The length of time that notifications are retained and how often they are generated are defined in the JMX console:

  1. Go to JMX Console > UCMDB:service=Settings Services > setSettingValue.

  2. To change each setting, follow these steps:

    1. In the name field, enter one of the strings listed below:

      • tql.tracker.queue.evaluation.initial.delay.in.min - the initial delay (in minutes) after startup, before a TQL query is calculated.
      • tql.tracker.queue.evaluation.period.in.min - the interval (in minutes) of how often a TQL query is scheduled to run.
      • tql.tracker.queue.max.single.run.time.in.min - the maximum length of time (in minutes) for the system to work on calculating changes on CIs or TQL queries during a single execution.
      • tql.tracker.min.time.between.tracker.runs.in.min - the minimum length of time between two runs of a TQL query.

      Note To find the default value for each setting, enter the required string in the name field of getSettingDefaultValue and click Invoke.

    2. In the value field, enter the value you want to set.

    3. Click Invoke.
  3. Restart the UCMDB server.

How to Re-index the CIs of a Given CI Type

You can re-index the CIs of a given CI type from the CMDB model database for search purposes. To do this, follow these steps:

  1. Go to JMX Console > UCMDB:service=Topology Search Services > reindexCiType.
  2. In the ciType field, enter the CI Type that you want to re-index.

  3. Select one of the following options for the includeSubtypes option:

    • True: Re-index all the subtypes of the specified CI Type.
    • False: Do not re-index the subtypes of the specified CI Type.
  4. Click Invoke.

To check the status and progress of the re-indexing operation, use the printStatusReport JMX method. This method can display the information such as overall status, progress, and number of indexed entries.

Note  

  • In a multi-UCMDB environment, the reindexCiType method triggers the re-indexing operation on all nodes in the cluster.
  • During the execution of the re-index operation, search operations are allowed and will return results based on what is already indexed.

Send Help Center feedback