Repository Browser

Repository Browser allows you to browse all instances in the RapidOSS repository. Repository is divided into 2:

Application instances: Instances of the modeled classes created as part of the developed solution or included in the product such as RsEvent, RsTopologyObject, etc. These are the classes configured in the ModelConfiguration.xml files.
System instances: Instances of the modeled classes that are used to maintain system meta-information such as datasource, connection, user, group instances. These are internal RapidOSS configuration classes.

While the Application category enables you to view your instances and their relationships, System category displays any system instances created as the administrator configures or the users use RapidOSS.

Go to the Repository Browser tab in the admin UI (admin.gsp) and expand classes of either the Application or the System category. Once you select the class of interest, you can further refine the results by entering search queries in the search box.

Each list item has a browse menu at the beginning of the row which will open up the details dialog to display detailed properties of the selected instance. You can also double click on an instance to display its details. Browsing over relations is available via the links provided in details dialog.

Properties and operations defined for each class is also available by selecting the "Get Properties and Operations" menu for any class on the tree.

URLs for Direct Access

Repository Browser provides some urls for fast access to the RapidOSS repository.

Listing all modeled and internal classes either with default html or xml format

http://.../RapidSuite/rsBrowser/classes
or
http://.../RapidSuite/rsBrowser/classes?format=xml

Listing the instances of a class specified in "className"

URL syntax: .../RapidSuite/rsBrowser/className/

For example:
http://.../RapidSuite/rsBrowser/rsEvent
http://.../RapidSuite/rsBrowser/rsEvent?format=xml

Accessing the details of an instance

URL syntax: .../RapidSuite/rsBrowser/className/id

http://.../RapidSuite/rsEvent/4566
http://.../RapidSuite/rsEvent/4566?format=xml

By default while getting properties of an instance federated properties are included whereas operation properties and relations are excluded. To exclude federated properties, or to include operation properties or relations federatedProperties=false, operationProperties=true and relations=true parameters should be provided. A sample URL can be like the following:

http://../RapidSuite/rsBrowser/rsEvent/733?format=xml&federatedProperties=false&operationProperties=true&relations=true

Searching using User or Public Queries

Search over instances of class specified with 'className" with the user or public query specified with "searchQuery".

URL syntax: .../RapidSuite/className/search/searchQuery

For example:
http://.../RapidSuite/rsBrowser/rsEvent/search/criticalEvents
http://.../RapidSuite/rsBrowser/rsEvent/search/criticalEvents?format=xml

Or you can simply provide the query with "query" parameter.

For example:
http://.../RapidSuite/rsBrowser/rsEvent/search?query=severiy:2

Getting Property and Operation Meta-data

http://../RapidSuite/rsBrowser/rsComputerSystem/propertiesAndOperations

sample result:

 <Class name="RsComputerSystem">
  <Properties>
    <Keys>
      <Property name="name" type="java.lang.String"/>
    </Keys>
    <SimpleProperties>
      <Property name="className" type="java.lang.String"/>
      <Property name="description" type="java.lang.String"/>
      <Property name="displayName" type="java.lang.String"/>
      <Property name="geocodes" type="java.lang.String"/>
      <Property name="id" type="java.lang.Long"/>
      <Property name="isManaged" type="java.lang.Boolean"/>
      <Property name="location" type="java.lang.String"/>
      <Property name="model" type="java.lang.String"/>
      <Property name="osVersion" type="java.lang.String"/>
      <Property name="primaryOwnerContact" type="java.lang.String"/>
      <Property name="primaryOwnerName" type="java.lang.String"/>
      <Property name="readCommunity" type="java.lang.String"/>
      <Property name="rsDatasource" type="java.lang.String"/>
      <Property name="rsInsertedAt" type="java.util.Date"/>
      <Property name="rsUpdatedAt" type="java.util.Date"/>
      <Property name="snmpAddress" type="java.lang.String"/>
      <Property name="systemName" type="java.lang.String"/>
      <Property name="systemObjectID" type="java.lang.String"/>
      <Property name="vendor" type="java.lang.String"/>
    </SimpleProperties>
    <Relations>
      <Property name="childObjects" type="RsTopologyObject"/>
      <Property name="connectedVia" type="RsLink"/>
      <Property name="parentObjects" type="RsTopologyObject"/>
      <Property name="relatedTickets" type="RsTicket"/>
    </Relations>
    <FederatedProperties/>
  </Properties>
  <Operations>
    <Operation name="getState" description="" returnType="class java.lang.Object" parameters=""/>
  </Operations>
</Class>