From Omar Wiki

Registry Browser - Web UI Browser User Guide

Contents 1 Introduction 2 Getting Started 3 Overall Layout 4 Discovering Content 5 Explore Registry 6 Search Registry 6.1 Displaying Search Results 6.2 Viewing Details of Serach results 6.3 Bookmarking Objects 6.3.1 Removing Objects From Bookmarks 6.4 Downloading Content From Registry 6.4.1 Downloading RegistryObject Metadata 6.4.2 Downloading RepositoryItem Content 7 Publishing Object To Registry 8 Creating Relationships 8.1 Creating References 8.2 Creating Associations

Introduction

This document describes how to use the Web UI Registry Browser publish, manage and discover information in the registry.

Getting Started

This section describes what you need to do to get started using the Registry Browser Web UI browser.

First, the Registry must be installed, configured and started. See Install for details.

Next, start a web browser. If the Registry is installed on a local machine using default configuration, enter the following URL in your browser:

http://localhost:8080/omar/registry/thin/WelcomePage.jsp

The URL shown above is the default. 'localhost' should resolve to your local machine name, '8080' is the default port, and 'omar/registry/thin/browser.jsp' is the default URI. If the Registry is not deployed locally, or not deployed using default properties, obtain the URL from the Registry Administrator.

After that, the Registry Browser Web UI should appear in your web browser. The following sections provide more information on layout, discovery, search results and drill down features.

Overall Layout

The Web UI layout is as follows:

• Header Panel
  • A configurable logo and banner text
  • Current User Indicator - Indicates who is the user currently associated with the web console session
  • Informational Links – Various links to documentation and other helpful resources
• Action Panel
  • Tasks Tab – Includes links to various registry tasks such as Create User Account and Create a New Registry Object.
  • Search Tab – Provides the controls for searching the registry using pre-defined queries
  • Explore Tab – Provides ability to explore the registry content as a hierarchical tree similar to a file system explorer
• Main Panel
  • Login – Allows logon / logoff to / from the registry
  • Reset Locale – Resets the locale associated with registry content to the system-wide default
  • Content Locale – Allows changing the locale associated with registry content to their preferred locale
  • End Session – Allows ending the currently opened session with the registry
  • Registry Objects Main Panel – The upper part of the main panel where Registry Objects matching search results and explore actions are displayed
  • Registry Objects Details Panel – The lower panel the main panel where details of a selected RegistryObject are displayed
  • Footer Panel – Includes any footer content such as copyright notices etc... This can be customized.

Discovering Content

There are two ways to discover Registry content: exploring content using file folders and querying content using query forms. Each is discussed in subsections below:

Explore Registry

In the Discovery page, click on the Explore Registry link. The Explore Registry page will load in the Discovery frame. This page allows you to navigate through Registry and Repository content using a hierarchy of file folders. The root folder, named 'registry', contains all Registry content, and is similar to the UNIX root directory.

Click on the expansion image directly left of the folder to expand the 'registry' folder. You should see a subfolder named 'userData'. This is the default folder where all user content is placed.

To review the contents of a folder, click on the folder image or the folder name. The search results will appear in the SearchResultsFrame directly to the right. You may review details of each item by clicking on the Details link located in the first column of the search results table. See the Search Result Drill Downs section below for details.

Search Registry

In the Discovery page, click on the Search Registry link. The Search Registry page will load in the Discovery frame. At the top of the page is a drop-down list, called 'Select ad-hoc query', that contains a list of preconfigured queries. Clicking a member of this list, causes a new query form to be loaded in the Search Registry page. Business Query query is the default query in the list, and will be used in the following description. 4.2.1 Business Query Form

This form enables querying based on the RIM type, name, description and one or more classifications. It is equivalent to the Business Query contained in the Thick Client. This query is good for general querying - more specific queries can be configured for specific target audiences.

The default ObjectType is 'RegistryObject' which is the parent type of all RIM objects. Not surprisingly, executing a query with this type will return a large result set. For smaller result sets, choose a different type such as 'Service' or 'Organization'. Then, click the Search button. The search results will appear in the SearchResultsFrame in the upper right. This kind of query is not filtered in any way - all objects are returned. See below for how to filter the result set.

