WSO2 Registry - User Guide [ Documentation Index ]

WSO2 Registry User Guide

The User Guide describes how to configure the WSO2 Registry using the Web based management console. The WSO2 Management Console has been tested on the Mozilla Firefox 2.0, 3.0 and Internet Explorer 6.0, 7.0 Web Browsers at a resolution of 1024x768.

Table of Contents

Installing and Running the WSO2 Registry

Please refer the Installation Guide for details on how to install and run the WSO2 Registry.

Accessing the Registry Web based Management Console

Once WSO2 Registry has been successfully installed and started, launch a Web browser instance and point it to the URL https://localhost:9443/carbon. This will take you to the Sign In page of the WSO2 Registry Management Console.

Known Issues and Limitations in this Version

  1. This release doesn't support clustering
  2. Remote Registry API doesn't support User Management
  3. Remote Registry API doesn't support custom media type processing

Signing In

Enter your user name and password to log on to the Registry Management Console.

The default username / password is : admin / admin

If you get any errors when trying to sign in, click Sign-in Help. A list of possible errors, their descriptions and solutions will be displayed.


Resources User Interface

In the navigator, under Registry, click Resources.

Figure 1 : Registry User Interface

Components of Registry User Interface

Resource Breadcrumb

Use the breadcrumb to navigate backward in the current branch of the directory path, by clicking on a directory name in the breadcrumb. Note that you can access the root of the directory path by clicking the Home icon in the breadcrumb.

Figure 2: The Breadcrumb

Meta Data Panel

The meta data panel displays the following properties of the resource or the collection

Figure 3 : The meta data panel

Content Panel

If the currently selected entity is a collection, the Content Panel shows the child entries under that collection. It provides details of each entry. An entry can be either another collection or a resource.

Figure 4 : View of Directory Entries

Adding a new Resource

Adding a resource could be done for a collection of resources or for an individual resource. To add a collection or directory, click on the "Add resource"/"Add collection" link provided and a page will be presented to fill in the required information. Optionally, a description can be included for the resource in question.

Note : Adding and and deleting resources within the registry are considered version operations. Therefore, provision is made to rollback or restore a resource to any previous version. Refer Versions for additional information on this topic.

Deleting a Resource

To delete a resource , click on the cylindric icon provided. However, upon doing so a resource will not be removed from the database but instead marked as deleted. This provides the opportunity to restore a previously deleted resource.

If the currently selected entity is a resource, the Content panel provides a user interface through which you can display, edit and download the content.

Figure 5 : View of the Content

Permissions

Using the following screen, WSO2 Registry permissions can be assigned to different roles and individual users. The top half of the permission's screen is used to define user roles and the bottom half for defining role permissions.

Figure 6 : Permissions

To assign permissions to users or roles follow the steps given below:

  1. select user/role from User/Role drop down
  2. choose an action from the 'Action' drop down menu
  3. select permission type. users are able to choose 'Allow' or 'Deny' by selecting appropriate option button.
  4. Click 'Add Permission' to apply selection

Existing permissions can be changed by selecting and clearing the check boxes for required permissions and clicking the "Apply All Permissions" button.

Note: 'User permissions' have higher priority over 'role permissions'. 'Deny' permissions have higher priority over 'allow' priorities. Essentially, this means that permissions assigned to users overrides permissions assigned for a role and that a deny permission always overrides an 'allow' permission assigned to a user.

The right side of the resources page houses 3 additional blocks, namely: Tags, Comments and Versions.

Tags

Provides space to enter tags for a given resource. These tags can be used when searching for a resource as key words for search criteria.

Users can enter as many tags as they like provided individual tags are separated by commas and a given tag is not used by the same author to identify the same resource repeatedly.

Figure 7 : Tags

Search

Users can perform a "tag" search using the search block. To perform an advanced search, in the navigator, under Registry, click Search.

Figure 8 : Search

Ratings

Users can either rate or view ratings made by others using the ratings block.

Figure 9 : Ratings

Comments

Users can either comment or refer comments made by others using the comments block.

To add a new comment:

1. select the "Add Comment" located on the comments block

2. enter comment in the text box provided

3. click the 'Add' button to continue.

Figure 10 : Comments

Dependencies and Associations

Resources or collections stored in the Registry can be associated according to the user's requirements. These can either be dependencies or named custom associations.

Activities

In the navigator, under Registry, click Activities.

All registry related activities can be searched through this interface. Your search can be refined by providing optional fields, username, resource path and date range.

Figure 11 : Registry activity search interface.

The date can be either entered in the format of MM/DD/YYYY or used the date picker user interface provided.

Figure 12 : Date picker user interface

Your search can be further refined by selecting one of the following options under "Filter By" field.

Figure 13 : Options under filter by field.

In the navigator, under Registry, click Search.

All resouces found in the registry, can be searched through this interface. Search could be refined by optionally providing, resource name, created date range, updated date range, tags, comments, property name, property value and the content.

Figure 14 : Search Interface

Created or Updated dates can be either entered in the format of MM/DD/YYYY or used the date picker user interface provided.

Figure 15 : Date picker user interface


Monitoring the System

This feature provides information about the Registry on the Administrator Console. It displays system statistics and system logs.

References

WSO2 Registry Installation Guide