WSO2 Governance Registry - Quick Start [ Documentation Index ]

WSO2 Governance Registry Quick Start

The Quick start describes how to install Governance Registry in Linux, Windows and how to start working with G-Reg.

Table of Contents

Installing and Running the WSO2 Governance Registry

Installing on Linux/Unix

The following steps will take you through the linux/unix distribution installation.

  1. Download the WSO2 Governance Registry binary distribution.
  2. Extract the zip archive where you want the WSO2 Governance Registry installed (e.g. /opt)
  3. Set the JAVA_HOME environment variable to your Java home using the export command or by editing /etc/profile, and add the Java /bin directory to your PATH
  4. Execute the WSO2 Governance Registry start script or the daemon script from the bin directory. e.g. ./wso2server.sh OR ./daemon.sh start OR ./wso2server.sh --console

Installing on MS Windows

The following steps will take you through the installation for the MS Windows operating system.

  1. Download the WSO2 Governance Registry binary distribution.
  2. Extract the zip archive where you want the WSO2 Governance Registry installed
  3. Set the JAVA_HOME environment variable to your Java installation, and the PATH environment variable to the Java /bin directory.
  4. Execute the WSO2 Governance Registry start script from the bin folder. e.g. wso2server.bat

Accessing the Registry Web based Management Console

Once WSO2 Governance 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 Governance Registry Management Console.

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.

Figure 1 : Registry login page

Resources User Interface

In the navigator, under Resources, click Browse.



Figure 2.1 : Registry User Interface in Tree View


Figure 2.2 : Registry User Interface in Detail View

Meta Data Panel

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

Figure 3 : The meta data panel

Properties Panel

This panel displays the properties of the currently selected resource or collection. New properties can be added, while existing properties can be edited or deleted.

Figure 4 : The properties 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 5 : View of Directory Entries

Adding a new Resource/Collection

To add a resource/collection, click on the "Add resource" or "Add collection" link provided and a page will be presented to fill in the required information.

Figure 6 : Add Resource Panel

Deleting a Resource

To delete a resource , click on the arrow in front of the resource name. Then the action panel will be displayed. You can click on the cylindric icon provided, to delete the resource.

Figure 7 : Action Panel

Similarly Edit, move, copy buttons can be used to rename, move, copy the 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 8 : View of the Content

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

Please refer the user guide

Users can perform a "tag" search using the search block within the registry browser. Note that this will only show the resources that contain the tag you are searching. In order to do a more customized search you have to use the Advanced Search described below.

Figure 9 : Search

In the navigator, under Registry, click Search.

All resources 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 10 : Advanced Search

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 : Activity Search