The Name, Description and Classifications are all used to filter the search results. For example, select 'Service' from the ObjectType list box, enter '%ebXML%' into the Name field, and click the Search button.

The '%' is used as the wildcard character.

Displaying Search Results

The search results from a query are displayed in the Registry Objects Main Panel in the upper right. They are displayed in a tabular format - RIM object attributes are displayed as table columns, each RIM object is displayed as table rows.

The columns displayed to the user can be configured for each RIM object. For example, Service objects can display five attributes, Extrinsic Objects display four attributes and so on. See the Registry Browser Web UI Configuration Guide for details.

If there are more rows in the result set than the Registry Browser Web UI can display, the scroller at the bottom of the Search Results page can be used to navigate forward and backward through the set.

Each row in the search results contains a Details column with a link to the Details page. Click on any of the links to see an object's details.

Viewing Details of Serach results

The search result table contains links to a Details page for any RIM object. Execute a query as explained previously. Click on the Details link. The Details page displays in the DetailFrame in the lower right. Scroll down the page to see all the object's attributes and composed objects. Other objects, related to the drill down object, are also displayed in adjacent tab folders. Click on any of these other tabs to see details on these related objects.

Bookmarking Objects

A user may bookmark one or more objects in the Registry Objects table after a performing a search. Bookmarking is functionally similar to the familiar shopping cart model used by many web sites. Bookmarking allows the web console to keep the bookmarked objects accessible to the user across different searches for the lifetime of the user session.

To bookmark one or more object from the Registry Objects table perform the following steps:

1. In the Registry Objects table, select the Pick checkbox for each object you wish to bookmark
2. Click Bookmark button in the button bar above the Registry Objects table

The selected objects will be shown as a separate tabled labelled Bookmarked Objects

Removing Objects From Bookmarks

To remove one or more objects from the Bookmarked Objects table perform the following actions:

1. In the Bookmarked Objects table, select the Pick checkbox for each object you wish to remove from the bookmarked objects table
2. Click Remove Bookmark button in the button bar above the Bookmarked Objects table

The selected objects will be removed from the Bookmarked Objects table

Downloading Content From Registry

Once a search has found the desired objects the user may download the RegistryObject metadata or the RepositoryItem content, if any, that is associated with the object.

Downloading RegistryObject Metadata

RegistryObject metadata may be downloaded by clicking on the unique id for the object within its details view.

Downloading RepositoryItem Content

Content is represented by a RepositoryItem, if any, associated with an object of type ExtrinsicObject or its subtype. To download a RepositoryItem click on View RepositoryItem Content link in the details view of the ExtrinsicObject or subtype.

Publishing Object To Registry

Before you can publish, you must first register. See the User Registration Guide for more details.

To create a new registry object, perform these steps:

  1. Click Create a New Registry Object in the left sidebar. The Create a New Registry Object page should appear in the left sidebar.
  2. Choose an object type from the drop-down list and click Add.
  3. Type entries in the fields of the Details form.
  4. Optionally, click on the object's tab folders, such as Slot, and add composed objects.
  5. Click Save.

Creating Relationships

There are two kinds of relationships: references and associations. A reference is a unidirectional relationship from source to target object. An assocation is a bidirectional relationship that contains additional metadata such as what kind of an assocation it is.

References are only supported between some pairs of object types. For example, a Service source object can have a reference to a ServiceBinding object. Assocations can be created between any two object types. If a reference is valid, the Reference option will be shown first. Users still have the option of creating an Asssocation. Click the radio button in the Relationship table to toggle between Reference and Association types.

Creating References

1. Select the source object.
2. Click the Reference radio button, if it is not already clicked. The valid reference attribute should display.
3. Click the Save button to save the reference.

Creating Associations

1. Select the source object.
2. Click the Assocation radio button, if it is not already clicked. The Assocation.jsp page should appear.
3. Fill out the Assocation.jsp form.
4. Click the Save button to save the association.