Service Registry 3.1 Administration Guide

Configuring the Search Results Display

By default, the Web Console displays 25 search results at a time for each query. If the search returns more than 25 results, users can display additional pages of results. As an administrator, you can modify the number of search results that appears on each page.

By default, the Web Console displays certain columns in the search results area. For each object, it displays the object type, name, description, version, and version comment. For some object types, a non-default display is configured. For example, for a ServiceBinding object, the display includes the endpoint instead of the version information. As an administrator, you can add configuration information to display non-default data for object types of your choice.

To perform each of these tasks, you edit a configuration file.

ProcedureTo Configure the Number of Rows in the Search Results Display

  1. Change to the directory RegistryDomain-base/domains/registry/applications/j2ee-modules/soar/WEB-INF/classes.

  2. Open the file in a text editor.

  3. Find the definition of the property omar.client.thinbrowser.numSearchResults:

  4. Change the value 25 to the value you prefer.

  5. Save and close the file.

  6. Follow the instructions in To Stop and Restart the Application Server Domain for the Registry.

ProcedureTo Configure the Columns in the Search Results Area

You can configure columns in the Search Results area for object types. The columns display the attributes of the objects.

  1. Change to the directory RegistryDomain-base/3.0/jaxr-ebxml.

  2. Open the file registry-browser-config.xml in a text editor.

  3. Add an entry to the registry-browser-config.xml file, or edit an existing one. Use the following format.

    This example configures a non-default display for Service objects.

        <SearchResultsColumn columnClass="java.lang.Object" 
          columnHeader="Object Type" columnWidth="25" editable="false" 
        <SearchResultsColumn columnClass="java.lang.Object" 
          columnHeader="Name" columnWidth="25" editable="true" method="getName"/>
        <SearchResultsColumn columnClass="java.lang.Object" 
          columnHeader="Description" columnWidth="30" editable="true" 
        <SearchResultsColumn columnClass="java.lang.Object" 
          columnHeader="Status" columnWidth="15" method="getStatusAsString"/>
        <SearchResultsColumn columnClass="java.lang.Object" 
          columnHeader="Version" columnWidth="5" method="getVersionName"/>

    The registry-browser-config.xml file provides syntax for the ObjectTypeConfig element. Use the elements that are already in the file as examples. These elements configure the default display for registry objects as well as non-default displays for ExternalLink, ExtrinsicObject, and ServiceBinding objects.

    The maximum number of columns that you can configure is 30.

    For the SearchResultsColumn element:

    • The columnClass attribute value is always java.lang.Object.

    • The columnHeader attribute value is a key to a message in the Web Console resource bundle files. These files are contained in the directory registryDomain-base/domains/registry/applications/j2ee-modules/soar/WEB-INF/classes/org/freebxml/omar/client/ui/thin/. For example, if you type Object Type for the columnHeader value, the Web Console's backing beans use the WebResourceBundle class to look up a message with that key. If the WebResourceBundle fails to find the message, it converts the key to lowercase and tries again. If this fails again, it sets the message value to"???"+key+"???" and logs a warning message about the missing resource bundle entry. So, to add new localized columnHeader values, you must enter new message keys into the ResourceBundle files contained in this directory.

    • The columnWidth attribute is not used by the Web Console.

    • The editable attribute is not used by the Web Console.

    • For the most part, you can deduce the method names for the method attribute from the class attributes in the ebXML Registry Information Model Version 3.0 specification (see Before You Read This Book for details). The getStatusAsString method can be found in the RegistryObjectImpl implementation class. (This release of Service Registry does not include API documentation, however.)

    You can have no more than one ObjectTypeConfig element for each omar.client.xml.registry.infomodel class name.

  4. Save and close the registry-browser-config.xml file.

  5. Follow the instructions in To Stop and Restart the Application Server Domain for the Registry.

  6. To verify the reconfiguration, use the Search or Explore menu of the Web Console to display the objects whose columns you changed.